skus

README

github.com/hashicorp/go-azure-sdk/resource-manager/storagecache/2024-03-01/skus Documentation

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

Client Initialization

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

Example Usage: SKUsClient.List

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

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

Documentation

Index

• func PossibleValuesForReasonCode() []string
• type ListCompleteResult
• type ListOperationResponse
• type ReasonCode
  • func (s *ReasonCode) UnmarshalJSON(bytes []byte) error
• type ResourceSku
• type ResourceSkuCapabilities
• type ResourceSkuLocationInfo
• type ResourceSkuOperationPredicate
  • func (p ResourceSkuOperationPredicate) Matches(input ResourceSku) bool
• type Restriction
• type SKUsClient
  • func NewSKUsClientWithBaseURI(sdkApi sdkEnv.Api) (*SKUsClient, error)
  • func (c SKUsClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)
  • func (c SKUsClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)
  • func (c SKUsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (result ListCompleteResult, err error)

Functions

func PossibleValuesForReasonCode

func PossibleValuesForReasonCode() []string

Types

type ListCompleteResult

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

type ListOperationResponse

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

type ReasonCode

type ReasonCode string

const (
	ReasonCodeNotAvailableForSubscription ReasonCode = "NotAvailableForSubscription"
	ReasonCodeQuotaId                     ReasonCode = "QuotaId"
)

func (*ReasonCode) UnmarshalJSON

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

type ResourceSku

type ResourceSku struct {
	Capabilities *[]ResourceSkuCapabilities `json:"capabilities,omitempty"`
	LocationInfo *[]ResourceSkuLocationInfo `json:"locationInfo,omitempty"`
	Locations    *[]string                  `json:"locations,omitempty"`
	Name         *string                    `json:"name,omitempty"`
	ResourceType *string                    `json:"resourceType,omitempty"`
	Restrictions *[]Restriction             `json:"restrictions,omitempty"`
}

type ResourceSkuCapabilities

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

type ResourceSkuLocationInfo

type ResourceSkuLocationInfo struct {
	Location *string       `json:"location,omitempty"`
	Zones    *zones.Schema `json:"zones,omitempty"`
}

type ResourceSkuOperationPredicate

type ResourceSkuOperationPredicate struct {
	Name         *string
	ResourceType *string
}

func (ResourceSkuOperationPredicate) Matches

func (p ResourceSkuOperationPredicate) Matches(input ResourceSku) bool

type Restriction

type Restriction struct {
	ReasonCode *ReasonCode `json:"reasonCode,omitempty"`
	Type       *string     `json:"type,omitempty"`
	Values     *[]string   `json:"values,omitempty"`
}

type SKUsClient

type SKUsClient struct {
	Client *resourcemanager.Client
}

func NewSKUsClientWithBaseURI

func NewSKUsClientWithBaseURI(sdkApi sdkEnv.Api) (*SKUsClient, error)

func (SKUsClient) List

func (c SKUsClient) List(ctx context.Context, id commonids.SubscriptionId) (result ListOperationResponse, err error)

List ...

func (SKUsClient) ListComplete

func (c SKUsClient) ListComplete(ctx context.Context, id commonids.SubscriptionId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (SKUsClient) ListCompleteMatchingPredicate

func (c SKUsClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate ResourceSkuOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate