subscriptionquotaallocation

README

github.com/hashicorp/go-azure-sdk/resource-manager/quota/2025-03-01/subscriptionquotaallocation Documentation

The subscriptionquotaallocation SDK allows for interaction with Azure Resource Manager quota (API Version 2025-03-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/quota/2025-03-01/subscriptionquotaallocation"

Client Initialization

client := subscriptionquotaallocation.NewSubscriptionQuotaAllocationClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: SubscriptionQuotaAllocationClient.GroupQuotaSubscriptionAllocationList

ctx := context.TODO()
id := subscriptionquotaallocation.NewQuotaAllocationID("managementGroupId", "12345678-1234-9876-4563-123456789012", "groupQuotaName", "resourceProviderName", "quotaAllocationName")

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

Example Usage: SubscriptionQuotaAllocationClient.GroupQuotaSubscriptionAllocationRequestUpdate

ctx := context.TODO()
id := subscriptionquotaallocation.NewQuotaAllocationID("managementGroupId", "12345678-1234-9876-4563-123456789012", "groupQuotaName", "resourceProviderName", "quotaAllocationName")

payload := subscriptionquotaallocation.SubscriptionQuotaAllocationsList{
	// ...
}


if err := client.GroupQuotaSubscriptionAllocationRequestUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Documentation

Index

• func PossibleValuesForRequestState() []string
• func ValidateQuotaAllocationID(input interface{}, key string) (warnings []string, errors []error)
• type GroupQuotaSubscriptionAllocationListOperationResponse
• type GroupQuotaSubscriptionAllocationRequestUpdateOperationResponse
• type QuotaAllocationId
  • func NewQuotaAllocationID(managementGroupId string, subscriptionId string, groupQuotaName string, ...) QuotaAllocationId
  • func ParseQuotaAllocationID(input string) (*QuotaAllocationId, error)
  • func ParseQuotaAllocationIDInsensitively(input string) (*QuotaAllocationId, error)
  • func (id *QuotaAllocationId) FromParseResult(input resourceids.ParseResult) error
  • func (id QuotaAllocationId) ID() string
  • func (id QuotaAllocationId) Segments() []resourceids.Segment
  • func (id QuotaAllocationId) String() string
• type RequestState
  • func (s *RequestState) UnmarshalJSON(bytes []byte) error
• type SubscriptionQuotaAllocationClient
  • func NewSubscriptionQuotaAllocationClientWithBaseURI(sdkApi sdkEnv.Api) (*SubscriptionQuotaAllocationClient, error)
  • func (c SubscriptionQuotaAllocationClient) GroupQuotaSubscriptionAllocationList(ctx context.Context, id QuotaAllocationId) (result GroupQuotaSubscriptionAllocationListOperationResponse, err error)
  • func (c SubscriptionQuotaAllocationClient) GroupQuotaSubscriptionAllocationRequestUpdate(ctx context.Context, id QuotaAllocationId, ...) (result GroupQuotaSubscriptionAllocationRequestUpdateOperationResponse, ...)
  • func (c SubscriptionQuotaAllocationClient) GroupQuotaSubscriptionAllocationRequestUpdateThenPoll(ctx context.Context, id QuotaAllocationId, ...) error
• type SubscriptionQuotaAllocations
• type SubscriptionQuotaAllocationsList
• type SubscriptionQuotaAllocationsListProperties
• type SubscriptionQuotaDetails
• type SubscriptionQuotaDetailsName

Functions

func PossibleValuesForRequestState

func PossibleValuesForRequestState() []string

func ValidateQuotaAllocationID

func ValidateQuotaAllocationID(input interface{}, key string) (warnings []string, errors []error)

ValidateQuotaAllocationID checks that 'input' can be parsed as a Quota Allocation ID

Types

type GroupQuotaSubscriptionAllocationListOperationResponse

type GroupQuotaSubscriptionAllocationListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SubscriptionQuotaAllocationsList
}

type GroupQuotaSubscriptionAllocationRequestUpdateOperationResponse

type GroupQuotaSubscriptionAllocationRequestUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *SubscriptionQuotaAllocationsList
}

type QuotaAllocationId

type QuotaAllocationId struct {
	ManagementGroupId    string
	SubscriptionId       string
	GroupQuotaName       string
	ResourceProviderName string
	QuotaAllocationName  string
}

QuotaAllocationId is a struct representing the Resource ID for a Quota Allocation

func NewQuotaAllocationID

func NewQuotaAllocationID(managementGroupId string, subscriptionId string, groupQuotaName string, resourceProviderName string, quotaAllocationName string) QuotaAllocationId

NewQuotaAllocationID returns a new QuotaAllocationId struct

