elasticsanskus

README

github.com/hashicorp/go-azure-sdk/resource-manager/elasticsan/2024-05-01/elasticsanskus Documentation

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

Client Initialization

client := elasticsanskus.NewElasticSanSkusClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ElasticSanSkusClient.SkusList

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

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

Documentation

Index

• func PossibleValuesForSkuName() []string
• func PossibleValuesForSkuTier() []string
• type ElasticSanSkusClient
  • func NewElasticSanSkusClientWithBaseURI(sdkApi sdkEnv.Api) (*ElasticSanSkusClient, error)
  • func (c ElasticSanSkusClient) SkusList(ctx context.Context, id commonids.SubscriptionId, ...) (result SkusListOperationResponse, err error)
  • func (c ElasticSanSkusClient) SkusListComplete(ctx context.Context, id commonids.SubscriptionId, ...) (SkusListCompleteResult, error)
  • func (c ElasticSanSkusClient) SkusListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (result SkusListCompleteResult, err error)
• type SKUCapability
• type SkuInformation
• type SkuInformationOperationPredicate
  • func (p SkuInformationOperationPredicate) Matches(input SkuInformation) bool
• type SkuLocationInfo
• type SkuName
  • func (s *SkuName) UnmarshalJSON(bytes []byte) error
• type SkuTier
  • func (s *SkuTier) UnmarshalJSON(bytes []byte) error
• type SkusListCompleteResult
• type SkusListOperationOptions
  • func DefaultSkusListOperationOptions() SkusListOperationOptions
  • func (o SkusListOperationOptions) ToHeaders() *client.Headers
  • func (o SkusListOperationOptions) ToOData() *odata.Query
  • func (o SkusListOperationOptions) ToQuery() *client.QueryParams
• type SkusListOperationResponse

Functions

func PossibleValuesForSkuName

func PossibleValuesForSkuName() []string

func PossibleValuesForSkuTier

func PossibleValuesForSkuTier() []string

Types

type ElasticSanSkusClient

type ElasticSanSkusClient struct {
	Client *resourcemanager.Client
}

func NewElasticSanSkusClientWithBaseURI

func NewElasticSanSkusClientWithBaseURI(sdkApi sdkEnv.Api) (*ElasticSanSkusClient, error)

func (ElasticSanSkusClient) SkusList

func (c ElasticSanSkusClient) SkusList(ctx context.Context, id commonids.SubscriptionId, options SkusListOperationOptions) (result SkusListOperationResponse, err error)

SkusList ...

func (ElasticSanSkusClient) SkusListComplete

func (c ElasticSanSkusClient) SkusListComplete(ctx context.Context, id commonids.SubscriptionId, options SkusListOperationOptions) (SkusListCompleteResult, error)

SkusListComplete retrieves all the results into a single object

func (ElasticSanSkusClient) SkusListCompleteMatchingPredicate

func (c ElasticSanSkusClient) SkusListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options SkusListOperationOptions, predicate SkuInformationOperationPredicate) (result SkusListCompleteResult, err error)

SkusListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type SKUCapability

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

type SkuInformation

type SkuInformation struct {
	Capabilities *[]SKUCapability   `json:"capabilities,omitempty"`
	LocationInfo *[]SkuLocationInfo `json:"locationInfo,omitempty"`
	Locations    *[]string          `json:"locations,omitempty"`
	Name         SkuName            `json:"name"`
	ResourceType *string            `json:"resourceType,omitempty"`
	Tier         *SkuTier           `json:"tier,omitempty"`
}

type SkuInformationOperationPredicate

type SkuInformationOperationPredicate struct {
	ResourceType *string
}

func (SkuInformationOperationPredicate) Matches

func (p SkuInformationOperationPredicate) Matches(input SkuInformation) bool

type SkuLocationInfo

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

type SkuName

type SkuName string

const (
	SkuNamePremiumLRS SkuName = "Premium_LRS"
	SkuNamePremiumZRS SkuName = "Premium_ZRS"
)

func (*SkuName) UnmarshalJSON

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

type SkuTier

type SkuTier string

const (
	SkuTierPremium SkuTier = "Premium"
)

func (*SkuTier) UnmarshalJSON

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

type SkusListCompleteResult

type SkusListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []SkuInformation
}

type SkusListOperationOptions

type SkusListOperationOptions struct {
	Filter *string
}

func DefaultSkusListOperationOptions

func DefaultSkusListOperationOptions() SkusListOperationOptions

func (SkusListOperationOptions) ToHeaders

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

func (SkusListOperationOptions) ToOData

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

func (SkusListOperationOptions) ToQuery

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

type SkusListOperationResponse

type SkusListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]SkuInformation
}