quota

package
v0.20241004.1180715 Latest Latest
Warning

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

 Go to latest Published: Oct 4, 2024 License: MPL-2.0 Imports: 11 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/machinelearningservices/2024-04-01/quota Documentation

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

Client Initialization

client := quota.NewQuotaClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: QuotaClient.List

ctx := context.TODO()
id := quota.NewLocationID("12345678-1234-9876-4563-123456789012", "location")

// 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: QuotaClient.Update

ctx := context.TODO()
id := quota.NewLocationID("12345678-1234-9876-4563-123456789012", "location")

payload := quota.QuotaUpdateParameters{
	// ...
}


// alternatively `client.Update(ctx, id, payload)` can be used to do batched pagination
items, err := client.UpdateComplete(ctx, id, payload)
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 PossibleValuesForQuotaUnit 

func PossibleValuesForQuotaUnit() []string

func PossibleValuesForStatus 

func PossibleValuesForStatus() []string

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 ListCompleteResult 

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

type ListCustomPager added in v0.20240628.1153531 

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        *[]ResourceQuota
}

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 

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 QuotaBaseProperties 

type QuotaBaseProperties struct {
	Id    *string    `json:"id,omitempty"`
	Limit *int64     `json:"limit,omitempty"`
	Type  *string    `json:"type,omitempty"`
	Unit  *QuotaUnit `json:"unit,omitempty"`
}

type QuotaClient 

type QuotaClient struct {
	Client *resourcemanager.Client
}

func NewQuotaClientWithBaseURI 

func NewQuotaClientWithBaseURI(sdkApi sdkEnv.Api) (*QuotaClient, error)

func (QuotaClient) List 

func (c QuotaClient) List(ctx context.Context, id LocationId) (result ListOperationResponse, err error)

List ...

func (QuotaClient) ListComplete 

func (c QuotaClient) ListComplete(ctx context.Context, id LocationId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (QuotaClient) ListCompleteMatchingPredicate 

func (c QuotaClient) ListCompleteMatchingPredicate(ctx context.Context, id LocationId, predicate ResourceQuotaOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (QuotaClient) Update 

func (c QuotaClient) Update(ctx context.Context, id LocationId, input QuotaUpdateParameters) (result UpdateOperationResponse, err error)

Update ...

func (QuotaClient) UpdateComplete 

func (c QuotaClient) UpdateComplete(ctx context.Context, id LocationId, input QuotaUpdateParameters) (UpdateCompleteResult, error)

UpdateComplete retrieves all the results into a single object

func (QuotaClient) UpdateCompleteMatchingPredicate 

func (c QuotaClient) UpdateCompleteMatchingPredicate(ctx context.Context, id LocationId, input QuotaUpdateParameters, predicate UpdateWorkspaceQuotasOperationPredicate) (result UpdateCompleteResult, err error)

UpdateCompleteMatchingPredicate retrieves all the results and then applies the predicate

type QuotaUnit 

type QuotaUnit string
const (
	QuotaUnitCount QuotaUnit = "Count"
)

func (*QuotaUnit) UnmarshalJSON 

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

type QuotaUpdateParameters 

type QuotaUpdateParameters struct {
	Location *string                `json:"location,omitempty"`
	Value    *[]QuotaBaseProperties `json:"value,omitempty"`
}

type ResourceName 

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

type ResourceQuota 

type ResourceQuota struct {
	AmlWorkspaceLocation *string       `json:"amlWorkspaceLocation,omitempty"`
	Id                   *string       `json:"id,omitempty"`
	Limit                *int64        `json:"limit,omitempty"`
	Name                 *ResourceName `json:"name,omitempty"`
	Type                 *string       `json:"type,omitempty"`
	Unit                 *QuotaUnit    `json:"unit,omitempty"`
}

type ResourceQuotaOperationPredicate 

type ResourceQuotaOperationPredicate struct {
	AmlWorkspaceLocation *string
	Id                   *string
	Limit                *int64
	Type                 *string
}

func (ResourceQuotaOperationPredicate) Matches 

func (p ResourceQuotaOperationPredicate) Matches(input ResourceQuota) bool

type Status 

type Status string
const (
	StatusFailure                              Status = "Failure"
	StatusInvalidQuotaBelowClusterMinimum      Status = "InvalidQuotaBelowClusterMinimum"
	StatusInvalidQuotaExceedsSubscriptionLimit Status = "InvalidQuotaExceedsSubscriptionLimit"
	StatusInvalidVMFamilyName                  Status = "InvalidVMFamilyName"
	StatusOperationNotEnabledForRegion         Status = "OperationNotEnabledForRegion"
	StatusOperationNotSupportedForSku          Status = "OperationNotSupportedForSku"
	StatusSuccess                              Status = "Success"
	StatusUndefined                            Status = "Undefined"
)

func (*Status) UnmarshalJSON 

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

type UpdateCompleteResult 

type UpdateCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []UpdateWorkspaceQuotas
}

type UpdateCustomPager added in v0.20240628.1153531 

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

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]UpdateWorkspaceQuotas
}

type UpdateWorkspaceQuotas 

type UpdateWorkspaceQuotas struct {
	Id     *string    `json:"id,omitempty"`
	Limit  *int64     `json:"limit,omitempty"`
	Status *Status    `json:"status,omitempty"`
	Type   *string    `json:"type,omitempty"`
	Unit   *QuotaUnit `json:"unit,omitempty"`
}

type UpdateWorkspaceQuotasOperationPredicate 

type UpdateWorkspaceQuotasOperationPredicate struct {
	Id    *string
	Limit *int64
	Type  *string
}

func (UpdateWorkspaceQuotasOperationPredicate) Matches 

func (p UpdateWorkspaceQuotasOperationPredicate) Matches(input UpdateWorkspaceQuotas) 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.