trafficcontrollerinterface

package
v0.20240327.1161949 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/servicenetworking/2023-11-01/trafficcontrollerinterface Documentation

The trafficcontrollerinterface SDK allows for interaction with the Azure Resource Manager Service servicenetworking (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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/servicenetworking/2023-11-01/trafficcontrollerinterface"

Client Initialization

client := trafficcontrollerinterface.NewTrafficControllerInterfaceClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: TrafficControllerInterfaceClient.CreateOrUpdate

ctx := context.TODO()
id := trafficcontrollerinterface.NewTrafficControllerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "trafficControllerValue")

payload := trafficcontrollerinterface.TrafficController{
	// ...
}


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

Example Usage: TrafficControllerInterfaceClient.Delete

ctx := context.TODO()
id := trafficcontrollerinterface.NewTrafficControllerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "trafficControllerValue")

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

Example Usage: TrafficControllerInterfaceClient.Get

ctx := context.TODO()
id := trafficcontrollerinterface.NewTrafficControllerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "trafficControllerValue")

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: TrafficControllerInterfaceClient.ListByResourceGroup

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

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

Example Usage: TrafficControllerInterfaceClient.ListBySubscription

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Example Usage: TrafficControllerInterfaceClient.Update

ctx := context.TODO()
id := trafficcontrollerinterface.NewTrafficControllerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "trafficControllerValue")

payload := trafficcontrollerinterface.TrafficControllerUpdate{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func ValidateTrafficControllerID

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

ValidateTrafficControllerID checks that 'input' can be parsed as a Traffic Controller ID

Types

type CreateOrUpdateOperationResponse

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

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        *TrafficController
}

type ListByResourceGroupCompleteResult

type ListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []TrafficController
}

type ListByResourceGroupOperationResponse

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]TrafficController
}

type ListBySubscriptionCompleteResult

type ListBySubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []TrafficController
}

type ListBySubscriptionOperationResponse

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]TrafficController
}

type ProvisioningState

type ProvisioningState string
const (
	ProvisioningStateAccepted     ProvisioningState = "Accepted"
	ProvisioningStateCanceled     ProvisioningState = "Canceled"
	ProvisioningStateDeleting     ProvisioningState = "Deleting"
	ProvisioningStateFailed       ProvisioningState = "Failed"
	ProvisioningStateProvisioning ProvisioningState = "Provisioning"
	ProvisioningStateSucceeded    ProvisioningState = "Succeeded"
	ProvisioningStateUpdating     ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON

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

type ResourceId

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

type TrafficController

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

type TrafficControllerId

type TrafficControllerId struct {
	SubscriptionId        string
	ResourceGroupName     string
	TrafficControllerName string
}

TrafficControllerId is a struct representing the Resource ID for a Traffic Controller

func NewTrafficControllerID

func NewTrafficControllerID(subscriptionId string, resourceGroupName string, trafficControllerName string) TrafficControllerId

NewTrafficControllerID returns a new TrafficControllerId struct

func ParseTrafficControllerID

func ParseTrafficControllerID(input string) (*TrafficControllerId, error)

ParseTrafficControllerID parses 'input' into a TrafficControllerId

func ParseTrafficControllerIDInsensitively

func ParseTrafficControllerIDInsensitively(input string) (*TrafficControllerId, error)

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

func (*TrafficControllerId) FromParseResult

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

func (TrafficControllerId) ID

func (id TrafficControllerId) ID() string

ID returns the formatted Traffic Controller ID

func (TrafficControllerId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Traffic Controller ID

func (TrafficControllerId) String

func (id TrafficControllerId) String() string

String returns a human-readable description of this Traffic Controller ID

type TrafficControllerInterfaceClient

type TrafficControllerInterfaceClient struct {
	Client *resourcemanager.Client
}

func NewTrafficControllerInterfaceClientWithBaseURI

func NewTrafficControllerInterfaceClientWithBaseURI(sdkApi sdkEnv.Api) (*TrafficControllerInterfaceClient, error)

func (TrafficControllerInterfaceClient) CreateOrUpdate

CreateOrUpdate ...

func (TrafficControllerInterfaceClient) CreateOrUpdateThenPoll

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (TrafficControllerInterfaceClient) Delete

Delete ...

func (TrafficControllerInterfaceClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (TrafficControllerInterfaceClient) Get

Get ...

func (TrafficControllerInterfaceClient) ListByResourceGroup

ListByResourceGroup ...

func (TrafficControllerInterfaceClient) ListByResourceGroupComplete

ListByResourceGroupComplete retrieves all the results into a single object

func (TrafficControllerInterfaceClient) ListByResourceGroupCompleteMatchingPredicate

func (c TrafficControllerInterfaceClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate TrafficControllerOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (TrafficControllerInterfaceClient) ListBySubscription

ListBySubscription ...

func (TrafficControllerInterfaceClient) ListBySubscriptionComplete

ListBySubscriptionComplete retrieves all the results into a single object

func (TrafficControllerInterfaceClient) ListBySubscriptionCompleteMatchingPredicate

func (c TrafficControllerInterfaceClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate TrafficControllerOperationPredicate) (result ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (TrafficControllerInterfaceClient) Update

Update ...

type TrafficControllerOperationPredicate

type TrafficControllerOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (TrafficControllerOperationPredicate) Matches

type TrafficControllerProperties

type TrafficControllerProperties struct {
	Associations           *[]ResourceId      `json:"associations,omitempty"`
	ConfigurationEndpoints *[]string          `json:"configurationEndpoints,omitempty"`
	Frontends              *[]ResourceId      `json:"frontends,omitempty"`
	ProvisioningState      *ProvisioningState `json:"provisioningState,omitempty"`
}

type TrafficControllerUpdate

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

type UpdateOperationResponse

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *TrafficController
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL