privatednszonegroups

package
v0.20240731.1212841 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 31, 2024 License: MPL-2.0 Imports: 12 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-11-01/privatednszonegroups Documentation

The privatednszonegroups SDK allows for interaction with the Azure Resource Manager Service network (API Version 2023-11-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-11-01/privatednszonegroups"

Client Initialization

client := privatednszonegroups.NewPrivateDnsZoneGroupsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PrivateDnsZoneGroupsClient.CreateOrUpdate

ctx := context.TODO()
id := privatednszonegroups.NewPrivateDnsZoneGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateEndpointValue", "privateDnsZoneGroupValue")

payload := privatednszonegroups.PrivateDnsZoneGroup{
	// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: PrivateDnsZoneGroupsClient.Delete

ctx := context.TODO()
id := privatednszonegroups.NewPrivateDnsZoneGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateEndpointValue", "privateDnsZoneGroupValue")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: PrivateDnsZoneGroupsClient.Get

ctx := context.TODO()
id := privatednszonegroups.NewPrivateDnsZoneGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateEndpointValue", "privateDnsZoneGroupValue")

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: PrivateDnsZoneGroupsClient.List

ctx := context.TODO()
id := privatednszonegroups.NewPrivateEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "privateEndpointValue")

// alternatively `client.List(ctx, id)` can be used to do batched pagination
items, err := client.ListComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidatePrivateDnsZoneGroupID 

func ValidatePrivateDnsZoneGroupID(input interface{}, key string) (warnings []string, errors []error)

ValidatePrivateDnsZoneGroupID checks that 'input' can be parsed as a Private Dns Zone Group ID

func ValidatePrivateEndpointID 

func ValidatePrivateEndpointID(input interface{}, key string) (warnings []string, errors []error)

ValidatePrivateEndpointID checks that 'input' can be parsed as a Private Endpoint ID

Types

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateDnsZoneGroup
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *PrivateDnsZoneGroup
}

type ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []PrivateDnsZoneGroup
}

type ListCustomPager added in v0.20240628.1153531 

type ListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListCustomPager) NextPageLink() *odata.Link

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]PrivateDnsZoneGroup
}

type PrivateDnsZoneConfig 

type PrivateDnsZoneConfig struct {
	Name       *string                         `json:"name,omitempty"`
	Properties *PrivateDnsZonePropertiesFormat `json:"properties,omitempty"`
}

type PrivateDnsZoneGroup 

type PrivateDnsZoneGroup struct {
	Etag       *string                              `json:"etag,omitempty"`
	Id         *string                              `json:"id,omitempty"`
	Name       *string                              `json:"name,omitempty"`
	Properties *PrivateDnsZoneGroupPropertiesFormat `json:"properties,omitempty"`
}

type PrivateDnsZoneGroupId 

type PrivateDnsZoneGroupId struct {
	SubscriptionId          string
	ResourceGroupName       string
	PrivateEndpointName     string
	PrivateDnsZoneGroupName string
}

PrivateDnsZoneGroupId is a struct representing the Resource ID for a Private Dns Zone Group

func NewPrivateDnsZoneGroupID 

func NewPrivateDnsZoneGroupID(subscriptionId string, resourceGroupName string, privateEndpointName string, privateDnsZoneGroupName string) PrivateDnsZoneGroupId

NewPrivateDnsZoneGroupID returns a new PrivateDnsZoneGroupId struct

func ParsePrivateDnsZoneGroupID 

func ParsePrivateDnsZoneGroupID(input string) (*PrivateDnsZoneGroupId, error)

ParsePrivateDnsZoneGroupID parses 'input' into a PrivateDnsZoneGroupId

func ParsePrivateDnsZoneGroupIDInsensitively 

func ParsePrivateDnsZoneGroupIDInsensitively(input string) (*PrivateDnsZoneGroupId, error)

ParsePrivateDnsZoneGroupIDInsensitively parses 'input' case-insensitively into a PrivateDnsZoneGroupId note: this method should only be used for API response data and not user input

func (*PrivateDnsZoneGroupId) FromParseResult 

func (id *PrivateDnsZoneGroupId) FromParseResult(input resourceids.ParseResult) error

func (PrivateDnsZoneGroupId) ID 

func (id PrivateDnsZoneGroupId) ID() string

ID returns the formatted Private Dns Zone Group ID

func (PrivateDnsZoneGroupId) Segments 

