servicetags

README

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

The servicetags 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-sdk/resource-manager/network/2023-04-01/servicetags"

Client Initialization

client := servicetags.NewServiceTagsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ServiceTagsClient.ServiceTagInformationList

ctx := context.TODO()
id := servicetags.NewLocationID("12345678-1234-9876-4563-123456789012", "locationValue")

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

Example Usage: ServiceTagsClient.ServiceTagsList

ctx := context.TODO()
id := servicetags.NewLocationID("12345678-1234-9876-4563-123456789012", "locationValue")

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

Documentation

Index

• func ValidateLocationID(input interface{}, key string) (warnings []string, errors []error)
• type LocationId
  • func NewLocationID(subscriptionId string, locationName string) LocationId
  • func ParseLocationID(input string) (*LocationId, error)
  • func ParseLocationIDInsensitively(input string) (*LocationId, error)
  • func (id *LocationId) FromParseResult(input resourceids.ParseResult) error
  • func (id LocationId) ID() string
  • func (id LocationId) Segments() []resourceids.Segment
  • func (id LocationId) String() string
• type ServiceTagInformation
• type ServiceTagInformationListCompleteResult
• type ServiceTagInformationListOperationOptions
  • func DefaultServiceTagInformationListOperationOptions() ServiceTagInformationListOperationOptions
  • func (o ServiceTagInformationListOperationOptions) ToHeaders() *client.Headers
  • func (o ServiceTagInformationListOperationOptions) ToOData() *odata.Query
  • func (o ServiceTagInformationListOperationOptions) ToQuery() *client.QueryParams
• type ServiceTagInformationListOperationResponse
• type ServiceTagInformationOperationPredicate
  • func (p ServiceTagInformationOperationPredicate) Matches(input ServiceTagInformation) bool
• type ServiceTagInformationPropertiesFormat
• type ServiceTagsClient
  • func NewServiceTagsClientWithBaseURI(sdkApi sdkEnv.Api) (*ServiceTagsClient, error)
  • func (c ServiceTagsClient) ServiceTagInformationList(ctx context.Context, id LocationId, ...) (result ServiceTagInformationListOperationResponse, err error)
  • func (c ServiceTagsClient) ServiceTagInformationListComplete(ctx context.Context, id LocationId, ...) (ServiceTagInformationListCompleteResult, error)
  • func (c ServiceTagsClient) ServiceTagInformationListCompleteMatchingPredicate(ctx context.Context, id LocationId, ...) (result ServiceTagInformationListCompleteResult, err error)
  • func (c ServiceTagsClient) ServiceTagsList(ctx context.Context, id LocationId) (result ServiceTagsListOperationResponse, err error)
• type ServiceTagsListOperationResponse
• type ServiceTagsListResult

Functions

func ValidateLocationID

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

ValidateLocationID checks that 'input' can be parsed as a Location ID

Types

type LocationId

type LocationId struct {
	SubscriptionId string
	LocationName   string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID

func NewLocationID(subscriptionId string, locationName string) LocationId

NewLocationID returns a new LocationId struct

func ParseLocationID

func ParseLocationID(input string) (*LocationId, error)

ParseLocationID parses 'input' into a LocationId

func ParseLocationIDInsensitively

func ParseLocationIDInsensitively(input string) (*LocationId, error)

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

func (*LocationId) FromParseResult

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

func (LocationId) ID

func (id LocationId) ID() string

ID returns the formatted Location ID

func (LocationId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Location ID

func (LocationId) String

func (id LocationId) String() string

String returns a human-readable description of this Location ID

type ServiceTagInformation

type ServiceTagInformation struct {
	Id                     *string                                `json:"id,omitempty"`
	Name                   *string                                `json:"name,omitempty"`
	Properties             *ServiceTagInformationPropertiesFormat `json:"properties,omitempty"`
	ServiceTagChangeNumber *string                                `json:"serviceTagChangeNumber,omitempty"`
}

type ServiceTagInformationListCompleteResult

type ServiceTagInformationListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ServiceTagInformation
}

type ServiceTagInformationListOperationOptions

type ServiceTagInformationListOperationOptions struct {
	NoAddressPrefixes *bool
	TagName           *string
}

func DefaultServiceTagInformationListOperationOptions

func DefaultServiceTagInformationListOperationOptions() ServiceTagInformationListOperationOptions

func (ServiceTagInformationListOperationOptions) ToHeaders

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

func (ServiceTagInformationListOperationOptions) ToOData

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

func (ServiceTagInformationListOperationOptions) ToQuery

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

type ServiceTagInformationListOperationResponse

type ServiceTagInformationListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ServiceTagInformation
}

type ServiceTagInformationOperationPredicate

type ServiceTagInformationOperationPredicate struct {
	Id                     *string
	Name                   *string
	ServiceTagChangeNumber *string
}

func (ServiceTagInformationOperationPredicate) Matches

func (p ServiceTagInformationOperationPredicate) Matches(input ServiceTagInformation) bool

type ServiceTagInformationPropertiesFormat

type ServiceTagInformationPropertiesFormat struct {
	AddressPrefixes *[]string `json:"addressPrefixes,omitempty"`
	ChangeNumber    *string   `json:"changeNumber,omitempty"`
	Region          *string   `json:"region,omitempty"`
	State           *string   `json:"state,omitempty"`
	SystemService   *string   `json:"systemService,omitempty"`
}

type ServiceTagsClient

type ServiceTagsClient struct {
	Client *resourcemanager.Client
}

func NewServiceTagsClientWithBaseURI

func NewServiceTagsClientWithBaseURI(sdkApi sdkEnv.Api) (*ServiceTagsClient, error)

func (ServiceTagsClient) ServiceTagInformationList

func (c ServiceTagsClient) ServiceTagInformationList(ctx context.Context, id LocationId, options ServiceTagInformationListOperationOptions) (result ServiceTagInformationListOperationResponse, err error)

ServiceTagInformationList ...

func (ServiceTagsClient) ServiceTagInformationListComplete

func (c ServiceTagsClient) ServiceTagInformationListComplete(ctx context.Context, id LocationId, options ServiceTagInformationListOperationOptions) (ServiceTagInformationListCompleteResult, error)

ServiceTagInformationListComplete retrieves all the results into a single object

func (ServiceTagsClient) ServiceTagInformationListCompleteMatchingPredicate

func (c ServiceTagsClient) ServiceTagInformationListCompleteMatchingPredicate(ctx context.Context, id LocationId, options ServiceTagInformationListOperationOptions, predicate ServiceTagInformationOperationPredicate) (result ServiceTagInformationListCompleteResult, err error)

ServiceTagInformationListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ServiceTagsClient) ServiceTagsList

func (c ServiceTagsClient) ServiceTagsList(ctx context.Context, id LocationId) (result ServiceTagsListOperationResponse, err error)

ServiceTagsList ...

type ServiceTagsListOperationResponse

type ServiceTagsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ServiceTagsListResult
}

type ServiceTagsListResult

type ServiceTagsListResult struct {
	ChangeNumber *string                  `json:"changeNumber,omitempty"`
	Cloud        *string                  `json:"cloud,omitempty"`
	Id           *string                  `json:"id,omitempty"`
	Name         *string                  `json:"name,omitempty"`
	NextLink     *string                  `json:"nextLink,omitempty"`
	Type         *string                  `json:"type,omitempty"`
	Values       *[]ServiceTagInformation `json:"values,omitempty"`
}