location

package
v0.20240112.1133231 Latest Latest
Warning

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

 Go to latest Published: Jan 12, 2024 License: MPL-2.0 Imports: 9 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/batch/2023-05-01/location Documentation

The location SDK allows for interaction with the Azure Resource Manager Service batch (API Version 2023-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/batch/2023-05-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 {
	LatestHttpResponse *http.Response
	Items              []SupportedSku
}

type ListSupportedCloudServiceSkusOperationOptions 

type ListSupportedCloudServiceSkusOperationOptions struct {
	Filter     *string
	Maxresults *int64
}

func DefaultListSupportedCloudServiceSkusOperationOptions 

func DefaultListSupportedCloudServiceSkusOperationOptions() ListSupportedCloudServiceSkusOperationOptions

func (ListSupportedCloudServiceSkusOperationOptions) ToHeaders 

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

func (ListSupportedCloudServiceSkusOperationOptions) ToOData 

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

func (ListSupportedCloudServiceSkusOperationOptions) ToQuery 

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

type ListSupportedCloudServiceSkusOperationResponse 

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

type ListSupportedVirtualMachineSkusCompleteResult 

type ListSupportedVirtualMachineSkusCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []SupportedSku
}

type ListSupportedVirtualMachineSkusOperationOptions 

type ListSupportedVirtualMachineSkusOperationOptions struct {
	Filter     *string
	Maxresults *int64
}

func DefaultListSupportedVirtualMachineSkusOperationOptions 

func DefaultListSupportedVirtualMachineSkusOperationOptions() ListSupportedVirtualMachineSkusOperationOptions

func (ListSupportedVirtualMachineSkusOperationOptions) ToHeaders 

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

func (ListSupportedVirtualMachineSkusOperationOptions) ToOData 

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

func (ListSupportedVirtualMachineSkusOperationOptions) ToQuery 

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

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(sdkApi sdkEnv.Api) (*LocationClient, error)

func (LocationClient) GetQuotas 

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

GetQuotas ...

func (LocationClient) ListSupportedCloudServiceSkus 

func (c LocationClient) ListSupportedCloudServiceSkus(ctx context.Context, id LocationId, options ListSupportedCloudServiceSkusOperationOptions) (result ListSupportedCloudServiceSkusOperationResponse, err error)

ListSupportedCloudServiceSkus ...

func (LocationClient) ListSupportedCloudServiceSkusComplete 

func (c LocationClient) ListSupportedCloudServiceSkusComplete(ctx context.Context, id LocationId, options ListSupportedCloudServiceSkusOperationOptions) (ListSupportedCloudServiceSkusCompleteResult, error)

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 

func (c LocationClient) ListSupportedVirtualMachineSkus(ctx context.Context, id LocationId, options ListSupportedVirtualMachineSkusOperationOptions) (result ListSupportedVirtualMachineSkusOperationResponse, err error)

ListSupportedVirtualMachineSkus ...

func (LocationClient) ListSupportedVirtualMachineSkusComplete 

func (c LocationClient) ListSupportedVirtualMachineSkusComplete(ctx context.Context, id LocationId, options ListSupportedVirtualMachineSkusOperationOptions) (ListSupportedVirtualMachineSkusCompleteResult, error)

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) FromParseResult added in v0.20231127.1171502 

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

func (p SupportedSkuOperationPredicate) Matches(input SupportedSku) bool

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.