frontendsinterface

package
v0.20240715.1103416 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/servicenetworking/2023-05-01-preview/frontendsinterface Documentation

The frontendsinterface SDK allows for interaction with the Azure Resource Manager Service servicenetworking (API Version 2023-05-01-preview).

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/servicenetworking/2023-05-01-preview/frontendsinterface"

Client Initialization

client := frontendsinterface.NewFrontendsInterfaceClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: FrontendsInterfaceClient.CreateOrUpdate

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

payload := frontendsinterface.Frontend{
	// ...
}


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

Example Usage: FrontendsInterfaceClient.Delete

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

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

Example Usage: FrontendsInterfaceClient.Get

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

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: FrontendsInterfaceClient.ListByTrafficController

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

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

Example Usage: FrontendsInterfaceClient.Update

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

payload := frontendsinterface.FrontendUpdate{
	// ...
}


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 ValidateFrontendID

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

ValidateFrontendID checks that 'input' can be parsed as a Frontend ID

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

type DeleteOperationResponse

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

type Frontend

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

type FrontendId

type FrontendId struct {
	SubscriptionId        string
	ResourceGroupName     string
	TrafficControllerName string
	FrontendName          string
}

FrontendId is a struct representing the Resource ID for a Frontend

func NewFrontendID

func NewFrontendID(subscriptionId string, resourceGroupName string, trafficControllerName string, frontendName string) FrontendId

NewFrontendID returns a new FrontendId struct

func ParseFrontendID

func ParseFrontendID(input string) (*FrontendId, error)

ParseFrontendID parses 'input' into a FrontendId

func ParseFrontendIDInsensitively

func ParseFrontendIDInsensitively(input string) (*FrontendId, error)

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

func (*FrontendId) FromParseResult

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

func (FrontendId) ID

func (id FrontendId) ID() string

ID returns the formatted Frontend ID

func (FrontendId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Frontend ID

func (FrontendId) String

func (id FrontendId) String() string

String returns a human-readable description of this Frontend ID

type FrontendOperationPredicate

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

func (FrontendOperationPredicate) Matches

func (p FrontendOperationPredicate) Matches(input Frontend) bool

type FrontendProperties

type FrontendProperties struct {
	Fqdn              *string            `json:"fqdn,omitempty"`
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"`
}

type FrontendUpdate

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

type FrontendsInterfaceClient

type FrontendsInterfaceClient struct {
	Client *resourcemanager.Client
}

func NewFrontendsInterfaceClientWithBaseURI

func NewFrontendsInterfaceClientWithBaseURI(sdkApi sdkEnv.Api) (*FrontendsInterfaceClient, error)

func (FrontendsInterfaceClient) CreateOrUpdate

func (c FrontendsInterfaceClient) CreateOrUpdate(ctx context.Context, id FrontendId, input Frontend) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (FrontendsInterfaceClient) CreateOrUpdateThenPoll

func (c FrontendsInterfaceClient) CreateOrUpdateThenPoll(ctx context.Context, id FrontendId, input Frontend) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (FrontendsInterfaceClient) Delete

Delete ...

func (FrontendsInterfaceClient) DeleteThenPoll

func (c FrontendsInterfaceClient) DeleteThenPoll(ctx context.Context, id FrontendId) error

DeleteThenPoll performs Delete then polls until it's completed

func (FrontendsInterfaceClient) Get

Get ...

func (FrontendsInterfaceClient) ListByTrafficController

ListByTrafficController ...

func (FrontendsInterfaceClient) ListByTrafficControllerComplete

ListByTrafficControllerComplete retrieves all the results into a single object

func (FrontendsInterfaceClient) ListByTrafficControllerCompleteMatchingPredicate

func (c FrontendsInterfaceClient) ListByTrafficControllerCompleteMatchingPredicate(ctx context.Context, id TrafficControllerId, predicate FrontendOperationPredicate) (result ListByTrafficControllerCompleteResult, err error)

ListByTrafficControllerCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (FrontendsInterfaceClient) Update

Update ...

type GetOperationResponse

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

type ListByTrafficControllerCompleteResult

type ListByTrafficControllerCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Frontend
}

type ListByTrafficControllerCustomPager added in v0.20240628.1153531

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

type ListByTrafficControllerOperationResponse

type ListByTrafficControllerOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Frontend
}

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 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 UpdateOperationResponse

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

Jump to

Keyboard shortcuts

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