routefilters

package
v0.20240315.1103122 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-04-01/routefilters Documentation

The routefilters SDK allows for interaction with the Azure Resource Manager Service network (API Version 2023-04-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/network/2023-04-01/routefilters"

Client Initialization

client := routefilters.NewRouteFiltersClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: RouteFiltersClient.CreateOrUpdate

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

payload := routefilters.RouteFilter{
	// ...
}


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

Example Usage: RouteFiltersClient.Delete

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

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

Example Usage: RouteFiltersClient.Get

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

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

Example Usage: RouteFiltersClient.List

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

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

Example Usage: RouteFiltersClient.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: RouteFiltersClient.UpdateTags

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

payload := routefilters.TagsObject{
	// ...
}


read, err := client.UpdateTags(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 PossibleValuesForAccess 

func PossibleValuesForAccess() []string

func PossibleValuesForCircuitConnectionStatus 

func PossibleValuesForCircuitConnectionStatus() []string

func PossibleValuesForExpressRouteCircuitPeeringAdvertisedPublicPrefixState 

func PossibleValuesForExpressRouteCircuitPeeringAdvertisedPublicPrefixState() []string

func PossibleValuesForExpressRouteCircuitPeeringState 

func PossibleValuesForExpressRouteCircuitPeeringState() []string

func PossibleValuesForExpressRoutePeeringState 

func PossibleValuesForExpressRoutePeeringState() []string

func PossibleValuesForExpressRoutePeeringType 

func PossibleValuesForExpressRoutePeeringType() []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

Types

type Access 

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

func (*Access) UnmarshalJSON 

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

type CircuitConnectionStatus 

type CircuitConnectionStatus string
const (
	CircuitConnectionStatusConnected    CircuitConnectionStatus = "Connected"
	CircuitConnectionStatusConnecting   CircuitConnectionStatus = "Connecting"
	CircuitConnectionStatusDisconnected CircuitConnectionStatus = "Disconnected"
)

func (*CircuitConnectionStatus) UnmarshalJSON 

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

type CreateOrUpdateOperationResponse 

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

type DeleteOperationResponse 

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

type ExpressRouteCircuitConnection 

type ExpressRouteCircuitConnection struct {
	Etag       *string                                        `json:"etag,omitempty"`
	Id         *string                                        `json:"id,omitempty"`
	Name       *string                                        `json:"name,omitempty"`
	Properties *ExpressRouteCircuitConnectionPropertiesFormat `json:"properties,omitempty"`
	Type       *string                                        `json:"type,omitempty"`
}

type ExpressRouteCircuitConnectionPropertiesFormat 

type ExpressRouteCircuitConnectionPropertiesFormat struct {
	AddressPrefix                  *string                      `json:"addressPrefix,omitempty"`
	AuthorizationKey               *string                      `json:"authorizationKey,omitempty"`
	CircuitConnectionStatus        *CircuitConnectionStatus     `json:"circuitConnectionStatus,omitempty"`
	ExpressRouteCircuitPeering     *SubResource                 `json:"expressRouteCircuitPeering,omitempty"`
	IPv6CircuitConnectionConfig    *IPv6CircuitConnectionConfig `json:"ipv6CircuitConnectionConfig,omitempty"`
	PeerExpressRouteCircuitPeering *SubResource                 `json:"peerExpressRouteCircuitPeering,omitempty"`
	ProvisioningState              *ProvisioningState           `json:"provisioningState,omitempty"`
}

type ExpressRouteCircuitPeering 

type ExpressRouteCircuitPeering struct {
	Etag       *string                                     `json:"etag,omitempty"`
	Id         *string                                     `json:"id,omitempty"`
	Name       *string                                     `json:"name,omitempty"`
	Properties *ExpressRouteCircuitPeeringPropertiesFormat `json:"properties,omitempty"`
	Type       *string                                     `json:"type,omitempty"`
}

type ExpressRouteCircuitPeeringAdvertisedPublicPrefixState 

type ExpressRouteCircuitPeeringAdvertisedPublicPrefixState string
const (
	ExpressRouteCircuitPeeringAdvertisedPublicPrefixStateConfigured       ExpressRouteCircuitPeeringAdvertisedPublicPrefixState = "Configured"
	ExpressRouteCircuitPeeringAdvertisedPublicPrefixStateConfiguring      ExpressRouteCircuitPeeringAdvertisedPublicPrefixState = "Configuring"
	ExpressRouteCircuitPeeringAdvertisedPublicPrefixStateNotConfigured    ExpressRouteCircuitPeeringAdvertisedPublicPrefixState = "NotConfigured"
	ExpressRouteCircuitPeeringAdvertisedPublicPrefixStateValidationNeeded ExpressRouteCircuitPeeringAdvertisedPublicPrefixState = "ValidationNeeded"
)

func (*ExpressRouteCircuitPeeringAdvertisedPublicPrefixState) UnmarshalJSON 

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

type ExpressRouteCircuitPeeringConfig 

type ExpressRouteCircuitPeeringConfig struct {
	AdvertisedCommunities         *[]string                                              `json:"advertisedCommunities,omitempty"`
	AdvertisedPublicPrefixes      *[]string                                              `json:"advertisedPublicPrefixes,omitempty"`
	AdvertisedPublicPrefixesState *ExpressRouteCircuitPeeringAdvertisedPublicPrefixState `json:"advertisedPublicPrefixesState,omitempty"`
	CustomerASN                   *int64                                                 `json:"customerASN,omitempty"`
	LegacyMode                    *int64                                                 `json:"legacyMode,omitempty"`
	RoutingRegistryName           *string                                                `json:"routingRegistryName,omitempty"`
}

type ExpressRouteCircuitPeeringPropertiesFormat 

type ExpressRouteCircuitPeeringPropertiesFormat struct {
	AzureASN                   *int64                                `json:"azureASN,omitempty"`
	Connections                *[]ExpressRouteCircuitConnection      `json:"connections,omitempty"`
	ExpressRouteConnection     *ExpressRouteConnectionId             `json:"expressRouteConnection,omitempty"`
	GatewayManagerEtag         *string                               `json:"gatewayManagerEtag,omitempty"`
	IPv6PeeringConfig          *IPv6ExpressRouteCircuitPeeringConfig `json:"ipv6PeeringConfig,omitempty"`
	LastModifiedBy             *string                               `json:"lastModifiedBy,omitempty"`
	MicrosoftPeeringConfig     *ExpressRouteCircuitPeeringConfig     `json:"microsoftPeeringConfig,omitempty"`
	PeerASN                    *int64                                `json:"peerASN,omitempty"`
	PeeredConnections          *[]PeerExpressRouteCircuitConnection  `json:"peeredConnections,omitempty"`
	PeeringType                *ExpressRoutePeeringType              `json:"peeringType,omitempty"`
	PrimaryAzurePort           *string                               `json:"primaryAzurePort,omitempty"`
	PrimaryPeerAddressPrefix   *string                               `json:"primaryPeerAddressPrefix,omitempty"`
	ProvisioningState          *ProvisioningState                    `json:"provisioningState,omitempty"`
	RouteFilter                *SubResource                          `json:"routeFilter,omitempty"`
	SecondaryAzurePort         *string                               `json:"secondaryAzurePort,omitempty"`
	SecondaryPeerAddressPrefix *string                               `json:"secondaryPeerAddressPrefix,omitempty"`
	SharedKey                  *string                               `json:"sharedKey,omitempty"`
	State                      *ExpressRoutePeeringState             `json:"state,omitempty"`
	Stats                      *ExpressRouteCircuitStats             `json:"stats,omitempty"`
	VlanId                     *int64                                `json:"vlanId,omitempty"`
}

type ExpressRouteCircuitPeeringState 

type ExpressRouteCircuitPeeringState string
const (
	ExpressRouteCircuitPeeringStateDisabled ExpressRouteCircuitPeeringState = "Disabled"
	ExpressRouteCircuitPeeringStateEnabled  ExpressRouteCircuitPeeringState = "Enabled"
)

func (*ExpressRouteCircuitPeeringState) UnmarshalJSON 

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

type ExpressRouteCircuitStats 

type ExpressRouteCircuitStats struct {
	PrimarybytesIn    *int64 `json:"primarybytesIn,omitempty"`
	PrimarybytesOut   *int64 `json:"primarybytesOut,omitempty"`
	SecondarybytesIn  *int64 `json:"secondarybytesIn,omitempty"`
	SecondarybytesOut *int64 `json:"secondarybytesOut,omitempty"`
}

type ExpressRouteConnectionId 

type ExpressRouteConnectionId struct {
	Id *string `json:"id,omitempty"`
}

type ExpressRoutePeeringState 

type ExpressRoutePeeringState string
const (
	ExpressRoutePeeringStateDisabled ExpressRoutePeeringState = "Disabled"
	ExpressRoutePeeringStateEnabled  ExpressRoutePeeringState = "Enabled"
)

func (*ExpressRoutePeeringState) UnmarshalJSON 

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

type ExpressRoutePeeringType 

type ExpressRoutePeeringType string
const (
	ExpressRoutePeeringTypeAzurePrivatePeering ExpressRoutePeeringType = "AzurePrivatePeering"
	ExpressRoutePeeringTypeAzurePublicPeering  ExpressRoutePeeringType = "AzurePublicPeering"
	ExpressRoutePeeringTypeMicrosoftPeering    ExpressRoutePeeringType = "MicrosoftPeering"
)

func (*ExpressRoutePeeringType) UnmarshalJSON 

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

type GetOperationOptions 

type GetOperationOptions struct {
	Expand *string
}

func DefaultGetOperationOptions 

func DefaultGetOperationOptions() GetOperationOptions

func (GetOperationOptions) ToHeaders 

func (o GetOperationOptions) ToHeaders() *client.Headers

func (GetOperationOptions) ToOData 

func (o GetOperationOptions) ToOData() *odata.Query

func (GetOperationOptions) ToQuery 

func (o GetOperationOptions) ToQuery() *client.QueryParams

type GetOperationResponse 

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

type IPv6CircuitConnectionConfig 

type IPv6CircuitConnectionConfig struct {
	AddressPrefix           *string                  `json:"addressPrefix,omitempty"`
	CircuitConnectionStatus *CircuitConnectionStatus `json:"circuitConnectionStatus,omitempty"`
}

type IPv6ExpressRouteCircuitPeeringConfig 

type IPv6ExpressRouteCircuitPeeringConfig struct {
	MicrosoftPeeringConfig     *ExpressRouteCircuitPeeringConfig `json:"microsoftPeeringConfig,omitempty"`
	PrimaryPeerAddressPrefix   *string                           `json:"primaryPeerAddressPrefix,omitempty"`
	RouteFilter                *SubResource                      `json:"routeFilter,omitempty"`
	SecondaryPeerAddressPrefix *string                           `json:"secondaryPeerAddressPrefix,omitempty"`
	State                      *ExpressRouteCircuitPeeringState  `json:"state,omitempty"`
}

type ListByResourceGroupCompleteResult 

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

type ListByResourceGroupOperationResponse 

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

type ListCompleteResult 

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

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]RouteFilter
}

