apimanagementserviceskus

README

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

The apimanagementserviceskus SDK allows for interaction with Azure Resource Manager apimanagement (API Version 2023-03-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-03-01-preview/apimanagementserviceskus"

Client Initialization

client := apimanagementserviceskus.NewApiManagementServiceSkusClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ApiManagementServiceSkusClient.ListAvailableServiceSkus

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

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

Documentation

Index

• func PossibleValuesForResourceSkuCapacityScaleType() []string
• func PossibleValuesForSkuType() []string
• func ValidateServiceID(input interface{}, key string) (warnings []string, errors []error)
• type ApiManagementServiceSkusClient
  • func NewApiManagementServiceSkusClientWithBaseURI(sdkApi sdkEnv.Api) (*ApiManagementServiceSkusClient, error)
  • func (c ApiManagementServiceSkusClient) ListAvailableServiceSkus(ctx context.Context, id ServiceId) (result ListAvailableServiceSkusOperationResponse, err error)
  • func (c ApiManagementServiceSkusClient) ListAvailableServiceSkusComplete(ctx context.Context, id ServiceId) (ListAvailableServiceSkusCompleteResult, error)
  • func (c ApiManagementServiceSkusClient) ListAvailableServiceSkusCompleteMatchingPredicate(ctx context.Context, id ServiceId, ...) (result ListAvailableServiceSkusCompleteResult, err error)
• type ListAvailableServiceSkusCompleteResult
• type ListAvailableServiceSkusCustomPager
  • func (p *ListAvailableServiceSkusCustomPager) NextPageLink() *odata.Link
• type ListAvailableServiceSkusOperationResponse
• type ResourceSku
• type ResourceSkuCapacity
• type ResourceSkuCapacityScaleType
  • func (s *ResourceSkuCapacityScaleType) UnmarshalJSON(bytes []byte) error
• type ResourceSkuResult
• type ResourceSkuResultOperationPredicate
  • func (p ResourceSkuResultOperationPredicate) Matches(input ResourceSkuResult) 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
• type SkuType
  • func (s *SkuType) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForResourceSkuCapacityScaleType

func PossibleValuesForResourceSkuCapacityScaleType() []string

func PossibleValuesForSkuType

func PossibleValuesForSkuType() []string

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 ApiManagementServiceSkusClient

type ApiManagementServiceSkusClient struct {
	Client *resourcemanager.Client
}

func NewApiManagementServiceSkusClientWithBaseURI

func NewApiManagementServiceSkusClientWithBaseURI(sdkApi sdkEnv.Api) (*ApiManagementServiceSkusClient, error)

func (ApiManagementServiceSkusClient) ListAvailableServiceSkus

func (c ApiManagementServiceSkusClient) ListAvailableServiceSkus(ctx context.Context, id ServiceId) (result ListAvailableServiceSkusOperationResponse, err error)

ListAvailableServiceSkus ...

func (ApiManagementServiceSkusClient) ListAvailableServiceSkusComplete

func (c ApiManagementServiceSkusClient) ListAvailableServiceSkusComplete(ctx context.Context, id ServiceId) (ListAvailableServiceSkusCompleteResult, error)

ListAvailableServiceSkusComplete retrieves all the results into a single object

func (ApiManagementServiceSkusClient) ListAvailableServiceSkusCompleteMatchingPredicate

func (c ApiManagementServiceSkusClient) ListAvailableServiceSkusCompleteMatchingPredicate(ctx context.Context, id ServiceId, predicate ResourceSkuResultOperationPredicate) (result ListAvailableServiceSkusCompleteResult, err error)

ListAvailableServiceSkusCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ListAvailableServiceSkusCompleteResult

type ListAvailableServiceSkusCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ResourceSkuResult
}

type ListAvailableServiceSkusCustomPager

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

func (*ListAvailableServiceSkusCustomPager) NextPageLink

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

type ListAvailableServiceSkusOperationResponse

type ListAvailableServiceSkusOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ResourceSkuResult
}

type ResourceSku

type ResourceSku struct {
	Name *SkuType `json:"name,omitempty"`
}

type ResourceSkuCapacity

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

type ResourceSkuCapacityScaleType

type ResourceSkuCapacityScaleType string

const (
	ResourceSkuCapacityScaleTypeAutomatic ResourceSkuCapacityScaleType = "automatic"
	ResourceSkuCapacityScaleTypeManual    ResourceSkuCapacityScaleType = "manual"
	ResourceSkuCapacityScaleTypeNone      ResourceSkuCapacityScaleType = "none"
)

func (*ResourceSkuCapacityScaleType) UnmarshalJSON

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

type ResourceSkuResult

type ResourceSkuResult struct {
	Capacity     *ResourceSkuCapacity `json:"capacity,omitempty"`
	ResourceType *string              `json:"resourceType,omitempty"`
	Sku          *ResourceSku         `json:"sku,omitempty"`
}

type ResourceSkuResultOperationPredicate

type ResourceSkuResultOperationPredicate struct {
	ResourceType *string
}

func (ResourceSkuResultOperationPredicate) Matches

func (p ResourceSkuResultOperationPredicate) Matches(input ResourceSkuResult) 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

type SkuType

type SkuType string

const (
	SkuTypeBasic       SkuType = "Basic"
	SkuTypeConsumption SkuType = "Consumption"
	SkuTypeDeveloper   SkuType = "Developer"
	SkuTypeIsolated    SkuType = "Isolated"
	SkuTypePremium     SkuType = "Premium"
	SkuTypeStandard    SkuType = "Standard"
)

func (*SkuType) UnmarshalJSON

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