routefilterrules

package
v0.20241126.2320 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: 12 Imported by: 0

README

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

The routefilterrules 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/routefilterrules"

Client Initialization

client := routefilterrules.NewRouteFilterRulesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: RouteFilterRulesClient.CreateOrUpdate

ctx := context.TODO()
id := routefilterrules.NewRouteFilterRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "routeFilterName", "routeFilterRuleName")

payload := routefilterrules.RouteFilterRule{
	// ...
}


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

Example Usage: RouteFilterRulesClient.Delete

ctx := context.TODO()
id := routefilterrules.NewRouteFilterRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "routeFilterName", "routeFilterRuleName")

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

Example Usage: RouteFilterRulesClient.Get

ctx := context.TODO()
id := routefilterrules.NewRouteFilterRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "routeFilterName", "routeFilterRuleName")

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: RouteFilterRulesClient.ListByRouteFilter

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

// alternatively `client.ListByRouteFilter(ctx, id)` can be used to do batched pagination
items, err := client.ListByRouteFilterComplete(ctx, id)
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 PossibleValuesForAccess 

func PossibleValuesForAccess() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForRouteFilterRuleType 

func PossibleValuesForRouteFilterRuleType() []string

func ValidateRouteFilterID 

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

ValidateRouteFilterID checks that 'input' can be parsed as a Route Filter ID

func ValidateRouteFilterRuleID 

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

ValidateRouteFilterRuleID checks that 'input' can be parsed as a Route Filter Rule ID

Types

type Access 

type Access string
const (
	AccessAllow Access = "Allow"
	AccessDeny  Access = "Deny"
)

func (*Access) UnmarshalJSON 

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

type CreateOrUpdateOperationResponse 

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

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

type ListByRouteFilterCompleteResult 

type ListByRouteFilterCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []RouteFilterRule
}

type ListByRouteFilterCustomPager 

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

type ListByRouteFilterOperationResponse 

type ListByRouteFilterOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]RouteFilterRule
}

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 RouteFilterId 

type RouteFilterId struct {
	SubscriptionId    string
	ResourceGroupName string
	RouteFilterName   string
}

RouteFilterId is a struct representing the Resource ID for a Route Filter

func NewRouteFilterID 

func NewRouteFilterID(subscriptionId string, resourceGroupName string, routeFilterName string) RouteFilterId

NewRouteFilterID returns a new RouteFilterId struct

func ParseRouteFilterID 

func ParseRouteFilterID(input string) (*RouteFilterId, error)

ParseRouteFilterID parses 'input' into a RouteFilterId

func ParseRouteFilterIDInsensitively 

func ParseRouteFilterIDInsensitively(input string) (*RouteFilterId, error)

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

func (*RouteFilterId) FromParseResult 

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

func (RouteFilterId) ID 

func (id RouteFilterId) ID() string

ID returns the formatted Route Filter ID

func (RouteFilterId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Route Filter ID

func (RouteFilterId) String 

func (id RouteFilterId) String() string

String returns a human-readable description of this Route Filter ID

type RouteFilterRule 

type RouteFilterRule struct {
	Etag       *string                          `json:"etag,omitempty"`
	Id         *string                          `json:"id,omitempty"`
	Location   *string                          `json:"location,omitempty"`
	Name       *string                          `json:"name,omitempty"`
	Properties *RouteFilterRulePropertiesFormat `json:"properties,omitempty"`
}

type RouteFilterRuleId 

type RouteFilterRuleId struct {
	SubscriptionId      string
	ResourceGroupName   string
	RouteFilterName     string
	RouteFilterRuleName string
}

RouteFilterRuleId is a struct representing the Resource ID for a Route Filter Rule

func NewRouteFilterRuleID 

func NewRouteFilterRuleID(subscriptionId string, resourceGroupName string, routeFilterName string, routeFilterRuleName string) RouteFilterRuleId

NewRouteFilterRuleID returns a new RouteFilterRuleId struct

func ParseRouteFilterRuleID 

func ParseRouteFilterRuleID(input string) (*RouteFilterRuleId, error)

ParseRouteFilterRuleID parses 'input' into a RouteFilterRuleId

func ParseRouteFilterRuleIDInsensitively 

func ParseRouteFilterRuleIDInsensitively(input string) (*RouteFilterRuleId, error)

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

func (*RouteFilterRuleId) FromParseResult 

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

func (RouteFilterRuleId) ID 

func (id RouteFilterRuleId) ID() string

ID returns the formatted Route Filter Rule ID

func (RouteFilterRuleId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Route Filter Rule ID

func (RouteFilterRuleId) String 

func (id RouteFilterRuleId) String() string

String returns a human-readable description of this Route Filter Rule ID

type RouteFilterRuleOperationPredicate 

type RouteFilterRuleOperationPredicate struct {
	Etag     *string
	Id       *string
	Location *string
	Name     *string
}

func (RouteFilterRuleOperationPredicate) Matches 

func (p RouteFilterRuleOperationPredicate) Matches(input RouteFilterRule) bool

type RouteFilterRulePropertiesFormat 

type RouteFilterRulePropertiesFormat struct {
	Access              Access              `json:"access"`
	Communities         []string            `json:"communities"`
	ProvisioningState   *ProvisioningState  `json:"provisioningState,omitempty"`
	RouteFilterRuleType RouteFilterRuleType `json:"routeFilterRuleType"`
}

type RouteFilterRuleType 

type RouteFilterRuleType string
const (
	RouteFilterRuleTypeCommunity RouteFilterRuleType = "Community"
)

func (*RouteFilterRuleType) UnmarshalJSON 

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

type RouteFilterRulesClient 

type RouteFilterRulesClient struct {
	Client *resourcemanager.Client
}

func NewRouteFilterRulesClientWithBaseURI 

func NewRouteFilterRulesClientWithBaseURI(sdkApi sdkEnv.Api) (*RouteFilterRulesClient, error)

func (RouteFilterRulesClient) CreateOrUpdate 

func (c RouteFilterRulesClient) CreateOrUpdate(ctx context.Context, id RouteFilterRuleId, input RouteFilterRule) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (RouteFilterRulesClient) CreateOrUpdateThenPoll 

func (c RouteFilterRulesClient) CreateOrUpdateThenPoll(ctx context.Context, id RouteFilterRuleId, input RouteFilterRule) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (RouteFilterRulesClient) Delete 

func (c RouteFilterRulesClient) Delete(ctx context.Context, id RouteFilterRuleId) (result DeleteOperationResponse, err error)

Delete ...

func (RouteFilterRulesClient) DeleteThenPoll 

func (c RouteFilterRulesClient) DeleteThenPoll(ctx context.Context, id RouteFilterRuleId) error

DeleteThenPoll performs Delete then polls until it's completed

func (RouteFilterRulesClient) Get 

func (c RouteFilterRulesClient) Get(ctx context.Context, id RouteFilterRuleId) (result GetOperationResponse, err error)

Get ...

func (RouteFilterRulesClient) ListByRouteFilter 

func (c RouteFilterRulesClient) ListByRouteFilter(ctx context.Context, id RouteFilterId) (result ListByRouteFilterOperationResponse, err error)

ListByRouteFilter ...

func (RouteFilterRulesClient) ListByRouteFilterComplete 

func (c RouteFilterRulesClient) ListByRouteFilterComplete(ctx context.Context, id RouteFilterId) (ListByRouteFilterCompleteResult, error)

ListByRouteFilterComplete retrieves all the results into a single object

func (RouteFilterRulesClient) ListByRouteFilterCompleteMatchingPredicate 

func (c RouteFilterRulesClient) ListByRouteFilterCompleteMatchingPredicate(ctx context.Context, id RouteFilterId, predicate RouteFilterRuleOperationPredicate) (result ListByRouteFilterCompleteResult, err error)

ListByRouteFilterCompleteMatchingPredicate retrieves all the results and then applies the predicate

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.