type PeerExpressRouteCircuitConnection 

type PeerExpressRouteCircuitConnection struct {
	Etag       *string                                            `json:"etag,omitempty"`
	Id         *string                                            `json:"id,omitempty"`
	Name       *string                                            `json:"name,omitempty"`
	Properties *PeerExpressRouteCircuitConnectionPropertiesFormat `json:"properties,omitempty"`
	Type       *string                                            `json:"type,omitempty"`
}

type PeerExpressRouteCircuitConnectionPropertiesFormat 

type PeerExpressRouteCircuitConnectionPropertiesFormat struct {
	AddressPrefix                  *string                  `json:"addressPrefix,omitempty"`
	AuthResourceGuid               *string                  `json:"authResourceGuid,omitempty"`
	CircuitConnectionStatus        *CircuitConnectionStatus `json:"circuitConnectionStatus,omitempty"`
	ConnectionName                 *string                  `json:"connectionName,omitempty"`
	ExpressRouteCircuitPeering     *SubResource             `json:"expressRouteCircuitPeering,omitempty"`
	PeerExpressRouteCircuitPeering *SubResource             `json:"peerExpressRouteCircuitPeering,omitempty"`
	ProvisioningState              *ProvisioningState       `json:"provisioningState,omitempty"`
}

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 RouteFilter 

