skus

README

github.com/hashicorp/go-azure-sdk/resource-manager/devcenter/2023-04-01/skus Documentation

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

Client Initialization

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

Example Usage: SKUsClient.ListBySubscription

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

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

Documentation

Index

• func PossibleValuesForSkuTier() []string
• type Capability
• type DevCenterSku
• type DevCenterSkuOperationPredicate
  • func (p DevCenterSkuOperationPredicate) Matches(input DevCenterSku) bool
• type ListBySubscriptionCompleteResult
• type ListBySubscriptionOperationResponse
• type SKUsClient
  • func NewSKUsClientWithBaseURI(sdkApi sdkEnv.Api) (*SKUsClient, error)
  • func (c SKUsClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)
  • func (c SKUsClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)
  • func (c SKUsClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (result ListBySubscriptionCompleteResult, err error)
• type SkuTier
  • func (s *SkuTier) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForSkuTier

func PossibleValuesForSkuTier() []string

Types

type Capability

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

type DevCenterSku

type DevCenterSku struct {
	Capabilities *[]Capability `json:"capabilities,omitempty"`
	Capacity     *int64        `json:"capacity,omitempty"`
	Family       *string       `json:"family,omitempty"`
	Locations    *[]string     `json:"locations,omitempty"`
	Name         string        `json:"name"`
	ResourceType *string       `json:"resourceType,omitempty"`
	Size         *string       `json:"size,omitempty"`
	Tier         *SkuTier      `json:"tier,omitempty"`
}

type DevCenterSkuOperationPredicate

type DevCenterSkuOperationPredicate struct {
	Capacity     *int64
	Family       *string
	Name         *string
	ResourceType *string
	Size         *string
}

func (DevCenterSkuOperationPredicate) Matches

func (p DevCenterSkuOperationPredicate) Matches(input DevCenterSku) bool

type ListBySubscriptionCompleteResult

type ListBySubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []DevCenterSku
}

type ListBySubscriptionOperationResponse

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]DevCenterSku
}

type SKUsClient

type SKUsClient struct {
	Client *resourcemanager.Client
}

func NewSKUsClientWithBaseURI

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

func (SKUsClient) ListBySubscription

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

ListBySubscription ...

func (SKUsClient) ListBySubscriptionComplete

func (c SKUsClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)

ListBySubscriptionComplete retrieves all the results into a single object

func (SKUsClient) ListBySubscriptionCompleteMatchingPredicate

func (c SKUsClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate DevCenterSkuOperationPredicate) (result ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

type SkuTier

type SkuTier string

const (
	SkuTierBasic    SkuTier = "Basic"
	SkuTierFree     SkuTier = "Free"
	SkuTierPremium  SkuTier = "Premium"
	SkuTierStandard SkuTier = "Standard"
)

func (*SkuTier) UnmarshalJSON

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