routingrulecollections

package
v0.20241126.1110949 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2024-05-01/routingrulecollections Documentation

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

Client Initialization

client := routingrulecollections.NewRoutingRuleCollectionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: RoutingRuleCollectionsClient.CreateOrUpdate

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

payload := routingrulecollections.RoutingRuleCollection{
	// ...
}


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: RoutingRuleCollectionsClient.Delete

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

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

Example Usage: RoutingRuleCollectionsClient.Get

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

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

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

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

func PossibleValuesForDisableBgpRoutePropagation() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func ValidateRoutingConfigurationID 

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

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

func ValidateRuleCollectionID 

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

ValidateRuleCollectionID checks that 'input' can be parsed as a Rule Collection ID

Types

type CreateOrUpdateOperationResponse 

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

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 DisableBgpRoutePropagation 

type DisableBgpRoutePropagation string
const (
	DisableBgpRoutePropagationFalse DisableBgpRoutePropagation = "False"
	DisableBgpRoutePropagationTrue  DisableBgpRoutePropagation = "True"
)

func (*DisableBgpRoutePropagation) UnmarshalJSON 

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

type GetOperationResponse 

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

type ListCompleteResult 

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

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

type NetworkManagerRoutingGroupItem 

type NetworkManagerRoutingGroupItem struct {
	NetworkGroupId string `json:"networkGroupId"`
}

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

type RoutingRuleCollection 

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

type RoutingRuleCollectionOperationPredicate 

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

func (RoutingRuleCollectionOperationPredicate) Matches 

func (p RoutingRuleCollectionOperationPredicate) Matches(input RoutingRuleCollection) bool

type RoutingRuleCollectionPropertiesFormat 

type RoutingRuleCollectionPropertiesFormat struct {
	AppliesTo                  []NetworkManagerRoutingGroupItem `json:"appliesTo"`
	Description                *string                          `json:"description,omitempty"`
	DisableBgpRoutePropagation *DisableBgpRoutePropagation      `json:"disableBgpRoutePropagation,omitempty"`
	ProvisioningState          *ProvisioningState               `json:"provisioningState,omitempty"`
	ResourceGuid               *string                          `json:"resourceGuid,omitempty"`
}

type RoutingRuleCollectionsClient 

type RoutingRuleCollectionsClient struct {
	Client *resourcemanager.Client
}

func NewRoutingRuleCollectionsClientWithBaseURI 

func NewRoutingRuleCollectionsClientWithBaseURI(sdkApi sdkEnv.Api) (*RoutingRuleCollectionsClient, error)

func (RoutingRuleCollectionsClient) CreateOrUpdate 

func (c RoutingRuleCollectionsClient) CreateOrUpdate(ctx context.Context, id RuleCollectionId, input RoutingRuleCollection) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (RoutingRuleCollectionsClient) Delete 

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

Delete ...

func (RoutingRuleCollectionsClient) DeleteThenPoll 

func (c RoutingRuleCollectionsClient) DeleteThenPoll(ctx context.Context, id RuleCollectionId, options DeleteOperationOptions) error

DeleteThenPoll performs Delete then polls until it's completed

func (RoutingRuleCollectionsClient) Get 

func (c RoutingRuleCollectionsClient) Get(ctx context.Context, id RuleCollectionId) (result GetOperationResponse, err error)

Get ...

func (RoutingRuleCollectionsClient) List 

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

List ...

func (RoutingRuleCollectionsClient) ListComplete 

func (c RoutingRuleCollectionsClient) ListComplete(ctx context.Context, id RoutingConfigurationId, options ListOperationOptions) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (RoutingRuleCollectionsClient) ListCompleteMatchingPredicate 

func (c RoutingRuleCollectionsClient) ListCompleteMatchingPredicate(ctx context.Context, id RoutingConfigurationId, options ListOperationOptions, predicate RoutingRuleCollectionOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type RuleCollectionId 

type RuleCollectionId struct {
	SubscriptionId           string
	ResourceGroupName        string
	NetworkManagerName       string
	RoutingConfigurationName string
	RuleCollectionName       string
}

RuleCollectionId is a struct representing the Resource ID for a Rule Collection

func NewRuleCollectionID 

func NewRuleCollectionID(subscriptionId string, resourceGroupName string, networkManagerName string, routingConfigurationName string, ruleCollectionName string) RuleCollectionId

NewRuleCollectionID returns a new RuleCollectionId struct

func ParseRuleCollectionID 

func ParseRuleCollectionID(input string) (*RuleCollectionId, error)

ParseRuleCollectionID parses 'input' into a RuleCollectionId

func ParseRuleCollectionIDInsensitively 

func ParseRuleCollectionIDInsensitively(input string) (*RuleCollectionId, error)

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

func (*RuleCollectionId) FromParseResult 

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

func (RuleCollectionId) ID 

func (id RuleCollectionId) ID() string

ID returns the formatted Rule Collection ID

func (RuleCollectionId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Rule Collection ID

func (RuleCollectionId) String 

func (id RuleCollectionId) String() string

String returns a human-readable description of this Rule Collection 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.