type RouteFilter struct {
	Etag       *string                      `json:"etag,omitempty"`
	Id         *string                      `json:"id,omitempty"`
	Location   *string                      `json:"location,omitempty"`
	Name       *string                      `json:"name,omitempty"`
	Properties *RouteFilterPropertiesFormat `json:"properties,omitempty"`
	Tags       *map[string]string           `json:"tags,omitempty"`
	Type       *string                      `json:"type,omitempty"`
}

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 RouteFilterOperationPredicate 

type RouteFilterOperationPredicate struct {
	Etag     *string
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (RouteFilterOperationPredicate) Matches 

func (p RouteFilterOperationPredicate) Matches(input RouteFilter) bool

type RouteFilterPropertiesFormat 

type RouteFilterPropertiesFormat struct {
	IPv6Peerings      *[]ExpressRouteCircuitPeering `json:"ipv6Peerings,omitempty"`
	Peerings          *[]ExpressRouteCircuitPeering `json:"peerings,omitempty"`
	ProvisioningState *ProvisioningState            `json:"provisioningState,omitempty"`
	Rules             *[]RouteFilterRule            `json:"rules,omitempty"`
}

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

type RouteFiltersClient struct {
	Client *resourcemanager.Client
}

func NewRouteFiltersClientWithBaseURI 

func NewRouteFiltersClientWithBaseURI(sdkApi sdkEnv.Api) (*RouteFiltersClient, error)

func (RouteFiltersClient) CreateOrUpdate 

func (c RouteFiltersClient) CreateOrUpdate(ctx context.Context, id RouteFilterId, input RouteFilter) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (RouteFiltersClient) CreateOrUpdateThenPoll 

func (c RouteFiltersClient) CreateOrUpdateThenPoll(ctx context.Context, id RouteFilterId, input RouteFilter) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (RouteFiltersClient) Delete 

func (c RouteFiltersClient) Delete(ctx context.Context, id RouteFilterId) (result DeleteOperationResponse, err error)

Delete ...

func (RouteFiltersClient) DeleteThenPoll 

func (c RouteFiltersClient) DeleteThenPoll(ctx context.Context, id RouteFilterId) error

DeleteThenPoll performs Delete then polls until it's completed

func (RouteFiltersClient) Get 

func (c RouteFiltersClient) Get(ctx context.Context, id RouteFilterId, options GetOperationOptions) (result GetOperationResponse, err error)

Get ...

func (RouteFiltersClient) List 

func (c RouteFiltersClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)

List ...

func (RouteFiltersClient) ListByResourceGroup 

func (c RouteFiltersClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (RouteFiltersClient) ListByResourceGroupComplete 

func (c RouteFiltersClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)

ListByResourceGroupComplete retrieves all the results into a single object

func (RouteFiltersClient) ListByResourceGroupCompleteMatchingPredicate 

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

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (RouteFiltersClient) ListComplete 

func (c RouteFiltersClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (RouteFiltersClient) ListCompleteMatchingPredicate 

func (c RouteFiltersClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate RouteFilterOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (RouteFiltersClient) UpdateTags 

func (c RouteFiltersClient) UpdateTags(ctx context.Context, id RouteFilterId, input TagsObject) (result UpdateTagsOperationResponse, err error)

UpdateTags ...

type SubResource 

type SubResource struct {
	Id *string `json:"id,omitempty"`
}

type TagsObject 

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

type UpdateTagsOperationResponse 

type UpdateTagsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *RouteFilter
}

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.