skus

README

github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2023-05-01/skus Documentation

The skus SDK allows for interaction with the Azure Resource Manager Service cognitive (API Version 2023-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/cognitive/2023-05-01/skus"

Client Initialization

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

Example Usage: SkusClient.ResourceSkusList

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

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

Documentation

Index

• func PossibleValuesForResourceSkuRestrictionsReasonCode() []string
• func PossibleValuesForResourceSkuRestrictionsType() []string
• type ResourceSku
• type ResourceSkuOperationPredicate
  • func (p ResourceSkuOperationPredicate) Matches(input ResourceSku) bool
• type ResourceSkuRestrictionInfo
• type ResourceSkuRestrictions
• type ResourceSkuRestrictionsReasonCode
  • func (s *ResourceSkuRestrictionsReasonCode) UnmarshalJSON(bytes []byte) error
• type ResourceSkuRestrictionsType
  • func (s *ResourceSkuRestrictionsType) UnmarshalJSON(bytes []byte) error
• type ResourceSkusListCompleteResult
• type ResourceSkusListCustomPager
  • func (p *ResourceSkusListCustomPager) NextPageLink() *odata.Link
• type ResourceSkusListOperationResponse
• type SkusClient
  • func NewSkusClientWithBaseURI(sdkApi sdkEnv.Api) (*SkusClient, error)
  • func (c SkusClient) ResourceSkusList(ctx context.Context, id commonids.SubscriptionId) (result ResourceSkusListOperationResponse, err error)
  • func (c SkusClient) ResourceSkusListComplete(ctx context.Context, id commonids.SubscriptionId) (ResourceSkusListCompleteResult, error)
  • func (c SkusClient) ResourceSkusListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (result ResourceSkusListCompleteResult, err error)

Functions

func PossibleValuesForResourceSkuRestrictionsReasonCode

func PossibleValuesForResourceSkuRestrictionsReasonCode() []string

func PossibleValuesForResourceSkuRestrictionsType

func PossibleValuesForResourceSkuRestrictionsType() []string

Types

type ResourceSku

type ResourceSku struct {
	Kind         *string                    `json:"kind,omitempty"`
	Locations    *[]string                  `json:"locations,omitempty"`
	Name         *string                    `json:"name,omitempty"`
	ResourceType *string                    `json:"resourceType,omitempty"`
	Restrictions *[]ResourceSkuRestrictions `json:"restrictions,omitempty"`
	Tier         *string                    `json:"tier,omitempty"`
}

type ResourceSkuOperationPredicate

type ResourceSkuOperationPredicate struct {
	Kind         *string
	Name         *string
	ResourceType *string
	Tier         *string
}

func (ResourceSkuOperationPredicate) Matches

func (p ResourceSkuOperationPredicate) Matches(input ResourceSku) bool

type ResourceSkuRestrictionInfo

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

type ResourceSkuRestrictions

type ResourceSkuRestrictions struct {
	ReasonCode      *ResourceSkuRestrictionsReasonCode `json:"reasonCode,omitempty"`
	RestrictionInfo *ResourceSkuRestrictionInfo        `json:"restrictionInfo,omitempty"`
	Type            *ResourceSkuRestrictionsType       `json:"type,omitempty"`
	Values          *[]string                          `json:"values,omitempty"`
}

type ResourceSkuRestrictionsReasonCode

type ResourceSkuRestrictionsReasonCode string

const (
	ResourceSkuRestrictionsReasonCodeNotAvailableForSubscription ResourceSkuRestrictionsReasonCode = "NotAvailableForSubscription"
	ResourceSkuRestrictionsReasonCodeQuotaId                     ResourceSkuRestrictionsReasonCode = "QuotaId"
)

func (*ResourceSkuRestrictionsReasonCode) UnmarshalJSON

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

type ResourceSkuRestrictionsType

type ResourceSkuRestrictionsType string

const (
	ResourceSkuRestrictionsTypeLocation ResourceSkuRestrictionsType = "Location"
	ResourceSkuRestrictionsTypeZone     ResourceSkuRestrictionsType = "Zone"
)

func (*ResourceSkuRestrictionsType) UnmarshalJSON

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

type ResourceSkusListCompleteResult

type ResourceSkusListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ResourceSku
}

type ResourceSkusListCustomPager

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

func (*ResourceSkusListCustomPager) NextPageLink

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

type ResourceSkusListOperationResponse

type ResourceSkusListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ResourceSku
}

type SkusClient

type SkusClient struct {
	Client *resourcemanager.Client
}

func NewSkusClientWithBaseURI

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

func (SkusClient) ResourceSkusList

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

ResourceSkusList ...

func (SkusClient) ResourceSkusListComplete

func (c SkusClient) ResourceSkusListComplete(ctx context.Context, id commonids.SubscriptionId) (ResourceSkusListCompleteResult, error)

ResourceSkusListComplete retrieves all the results into a single object

func (SkusClient) ResourceSkusListCompleteMatchingPredicate

func (c SkusClient) ResourceSkusListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate ResourceSkuOperationPredicate) (result ResourceSkusListCompleteResult, err error)

ResourceSkusListCompleteMatchingPredicate retrieves all the results and then applies the predicate