skus

README

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

The skus SDK allows for interaction with the Azure Resource Manager Service 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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/apimanagement/2024-05-01/skus"

Client Initialization

client := skus.NewSkusClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SkusClient.ApiManagementSkusList

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Documentation

Index

• func PossibleValuesForApiManagementSkuCapacityScaleType() []string
• func PossibleValuesForApiManagementSkuRestrictionsReasonCode() []string
• func PossibleValuesForApiManagementSkuRestrictionsType() []string
• type ApiManagementSku
• type ApiManagementSkuCapabilities
• type ApiManagementSkuCapacity
• type ApiManagementSkuCapacityScaleType
  • func (s *ApiManagementSkuCapacityScaleType) UnmarshalJSON(bytes []byte) error
• type ApiManagementSkuCosts
• type ApiManagementSkuLocationInfo
• type ApiManagementSkuOperationPredicate
  • func (p ApiManagementSkuOperationPredicate) Matches(input ApiManagementSku) bool
• type ApiManagementSkuRestrictionInfo
• type ApiManagementSkuRestrictions
• type ApiManagementSkuRestrictionsReasonCode
  • func (s *ApiManagementSkuRestrictionsReasonCode) UnmarshalJSON(bytes []byte) error
• type ApiManagementSkuRestrictionsType
  • func (s *ApiManagementSkuRestrictionsType) UnmarshalJSON(bytes []byte) error
• type ApiManagementSkuZoneDetails
• type ApiManagementSkusListCompleteResult
• type ApiManagementSkusListCustomPager
  • func (p *ApiManagementSkusListCustomPager) NextPageLink() *odata.Link
• type ApiManagementSkusListOperationResponse
• type SkusClient
  • func NewSkusClientWithBaseURI(sdkApi sdkEnv.Api) (*SkusClient, error)
  • func (c SkusClient) ApiManagementSkusList(ctx context.Context, id commonids.SubscriptionId) (result ApiManagementSkusListOperationResponse, err error)
  • func (c SkusClient) ApiManagementSkusListComplete(ctx context.Context, id commonids.SubscriptionId) (ApiManagementSkusListCompleteResult, error)
  • func (c SkusClient) ApiManagementSkusListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (result ApiManagementSkusListCompleteResult, err error)

Functions

func PossibleValuesForApiManagementSkuCapacityScaleType

func PossibleValuesForApiManagementSkuCapacityScaleType() []string

func PossibleValuesForApiManagementSkuRestrictionsReasonCode

func PossibleValuesForApiManagementSkuRestrictionsReasonCode() []string

func PossibleValuesForApiManagementSkuRestrictionsType

func PossibleValuesForApiManagementSkuRestrictionsType() []string

Types

type ApiManagementSku

type ApiManagementSku struct {
	ApiVersions  *[]string                       `json:"apiVersions,omitempty"`
	Capabilities *[]ApiManagementSkuCapabilities `json:"capabilities,omitempty"`
	Capacity     *ApiManagementSkuCapacity       `json:"capacity,omitempty"`
	Costs        *[]ApiManagementSkuCosts        `json:"costs,omitempty"`
	Family       *string                         `json:"family,omitempty"`
	Kind         *string                         `json:"kind,omitempty"`
	LocationInfo *[]ApiManagementSkuLocationInfo `json:"locationInfo,omitempty"`
	Locations    *[]string                       `json:"locations,omitempty"`
	Name         *string                         `json:"name,omitempty"`
	ResourceType *string                         `json:"resourceType,omitempty"`
	Restrictions *[]ApiManagementSkuRestrictions `json:"restrictions,omitempty"`
	Size         *string                         `json:"size,omitempty"`
	Tier         *string                         `json:"tier,omitempty"`
}

type ApiManagementSkuCapabilities

type ApiManagementSkuCapabilities struct {
	Name  *string `json:"name,omitempty"`
	Value *string `json:"value,omitempty"`
}

type ApiManagementSkuCapacity

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

type ApiManagementSkuCapacityScaleType

type ApiManagementSkuCapacityScaleType string

const (
	ApiManagementSkuCapacityScaleTypeAutomatic ApiManagementSkuCapacityScaleType = "Automatic"
	ApiManagementSkuCapacityScaleTypeManual    ApiManagementSkuCapacityScaleType = "Manual"
	ApiManagementSkuCapacityScaleTypeNone      ApiManagementSkuCapacityScaleType = "None"
)