func (id PrivateDnsZoneGroupId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Private Dns Zone Group ID

func (PrivateDnsZoneGroupId) String 

func (id PrivateDnsZoneGroupId) String() string

String returns a human-readable description of this Private Dns Zone Group ID

type PrivateDnsZoneGroupOperationPredicate 

type PrivateDnsZoneGroupOperationPredicate struct {
	Etag *string
	Id   *string
	Name *string
}

func (PrivateDnsZoneGroupOperationPredicate) Matches 

func (p PrivateDnsZoneGroupOperationPredicate) Matches(input PrivateDnsZoneGroup) bool

type PrivateDnsZoneGroupPropertiesFormat 

type PrivateDnsZoneGroupPropertiesFormat struct {
	PrivateDnsZoneConfigs *[]PrivateDnsZoneConfig `json:"privateDnsZoneConfigs,omitempty"`
	ProvisioningState     *ProvisioningState      `json:"provisioningState,omitempty"`
}

type PrivateDnsZoneGroupsClient 

type PrivateDnsZoneGroupsClient struct {
	Client *resourcemanager.Client
}

func NewPrivateDnsZoneGroupsClientWithBaseURI 

func NewPrivateDnsZoneGroupsClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateDnsZoneGroupsClient, error)

func (PrivateDnsZoneGroupsClient) CreateOrUpdate 

func (c PrivateDnsZoneGroupsClient) CreateOrUpdate(ctx context.Context, id PrivateDnsZoneGroupId, input PrivateDnsZoneGroup) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (PrivateDnsZoneGroupsClient) CreateOrUpdateThenPoll 

func (c PrivateDnsZoneGroupsClient) CreateOrUpdateThenPoll(ctx context.Context, id PrivateDnsZoneGroupId, input PrivateDnsZoneGroup) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (PrivateDnsZoneGroupsClient) Delete 

func (c PrivateDnsZoneGroupsClient) Delete(ctx context.Context, id PrivateDnsZoneGroupId) (result DeleteOperationResponse, err error)

Delete ...

func (PrivateDnsZoneGroupsClient) DeleteThenPoll 

func (c PrivateDnsZoneGroupsClient) DeleteThenPoll(ctx context.Context, id PrivateDnsZoneGroupId) error

DeleteThenPoll performs Delete then polls until it's completed

func (PrivateDnsZoneGroupsClient) Get 

func (c PrivateDnsZoneGroupsClient) Get(ctx context.Context, id PrivateDnsZoneGroupId) (result GetOperationResponse, err error)

Get ...

func (PrivateDnsZoneGroupsClient) List 

func (c PrivateDnsZoneGroupsClient) List(ctx context.Context, id PrivateEndpointId) (result ListOperationResponse, err error)

List ...

func (PrivateDnsZoneGroupsClient) ListComplete 

func (c PrivateDnsZoneGroupsClient) ListComplete(ctx context.Context, id PrivateEndpointId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (PrivateDnsZoneGroupsClient) ListCompleteMatchingPredicate 

func (c PrivateDnsZoneGroupsClient) ListCompleteMatchingPredicate(ctx context.Context, id PrivateEndpointId, predicate PrivateDnsZoneGroupOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type PrivateDnsZonePropertiesFormat 

type PrivateDnsZonePropertiesFormat struct {
	PrivateDnsZoneId *string      `json:"privateDnsZoneId,omitempty"`
	RecordSets       *[]RecordSet `json:"recordSets,omitempty"`
}

type PrivateEndpointId 

type PrivateEndpointId struct {
	SubscriptionId      string
	ResourceGroupName   string
	PrivateEndpointName string
}

PrivateEndpointId is a struct representing the Resource ID for a Private Endpoint

func NewPrivateEndpointID 

func NewPrivateEndpointID(subscriptionId string, resourceGroupName string, privateEndpointName string) PrivateEndpointId

NewPrivateEndpointID returns a new PrivateEndpointId struct

func ParsePrivateEndpointID 

func ParsePrivateEndpointID(input string) (*PrivateEndpointId, error)

ParsePrivateEndpointID parses 'input' into a PrivateEndpointId

func ParsePrivateEndpointIDInsensitively 

func ParsePrivateEndpointIDInsensitively(input string) (*PrivateEndpointId, error)

ParsePrivateEndpointIDInsensitively parses 'input' case-insensitively into a PrivateEndpointId note: this method should only be used for API response data and not user input

func (*PrivateEndpointId) FromParseResult 

func (id *PrivateEndpointId) FromParseResult(input resourceids.ParseResult) error

func (PrivateEndpointId) ID 

func (id PrivateEndpointId) ID() string

ID returns the formatted Private Endpoint ID

func (PrivateEndpointId) Segments 

func (id PrivateEndpointId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Private Endpoint ID

func (PrivateEndpointId) String 

func (id PrivateEndpointId) String() string

String returns a human-readable description of this Private Endpoint ID

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	ProvisioningStateUpdating  ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON 

func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error

type RecordSet 

type RecordSet struct {
	Fqdn              *string            `json:"fqdn,omitempty"`
	IPAddresses       *[]string          `json:"ipAddresses,omitempty"`
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"`
	RecordSetName     *string            `json:"recordSetName,omitempty"`
	RecordType        *string            `json:"recordType,omitempty"`
	Ttl               *int64             `json:"ttl,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.