location

package
v0.20230628.1090132 Latest Latest
Warning

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

Go to latest
Published: Jun 28, 2023 License: MPL-2.0 Imports: 9 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/batch/2022-10-01/location Documentation

The location SDK allows for interaction with the Azure Resource Manager Service batch (API Version 2022-10-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/batch/2022-10-01/location"

Client Initialization

client := location.NewLocationClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: LocationClient.GetQuotas

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

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

Example Usage: LocationClient.ListSupportedCloudServiceSkus

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

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

Example Usage: LocationClient.ListSupportedVirtualMachineSkus

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

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 BatchLocationQuota

type BatchLocationQuota struct {
	AccountQuota *int64 `json:"accountQuota,omitempty"`
}

type GetQuotasOperationResponse

type GetQuotasOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *BatchLocationQuota
}

type ListSupportedCloudServiceSkusCompleteResult

type ListSupportedCloudServiceSkusCompleteResult struct {
	Items []SupportedSku
}

type ListSupportedCloudServiceSkusOperationOptions

type ListSupportedCloudServiceSkusOperationOptions struct {
	Filter     *string
	Maxresults *int64
}

func DefaultListSupportedCloudServiceSkusOperationOptions

func DefaultListSupportedCloudServiceSkusOperationOptions() ListSupportedCloudServiceSkusOperationOptions

func (ListSupportedCloudServiceSkusOperationOptions) ToHeaders added in v0.20230503.1093249

func (ListSupportedCloudServiceSkusOperationOptions) ToOData added in v0.20230503.1093249

func (ListSupportedCloudServiceSkusOperationOptions) ToQuery added in v0.20230503.1093249

type ListSupportedCloudServiceSkusOperationResponse

type ListSupportedCloudServiceSkusOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]SupportedSku
}

type ListSupportedVirtualMachineSkusCompleteResult

type ListSupportedVirtualMachineSkusCompleteResult struct {
	Items []SupportedSku
}

type ListSupportedVirtualMachineSkusOperationOptions

type ListSupportedVirtualMachineSkusOperationOptions struct {
	Filter     *string
	Maxresults *int64
}

func DefaultListSupportedVirtualMachineSkusOperationOptions

func DefaultListSupportedVirtualMachineSkusOperationOptions() ListSupportedVirtualMachineSkusOperationOptions

func (ListSupportedVirtualMachineSkusOperationOptions) ToHeaders added in v0.20230503.1093249

func (ListSupportedVirtualMachineSkusOperationOptions) ToOData added in v0.20230503.1093249

func (ListSupportedVirtualMachineSkusOperationOptions) ToQuery added in v0.20230503.1093249

type ListSupportedVirtualMachineSkusOperationResponse

type ListSupportedVirtualMachineSkusOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]SupportedSku
}

type LocationClient

type LocationClient struct {
	Client *resourcemanager.Client
}

func NewLocationClientWithBaseURI

func NewLocationClientWithBaseURI(api environments.Api) (*LocationClient, error)

func (LocationClient) GetQuotas

func (c LocationClient) GetQuotas(ctx context.Context, id LocationId) (result GetQuotasOperationResponse, err error)

GetQuotas ...

func (LocationClient) ListSupportedCloudServiceSkus

ListSupportedCloudServiceSkus ...

func (LocationClient) ListSupportedCloudServiceSkusComplete

ListSupportedCloudServiceSkusComplete retrieves all the results into a single object

func (LocationClient) ListSupportedCloudServiceSkusCompleteMatchingPredicate

func (c LocationClient) ListSupportedCloudServiceSkusCompleteMatchingPredicate(ctx context.Context, id LocationId, options ListSupportedCloudServiceSkusOperationOptions, predicate SupportedSkuOperationPredicate) (result ListSupportedCloudServiceSkusCompleteResult, err error)

ListSupportedCloudServiceSkusCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (LocationClient) ListSupportedVirtualMachineSkus

ListSupportedVirtualMachineSkus ...

func (LocationClient) ListSupportedVirtualMachineSkusComplete

ListSupportedVirtualMachineSkusComplete retrieves all the results into a single object

func (LocationClient) ListSupportedVirtualMachineSkusCompleteMatchingPredicate

func (c LocationClient) ListSupportedVirtualMachineSkusCompleteMatchingPredicate(ctx context.Context, id LocationId, options ListSupportedVirtualMachineSkusOperationOptions, predicate SupportedSkuOperationPredicate) (result ListSupportedVirtualMachineSkusCompleteResult, err error)

ListSupportedVirtualMachineSkusCompleteMatchingPredicate retrieves all the results and then applies the predicate

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 SkuCapability

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

type SupportedSku

type SupportedSku struct {
	Capabilities *[]SkuCapability `json:"capabilities,omitempty"`
	FamilyName   *string          `json:"familyName,omitempty"`
	Name         *string          `json:"name,omitempty"`
}

type SupportedSkuOperationPredicate

type SupportedSkuOperationPredicate struct {
	FamilyName *string
	Name       *string
}

func (SupportedSkuOperationPredicate) Matches

Jump to

Keyboard shortcuts

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