groupquotalimits

README

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

The groupquotalimits 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/groupquotalimits"

Client Initialization

client := groupquotalimits.NewGroupQuotaLimitsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: GroupQuotaLimitsClient.List

ctx := context.TODO()
id := groupquotalimits.NewGroupQuotaLimitID("managementGroupId", "groupQuotaName", "resourceProviderName", "groupQuotaLimitName")

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

Example Usage: GroupQuotaLimitsClient.RequestUpdate

ctx := context.TODO()
id := groupquotalimits.NewGroupQuotaLimitID("managementGroupId", "groupQuotaName", "resourceProviderName", "groupQuotaLimitName")

payload := groupquotalimits.GroupQuotaLimitList{
	// ...
}


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

Documentation

Index

• func PossibleValuesForRequestState() []string
• func ValidateGroupQuotaLimitID(input interface{}, key string) (warnings []string, errors []error)
• type AllocatedQuotaToSubscriptionList
• type AllocatedToSubscription
• type GroupQuotaDetails
• type GroupQuotaDetailsName
• type GroupQuotaLimit
• type GroupQuotaLimitId
  • func NewGroupQuotaLimitID(managementGroupId string, groupQuotaName string, resourceProviderName string, ...) GroupQuotaLimitId
  • func ParseGroupQuotaLimitID(input string) (*GroupQuotaLimitId, error)
  • func ParseGroupQuotaLimitIDInsensitively(input string) (*GroupQuotaLimitId, error)
  • func (id *GroupQuotaLimitId) FromParseResult(input resourceids.ParseResult) error
  • func (id GroupQuotaLimitId) ID() string
  • func (id GroupQuotaLimitId) Segments() []resourceids.Segment
  • func (id GroupQuotaLimitId) String() string
• type GroupQuotaLimitList
• type GroupQuotaLimitListProperties
• type GroupQuotaLimitsClient
  • func NewGroupQuotaLimitsClientWithBaseURI(sdkApi sdkEnv.Api) (*GroupQuotaLimitsClient, error)
  • func (c GroupQuotaLimitsClient) List(ctx context.Context, id GroupQuotaLimitId) (result ListOperationResponse, err error)
  • func (c GroupQuotaLimitsClient) RequestUpdate(ctx context.Context, id GroupQuotaLimitId, input GroupQuotaLimitList) (result RequestUpdateOperationResponse, err error)
  • func (c GroupQuotaLimitsClient) RequestUpdateThenPoll(ctx context.Context, id GroupQuotaLimitId, input GroupQuotaLimitList) error
• type ListOperationResponse
• type RequestState
  • func (s *RequestState) UnmarshalJSON(bytes []byte) error
• type RequestUpdateOperationResponse

Functions

func PossibleValuesForRequestState

func PossibleValuesForRequestState() []string

func ValidateGroupQuotaLimitID

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

ValidateGroupQuotaLimitID checks that 'input' can be parsed as a Group Quota Limit ID

Types

type AllocatedQuotaToSubscriptionList

type AllocatedQuotaToSubscriptionList struct {
	Value *[]AllocatedToSubscription `json:"value,omitempty"`
}

type AllocatedToSubscription

type AllocatedToSubscription struct {
	QuotaAllocated *int64  `json:"quotaAllocated,omitempty"`
	SubscriptionId *string `json:"subscriptionId,omitempty"`
}

type GroupQuotaDetails

type GroupQuotaDetails struct {
	AllocatedToSubscriptions *AllocatedQuotaToSubscriptionList `json:"allocatedToSubscriptions,omitempty"`
	AvailableLimit           *int64                            `json:"availableLimit,omitempty"`
	Comment                  *string                           `json:"comment,omitempty"`
	Limit                    *int64                            `json:"limit,omitempty"`
	Name                     *GroupQuotaDetailsName            `json:"name,omitempty"`
	ResourceName             *string                           `json:"resourceName,omitempty"`
	Unit                     *string                           `json:"unit,omitempty"`
}

type GroupQuotaDetailsName

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

type GroupQuotaLimit

type GroupQuotaLimit struct {
	Properties *GroupQuotaDetails `json:"properties,omitempty"`
}

type GroupQuotaLimitId

type GroupQuotaLimitId struct {
	ManagementGroupId    string
	GroupQuotaName       string
	ResourceProviderName string
	GroupQuotaLimitName  string
}

GroupQuotaLimitId is a struct representing the Resource ID for a Group Quota Limit

func NewGroupQuotaLimitID

func NewGroupQuotaLimitID(managementGroupId string, groupQuotaName string, resourceProviderName string, groupQuotaLimitName string) GroupQuotaLimitId

NewGroupQuotaLimitID returns a new GroupQuotaLimitId struct

func ParseGroupQuotaLimitID

func ParseGroupQuotaLimitID(input string) (*GroupQuotaLimitId, error)

ParseGroupQuotaLimitID parses 'input' into a GroupQuotaLimitId

func ParseGroupQuotaLimitIDInsensitively

func ParseGroupQuotaLimitIDInsensitively(input string) (*GroupQuotaLimitId, error)

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

func (*GroupQuotaLimitId) FromParseResult

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

func (GroupQuotaLimitId) ID

func (id GroupQuotaLimitId) ID() string

ID returns the formatted Group Quota Limit ID

func (GroupQuotaLimitId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Group Quota Limit ID

func (GroupQuotaLimitId) String

func (id GroupQuotaLimitId) String() string

String returns a human-readable description of this Group Quota Limit ID

type GroupQuotaLimitList

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

type GroupQuotaLimitListProperties

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

type GroupQuotaLimitsClient

type GroupQuotaLimitsClient struct {
	Client *resourcemanager.Client
}

func NewGroupQuotaLimitsClientWithBaseURI

func NewGroupQuotaLimitsClientWithBaseURI(sdkApi sdkEnv.Api) (*GroupQuotaLimitsClient, error)

func (GroupQuotaLimitsClient) List

func (c GroupQuotaLimitsClient) List(ctx context.Context, id GroupQuotaLimitId) (result ListOperationResponse, err error)

List ...

func (GroupQuotaLimitsClient) RequestUpdate

func (c GroupQuotaLimitsClient) RequestUpdate(ctx context.Context, id GroupQuotaLimitId, input GroupQuotaLimitList) (result RequestUpdateOperationResponse, err error)

RequestUpdate ...

func (GroupQuotaLimitsClient) RequestUpdateThenPoll

func (c GroupQuotaLimitsClient) RequestUpdateThenPoll(ctx context.Context, id GroupQuotaLimitId, input GroupQuotaLimitList) error

RequestUpdateThenPoll performs RequestUpdate then polls until it's completed

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GroupQuotaLimitList
}

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 RequestUpdateOperationResponse

type RequestUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GroupQuotaLimitList
}