func ParseQuotaAllocationID

func ParseQuotaAllocationID(input string) (*QuotaAllocationId, error)

ParseQuotaAllocationID parses 'input' into a QuotaAllocationId

func ParseQuotaAllocationIDInsensitively

func ParseQuotaAllocationIDInsensitively(input string) (*QuotaAllocationId, error)

ParseQuotaAllocationIDInsensitively parses 'input' case-insensitively into a QuotaAllocationId note: this method should only be used for API response data and not user input

func (*QuotaAllocationId) FromParseResult

func (id *QuotaAllocationId) FromParseResult(input resourceids.ParseResult) error

func (QuotaAllocationId) ID

func (id QuotaAllocationId) ID() string

ID returns the formatted Quota Allocation ID

func (QuotaAllocationId) Segments

func (id QuotaAllocationId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Quota Allocation ID

func (QuotaAllocationId) String

func (id QuotaAllocationId) String() string

String returns a human-readable description of this Quota Allocation ID

type RequestState

type RequestState string

const (
	RequestStateAccepted   RequestState = "Accepted"
	RequestStateCanceled   RequestState = "Canceled"
	RequestStateCreated    RequestState = "Created"
	RequestStateFailed     RequestState = "Failed"
	RequestStateInProgress RequestState = "InProgress"
	RequestStateInvalid    RequestState = "Invalid"
	RequestStateSucceeded  RequestState = "Succeeded"
)

func (*RequestState) UnmarshalJSON

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

type SubscriptionQuotaAllocationClient

type SubscriptionQuotaAllocationClient struct {
	Client *resourcemanager.Client
}

func NewSubscriptionQuotaAllocationClientWithBaseURI

func NewSubscriptionQuotaAllocationClientWithBaseURI(sdkApi sdkEnv.Api) (*SubscriptionQuotaAllocationClient, error)

func (SubscriptionQuotaAllocationClient) GroupQuotaSubscriptionAllocationList

func (c SubscriptionQuotaAllocationClient) GroupQuotaSubscriptionAllocationList(ctx context.Context, id QuotaAllocationId) (result GroupQuotaSubscriptionAllocationListOperationResponse, err error)

GroupQuotaSubscriptionAllocationList ...

func (SubscriptionQuotaAllocationClient) GroupQuotaSubscriptionAllocationRequestUpdate

func (c SubscriptionQuotaAllocationClient) GroupQuotaSubscriptionAllocationRequestUpdate(ctx context.Context, id QuotaAllocationId, input SubscriptionQuotaAllocationsList) (result GroupQuotaSubscriptionAllocationRequestUpdateOperationResponse, err error)

GroupQuotaSubscriptionAllocationRequestUpdate ...

func (SubscriptionQuotaAllocationClient) GroupQuotaSubscriptionAllocationRequestUpdateThenPoll

func (c SubscriptionQuotaAllocationClient) GroupQuotaSubscriptionAllocationRequestUpdateThenPoll(ctx context.Context, id QuotaAllocationId, input SubscriptionQuotaAllocationsList) error

GroupQuotaSubscriptionAllocationRequestUpdateThenPoll performs GroupQuotaSubscriptionAllocationRequestUpdate then polls until it's completed

type SubscriptionQuotaAllocations

type SubscriptionQuotaAllocations struct {
	Properties *SubscriptionQuotaDetails `json:"properties,omitempty"`
}

type SubscriptionQuotaAllocationsList

type SubscriptionQuotaAllocationsList struct {
	Id         *string                                     `json:"id,omitempty"`
	Name       *string                                     `json:"name,omitempty"`
	Properties *SubscriptionQuotaAllocationsListProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData                      `json:"systemData,omitempty"`
	Type       *string                                     `json:"type,omitempty"`
}

type SubscriptionQuotaAllocationsListProperties

type SubscriptionQuotaAllocationsListProperties struct {
	NextLink          *string                         `json:"nextLink,omitempty"`
	ProvisioningState *RequestState                   `json:"provisioningState,omitempty"`
	Value             *[]SubscriptionQuotaAllocations `json:"value,omitempty"`
}

type SubscriptionQuotaDetails

type SubscriptionQuotaDetails struct {
	Limit          *int64                        `json:"limit,omitempty"`
	Name           *SubscriptionQuotaDetailsName `json:"name,omitempty"`
	ResourceName   *string                       `json:"resourceName,omitempty"`
	ShareableQuota *int64                        `json:"shareableQuota,omitempty"`
}

type SubscriptionQuotaDetailsName

type SubscriptionQuotaDetailsName struct {
	LocalizedValue *string `json:"localizedValue,omitempty"`
	Value          *string `json:"value,omitempty"`
}