outboundendpoints

package
v0.20241029.1112340 Latest Latest
Warning

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

 Go to latest Published: Oct 29, 2024 License: MPL-2.0 Imports: 13 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/dnsresolver/2022-07-01/outboundendpoints Documentation

The outboundendpoints SDK allows for interaction with Azure Resource Manager dnsresolver (API Version 2022-07-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/dnsresolver/2022-07-01/outboundendpoints"

Client Initialization

client := outboundendpoints.NewOutboundEndpointsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: OutboundEndpointsClient.CreateOrUpdate

ctx := context.TODO()
id := outboundendpoints.NewOutboundEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dnsResolverName", "outboundEndpointName")

payload := outboundendpoints.OutboundEndpoint{
	// ...
}


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

Example Usage: OutboundEndpointsClient.Delete

ctx := context.TODO()
id := outboundendpoints.NewOutboundEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dnsResolverName", "outboundEndpointName")

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

Example Usage: OutboundEndpointsClient.Get

ctx := context.TODO()
id := outboundendpoints.NewOutboundEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dnsResolverName", "outboundEndpointName")

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: OutboundEndpointsClient.List

ctx := context.TODO()
id := outboundendpoints.NewDnsResolverID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dnsResolverName")

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

Example Usage: OutboundEndpointsClient.Update

ctx := context.TODO()
id := outboundendpoints.NewOutboundEndpointID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dnsResolverName", "outboundEndpointName")

payload := outboundendpoints.OutboundEndpointPatch{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidateDnsResolverID 

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

ValidateDnsResolverID checks that 'input' can be parsed as a Dns Resolver ID

func ValidateOutboundEndpointID 

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

ValidateOutboundEndpointID checks that 'input' can be parsed as a Outbound Endpoint ID

Types

type CreateOrUpdateOperationOptions 

type CreateOrUpdateOperationOptions struct {
	IfMatch     *string
	IfNoneMatch *string
}

func DefaultCreateOrUpdateOperationOptions 

func DefaultCreateOrUpdateOperationOptions() CreateOrUpdateOperationOptions

func (CreateOrUpdateOperationOptions) ToHeaders 

func (o CreateOrUpdateOperationOptions) ToHeaders() *client.Headers

func (CreateOrUpdateOperationOptions) ToOData 

func (o CreateOrUpdateOperationOptions) ToOData() *odata.Query

func (CreateOrUpdateOperationOptions) ToQuery 

func (o CreateOrUpdateOperationOptions) ToQuery() *client.QueryParams

type CreateOrUpdateOperationResponse 

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

type DeleteOperationOptions 

type DeleteOperationOptions struct {
	IfMatch *string
}

func DefaultDeleteOperationOptions 

func DefaultDeleteOperationOptions() DeleteOperationOptions

func (DeleteOperationOptions) ToHeaders 

func (o DeleteOperationOptions) ToHeaders() *client.Headers

func (DeleteOperationOptions) ToOData 

func (o DeleteOperationOptions) ToOData() *odata.Query

func (DeleteOperationOptions) ToQuery 

func (o DeleteOperationOptions) ToQuery() *client.QueryParams

type DeleteOperationResponse 

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

type DnsResolverId 

type DnsResolverId struct {
	SubscriptionId    string
	ResourceGroupName string
	DnsResolverName   string
}

DnsResolverId is a struct representing the Resource ID for a Dns Resolver

func NewDnsResolverID 

func NewDnsResolverID(subscriptionId string, resourceGroupName string, dnsResolverName string) DnsResolverId

NewDnsResolverID returns a new DnsResolverId struct

func ParseDnsResolverID 

func ParseDnsResolverID(input string) (*DnsResolverId, error)

ParseDnsResolverID parses 'input' into a DnsResolverId

func ParseDnsResolverIDInsensitively 

func ParseDnsResolverIDInsensitively(input string) (*DnsResolverId, error)

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

func (*DnsResolverId) FromParseResult 

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

func (DnsResolverId) ID 

func (id DnsResolverId) ID() string

ID returns the formatted Dns Resolver ID

func (DnsResolverId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Dns Resolver ID

func (DnsResolverId) String 

func (id DnsResolverId) String() string

String returns a human-readable description of this Dns Resolver ID

type GetOperationResponse 

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

type ListCompleteResult 

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

type ListCustomPager added in v0.20240628.1153531 

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

type ListOperationOptions 

type ListOperationOptions struct {
	Top *int64
}

func DefaultListOperationOptions 

func DefaultListOperationOptions() ListOperationOptions

func (ListOperationOptions) ToHeaders 

func (o ListOperationOptions) ToHeaders() *client.Headers

func (ListOperationOptions) ToOData 

func (o ListOperationOptions) ToOData() *odata.Query

func (ListOperationOptions) ToQuery 

func (o ListOperationOptions) ToQuery() *client.QueryParams

type ListOperationResponse 

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

type OutboundEndpoint 

type OutboundEndpoint struct {
	Etag       *string                    `json:"etag,omitempty"`
	Id         *string                    `json:"id,omitempty"`
	Location   string                     `json:"location"`
	Name       *string                    `json:"name,omitempty"`
	Properties OutboundEndpointProperties `json:"properties"`
	SystemData *systemdata.SystemData     `json:"systemData,omitempty"`
	Tags       *map[string]string         `json:"tags,omitempty"`
	Type       *string                    `json:"type,omitempty"`
}

type OutboundEndpointId 

type OutboundEndpointId struct {
	SubscriptionId       string
	ResourceGroupName    string
	DnsResolverName      string
	OutboundEndpointName string
}

OutboundEndpointId is a struct representing the Resource ID for a Outbound Endpoint

func NewOutboundEndpointID 

func NewOutboundEndpointID(subscriptionId string, resourceGroupName string, dnsResolverName string, outboundEndpointName string) OutboundEndpointId

NewOutboundEndpointID returns a new OutboundEndpointId struct

func ParseOutboundEndpointID 

func ParseOutboundEndpointID(input string) (*OutboundEndpointId, error)

ParseOutboundEndpointID parses 'input' into a OutboundEndpointId

func ParseOutboundEndpointIDInsensitively 

func ParseOutboundEndpointIDInsensitively(input string) (*OutboundEndpointId, error)

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

func (*OutboundEndpointId) FromParseResult 

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

func (OutboundEndpointId) ID 

func (id OutboundEndpointId) ID() string

ID returns the formatted Outbound Endpoint ID

func (OutboundEndpointId) Segments 

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

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

func (OutboundEndpointId) String 

func (id OutboundEndpointId) String() string

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

type OutboundEndpointOperationPredicate 

type OutboundEndpointOperationPredicate struct {
	Etag     *string
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (OutboundEndpointOperationPredicate) Matches 

func (p OutboundEndpointOperationPredicate) Matches(input OutboundEndpoint) bool

type OutboundEndpointPatch 

type OutboundEndpointPatch struct {
	Tags *map[string]string `json:"tags,omitempty"`
}

type OutboundEndpointProperties 

type OutboundEndpointProperties struct {
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"`
	ResourceGuid      *string            `json:"resourceGuid,omitempty"`
	Subnet            SubResource        `json:"subnet"`
}

type OutboundEndpointsClient 

type OutboundEndpointsClient struct {
	Client *resourcemanager.Client
}

func NewOutboundEndpointsClientWithBaseURI 

func NewOutboundEndpointsClientWithBaseURI(sdkApi sdkEnv.Api) (*OutboundEndpointsClient, error)

func (OutboundEndpointsClient) CreateOrUpdate 

func (c OutboundEndpointsClient) CreateOrUpdate(ctx context.Context, id OutboundEndpointId, input OutboundEndpoint, options CreateOrUpdateOperationOptions) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (OutboundEndpointsClient) CreateOrUpdateThenPoll 

func (c OutboundEndpointsClient) CreateOrUpdateThenPoll(ctx context.Context, id OutboundEndpointId, input OutboundEndpoint, options CreateOrUpdateOperationOptions) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (OutboundEndpointsClient) Delete 

func (c OutboundEndpointsClient) Delete(ctx context.Context, id OutboundEndpointId, options DeleteOperationOptions) (result DeleteOperationResponse, err error)

Delete ...

func (OutboundEndpointsClient) DeleteThenPoll 

func (c OutboundEndpointsClient) DeleteThenPoll(ctx context.Context, id OutboundEndpointId, options DeleteOperationOptions) error

DeleteThenPoll performs Delete then polls until it's completed

func (OutboundEndpointsClient) Get 

func (c OutboundEndpointsClient) Get(ctx context.Context, id OutboundEndpointId) (result GetOperationResponse, err error)

Get ...

func (OutboundEndpointsClient) List 

func (c OutboundEndpointsClient) List(ctx context.Context, id DnsResolverId, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

func (OutboundEndpointsClient) ListComplete 

func (c OutboundEndpointsClient) ListComplete(ctx context.Context, id DnsResolverId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (OutboundEndpointsClient) ListCompleteMatchingPredicate 

func (c OutboundEndpointsClient) ListCompleteMatchingPredicate(ctx context.Context, id DnsResolverId, options ListOperationOptions, predicate OutboundEndpointOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (OutboundEndpointsClient) Update 

func (c OutboundEndpointsClient) Update(ctx context.Context, id OutboundEndpointId, input OutboundEndpointPatch, options UpdateOperationOptions) (result UpdateOperationResponse, err error)

Update ...

func (OutboundEndpointsClient) UpdateThenPoll 

func (c OutboundEndpointsClient) UpdateThenPoll(ctx context.Context, id OutboundEndpointId, input OutboundEndpointPatch, options UpdateOperationOptions) error

UpdateThenPoll performs Update then polls until it's completed

type ProvisioningState 

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

func (*ProvisioningState) UnmarshalJSON 

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

type SubResource 

type SubResource struct {
	Id string `json:"id"`
}

type UpdateOperationOptions 

type UpdateOperationOptions struct {
	IfMatch *string
}

func DefaultUpdateOperationOptions 

func DefaultUpdateOperationOptions() UpdateOperationOptions

func (UpdateOperationOptions) ToHeaders 

func (o UpdateOperationOptions) ToHeaders() *client.Headers

func (UpdateOperationOptions) ToOData 

func (o UpdateOperationOptions) ToOData() *odata.Query

func (UpdateOperationOptions) ToQuery 

func (o UpdateOperationOptions) ToQuery() *client.QueryParams

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *OutboundEndpoint
}

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.