sku

README

github.com/hashicorp/go-azure-sdk/resource-manager/devopsinfrastructure/2024-04-04-preview/sku Documentation

The sku SDK allows for interaction with Azure Resource Manager devopsinfrastructure (API Version 2024-04-04-preview).

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-sdk/resource-manager/devopsinfrastructure/2024-04-04-preview/sku"

Client Initialization

client := sku.NewSkuClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SkuClient.ListByLocation

ctx := context.TODO()
id := sku.NewLocationID("12345678-1234-9876-4563-123456789012", "locationName")

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

Documentation

Index

• func PossibleValuesForResourceSkuRestrictionsReasonCode() []string
• func PossibleValuesForResourceSkuRestrictionsType() []string
• func ValidateLocationID(input interface{}, key string) (warnings []string, errors []error)
• type ListByLocationCompleteResult
• type ListByLocationCustomPager
  • func (p *ListByLocationCustomPager) NextPageLink() *odata.Link
• type ListByLocationOperationResponse
• type LocationId
  • func NewLocationID(subscriptionId string, locationName string) LocationId
  • func ParseLocationID(input string) (*LocationId, error)
  • func ParseLocationIDInsensitively(input string) (*LocationId, error)
  • func (id *LocationId) FromParseResult(input resourceids.ParseResult) error
  • func (id LocationId) ID() string
  • func (id LocationId) Segments() []resourceids.Segment
  • func (id LocationId) String() string
• type ResourceSku
• type ResourceSkuCapabilities
• type ResourceSkuLocationInfo
• type ResourceSkuOperationPredicate
  • func (p ResourceSkuOperationPredicate) Matches(input ResourceSku) bool
• type ResourceSkuProperties
• 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 SkuClient
  • func NewSkuClientWithBaseURI(sdkApi sdkEnv.Api) (*SkuClient, error)
  • func (c SkuClient) ListByLocation(ctx context.Context, id LocationId) (result ListByLocationOperationResponse, err error)
  • func (c SkuClient) ListByLocationComplete(ctx context.Context, id LocationId) (ListByLocationCompleteResult, error)
  • func (c SkuClient) ListByLocationCompleteMatchingPredicate(ctx context.Context, id LocationId, predicate ResourceSkuOperationPredicate) (result ListByLocationCompleteResult, err error)

Functions

func PossibleValuesForResourceSkuRestrictionsReasonCode

func PossibleValuesForResourceSkuRestrictionsReasonCode() []string

func PossibleValuesForResourceSkuRestrictionsType

func PossibleValuesForResourceSkuRestrictionsType() []string

func ValidateLocationID

func ValidateLocationID(input interface{}, key string) (warnings []string, errors []error)

ValidateLocationID checks that 'input' can be parsed as a Location ID

Types

type ListByLocationCompleteResult

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

type ListByLocationCustomPager

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

func (*ListByLocationCustomPager) NextPageLink

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

type ListByLocationOperationResponse

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

type LocationId

type LocationId struct {
	SubscriptionId string
	LocationName   string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID

func NewLocationID(subscriptionId string, locationName string) LocationId

NewLocationID returns a new LocationId struct

func ParseLocationID

func ParseLocationID(input string) (*LocationId, error)

ParseLocationID parses 'input' into a LocationId

func ParseLocationIDInsensitively

func ParseLocationIDInsensitively(input string) (*LocationId, error)

ParseLocationIDInsensitively parses 'input' case-insensitively into a LocationId note: this method should only be used for API response data and not user input

func (*LocationId) FromParseResult

func (id *LocationId) FromParseResult(input resourceids.ParseResult) error

func (LocationId) ID

func (id LocationId) ID() string

ID returns the formatted Location ID

func (LocationId) Segments

func (id LocationId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Location ID

func (LocationId) String

func (id LocationId) String() string

String returns a human-readable description of this Location ID

type ResourceSku

type ResourceSku struct {
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties *ResourceSkuProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type ResourceSkuCapabilities

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

type ResourceSkuLocationInfo

type ResourceSkuLocationInfo struct {
	Location    string                   `json:"location"`
	ZoneDetails []ResourceSkuZoneDetails `json:"zoneDetails"`
	Zones       zones.Schema             `json:"zones"`
}

type ResourceSkuOperationPredicate

type ResourceSkuOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (ResourceSkuOperationPredicate) Matches

func (p ResourceSkuOperationPredicate) Matches(input ResourceSku) bool

type ResourceSkuProperties

type ResourceSkuProperties struct {
	Capabilities []ResourceSkuCapabilities `json:"capabilities"`
	Family       string                    `json:"family"`
	LocationInfo []ResourceSkuLocationInfo `json:"locationInfo"`
	Locations    []string                  `json:"locations"`
	ResourceType string                    `json:"resourceType"`
	Restrictions []ResourceSkuRestrictions `json:"restrictions"`
	Size         string                    `json:"size"`
	Tier         string                    `json:"tier"`
}

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"`
	Type            *ResourceSkuRestrictionsType       `json:"type,omitempty"`
	Values          []string                           `json:"values"`
}

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"`
	Name         []string                  `json:"name"`
}

type SkuClient

type SkuClient struct {
	Client *resourcemanager.Client
}

func NewSkuClientWithBaseURI

func NewSkuClientWithBaseURI(sdkApi sdkEnv.Api) (*SkuClient, error)

func (SkuClient) ListByLocation

func (c SkuClient) ListByLocation(ctx context.Context, id LocationId) (result ListByLocationOperationResponse, err error)

ListByLocation ...

func (SkuClient) ListByLocationComplete

func (c SkuClient) ListByLocationComplete(ctx context.Context, id LocationId) (ListByLocationCompleteResult, error)

ListByLocationComplete retrieves all the results into a single object

func (SkuClient) ListByLocationCompleteMatchingPredicate

func (c SkuClient) ListByLocationCompleteMatchingPredicate(ctx context.Context, id LocationId, predicate ResourceSkuOperationPredicate) (result ListByLocationCompleteResult, err error)

ListByLocationCompleteMatchingPredicate retrieves all the results and then applies the predicate