locations

README

github.com/hashicorp/go-azure-sdk/resource-manager/vmware/2023-09-01/locations Documentation

The locations SDK allows for interaction with the Azure Resource Manager Service vmware (API Version 2023-09-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-sdk/resource-manager/vmware/2023-09-01/locations"

Client Initialization

client := locations.NewLocationsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: LocationsClient.CheckQuotaAvailability

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

read, err := client.CheckQuotaAvailability(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: LocationsClient.CheckTrialAvailability

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

payload := locations.Sku{
	// ...
}


read, err := client.CheckTrialAvailability(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

• func PossibleValuesForQuotaEnabled() []string
• func PossibleValuesForSkuTier() []string
• func PossibleValuesForTrialStatus() []string
• func ValidateLocationID(input interface{}, key string) (warnings []string, errors []error)
• type CheckQuotaAvailabilityOperationResponse
• type CheckTrialAvailabilityOperationResponse
• 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 LocationsClient
  • func NewLocationsClientWithBaseURI(sdkApi sdkEnv.Api) (*LocationsClient, error)
  • func (c LocationsClient) CheckQuotaAvailability(ctx context.Context, id LocationId) (result CheckQuotaAvailabilityOperationResponse, err error)
  • func (c LocationsClient) CheckTrialAvailability(ctx context.Context, id LocationId, input Sku) (result CheckTrialAvailabilityOperationResponse, err error)
• type Quota
• type QuotaEnabled
  • func (s *QuotaEnabled) UnmarshalJSON(bytes []byte) error
• type Sku
• type SkuTier
  • func (s *SkuTier) UnmarshalJSON(bytes []byte) error
• type Trial
• type TrialStatus
  • func (s *TrialStatus) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForQuotaEnabled

func PossibleValuesForQuotaEnabled() []string

func PossibleValuesForSkuTier

func PossibleValuesForSkuTier() []string

func PossibleValuesForTrialStatus

func PossibleValuesForTrialStatus() []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 CheckQuotaAvailabilityOperationResponse

type CheckQuotaAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Quota
}

type CheckTrialAvailabilityOperationResponse

type CheckTrialAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Trial
}

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 LocationsClient

type LocationsClient struct {
	Client *resourcemanager.Client
}

func NewLocationsClientWithBaseURI

func NewLocationsClientWithBaseURI(sdkApi sdkEnv.Api) (*LocationsClient, error)

func (LocationsClient) CheckQuotaAvailability

func (c LocationsClient) CheckQuotaAvailability(ctx context.Context, id LocationId) (result CheckQuotaAvailabilityOperationResponse, err error)

CheckQuotaAvailability ...

func (LocationsClient) CheckTrialAvailability

func (c LocationsClient) CheckTrialAvailability(ctx context.Context, id LocationId, input Sku) (result CheckTrialAvailabilityOperationResponse, err error)

CheckTrialAvailability ...

type Quota

type Quota struct {
	HostsRemaining *map[string]int64 `json:"hostsRemaining,omitempty"`
	QuotaEnabled   *QuotaEnabled     `json:"quotaEnabled,omitempty"`
}

type QuotaEnabled

type QuotaEnabled string

const (
	QuotaEnabledDisabled QuotaEnabled = "Disabled"
	QuotaEnabledEnabled  QuotaEnabled = "Enabled"
)

func (*QuotaEnabled) UnmarshalJSON

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

type Sku

type Sku struct {
	Capacity *int64   `json:"capacity,omitempty"`
	Family   *string  `json:"family,omitempty"`
	Name     string   `json:"name"`
	Size     *string  `json:"size,omitempty"`
	Tier     *SkuTier `json:"tier,omitempty"`
}

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

type Trial

type Trial struct {
	AvailableHosts *int64       `json:"availableHosts,omitempty"`
	Status         *TrialStatus `json:"status,omitempty"`
}

type TrialStatus

type TrialStatus string

const (
	TrialStatusTrialAvailable TrialStatus = "TrialAvailable"
	TrialStatusTrialDisabled  TrialStatus = "TrialDisabled"
	TrialStatusTrialUsed      TrialStatus = "TrialUsed"
)

func (*TrialStatus) UnmarshalJSON

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