groupquotas

package
v0.20250127.1142050 Latest Latest
Warning

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

 Go to latest Published: Jan 27, 2025 License: MPL-2.0 Imports: 14 Imported by: 0

README

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

The groupquotas 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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/quota/2025-03-01/groupquotas"

Client Initialization

client := groupquotas.NewGroupQuotasClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: GroupQuotasClient.CreateOrUpdate

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

payload := groupquotas.GroupQuotasEntity{
	// ...
}


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

Example Usage: GroupQuotasClient.Delete

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

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

Example Usage: GroupQuotasClient.Get

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

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

Example Usage: GroupQuotasClient.List

ctx := context.TODO()
id := commonids.NewManagementGroupID("groupId")

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

Example Usage: GroupQuotasClient.Update

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

payload := groupquotas.GroupQuotasEntityPatch{
	// ...
}


if err := client.UpdateThenPoll(ctx, id, payload); 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

Types

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GroupQuotasEntity
}

type DeleteOperationResponse 

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

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GroupQuotasEntity
}

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 GroupQuotasClient 

type GroupQuotasClient struct {
	Client *resourcemanager.Client
}

func NewGroupQuotasClientWithBaseURI 

func NewGroupQuotasClientWithBaseURI(sdkApi sdkEnv.Api) (*GroupQuotasClient, error)

func (GroupQuotasClient) CreateOrUpdate 

func (c GroupQuotasClient) CreateOrUpdate(ctx context.Context, id GroupQuotaId, input GroupQuotasEntity) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (GroupQuotasClient) CreateOrUpdateThenPoll 

func (c GroupQuotasClient) CreateOrUpdateThenPoll(ctx context.Context, id GroupQuotaId, input GroupQuotasEntity) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (GroupQuotasClient) Delete 

func (c GroupQuotasClient) Delete(ctx context.Context, id GroupQuotaId) (result DeleteOperationResponse, err error)

Delete ...

func (GroupQuotasClient) DeleteThenPoll 

func (c GroupQuotasClient) DeleteThenPoll(ctx context.Context, id GroupQuotaId) error

DeleteThenPoll performs Delete then polls until it's completed

func (GroupQuotasClient) Get 

func (c GroupQuotasClient) Get(ctx context.Context, id GroupQuotaId) (result GetOperationResponse, err error)

Get ...

func (GroupQuotasClient) List 

func (c GroupQuotasClient) List(ctx context.Context, id commonids.ManagementGroupId) (result ListOperationResponse, err error)

List ...

func (GroupQuotasClient) ListComplete 

func (c GroupQuotasClient) ListComplete(ctx context.Context, id commonids.ManagementGroupId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (GroupQuotasClient) ListCompleteMatchingPredicate 

func (c GroupQuotasClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.ManagementGroupId, predicate GroupQuotasEntityOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (GroupQuotasClient) Update 

func (c GroupQuotasClient) Update(ctx context.Context, id GroupQuotaId, input GroupQuotasEntityPatch) (result UpdateOperationResponse, err error)

Update ...

func (GroupQuotasClient) UpdateThenPoll 

func (c GroupQuotasClient) UpdateThenPoll(ctx context.Context, id GroupQuotaId, input GroupQuotasEntityPatch) error

UpdateThenPoll performs Update then polls until it's completed

type GroupQuotasEntity 

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

type GroupQuotasEntityBase 

type GroupQuotasEntityBase struct {
	DisplayName       *string       `json:"displayName,omitempty"`
	ProvisioningState *RequestState `json:"provisioningState,omitempty"`
}

type GroupQuotasEntityBasePatch 

type GroupQuotasEntityBasePatch struct {
	DisplayName       *string       `json:"displayName,omitempty"`
	ProvisioningState *RequestState `json:"provisioningState,omitempty"`
}

type GroupQuotasEntityOperationPredicate 

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

func (GroupQuotasEntityOperationPredicate) Matches 

func (p GroupQuotasEntityOperationPredicate) Matches(input GroupQuotasEntity) bool

type GroupQuotasEntityPatch 

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

type ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []GroupQuotasEntity
}

type ListCustomPager 

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

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]GroupQuotasEntity
}

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 UpdateOperationResponse 

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *GroupQuotasEntity
}

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.