bgpservicecommunities

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-06-01/bgpservicecommunities Documentation

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

Client Initialization

client := bgpservicecommunities.NewBgpServiceCommunitiesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: BgpServiceCommunitiesClient.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
}

Documentation

Index

• type BGPCommunity
• type BgpServiceCommunitiesClient
  • func NewBgpServiceCommunitiesClientWithBaseURI(sdkApi sdkEnv.Api) (*BgpServiceCommunitiesClient, error)
  • func (c BgpServiceCommunitiesClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)
  • func (c BgpServiceCommunitiesClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)
  • func (c BgpServiceCommunitiesClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (result ListCompleteResult, err error)
• type BgpServiceCommunity
• type BgpServiceCommunityOperationPredicate
  • func (p BgpServiceCommunityOperationPredicate) Matches(input BgpServiceCommunity) bool
• type BgpServiceCommunityPropertiesFormat
• type ListCompleteResult
• type ListOperationResponse

Types

type BGPCommunity

type BGPCommunity struct {
	CommunityName          *string   `json:"communityName,omitempty"`
	CommunityPrefixes      *[]string `json:"communityPrefixes,omitempty"`
	CommunityValue         *string   `json:"communityValue,omitempty"`
	IsAuthorizedToUse      *bool     `json:"isAuthorizedToUse,omitempty"`
	ServiceGroup           *string   `json:"serviceGroup,omitempty"`
	ServiceSupportedRegion *string   `json:"serviceSupportedRegion,omitempty"`
}

type BgpServiceCommunitiesClient

type BgpServiceCommunitiesClient struct {
	Client *resourcemanager.Client
}

func NewBgpServiceCommunitiesClientWithBaseURI

func NewBgpServiceCommunitiesClientWithBaseURI(sdkApi sdkEnv.Api) (*BgpServiceCommunitiesClient, error)

func (BgpServiceCommunitiesClient) List

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

List ...

func (BgpServiceCommunitiesClient) ListComplete

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

ListComplete retrieves all the results into a single object

func (BgpServiceCommunitiesClient) ListCompleteMatchingPredicate

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

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type BgpServiceCommunity

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

type BgpServiceCommunityOperationPredicate

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

func (BgpServiceCommunityOperationPredicate) Matches

func (p BgpServiceCommunityOperationPredicate) Matches(input BgpServiceCommunity) bool

type BgpServiceCommunityPropertiesFormat

type BgpServiceCommunityPropertiesFormat struct {
	BgpCommunities *[]BGPCommunity `json:"bgpCommunities,omitempty"`
	ServiceName    *string         `json:"serviceName,omitempty"`
}

type ListCompleteResult

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

type ListOperationResponse

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