locations

package
v0.20230425.1021638 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 25, 2023 License: MPL-2.0 Imports: 7 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/vmware/2022-05-01/locations Documentation

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

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForQuotaEnabled

func PossibleValuesForQuotaEnabled() []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
	Model        *Quota
}

type CheckTrialAvailabilityOperationResponse

type CheckTrialAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	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) 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 autorest.Client
	// contains filtered or unexported fields
}

func NewLocationsClientWithBaseURI

func NewLocationsClientWithBaseURI(endpoint string) LocationsClient

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"
)

type Sku

type Sku struct {
	Name string `json:"name"`
}

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"
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL