region

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2023-05-01-preview/region Documentation

The region SDK allows for interaction with the Azure Resource Manager Service apimanagement (API Version 2023-05-01-preview).

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/apimanagement/2023-05-01-preview/region"

Client Initialization

client := region.NewRegionClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: RegionClient.ListByService

ctx := context.TODO()
id := region.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serviceValue")

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

Documentation

Index

• func ValidateServiceID(input interface{}, key string) (warnings []string, errors []error)
• type ListByServiceCompleteResult
• type ListByServiceCustomPager
  • func (p *ListByServiceCustomPager) NextPageLink() *odata.Link
• type ListByServiceOperationResponse
• type RegionClient
  • func NewRegionClientWithBaseURI(sdkApi sdkEnv.Api) (*RegionClient, error)
  • func (c RegionClient) ListByService(ctx context.Context, id ServiceId) (result ListByServiceOperationResponse, err error)
  • func (c RegionClient) ListByServiceComplete(ctx context.Context, id ServiceId) (ListByServiceCompleteResult, error)
  • func (c RegionClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id ServiceId, predicate RegionContractOperationPredicate) (result ListByServiceCompleteResult, err error)
• type RegionContract
• type RegionContractOperationPredicate
  • func (p RegionContractOperationPredicate) Matches(input RegionContract) bool
• type ServiceId
  • func NewServiceID(subscriptionId string, resourceGroupName string, serviceName string) ServiceId
  • func ParseServiceID(input string) (*ServiceId, error)
  • func ParseServiceIDInsensitively(input string) (*ServiceId, error)
  • func (id *ServiceId) FromParseResult(input resourceids.ParseResult) error
  • func (id ServiceId) ID() string
  • func (id ServiceId) Segments() []resourceids.Segment
  • func (id ServiceId) String() string

Functions

func ValidateServiceID

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

ValidateServiceID checks that 'input' can be parsed as a Service ID

Types

type ListByServiceCompleteResult

type ListByServiceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []RegionContract
}

type ListByServiceCustomPager

type ListByServiceCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}

func (*ListByServiceCustomPager) NextPageLink

func (p *ListByServiceCustomPager) NextPageLink() *odata.Link

type ListByServiceOperationResponse

type ListByServiceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]RegionContract
}

type RegionClient

type RegionClient struct {
	Client *resourcemanager.Client
}

func NewRegionClientWithBaseURI

func NewRegionClientWithBaseURI(sdkApi sdkEnv.Api) (*RegionClient, error)

func (RegionClient) ListByService

func (c RegionClient) ListByService(ctx context.Context, id ServiceId) (result ListByServiceOperationResponse, err error)

ListByService ...

func (RegionClient) ListByServiceComplete

func (c RegionClient) ListByServiceComplete(ctx context.Context, id ServiceId) (ListByServiceCompleteResult, error)

ListByServiceComplete retrieves all the results into a single object

func (RegionClient) ListByServiceCompleteMatchingPredicate

func (c RegionClient) ListByServiceCompleteMatchingPredicate(ctx context.Context, id ServiceId, predicate RegionContractOperationPredicate) (result ListByServiceCompleteResult, err error)

ListByServiceCompleteMatchingPredicate retrieves all the results and then applies the predicate

type RegionContract

type RegionContract struct {
	IsDeleted      *bool   `json:"isDeleted,omitempty"`
	IsMasterRegion *bool   `json:"isMasterRegion,omitempty"`
	Name           *string `json:"name,omitempty"`
}

type RegionContractOperationPredicate

type RegionContractOperationPredicate struct {
	IsDeleted      *bool
	IsMasterRegion *bool
	Name           *string
}

func (RegionContractOperationPredicate) Matches

func (p RegionContractOperationPredicate) Matches(input RegionContract) bool

type ServiceId

type ServiceId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServiceName       string
}

ServiceId is a struct representing the Resource ID for a Service

func NewServiceID

func NewServiceID(subscriptionId string, resourceGroupName string, serviceName string) ServiceId

NewServiceID returns a new ServiceId struct

func ParseServiceID

func ParseServiceID(input string) (*ServiceId, error)

ParseServiceID parses 'input' into a ServiceId

func ParseServiceIDInsensitively

func ParseServiceIDInsensitively(input string) (*ServiceId, error)

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

func (*ServiceId) FromParseResult

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

func (ServiceId) ID

func (id ServiceId) ID() string

ID returns the formatted Service ID

func (ServiceId) Segments

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

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

func (ServiceId) String

func (id ServiceId) String() string

String returns a human-readable description of this Service ID