func (*ApiManagementSkuCapacityScaleType) UnmarshalJSON

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

type ApiManagementSkuCosts

type ApiManagementSkuCosts struct {
	ExtendedUnit *string `json:"extendedUnit,omitempty"`
	MeterID      *string `json:"meterID,omitempty"`
	Quantity     *int64  `json:"quantity,omitempty"`
}

type ApiManagementSkuLocationInfo

type ApiManagementSkuLocationInfo struct {
	Location    *string                        `json:"location,omitempty"`
	ZoneDetails *[]ApiManagementSkuZoneDetails `json:"zoneDetails,omitempty"`
	Zones       *zones.Schema                  `json:"zones,omitempty"`
}

type ApiManagementSkuOperationPredicate

type ApiManagementSkuOperationPredicate struct {
	Family       *string
	Kind         *string
	Name         *string
	ResourceType *string
	Size         *string
	Tier         *string
}

func (ApiManagementSkuOperationPredicate) Matches

func (p ApiManagementSkuOperationPredicate) Matches(input ApiManagementSku) bool

type ApiManagementSkuRestrictionInfo

type ApiManagementSkuRestrictionInfo struct {
	Locations *[]string     `json:"locations,omitempty"`
	Zones     *zones.Schema `json:"zones,omitempty"`
}

type ApiManagementSkuRestrictions

type ApiManagementSkuRestrictions struct {
	ReasonCode      *ApiManagementSkuRestrictionsReasonCode `json:"reasonCode,omitempty"`
	RestrictionInfo *ApiManagementSkuRestrictionInfo        `json:"restrictionInfo,omitempty"`
	Type            *ApiManagementSkuRestrictionsType       `json:"type,omitempty"`
	Values          *[]string                               `json:"values,omitempty"`
}

type ApiManagementSkuRestrictionsReasonCode

type ApiManagementSkuRestrictionsReasonCode string

const (
	ApiManagementSkuRestrictionsReasonCodeNotAvailableForSubscription ApiManagementSkuRestrictionsReasonCode = "NotAvailableForSubscription"
	ApiManagementSkuRestrictionsReasonCodeQuotaId                     ApiManagementSkuRestrictionsReasonCode = "QuotaId"
)

func (*ApiManagementSkuRestrictionsReasonCode) UnmarshalJSON

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

type ApiManagementSkuRestrictionsType

type ApiManagementSkuRestrictionsType string

const (
	ApiManagementSkuRestrictionsTypeLocation ApiManagementSkuRestrictionsType = "Location"
	ApiManagementSkuRestrictionsTypeZone     ApiManagementSkuRestrictionsType = "Zone"
)

func (*ApiManagementSkuRestrictionsType) UnmarshalJSON

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

type ApiManagementSkuZoneDetails

type ApiManagementSkuZoneDetails struct {
	Capabilities *[]ApiManagementSkuCapabilities `json:"capabilities,omitempty"`
	Name         *[]string                       `json:"name,omitempty"`
}

type ApiManagementSkusListCompleteResult

type ApiManagementSkusListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ApiManagementSku
}

type ApiManagementSkusListCustomPager

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

func (*ApiManagementSkusListCustomPager) NextPageLink

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

type ApiManagementSkusListOperationResponse

type ApiManagementSkusListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ApiManagementSku
}

type SkusClient

type SkusClient struct {
	Client *resourcemanager.Client
}

func NewSkusClientWithBaseURI

func NewSkusClientWithBaseURI(sdkApi sdkEnv.Api) (*SkusClient, error)

func (SkusClient) ApiManagementSkusList

func (c SkusClient) ApiManagementSkusList(ctx context.Context, id commonids.SubscriptionId) (result ApiManagementSkusListOperationResponse, err error)

ApiManagementSkusList ...

func (SkusClient) ApiManagementSkusListComplete

func (c SkusClient) ApiManagementSkusListComplete(ctx context.Context, id commonids.SubscriptionId) (ApiManagementSkusListCompleteResult, error)

ApiManagementSkusListComplete retrieves all the results into a single object

func (SkusClient) ApiManagementSkusListCompleteMatchingPredicate

func (c SkusClient) ApiManagementSkusListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate ApiManagementSkuOperationPredicate) (result ApiManagementSkusListCompleteResult, err error)

ApiManagementSkusListCompleteMatchingPredicate retrieves all the results and then applies the predicate