apimanagementgatewayskus

README

github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2024-05-01/apimanagementgatewayskus Documentation

The apimanagementgatewayskus SDK allows for interaction with Azure Resource Manager apimanagement (API Version 2024-05-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/apimanagement/2024-05-01/apimanagementgatewayskus"

Client Initialization

client := apimanagementgatewayskus.NewApiManagementGatewaySkusClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ApiManagementGatewaySkusClient.ListAvailableSkus

ctx := context.TODO()
id := apimanagementgatewayskus.NewGatewayID("12345678-1234-9876-4563-123456789012", "example-resource-group", "gatewayName")

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

Documentation

Index

• func PossibleValuesForApiGatewaySkuType() []string
• func PossibleValuesForGatewaySkuCapacityScaleType() []string
• func ValidateGatewayID(input interface{}, key string) (warnings []string, errors []error)
• type ApiGatewaySkuType
  • func (s *ApiGatewaySkuType) UnmarshalJSON(bytes []byte) error
• type ApiManagementGatewaySkusClient
  • func NewApiManagementGatewaySkusClientWithBaseURI(sdkApi sdkEnv.Api) (*ApiManagementGatewaySkusClient, error)
  • func (c ApiManagementGatewaySkusClient) ListAvailableSkus(ctx context.Context, id GatewayId) (result ListAvailableSkusOperationResponse, err error)
  • func (c ApiManagementGatewaySkusClient) ListAvailableSkusComplete(ctx context.Context, id GatewayId) (ListAvailableSkusCompleteResult, error)
  • func (c ApiManagementGatewaySkusClient) ListAvailableSkusCompleteMatchingPredicate(ctx context.Context, id GatewayId, ...) (result ListAvailableSkusCompleteResult, err error)
• type GatewayId
  • func NewGatewayID(subscriptionId string, resourceGroupName string, gatewayName string) GatewayId
  • func ParseGatewayID(input string) (*GatewayId, error)
  • func ParseGatewayIDInsensitively(input string) (*GatewayId, error)
  • func (id *GatewayId) FromParseResult(input resourceids.ParseResult) error
  • func (id GatewayId) ID() string
  • func (id GatewayId) Segments() []resourceids.Segment
  • func (id GatewayId) String() string
• type GatewayResourceSkuResult
• type GatewayResourceSkuResultOperationPredicate
  • func (p GatewayResourceSkuResultOperationPredicate) Matches(input GatewayResourceSkuResult) bool
• type GatewaySku
• type GatewaySkuCapacity
• type GatewaySkuCapacityScaleType
  • func (s *GatewaySkuCapacityScaleType) UnmarshalJSON(bytes []byte) error
• type ListAvailableSkusCompleteResult
• type ListAvailableSkusCustomPager
  • func (p *ListAvailableSkusCustomPager) NextPageLink() *odata.Link
• type ListAvailableSkusOperationResponse

Functions

func PossibleValuesForApiGatewaySkuType

func PossibleValuesForApiGatewaySkuType() []string

func PossibleValuesForGatewaySkuCapacityScaleType

func PossibleValuesForGatewaySkuCapacityScaleType() []string

func ValidateGatewayID

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

ValidateGatewayID checks that 'input' can be parsed as a Gateway ID

Types

type ApiGatewaySkuType

type ApiGatewaySkuType string

const (
	ApiGatewaySkuTypeStandard                 ApiGatewaySkuType = "Standard"
	ApiGatewaySkuTypeWorkspaceGatewayPremium  ApiGatewaySkuType = "WorkspaceGatewayPremium"
	ApiGatewaySkuTypeWorkspaceGatewayStandard ApiGatewaySkuType = "WorkspaceGatewayStandard"
)

func (*ApiGatewaySkuType) UnmarshalJSON

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

type ApiManagementGatewaySkusClient

type ApiManagementGatewaySkusClient struct {
	Client *resourcemanager.Client
}

func NewApiManagementGatewaySkusClientWithBaseURI

func NewApiManagementGatewaySkusClientWithBaseURI(sdkApi sdkEnv.Api) (*ApiManagementGatewaySkusClient, error)

func (ApiManagementGatewaySkusClient) ListAvailableSkus

func (c ApiManagementGatewaySkusClient) ListAvailableSkus(ctx context.Context, id GatewayId) (result ListAvailableSkusOperationResponse, err error)

ListAvailableSkus ...

func (ApiManagementGatewaySkusClient) ListAvailableSkusComplete

func (c ApiManagementGatewaySkusClient) ListAvailableSkusComplete(ctx context.Context, id GatewayId) (ListAvailableSkusCompleteResult, error)

ListAvailableSkusComplete retrieves all the results into a single object

func (ApiManagementGatewaySkusClient) ListAvailableSkusCompleteMatchingPredicate

func (c ApiManagementGatewaySkusClient) ListAvailableSkusCompleteMatchingPredicate(ctx context.Context, id GatewayId, predicate GatewayResourceSkuResultOperationPredicate) (result ListAvailableSkusCompleteResult, err error)

ListAvailableSkusCompleteMatchingPredicate retrieves all the results and then applies the predicate

type GatewayId

type GatewayId struct {
	SubscriptionId    string
	ResourceGroupName string
	GatewayName       string
}

GatewayId is a struct representing the Resource ID for a Gateway

func NewGatewayID

func NewGatewayID(subscriptionId string, resourceGroupName string, gatewayName string) GatewayId

NewGatewayID returns a new GatewayId struct

func ParseGatewayID

func ParseGatewayID(input string) (*GatewayId, error)

ParseGatewayID parses 'input' into a GatewayId

func ParseGatewayIDInsensitively

func ParseGatewayIDInsensitively(input string) (*GatewayId, error)

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

func (*GatewayId) FromParseResult

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

func (GatewayId) ID

func (id GatewayId) ID() string

ID returns the formatted Gateway ID

func (GatewayId) Segments

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

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

func (GatewayId) String

func (id GatewayId) String() string

String returns a human-readable description of this Gateway ID

type GatewayResourceSkuResult

type GatewayResourceSkuResult struct {
	Capacity     *GatewaySkuCapacity `json:"capacity,omitempty"`
	ResourceType *string             `json:"resourceType,omitempty"`
	Sku          *GatewaySku         `json:"sku,omitempty"`
}

type GatewayResourceSkuResultOperationPredicate

type GatewayResourceSkuResultOperationPredicate struct {
	ResourceType *string
}

func (GatewayResourceSkuResultOperationPredicate) Matches

func (p GatewayResourceSkuResultOperationPredicate) Matches(input GatewayResourceSkuResult) bool

type GatewaySku

type GatewaySku struct {
	Name *ApiGatewaySkuType `json:"name,omitempty"`
}

type GatewaySkuCapacity

type GatewaySkuCapacity struct {
	Default   *int64                       `json:"default,omitempty"`
	Maximum   *int64                       `json:"maximum,omitempty"`
	Minimum   *int64                       `json:"minimum,omitempty"`
	ScaleType *GatewaySkuCapacityScaleType `json:"scaleType,omitempty"`
}

type GatewaySkuCapacityScaleType

type GatewaySkuCapacityScaleType string

const (
	GatewaySkuCapacityScaleTypeAutomatic GatewaySkuCapacityScaleType = "Automatic"
	GatewaySkuCapacityScaleTypeManual    GatewaySkuCapacityScaleType = "Manual"
	GatewaySkuCapacityScaleTypeNone      GatewaySkuCapacityScaleType = "None"
)

func (*GatewaySkuCapacityScaleType) UnmarshalJSON

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

type ListAvailableSkusCompleteResult

type ListAvailableSkusCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []GatewayResourceSkuResult
}

type ListAvailableSkusCustomPager

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

func (*ListAvailableSkusCustomPager) NextPageLink

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

type ListAvailableSkusOperationResponse

type ListAvailableSkusOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]GatewayResourceSkuResult
}