groupquotassubscriptions

package
v0.20250310.1130319 Latest Latest
Warning

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

 Go to latest Published: Mar 10, 2025 License: MPL-2.0 Imports: 13 Imported by: 0

README

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

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

Client Initialization

client := groupquotassubscriptions.NewGroupQuotasSubscriptionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: GroupQuotasSubscriptionsClient.GroupQuotaSubscriptionsCreateOrUpdate

ctx := context.TODO()
id := groupquotassubscriptions.NewSubscriptionID("managementGroupId", "groupQuotaName", "12345678-1234-9876-4563-123456789012")

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

Example Usage: GroupQuotasSubscriptionsClient.GroupQuotaSubscriptionsDelete

ctx := context.TODO()
id := groupquotassubscriptions.NewSubscriptionID("managementGroupId", "groupQuotaName", "12345678-1234-9876-4563-123456789012")

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

Example Usage: GroupQuotasSubscriptionsClient.GroupQuotaSubscriptionsGet

ctx := context.TODO()
id := groupquotassubscriptions.NewSubscriptionID("managementGroupId", "groupQuotaName", "12345678-1234-9876-4563-123456789012")

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

Example Usage: GroupQuotasSubscriptionsClient.GroupQuotaSubscriptionsList

ctx := context.TODO()
id := groupquotassubscriptions.NewGroupQuotaID("managementGroupId", "groupQuotaName")

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

Example Usage: GroupQuotasSubscriptionsClient.GroupQuotaSubscriptionsUpdate

ctx := context.TODO()
id := groupquotassubscriptions.NewSubscriptionID("managementGroupId", "groupQuotaName", "12345678-1234-9876-4563-123456789012")

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForRequestState 

func PossibleValuesForRequestState() []string

func ValidateGroupQuotaID 

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

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

func ValidateSubscriptionID 

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

ValidateSubscriptionID checks that 'input' can be parsed as a Subscription ID

Types

type GroupQuotaId 

type GroupQuotaId struct {
	ManagementGroupId string
	GroupQuotaName    string
}

GroupQuotaId is a struct representing the Resource ID for a Group Quota

func NewGroupQuotaID 

func NewGroupQuotaID(managementGroupId string, groupQuotaName string) GroupQuotaId

NewGroupQuotaID returns a new GroupQuotaId struct

func ParseGroupQuotaID 

func ParseGroupQuotaID(input string) (*GroupQuotaId, error)

ParseGroupQuotaID parses 'input' into a GroupQuotaId

func ParseGroupQuotaIDInsensitively 

func ParseGroupQuotaIDInsensitively(input string) (*GroupQuotaId, error)

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

func (*GroupQuotaId) FromParseResult 

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

func (GroupQuotaId) ID 

func (id GroupQuotaId) ID() string

ID returns the formatted Group Quota ID

func (GroupQuotaId) Segments 

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

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

func (GroupQuotaId) String 

func (id GroupQuotaId) String() string

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

type GroupQuotaSubscriptionId 

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

type GroupQuotaSubscriptionIdOperationPredicate 

type GroupQuotaSubscriptionIdOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (GroupQuotaSubscriptionIdOperationPredicate) Matches 

func (p GroupQuotaSubscriptionIdOperationPredicate) Matches(input GroupQuotaSubscriptionId) bool

type GroupQuotaSubscriptionIdProperties 

type GroupQuotaSubscriptionIdProperties struct {
	ProvisioningState *RequestState `json:"provisioningState,omitempty"`
	SubscriptionId    *string       `json:"subscriptionId,omitempty"`
}

type GroupQuotaSubscriptionsCreateOrUpdateOperationResponse 

type GroupQuotaSubscriptionsCreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GroupQuotaSubscriptionId
}

type GroupQuotaSubscriptionsDeleteOperationResponse 

type GroupQuotaSubscriptionsDeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type GroupQuotaSubscriptionsGetOperationResponse 

type GroupQuotaSubscriptionsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GroupQuotaSubscriptionId
}

type GroupQuotaSubscriptionsListCompleteResult 

type GroupQuotaSubscriptionsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []GroupQuotaSubscriptionId
}

type GroupQuotaSubscriptionsListCustomPager 

type GroupQuotaSubscriptionsListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *GroupQuotaSubscriptionsListCustomPager) NextPageLink() *odata.Link

type GroupQuotaSubscriptionsListOperationResponse 

type GroupQuotaSubscriptionsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]GroupQuotaSubscriptionId
}

type GroupQuotaSubscriptionsUpdateOperationResponse 

type GroupQuotaSubscriptionsUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GroupQuotaSubscriptionId
}

type GroupQuotasSubscriptionsClient 

type GroupQuotasSubscriptionsClient struct {
	Client *resourcemanager.Client
}

func NewGroupQuotasSubscriptionsClientWithBaseURI 

func NewGroupQuotasSubscriptionsClientWithBaseURI(sdkApi sdkEnv.Api) (*GroupQuotasSubscriptionsClient, error)

