skus

README

github.com/hashicorp/go-azure-sdk/resource-manager/compute/2021-07-01/skus Documentation

The skus SDK allows for interaction with the Azure Resource Manager Service compute (API Version 2021-07-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/compute/2021-07-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, skus.DefaultResourceSkusListOperationOptions())` can be used to do batched pagination
items, err := client.ResourceSkusListComplete(ctx, id, skus.DefaultResourceSkusListOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

• func PossibleValuesForExtendedLocationType() []string
• func PossibleValuesForResourceSkuCapacityScaleType() []string
• func PossibleValuesForResourceSkuRestrictionsReasonCode() []string
• func PossibleValuesForResourceSkuRestrictionsType() []string
• type ExtendedLocationType
  • func (s *ExtendedLocationType) UnmarshalJSON(bytes []byte) error
• type ResourceSku
• type ResourceSkuCapabilities
• type ResourceSkuCapacity
• type ResourceSkuCapacityScaleType
  • func (s *ResourceSkuCapacityScaleType) UnmarshalJSON(bytes []byte) error
• type ResourceSkuCosts
• type ResourceSkuLocationInfo
• 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 ResourceSkuZoneDetails
• type ResourceSkusListCompleteResult
• type ResourceSkusListOperationOptions
  • func DefaultResourceSkusListOperationOptions() ResourceSkusListOperationOptions
  • func (o ResourceSkusListOperationOptions) ToHeaders() *client.Headers
  • func (o ResourceSkusListOperationOptions) ToOData() *odata.Query
  • func (o ResourceSkusListOperationOptions) ToQuery() *client.QueryParams
• 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 PossibleValuesForExtendedLocationType

func PossibleValuesForExtendedLocationType() []string

func PossibleValuesForResourceSkuCapacityScaleType

func PossibleValuesForResourceSkuCapacityScaleType() []string

func PossibleValuesForResourceSkuRestrictionsReasonCode

func PossibleValuesForResourceSkuRestrictionsReasonCode() []string

func PossibleValuesForResourceSkuRestrictionsType

func PossibleValuesForResourceSkuRestrictionsType() []string

Types

type ExtendedLocationType

type ExtendedLocationType string

const (
	ExtendedLocationTypeEdgeZone ExtendedLocationType = "EdgeZone"
)

func (*ExtendedLocationType) UnmarshalJSON

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

type ResourceSku

type ResourceSku struct {
	ApiVersions  *[]string                  `json:"apiVersions,omitempty"`
	Capabilities *[]ResourceSkuCapabilities `json:"capabilities,omitempty"`
	Capacity     *ResourceSkuCapacity       `json:"capacity,omitempty"`
	Costs        *[]ResourceSkuCosts        `json:"costs,omitempty"`
	Family       *string                    `json:"family,omitempty"`
	Kind         *string                    `json:"kind,omitempty"`
	LocationInfo *[]ResourceSkuLocationInfo `json:"locationInfo,omitempty"`
	Locations    *[]string                  `json:"locations,omitempty"`
	Name         *string                    `json:"name,omitempty"`
	ResourceType *string                    `json:"resourceType,omitempty"`
	Restrictions *[]ResourceSkuRestrictions `json:"restrictions,omitempty"`
	Size         *string                    `json:"size,omitempty"`
	Tier         *string                    `json:"tier,omitempty"`
}

type ResourceSkuCapabilities

type ResourceSkuCapabilities struct {
	Name  *string `json:"name,omitempty"`
	Value *string `json:"value,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 ResourceSkuCosts

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

type ResourceSkuLocationInfo

type ResourceSkuLocationInfo struct {
	ExtendedLocations *[]string                 `json:"extendedLocations,omitempty"`
	Location          *string                   `json:"location,omitempty"`
	Type              *ExtendedLocationType     `json:"type,omitempty"`
	ZoneDetails       *[]ResourceSkuZoneDetails `json:"zoneDetails,omitempty"`
	Zones             *zones.Schema             `json:"zones,omitempty"`
}

type ResourceSkuOperationPredicate

type ResourceSkuOperationPredicate struct {
	Family       *string
	Kind         *string
	Name         *string
	ResourceType *string
	Size         *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 ResourceSkuZoneDetails

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

type ResourceSkusListCompleteResult

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

type ResourceSkusListOperationOptions

type ResourceSkusListOperationOptions struct {
	Filter                   *string
	IncludeExtendedLocations *string
}

func DefaultResourceSkusListOperationOptions

func DefaultResourceSkusListOperationOptions() ResourceSkusListOperationOptions

func (ResourceSkusListOperationOptions) ToHeaders

func (o ResourceSkusListOperationOptions) ToHeaders() *client.Headers

func (ResourceSkusListOperationOptions) ToOData

func (o ResourceSkusListOperationOptions) ToOData() *odata.Query

func (ResourceSkusListOperationOptions) ToQuery

func (o ResourceSkusListOperationOptions) ToQuery() *client.QueryParams

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, options ResourceSkusListOperationOptions) (result ResourceSkusListOperationResponse, err error)

ResourceSkusList ...

func (SkusClient) ResourceSkusListComplete

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

ResourceSkusListComplete retrieves all the results into a single object

func (SkusClient) ResourceSkusListCompleteMatchingPredicate

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

ResourceSkusListCompleteMatchingPredicate retrieves all the results and then applies the predicate