networkmanagerroutingconfigurations

package
v0.20241128.1112539 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2024-03-01/networkmanagerroutingconfigurations Documentation

The networkmanagerroutingconfigurations SDK allows for interaction with Azure Resource Manager network (API Version 2024-03-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/2024-03-01/networkmanagerroutingconfigurations"

Client Initialization

client := networkmanagerroutingconfigurations.NewNetworkManagerRoutingConfigurationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: NetworkManagerRoutingConfigurationsClient.CreateOrUpdate

ctx := context.TODO()
id := networkmanagerroutingconfigurations.NewRoutingConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkManagerName", "routingConfigurationName")

payload := networkmanagerroutingconfigurations.NetworkManagerRoutingConfiguration{
	// ...
}


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

Example Usage: NetworkManagerRoutingConfigurationsClient.Delete

ctx := context.TODO()
id := networkmanagerroutingconfigurations.NewRoutingConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkManagerName", "routingConfigurationName")

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

Example Usage: NetworkManagerRoutingConfigurationsClient.Get

ctx := context.TODO()
id := networkmanagerroutingconfigurations.NewRoutingConfigurationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "networkManagerName", "routingConfigurationName")

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

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

// alternatively `client.List(ctx, id, networkmanagerroutingconfigurations.DefaultListOperationOptions())` can be used to do batched pagination
items, err := client.ListComplete(ctx, id, networkmanagerroutingconfigurations.DefaultListOperationOptions())
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 ValidateNetworkManagerID 

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

ValidateNetworkManagerID checks that 'input' can be parsed as a Network Manager ID

func ValidateRoutingConfigurationID 

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

ValidateRoutingConfigurationID checks that 'input' can be parsed as a Routing Configuration ID

Types

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *NetworkManagerRoutingConfiguration
}

type DeleteOperationOptions 

type DeleteOperationOptions struct {
	Force *bool
}

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 GetOperationResponse 

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

type ListCompleteResult 

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

type ListCustomPager 

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        *[]NetworkManagerRoutingConfiguration
}

type NetworkManagerId 

type NetworkManagerId struct {
	SubscriptionId     string
	ResourceGroupName  string
	NetworkManagerName string
}

NetworkManagerId is a struct representing the Resource ID for a Network Manager

func NewNetworkManagerID 

func NewNetworkManagerID(subscriptionId string, resourceGroupName string, networkManagerName string) NetworkManagerId

NewNetworkManagerID returns a new NetworkManagerId struct

func ParseNetworkManagerID 

func ParseNetworkManagerID(input string) (*NetworkManagerId, error)

ParseNetworkManagerID parses 'input' into a NetworkManagerId

func ParseNetworkManagerIDInsensitively 

func ParseNetworkManagerIDInsensitively(input string) (*NetworkManagerId, error)

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

func (*NetworkManagerId) FromParseResult 

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

func (NetworkManagerId) ID 

func (id NetworkManagerId) ID() string

ID returns the formatted Network Manager ID

func (NetworkManagerId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Network Manager ID

func (NetworkManagerId) String 

func (id NetworkManagerId) String() string

String returns a human-readable description of this Network Manager ID

type NetworkManagerRoutingConfiguration 

type NetworkManagerRoutingConfiguration struct {
	Etag       *string                                             `json:"etag,omitempty"`
	Id         *string                                             `json:"id,omitempty"`
	Name       *string                                             `json:"name,omitempty"`
	Properties *NetworkManagerRoutingConfigurationPropertiesFormat `json:"properties,omitempty"`
	SystemData *systemdata.SystemData                              `json:"systemData,omitempty"`
	Type       *string                                             `json:"type,omitempty"`
}

type NetworkManagerRoutingConfigurationOperationPredicate 

type NetworkManagerRoutingConfigurationOperationPredicate struct {
	Etag *string
	Id   *string
	Name *string
	Type *string
}

func (NetworkManagerRoutingConfigurationOperationPredicate) Matches 

func (p NetworkManagerRoutingConfigurationOperationPredicate) Matches(input NetworkManagerRoutingConfiguration) bool

type NetworkManagerRoutingConfigurationPropertiesFormat 

type NetworkManagerRoutingConfigurationPropertiesFormat struct {
	Description       *string            `json:"description,omitempty"`
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"`
	ResourceGuid      *string            `json:"resourceGuid,omitempty"`
}

type NetworkManagerRoutingConfigurationsClient 

type NetworkManagerRoutingConfigurationsClient struct {
	Client *resourcemanager.Client
}

func NewNetworkManagerRoutingConfigurationsClientWithBaseURI 

func NewNetworkManagerRoutingConfigurationsClientWithBaseURI(sdkApi sdkEnv.Api) (*NetworkManagerRoutingConfigurationsClient, error)

func (NetworkManagerRoutingConfigurationsClient) CreateOrUpdate 

func (c NetworkManagerRoutingConfigurationsClient) CreateOrUpdate(ctx context.Context, id RoutingConfigurationId, input NetworkManagerRoutingConfiguration) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (NetworkManagerRoutingConfigurationsClient) Delete 

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

Delete ...

func (NetworkManagerRoutingConfigurationsClient) DeleteThenPoll 

func (c NetworkManagerRoutingConfigurationsClient) DeleteThenPoll(ctx context.Context, id RoutingConfigurationId, options DeleteOperationOptions) error

DeleteThenPoll performs Delete then polls until it's completed

func (NetworkManagerRoutingConfigurationsClient) Get 

func (c NetworkManagerRoutingConfigurationsClient) Get(ctx context.Context, id RoutingConfigurationId) (result GetOperationResponse, err error)

Get ...

func (NetworkManagerRoutingConfigurationsClient) List 

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

List ...

func (NetworkManagerRoutingConfigurationsClient) ListComplete 

func (c NetworkManagerRoutingConfigurationsClient) ListComplete(ctx context.Context, id NetworkManagerId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (NetworkManagerRoutingConfigurationsClient) ListCompleteMatchingPredicate 

func (c NetworkManagerRoutingConfigurationsClient) ListCompleteMatchingPredicate(ctx context.Context, id NetworkManagerId, options ListOperationOptions, predicate NetworkManagerRoutingConfigurationOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

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 RoutingConfigurationId 

type RoutingConfigurationId struct {
	SubscriptionId           string
	ResourceGroupName        string
	NetworkManagerName       string
	RoutingConfigurationName string
}

RoutingConfigurationId is a struct representing the Resource ID for a Routing Configuration

func NewRoutingConfigurationID 

func NewRoutingConfigurationID(subscriptionId string, resourceGroupName string, networkManagerName string, routingConfigurationName string) RoutingConfigurationId

NewRoutingConfigurationID returns a new RoutingConfigurationId struct

func ParseRoutingConfigurationID 

func ParseRoutingConfigurationID(input string) (*RoutingConfigurationId, error)

ParseRoutingConfigurationID parses 'input' into a RoutingConfigurationId

func ParseRoutingConfigurationIDInsensitively 

func ParseRoutingConfigurationIDInsensitively(input string) (*RoutingConfigurationId, error)

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

func (*RoutingConfigurationId) FromParseResult 

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

func (RoutingConfigurationId) ID 

func (id RoutingConfigurationId) ID() string

ID returns the formatted Routing Configuration ID

func (RoutingConfigurationId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Routing Configuration ID

func (RoutingConfigurationId) String 

func (id RoutingConfigurationId) String() string

String returns a human-readable description of this Routing Configuration ID

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.