func (GroupQuotasSubscriptionsClient) GroupQuotaSubscriptionsCreateOrUpdate 

func (c GroupQuotasSubscriptionsClient) GroupQuotaSubscriptionsCreateOrUpdate(ctx context.Context, id SubscriptionId) (result GroupQuotaSubscriptionsCreateOrUpdateOperationResponse, err error)

GroupQuotaSubscriptionsCreateOrUpdate ...

func (GroupQuotasSubscriptionsClient) GroupQuotaSubscriptionsCreateOrUpdateThenPoll 

func (c GroupQuotasSubscriptionsClient) GroupQuotaSubscriptionsCreateOrUpdateThenPoll(ctx context.Context, id SubscriptionId) error

GroupQuotaSubscriptionsCreateOrUpdateThenPoll performs GroupQuotaSubscriptionsCreateOrUpdate then polls until it's completed

func (GroupQuotasSubscriptionsClient) GroupQuotaSubscriptionsDelete 

func (c GroupQuotasSubscriptionsClient) GroupQuotaSubscriptionsDelete(ctx context.Context, id SubscriptionId) (result GroupQuotaSubscriptionsDeleteOperationResponse, err error)

GroupQuotaSubscriptionsDelete ...

func (GroupQuotasSubscriptionsClient) GroupQuotaSubscriptionsDeleteThenPoll 

func (c GroupQuotasSubscriptionsClient) GroupQuotaSubscriptionsDeleteThenPoll(ctx context.Context, id SubscriptionId) error

GroupQuotaSubscriptionsDeleteThenPoll performs GroupQuotaSubscriptionsDelete then polls until it's completed

func (GroupQuotasSubscriptionsClient) GroupQuotaSubscriptionsGet 

func (c GroupQuotasSubscriptionsClient) GroupQuotaSubscriptionsGet(ctx context.Context, id SubscriptionId) (result GroupQuotaSubscriptionsGetOperationResponse, err error)

GroupQuotaSubscriptionsGet ...

func (GroupQuotasSubscriptionsClient) GroupQuotaSubscriptionsList 

func (c GroupQuotasSubscriptionsClient) GroupQuotaSubscriptionsList(ctx context.Context, id GroupQuotaId) (result GroupQuotaSubscriptionsListOperationResponse, err error)

GroupQuotaSubscriptionsList ...

func (GroupQuotasSubscriptionsClient) GroupQuotaSubscriptionsListComplete 

func (c GroupQuotasSubscriptionsClient) GroupQuotaSubscriptionsListComplete(ctx context.Context, id GroupQuotaId) (GroupQuotaSubscriptionsListCompleteResult, error)

GroupQuotaSubscriptionsListComplete retrieves all the results into a single object

func (GroupQuotasSubscriptionsClient) GroupQuotaSubscriptionsListCompleteMatchingPredicate 

func (c GroupQuotasSubscriptionsClient) GroupQuotaSubscriptionsListCompleteMatchingPredicate(ctx context.Context, id GroupQuotaId, predicate GroupQuotaSubscriptionIdOperationPredicate) (result GroupQuotaSubscriptionsListCompleteResult, err error)

GroupQuotaSubscriptionsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (GroupQuotasSubscriptionsClient) GroupQuotaSubscriptionsUpdate 

func (c GroupQuotasSubscriptionsClient) GroupQuotaSubscriptionsUpdate(ctx context.Context, id SubscriptionId) (result GroupQuotaSubscriptionsUpdateOperationResponse, err error)

GroupQuotaSubscriptionsUpdate ...

func (GroupQuotasSubscriptionsClient) GroupQuotaSubscriptionsUpdateThenPoll 

func (c GroupQuotasSubscriptionsClient) GroupQuotaSubscriptionsUpdateThenPoll(ctx context.Context, id SubscriptionId) error

GroupQuotaSubscriptionsUpdateThenPoll performs GroupQuotaSubscriptionsUpdate then polls until it's completed

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 SubscriptionId 

type SubscriptionId struct {
	ManagementGroupId string
	GroupQuotaName    string
	SubscriptionId    string
}

SubscriptionId is a struct representing the Resource ID for a Subscription

func NewSubscriptionID 

func NewSubscriptionID(managementGroupId string, groupQuotaName string, subscriptionId string) SubscriptionId

NewSubscriptionID returns a new SubscriptionId struct

func ParseSubscriptionID 

func ParseSubscriptionID(input string) (*SubscriptionId, error)

ParseSubscriptionID parses 'input' into a SubscriptionId

func ParseSubscriptionIDInsensitively 

func ParseSubscriptionIDInsensitively(input string) (*SubscriptionId, error)

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

func (*SubscriptionId) FromParseResult 

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

func (SubscriptionId) ID 

func (id SubscriptionId) ID() string

ID returns the formatted Subscription ID

func (SubscriptionId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Subscription ID

func (SubscriptionId) String 

func (id SubscriptionId) String() string

String returns a human-readable description of this Subscription ID

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.