quota

package
v59.3.1+incompatible Latest Latest
Warning

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

 Go to latest Published: Nov 25, 2021 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Package quota implements the Azure ARM Quota service API version 2021-03-15-preview.

Microsoft Azure Quota Resource Provider

Index

Constants

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Quota
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version 

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type BaseClient 

type BaseClient struct {
	autorest.Client
	BaseURI string
}

BaseClient is the base client for Quota.

func New 

func New() BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type BasicLimitJSONObject 

type BasicLimitJSONObject interface {
	AsLimitObject() (*LimitObject, bool)
	AsLimitJSONObject() (*LimitJSONObject, bool)
}

BasicLimitJSONObject limitJson abstract class.

type Client 

type Client struct {
	BaseClient
}

Client is the microsoft Azure Quota Resource Provider

func NewClient 

func NewClient() Client

NewClient creates an instance of the Client client.

func NewClientWithBaseURI 

func NewClientWithBaseURI(baseURI string) Client

NewClientWithBaseURI creates an instance of the Client client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (Client) CreateOrUpdate 

func (client Client) CreateOrUpdate(ctx context.Context, resourceName string, scope string, createQuotaRequest CurrentQuotaLimitBase) (result CreateOrUpdateFuture, err error)

CreateOrUpdate create or update the quota limit for the specified resource with the requested value. To update the quota, follow these steps: 1. Use the GET operation for quotas and usages to determine how much quota remains for the specific resource and to calculate the new quota limit. These steps are detailed in [this example](https://techcommunity.microsoft.com/t5/azure-governance-and-management/using-the-new-quota-rest-api/ba-p/2183670). 2. Use this PUT operation to update the quota limit. Please check the URI in location header for the detailed status of the request. Parameters: resourceName - resource name for a given resource provider. For example: - SKU name for Microsoft.Compute - SKU or TotalLowPriorityCores for Microsoft.MachineLearningServices For Microsoft.Network PublicIPAddresses. scope - the target Azure resource URI. For example, `/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/qms-test/providers/Microsoft.Batch/batchAccounts/testAccount/`. This is the target Azure resource URI for the List GET operation. If a `{resourceName}` is added after `/quotas`, then it's the target Azure resource URI in the GET operation for the specific resource. createQuotaRequest - quota request payload.

func (Client) CreateOrUpdatePreparer 

func (client Client) CreateOrUpdatePreparer(ctx context.Context, resourceName string, scope string, createQuotaRequest CurrentQuotaLimitBase) (*http.Request, error)

CreateOrUpdatePreparer prepares the CreateOrUpdate request.

func (Client) CreateOrUpdateResponder 

func (client Client) CreateOrUpdateResponder(resp *http.Response) (result CurrentQuotaLimitBase, err error)

CreateOrUpdateResponder handles the response to the CreateOrUpdate request. The method always closes the http.Response Body.

func (Client) CreateOrUpdateSender 

func (client Client) CreateOrUpdateSender(req *http.Request) (future CreateOrUpdateFuture, err error)

CreateOrUpdateSender sends the CreateOrUpdate request. The method will close the http.Response Body if it receives an error.

func (Client) Get 

func (client Client) Get(ctx context.Context, resourceName string, scope string) (result CurrentQuotaLimitBase, err error)

Get get the quota limit of a resource. The response can be used to determine the remaining quota to calculate a new quota limit that can be submitted with a PUT request. Parameters: resourceName - resource name for a given resource provider. For example: - SKU name for Microsoft.Compute - SKU or TotalLowPriorityCores for Microsoft.MachineLearningServices For Microsoft.Network PublicIPAddresses. scope - the target Azure resource URI. For example, `/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/qms-test/providers/Microsoft.Batch/batchAccounts/testAccount/`. This is the target Azure resource URI for the List GET operation. If a `{resourceName}` is added after `/quotas`, then it's the target Azure resource URI in the GET operation for the specific resource.

func (Client) GetPreparer 

func (client Client) GetPreparer(ctx context.Context, resourceName string, scope string) (*http.Request, error)

GetPreparer prepares the Get request.

func (Client) GetResponder 

func (client Client) GetResponder(resp *http.Response) (result CurrentQuotaLimitBase, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (Client) GetSender 

func (client Client) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (Client) List 

func (client Client) List(ctx context.Context, scope string) (result LimitsPage, err error)

List get a list of current quota limits of all resources for the specified scope. The response from this GET operation can be leveraged to submit requests to update a quota. Parameters: scope - the target Azure resource URI. For example, `/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/qms-test/providers/Microsoft.Batch/batchAccounts/testAccount/`. This is the target Azure resource URI for the List GET operation. If a `{resourceName}` is added after `/quotas`, then it's the target Azure resource URI in the GET operation for the specific resource.

func (Client) ListComplete 

func (client Client) ListComplete(ctx context.Context, scope string) (result LimitsIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (Client) ListPreparer 

func (client Client) ListPreparer(ctx context.Context, scope string) (*http.Request, error)

ListPreparer prepares the List request.

func (Client) ListResponder 

func (client Client) ListResponder(resp *http.Response) (result Limits, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (Client) ListSender 

func (client Client) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (Client) Update 

func (client Client) Update(ctx context.Context, resourceName string, scope string, createQuotaRequest CurrentQuotaLimitBase) (result UpdateFuture, err error)

Update update the quota limit for a specific resource to the specified value: 1. Use the Usages-GET and Quota-GET operations to determine the remaining quota for the specific resource and to calculate the new quota limit. These steps are detailed in [this example](https://techcommunity.microsoft.com/t5/azure-governance-and-management/using-the-new-quota-rest-api/ba-p/2183670). 2. Use this PUT operation to update the quota limit. Please check the URI in location header for the detailed status of the request. Parameters: resourceName - resource name for a given resource provider. For example: - SKU name for Microsoft.Compute - SKU or TotalLowPriorityCores for Microsoft.MachineLearningServices For Microsoft.Network PublicIPAddresses. scope - the target Azure resource URI. For example, `/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/qms-test/providers/Microsoft.Batch/batchAccounts/testAccount/`. This is the target Azure resource URI for the List GET operation. If a `{resourceName}` is added after `/quotas`, then it's the target Azure resource URI in the GET operation for the specific resource. createQuotaRequest - quota requests payload.

func (Client) UpdatePreparer 

func (client Client) UpdatePreparer(ctx context.Context, resourceName string, scope string, createQuotaRequest CurrentQuotaLimitBase) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (Client) UpdateResponder 

func (client Client) UpdateResponder(resp *http.Response) (result CurrentQuotaLimitBase, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (Client) UpdateSender 

func (client Client) UpdateSender(req *http.Request) (future UpdateFuture, err error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type CommonResourceProperties 

type CommonResourceProperties struct {
	// ID - READ-ONLY; Resource ID
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type. Example: "Microsoft.Quota/quotas"
	Type *string `json:"type,omitempty"`
}

CommonResourceProperties resource properties.

func (CommonResourceProperties) MarshalJSON 

func (crp CommonResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CommonResourceProperties.

type CreateGenericQuotaRequestParameters 

type CreateGenericQuotaRequestParameters struct {
	// Value - Quota change requests.
	Value *[]CurrentQuotaLimitBase `json:"value,omitempty"`
}

CreateGenericQuotaRequestParameters quota change requests information.

type CreateOrUpdateFuture 

type CreateOrUpdateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(Client) (CurrentQuotaLimitBase, error)
}

CreateOrUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*CreateOrUpdateFuture) UnmarshalJSON 

func (future *CreateOrUpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type CurrentQuotaLimitBase 

type CurrentQuotaLimitBase struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; The resource ID.
	ID *string `json:"id,omitempty"`
	// Type - READ-ONLY; The resource type.
	Type *string `json:"type,omitempty"`
	// Name - READ-ONLY; The resource name.
	Name *string `json:"name,omitempty"`
	// Properties - Quota properties for the specified resource, based on the API called, Quotas or Usages.
	Properties *Properties `json:"properties,omitempty"`
}

CurrentQuotaLimitBase quota limit.

func (CurrentQuotaLimitBase) MarshalJSON 

func (cqlb CurrentQuotaLimitBase) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CurrentQuotaLimitBase.

type CurrentUsagesBase 

type CurrentUsagesBase struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; The resource ID.
	ID *string `json:"id,omitempty"`
	// Type - READ-ONLY; The resource type.
	Type *string `json:"type,omitempty"`
	// Name - READ-ONLY; The resource name.
	Name *string `json:"name,omitempty"`
	// Properties - Usage properties for the specified resource.
	Properties *UsagesProperties `json:"properties,omitempty"`
}

CurrentUsagesBase resource usage.

func (CurrentUsagesBase) MarshalJSON 

func (cub CurrentUsagesBase) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CurrentUsagesBase.

type ExceptionResponse 

type ExceptionResponse struct {
	// Error - API error details.
	Error *ServiceError `json:"error,omitempty"`
}

ExceptionResponse error.

type LimitJSONObject 

type LimitJSONObject struct {
	// LimitObjectType - Possible values include: 'LimitObjectTypeLimitJSONObject', 'LimitObjectTypeLimitValue'
	LimitObjectType LimitObjectType `json:"limitObjectType,omitempty"`
}

LimitJSONObject limitJson abstract class.

func (LimitJSONObject) AsBasicLimitJSONObject 

func (ljo LimitJSONObject) AsBasicLimitJSONObject() (BasicLimitJSONObject, bool)

AsBasicLimitJSONObject is the BasicLimitJSONObject implementation for LimitJSONObject.

func (LimitJSONObject) AsLimitJSONObject 

func (ljo LimitJSONObject) AsLimitJSONObject() (*LimitJSONObject, bool)

AsLimitJSONObject is the BasicLimitJSONObject implementation for LimitJSONObject.

func (LimitJSONObject) AsLimitObject 

func (ljo LimitJSONObject) AsLimitObject() (*LimitObject, bool)

AsLimitObject is the BasicLimitJSONObject implementation for LimitJSONObject.

func (LimitJSONObject) MarshalJSON 

func (ljo LimitJSONObject) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for LimitJSONObject.

type LimitObject 

type LimitObject struct {
	// Value - The quota/limit value
	Value *int32 `json:"value,omitempty"`
	// LimitType - Possible values include: 'LimitTypesIndependent', 'LimitTypesShared'
	LimitType LimitTypes `json:"limitType,omitempty"`
	// LimitObjectType - Possible values include: 'LimitObjectTypeLimitJSONObject', 'LimitObjectTypeLimitValue'
	LimitObjectType LimitObjectType `json:"limitObjectType,omitempty"`
}

LimitObject the resource quota limit value.

func (LimitObject) AsBasicLimitJSONObject 

func (lo LimitObject) AsBasicLimitJSONObject() (BasicLimitJSONObject, bool)

AsBasicLimitJSONObject is the BasicLimitJSONObject implementation for LimitObject.

func (LimitObject) AsLimitJSONObject 

func (lo LimitObject) AsLimitJSONObject() (*LimitJSONObject, bool)

AsLimitJSONObject is the BasicLimitJSONObject implementation for LimitObject.

func (LimitObject) AsLimitObject 

func (lo LimitObject) AsLimitObject() (*LimitObject, bool)

AsLimitObject is the BasicLimitJSONObject implementation for LimitObject.

func (LimitObject) MarshalJSON 

func (lo LimitObject) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for LimitObject.

type LimitObjectType 

type LimitObjectType string

LimitObjectType enumerates the values for limit object type. 

const (
	// LimitObjectTypeLimitJSONObject ...
	LimitObjectTypeLimitJSONObject LimitObjectType = "LimitJsonObject"
	// LimitObjectTypeLimitValue ...
	LimitObjectTypeLimitValue LimitObjectType = "LimitValue"
)

func PossibleLimitObjectTypeValues 

func PossibleLimitObjectTypeValues() []LimitObjectType

PossibleLimitObjectTypeValues returns an array of possible values for the LimitObjectType const type.

type LimitType 

type LimitType string

LimitType enumerates the values for limit type. 

const (
	// LimitTypeLimitValue ...
	LimitTypeLimitValue LimitType = "LimitValue"
)

func PossibleLimitTypeValues 

func PossibleLimitTypeValues() []LimitType

PossibleLimitTypeValues returns an array of possible values for the LimitType const type.

type LimitTypes 

type LimitTypes string

LimitTypes enumerates the values for limit types. 

const (
	// LimitTypesIndependent ...
	LimitTypesIndependent LimitTypes = "Independent"
	// LimitTypesShared ...
	LimitTypesShared LimitTypes = "Shared"
)

func PossibleLimitTypesValues 

func PossibleLimitTypesValues() []LimitTypes

PossibleLimitTypesValues returns an array of possible values for the LimitTypes const type.

type Limits 

type Limits struct {
	autorest.Response `json:"-"`
	// Value - List of quota limits.
	Value *[]CurrentQuotaLimitBase `json:"value,omitempty"`
	// NextLink - The URI used to fetch the next page of quota limits. When there are no more pages, this string is null.
	NextLink *string `json:"nextLink,omitempty"`
}

Limits quota limits.

func (Limits) IsEmpty 

func (l Limits) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type LimitsIterator 

type LimitsIterator struct {
	// contains filtered or unexported fields
}

LimitsIterator provides access to a complete listing of CurrentQuotaLimitBase values.

func NewLimitsIterator 

func NewLimitsIterator(page LimitsPage) LimitsIterator

Creates a new instance of the LimitsIterator type.

func (*LimitsIterator) Next 

func (iter *LimitsIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*LimitsIterator) NextWithContext 

func (iter *LimitsIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (LimitsIterator) NotDone 

func (iter LimitsIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (LimitsIterator) Response 

func (iter LimitsIterator) Response() Limits

Response returns the raw server response from the last page request.

func (LimitsIterator) Value 

func (iter LimitsIterator) Value() CurrentQuotaLimitBase

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type LimitsPage 

type LimitsPage struct {
	// contains filtered or unexported fields
}

LimitsPage contains a page of CurrentQuotaLimitBase values.

func NewLimitsPage 

func NewLimitsPage(cur Limits, getNextPage func(context.Context, Limits) (Limits, error)) LimitsPage

Creates a new instance of the LimitsPage type.

func (*LimitsPage) Next 

func (page *LimitsPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*LimitsPage) NextWithContext 

func (page *LimitsPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (LimitsPage) NotDone 

func (page LimitsPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (LimitsPage) Response 

func (page LimitsPage) Response() Limits

Response returns the raw server response from the last page request.

func (LimitsPage) Values 

func (page LimitsPage) Values() []CurrentQuotaLimitBase

Values returns the slice of values for the current page or nil if there are no values.

type LimitsResponse 

type LimitsResponse struct {
	// Value - List of quota limits with the quota request status.
	Value *[]CurrentQuotaLimitBase `json:"value,omitempty"`
	// NextLink - The URI used to fetch the next page of quota limits. When there are no more pages, this is null.
	NextLink *string `json:"nextLink,omitempty"`
}

LimitsResponse quota limits request response.

type OperationClient 

type OperationClient struct {
	BaseClient
}

OperationClient is the microsoft Azure Quota Resource Provider

func NewOperationClient 

func NewOperationClient() OperationClient

NewOperationClient creates an instance of the OperationClient client.

func NewOperationClientWithBaseURI 

func NewOperationClientWithBaseURI(baseURI string) OperationClient

NewOperationClientWithBaseURI creates an instance of the OperationClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (OperationClient) List 

func (client OperationClient) List(ctx context.Context) (result OperationListPage, err error)

List list all the operations supported by the Microsoft.Quota resource provider.

func (OperationClient) ListComplete 

func (client OperationClient) ListComplete(ctx context.Context) (result OperationListIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (OperationClient) ListPreparer 

func (client OperationClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (OperationClient) ListResponder 

func (client OperationClient) ListResponder(resp *http.Response) (result OperationList, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (OperationClient) ListSender 

func (client OperationClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type OperationDisplay 

type OperationDisplay struct {
	// Provider - Provider name.
	Provider *string `json:"provider,omitempty"`
	// Resource - Resource name.
	Resource *string `json:"resource,omitempty"`
	// Operation - Operation name.
	Operation *string `json:"operation,omitempty"`
	// Description - Operation description.
	Description *string `json:"description,omitempty"`
}

OperationDisplay ...

type OperationList 

type OperationList struct {
	autorest.Response `json:"-"`
	Value             *[]OperationResponse `json:"value,omitempty"`
	// NextLink - URL to get the next page of items.
	NextLink *string `json:"nextLink,omitempty"`
}

OperationList ...

func (OperationList) IsEmpty 

func (ol OperationList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationListIterator 

type OperationListIterator struct {
	// contains filtered or unexported fields
}

OperationListIterator provides access to a complete listing of OperationResponse values.

func NewOperationListIterator 

func NewOperationListIterator(page OperationListPage) OperationListIterator

Creates a new instance of the OperationListIterator type.

func (*OperationListIterator) Next 

func (iter *OperationListIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationListIterator) NextWithContext 

func (iter *OperationListIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (OperationListIterator) NotDone 

func (iter OperationListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (OperationListIterator) Response 

func (iter OperationListIterator) Response() OperationList

Response returns the raw server response from the last page request.

func (OperationListIterator) Value 

func (iter OperationListIterator) Value() OperationResponse

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type OperationListPage 

type OperationListPage struct {
	// contains filtered or unexported fields
}

OperationListPage contains a page of OperationResponse values.

func NewOperationListPage 

func NewOperationListPage(cur OperationList, getNextPage func(context.Context, OperationList) (OperationList, error)) OperationListPage

Creates a new instance of the OperationListPage type.

func (*OperationListPage) Next 

func (page *OperationListPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OperationListPage) NextWithContext 

func (page *OperationListPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (OperationListPage) NotDone 

func (page OperationListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (OperationListPage) Response 

func (page OperationListPage) Response() OperationList

Response returns the raw server response from the last page request.

func (OperationListPage) Values 

func (page OperationListPage) Values() []OperationResponse

Values returns the slice of values for the current page or nil if there are no values.

type OperationResponse 

type OperationResponse struct {
	Name    *string           `json:"name,omitempty"`
	Display *OperationDisplay `json:"display,omitempty"`
	Origin  *string           `json:"origin,omitempty"`
}

OperationResponse ...

type Properties 

type Properties struct {
	// Limit - Resource quota limit properties.
	Limit BasicLimitJSONObject `json:"limit,omitempty"`
	// Unit - READ-ONLY;  The quota units, such as Count and Bytes. When requesting quota, use the **unit** value returned in the GET response in the request body of your PUT operation.
	Unit *string `json:"unit,omitempty"`
	// Name - Resource name provided by the resource provider. Use this property name when requesting quota.
	Name *ResourceName `json:"name,omitempty"`
	// ResourceType - Resource type name.
	ResourceType *string `json:"resourceType,omitempty"`
	// QuotaPeriod - READ-ONLY; The time period over which the quota usage values are summarized. For example:
	// *P1D (per one day)
	// *PT1M (per one minute)
	// *PT1S (per one second).
	// This parameter is optional because, for some resources like compute, the period is irrelevant.
	QuotaPeriod *string `json:"quotaPeriod,omitempty"`
	// IsQuotaApplicable - READ-ONLY; States if quota can be requested for this resource.
	IsQuotaApplicable *bool `json:"isQuotaApplicable,omitempty"`
	// Properties - Additional properties for the specific resource provider.
	Properties interface{} `json:"properties,omitempty"`
}

Properties quota properties for the specified resource.

func (Properties) MarshalJSON 

func (p Properties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Properties.

func (*Properties) UnmarshalJSON 

func (p *Properties) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Properties struct.

type RequestDetails 

type RequestDetails struct {
	autorest.Response `json:"-"`
	// ID - READ-ONLY; Quota request ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Quota request name.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type. "Microsoft.Quota/quotas".
	Type *string `json:"type,omitempty"`
	// RequestProperties - Quota request details.
	*RequestProperties `json:"properties,omitempty"`
}

RequestDetails list of quota requests with details.

func (RequestDetails) MarshalJSON 

func (rd RequestDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RequestDetails.

func (*RequestDetails) UnmarshalJSON 

func (rd *RequestDetails) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for RequestDetails struct.

type RequestDetailsList 

type RequestDetailsList struct {
	autorest.Response `json:"-"`
	// Value - Quota request details.
	Value *[]RequestDetails `json:"value,omitempty"`
	// NextLink - The URI for fetching the next page of quota limits. When there are no more pages, this string is null.
	NextLink *string `json:"nextLink,omitempty"`
}

RequestDetailsList quota request information.

func (RequestDetailsList) IsEmpty 

func (rdl RequestDetailsList) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type RequestDetailsListIterator 

type RequestDetailsListIterator struct {
	// contains filtered or unexported fields
}

RequestDetailsListIterator provides access to a complete listing of RequestDetails values.

func NewRequestDetailsListIterator 

func NewRequestDetailsListIterator(page RequestDetailsListPage) RequestDetailsListIterator

Creates a new instance of the RequestDetailsListIterator type.

func (*RequestDetailsListIterator) Next 

func (iter *RequestDetailsListIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*RequestDetailsListIterator) NextWithContext 

func (iter *RequestDetailsListIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (RequestDetailsListIterator) NotDone 

func (iter RequestDetailsListIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (RequestDetailsListIterator) Response 

func (iter RequestDetailsListIterator) Response() RequestDetailsList

Response returns the raw server response from the last page request.

func (RequestDetailsListIterator) Value 

func (iter RequestDetailsListIterator) Value() RequestDetails

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type RequestDetailsListPage 

type RequestDetailsListPage struct {
	// contains filtered or unexported fields
}

RequestDetailsListPage contains a page of RequestDetails values.

func NewRequestDetailsListPage 

func NewRequestDetailsListPage(cur RequestDetailsList, getNextPage func(context.Context, RequestDetailsList) (RequestDetailsList, error)) RequestDetailsListPage

Creates a new instance of the RequestDetailsListPage type.

func (*RequestDetailsListPage) Next 

func (page *RequestDetailsListPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*RequestDetailsListPage) NextWithContext 

func (page *RequestDetailsListPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (RequestDetailsListPage) NotDone 

func (page RequestDetailsListPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (RequestDetailsListPage) Response 

func (page RequestDetailsListPage) Response() RequestDetailsList

Response returns the raw server response from the last page request.

func (RequestDetailsListPage) Values 

func (page RequestDetailsListPage) Values() []RequestDetails

Values returns the slice of values for the current page or nil if there are no values.

type RequestOneResourceProperties 

type RequestOneResourceProperties struct {
	// ProvisioningState - READ-ONLY; Quota request status. Possible values include: 'RequestStateAccepted', 'RequestStateInvalid', 'RequestStateSucceeded', 'RequestStateFailed', 'RequestStateInProgress'
	ProvisioningState RequestState `json:"provisioningState,omitempty"`
	// Message - READ-ONLY; User-friendly status message.
	Message *string `json:"message,omitempty"`
	// RequestSubmitTime - READ-ONLY; Quota request submission time. The date conforms to the following ISO 8601 standard format: yyyy-MM-ddTHH:mm:ssZ.
	RequestSubmitTime *date.Time `json:"requestSubmitTime,omitempty"`
	// Limit - Resource quota limit properties.
	Limit *LimitObject `json:"limit,omitempty"`
	// CurrentValue - READ-ONLY; Usage information for the current resource.
	CurrentValue *int32 `json:"currentValue,omitempty"`
	// Unit -  The quota limit units, such as Count and Bytes. When requesting quota, use the **unit** value returned in the GET response in the request body of your PUT operation.
	Unit *string `json:"unit,omitempty"`
	// Name - Resource name provided by the resource provider. Use this property name when requesting quota.
	Name *ResourceName `json:"name,omitempty"`
	// ResourceType - Resource type name.
	ResourceType *string `json:"resourceType,omitempty"`
	// QuotaPeriod - READ-ONLY; The time period over which the quota usage values are summarized. For example:
	// *P1D (per one day)
	// *PT1M (per one minute)
	// *PT1S (per one second).
	// This parameter is optional because, for some resources like compute, the period is irrelevant.
	QuotaPeriod *string `json:"quotaPeriod,omitempty"`
	// IsQuotaApplicable - READ-ONLY; States if quota can be requested for this resource.
	IsQuotaApplicable *bool `json:"isQuotaApplicable,omitempty"`
	// Error - Error details of the quota request.
	Error *ServiceErrorDetail `json:"error,omitempty"`
	// Properties - Additional properties for the specific resource provider.
	Properties interface{} `json:"properties,omitempty"`
}

RequestOneResourceProperties quota request.

func (RequestOneResourceProperties) MarshalJSON 

func (rorp RequestOneResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RequestOneResourceProperties.

type RequestOneResourceSubmitResponse 

type RequestOneResourceSubmitResponse struct {
	// ID - READ-ONLY; Quota request ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; The name of the quota request.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type. "Microsoft.Quota/ServiceLimitRequests"
	Type *string `json:"type,omitempty"`
	// RequestOneResourceProperties - Quota request details.
	*RequestOneResourceProperties `json:"properties,omitempty"`
}

RequestOneResourceSubmitResponse quota request response.

func (RequestOneResourceSubmitResponse) MarshalJSON 

func (rorsr RequestOneResourceSubmitResponse) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RequestOneResourceSubmitResponse.

func (*RequestOneResourceSubmitResponse) UnmarshalJSON 

func (rorsr *RequestOneResourceSubmitResponse) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for RequestOneResourceSubmitResponse struct.

type RequestProperties 

type RequestProperties struct {
	// ProvisioningState - The quota request status. Possible values include: 'RequestStateAccepted', 'RequestStateInvalid', 'RequestStateSucceeded', 'RequestStateFailed', 'RequestStateInProgress'
	ProvisioningState RequestState `json:"provisioningState,omitempty"`
	// Message - READ-ONLY; User-friendly status message.
	Message *string `json:"message,omitempty"`
	// Error - Error details of the quota request.
	Error *ServiceErrorDetail `json:"error,omitempty"`
	// RequestSubmitTime - READ-ONLY; The quota request submission time. The date conforms to the following format specified by the ISO 8601 standard: yyyy-MM-ddTHH:mm:ssZ
	RequestSubmitTime *date.Time `json:"requestSubmitTime,omitempty"`
	// Value - Quota request details.
	Value *[]SubRequest `json:"value,omitempty"`
}

RequestProperties quota request properties.

func (RequestProperties) MarshalJSON 

func (rp RequestProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RequestProperties.

type RequestState 

type RequestState string

RequestState enumerates the values for request state. 

const (
	// RequestStateAccepted ...
	RequestStateAccepted RequestState = "Accepted"
	// RequestStateFailed ...
	RequestStateFailed RequestState = "Failed"
	// RequestStateInProgress ...
	RequestStateInProgress RequestState = "InProgress"
	// RequestStateInvalid ...
	RequestStateInvalid RequestState = "Invalid"
	// RequestStateSucceeded ...
	RequestStateSucceeded RequestState = "Succeeded"
)

func PossibleRequestStateValues 

func PossibleRequestStateValues() []RequestState

PossibleRequestStateValues returns an array of possible values for the RequestState const type.

type RequestStatusClient 

type RequestStatusClient struct {
	BaseClient
}

RequestStatusClient is the microsoft Azure Quota Resource Provider

func NewRequestStatusClient 

func NewRequestStatusClient() RequestStatusClient

NewRequestStatusClient creates an instance of the RequestStatusClient client.

func NewRequestStatusClientWithBaseURI 

func NewRequestStatusClientWithBaseURI(baseURI string) RequestStatusClient

NewRequestStatusClientWithBaseURI creates an instance of the RequestStatusClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (RequestStatusClient) Get 

func (client RequestStatusClient) Get(ctx context.Context, ID string, scope string) (result RequestDetails, err error)

Get get the quota request details and status by quota request ID for the resources of the resource provider at a specific location. The quota request ID **id** is returned in the response of the PUT operation. Parameters: ID - quota request ID. scope - the target Azure resource URI. For example, `/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/qms-test/providers/Microsoft.Batch/batchAccounts/testAccount/`. This is the target Azure resource URI for the List GET operation. If a `{resourceName}` is added after `/quotas`, then it's the target Azure resource URI in the GET operation for the specific resource.

func (RequestStatusClient) GetPreparer 

func (client RequestStatusClient) GetPreparer(ctx context.Context, ID string, scope string) (*http.Request, error)

GetPreparer prepares the Get request.

func (RequestStatusClient) GetResponder 

func (client RequestStatusClient) GetResponder(resp *http.Response) (result RequestDetails, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (RequestStatusClient) GetSender 

func (client RequestStatusClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (RequestStatusClient) List 

func (client RequestStatusClient) List(ctx context.Context, scope string, filter string, top *int32, skiptoken string) (result RequestDetailsListPage, err error)

List for the specified scope, get the current quota requests for a one year period ending at the time is made. Use the **oData** filter to select quota requests. Parameters: scope - the target Azure resource URI. For example, `/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/qms-test/providers/Microsoft.Batch/batchAccounts/testAccount/`. This is the target Azure resource URI for the List GET operation. If a `{resourceName}` is added after `/quotas`, then it's the target Azure resource URI in the GET operation for the specific resource. filter - | Field | Supported operators |---------------------|------------------------

|requestSubmitTime | ge, le, eq, gt, lt |provisioningState eq {QuotaRequestState} |resourceName eq {resourceName} top - number of records to return. skiptoken - the **Skiptoken** parameter is used only if a previous operation returned a partial result. If a previous response contains a **nextLink** element, its value includes a **skiptoken** parameter that specifies a starting point to use for subsequent calls.

func (RequestStatusClient) ListComplete 

func (client RequestStatusClient) ListComplete(ctx context.Context, scope string, filter string, top *int32, skiptoken string) (result RequestDetailsListIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (RequestStatusClient) ListPreparer 

func (client RequestStatusClient) ListPreparer(ctx context.Context, scope string, filter string, top *int32, skiptoken string) (*http.Request, error)

ListPreparer prepares the List request.

func (RequestStatusClient) ListResponder 

func (client RequestStatusClient) ListResponder(resp *http.Response) (result RequestDetailsList, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (RequestStatusClient) ListSender 

func (client RequestStatusClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type RequestStatusDetails 

type RequestStatusDetails struct {
	// ProvisioningState - READ-ONLY; Quota request status. Possible values include: 'RequestStateAccepted', 'RequestStateInvalid', 'RequestStateSucceeded', 'RequestStateFailed', 'RequestStateInProgress'
	ProvisioningState RequestState `json:"provisioningState,omitempty"`
	// Message - READ-ONLY; User-friendly message.
	Message *string `json:"message,omitempty"`
	// Limit - Resource quota limit properties.
	Limit *LimitObject `json:"limit,omitempty"`
	// Unit -  The quota limit units, such as Count and Bytes. When requesting quota, use the **unit** value returned in the GET response in the request body of your PUT operation.
	Unit *string `json:"unit,omitempty"`
	// Name - Resource name provided by the resource provider. Use this property name when requesting quota.
	Name *ResourceName `json:"name,omitempty"`
	// ResourceType - Resource type name.
	ResourceType *string `json:"resourceType,omitempty"`
	// QuotaPeriod - READ-ONLY; The time period over which the quota usage values are summarized. For example:
	// *P1D (per one day)
	// *PT1M (per one minute)
	// *PT1S (per one second).
	// This parameter is optional because, for some resources like compute, the period is irrelevant.
	QuotaPeriod *string `json:"quotaPeriod,omitempty"`
	// Properties - Additional properties for the specific resource provider.
	Properties interface{} `json:"properties,omitempty"`
}

RequestStatusDetails quota request status details.

func (RequestStatusDetails) MarshalJSON 

func (rsd RequestStatusDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RequestStatusDetails.

type RequestSubmitResponse 

type RequestSubmitResponse struct {
	// ID - READ-ONLY; Quota request ID.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Quota request name.
	Name *string `json:"name,omitempty"`
	// Properties - Quota request details.
	Properties *RequestProperties `json:"properties,omitempty"`
	// Type - READ-ONLY; Resource type. "Microsoft.Quota/quotas".
	Type *string `json:"type,omitempty"`
}

RequestSubmitResponse quota request response.

func (RequestSubmitResponse) MarshalJSON 

func (rsr RequestSubmitResponse) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RequestSubmitResponse.

type RequestSubmitResponse202 

type RequestSubmitResponse202 struct {
	// ID - READ-ONLY; The quota request ID. To check the request status, use the **id** value in a [Quota Request Status](https://docs.microsoft.com/en-us/rest/api/reserved-vm-instances/quotarequeststatus/get) GET operation.
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Operation ID.
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type.
	Type *string `json:"type,omitempty"`
	// RequestStatusDetails - Quota request status.
	*RequestStatusDetails `json:"properties,omitempty"`
}

RequestSubmitResponse202 the quota request response with the quota request ID.

func (RequestSubmitResponse202) MarshalJSON 

func (rsr2 RequestSubmitResponse202) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RequestSubmitResponse202.

func (*RequestSubmitResponse202) UnmarshalJSON 

func (rsr2 *RequestSubmitResponse202) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for RequestSubmitResponse202 struct.

type ResourceName 

type ResourceName struct {
	// Value - Resource name.
	Value *string `json:"value,omitempty"`
	// LocalizedValue - READ-ONLY; Resource display name.
	LocalizedValue *string `json:"localizedValue,omitempty"`
}

ResourceName name of the resource provided by the resource Provider. When requesting quota, use this property name.

func (ResourceName) MarshalJSON 

func (rn ResourceName) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ResourceName.

type ServiceError 

type ServiceError struct {
	// Code - Error code.
	Code *string `json:"code,omitempty"`
	// Message - Error message.
	Message *string `json:"message,omitempty"`
	// Details - READ-ONLY; List of error details.
	Details *[]ServiceErrorDetail `json:"details,omitempty"`
}

ServiceError API error details.

func (ServiceError) MarshalJSON 

func (se ServiceError) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServiceError.

type ServiceErrorDetail 

type ServiceErrorDetail struct {
	// Code - READ-ONLY; Error code.
	Code *string `json:"code,omitempty"`
	// Message - READ-ONLY; Error message.
	Message *string `json:"message,omitempty"`
}

ServiceErrorDetail error details.

func (ServiceErrorDetail) MarshalJSON 

func (sed ServiceErrorDetail) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServiceErrorDetail.

type SubRequest 

type SubRequest struct {
	// Name - Resource name.
	Name *ResourceName `json:"name,omitempty"`
	// ResourceType - READ-ONLY; Resource type for which the quota properties were requested.
	ResourceType *string `json:"resourceType,omitempty"`
	// Unit -  Quota limit units, such as Count and Bytes. When requesting quota, use the **unit** value returned in the GET response in the request body of your PUT operation.
	Unit *string `json:"unit,omitempty"`
	// ProvisioningState - The quota request status. Possible values include: 'RequestStateAccepted', 'RequestStateInvalid', 'RequestStateSucceeded', 'RequestStateFailed', 'RequestStateInProgress'
	ProvisioningState RequestState `json:"provisioningState,omitempty"`
	// Message - READ-ONLY; User-friendly status message.
	Message *string `json:"message,omitempty"`
	// SubRequestID - READ-ONLY; Quota request ID.
	SubRequestID *string `json:"subRequestId,omitempty"`
	// Limit - Resource quota limit properties.
	Limit BasicLimitJSONObject `json:"limit,omitempty"`
}

SubRequest request property.

func (SubRequest) MarshalJSON 

func (sr SubRequest) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SubRequest.

func (*SubRequest) UnmarshalJSON 

func (sr *SubRequest) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SubRequest struct.

type UpdateFuture 

type UpdateFuture struct {
	azure.FutureAPI
	// Result returns the result of the asynchronous operation.
	// If the operation has not completed it will return an error.
	Result func(Client) (CurrentQuotaLimitBase, error)
}

UpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*UpdateFuture) UnmarshalJSON 

func (future *UpdateFuture) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaller for CreateFuture.

type UsagesClient 

type UsagesClient struct {
	BaseClient
}

UsagesClient is the microsoft Azure Quota Resource Provider

func NewUsagesClient 

func NewUsagesClient() UsagesClient

NewUsagesClient creates an instance of the UsagesClient client.

func NewUsagesClientWithBaseURI 

func NewUsagesClientWithBaseURI(baseURI string) UsagesClient

NewUsagesClientWithBaseURI creates an instance of the UsagesClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (UsagesClient) Get 

func (client UsagesClient) Get(ctx context.Context, resourceName string, scope string) (result CurrentUsagesBase, err error)

Get get the current usage of a resource. Parameters: resourceName - resource name for a given resource provider. For example: - SKU name for Microsoft.Compute - SKU or TotalLowPriorityCores for Microsoft.MachineLearningServices For Microsoft.Network PublicIPAddresses. scope - the target Azure resource URI. For example, `/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/qms-test/providers/Microsoft.Batch/batchAccounts/testAccount/`. This is the target Azure resource URI for the List GET operation. If a `{resourceName}` is added after `/quotas`, then it's the target Azure resource URI in the GET operation for the specific resource.

func (UsagesClient) GetPreparer 

func (client UsagesClient) GetPreparer(ctx context.Context, resourceName string, scope string) (*http.Request, error)

GetPreparer prepares the Get request.

func (UsagesClient) GetResponder 

func (client UsagesClient) GetResponder(resp *http.Response) (result CurrentUsagesBase, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (UsagesClient) GetSender 

func (client UsagesClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (UsagesClient) List 

func (client UsagesClient) List(ctx context.Context, scope string) (result UsagesLimitsPage, err error)

List get a list of current usage for all resources for the scope specified. Parameters: scope - the target Azure resource URI. For example, `/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/qms-test/providers/Microsoft.Batch/batchAccounts/testAccount/`. This is the target Azure resource URI for the List GET operation. If a `{resourceName}` is added after `/quotas`, then it's the target Azure resource URI in the GET operation for the specific resource.

func (UsagesClient) ListComplete 

func (client UsagesClient) ListComplete(ctx context.Context, scope string) (result UsagesLimitsIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (UsagesClient) ListPreparer 

func (client UsagesClient) ListPreparer(ctx context.Context, scope string) (*http.Request, error)

ListPreparer prepares the List request.

func (UsagesClient) ListResponder 

func (client UsagesClient) ListResponder(resp *http.Response) (result UsagesLimits, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (UsagesClient) ListSender 

func (client UsagesClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type UsagesLimits 

type UsagesLimits struct {
	autorest.Response `json:"-"`
	// Value - List of quota limits.
	Value *[]CurrentUsagesBase `json:"value,omitempty"`
	// NextLink - The URI used to fetch the next page of quota limits. When there are no more pages, this is null.
	NextLink *string `json:"nextLink,omitempty"`
}

UsagesLimits quota limits.

func (UsagesLimits) IsEmpty 

func (ul UsagesLimits) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type UsagesLimitsIterator 

type UsagesLimitsIterator struct {
	// contains filtered or unexported fields
}

UsagesLimitsIterator provides access to a complete listing of CurrentUsagesBase values.

func NewUsagesLimitsIterator 

func NewUsagesLimitsIterator(page UsagesLimitsPage) UsagesLimitsIterator

Creates a new instance of the UsagesLimitsIterator type.

func (*UsagesLimitsIterator) Next 

func (iter *UsagesLimitsIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*UsagesLimitsIterator) NextWithContext 

func (iter *UsagesLimitsIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (UsagesLimitsIterator) NotDone 

func (iter UsagesLimitsIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (UsagesLimitsIterator) Response 

func (iter UsagesLimitsIterator) Response() UsagesLimits

Response returns the raw server response from the last page request.

func (UsagesLimitsIterator) Value 

func (iter UsagesLimitsIterator) Value() CurrentUsagesBase

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type UsagesLimitsPage 

type UsagesLimitsPage struct {
	// contains filtered or unexported fields
}

UsagesLimitsPage contains a page of CurrentUsagesBase values.

func NewUsagesLimitsPage 

func NewUsagesLimitsPage(cur UsagesLimits, getNextPage func(context.Context, UsagesLimits) (UsagesLimits, error)) UsagesLimitsPage

Creates a new instance of the UsagesLimitsPage type.

func (*UsagesLimitsPage) Next 

func (page *UsagesLimitsPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*UsagesLimitsPage) NextWithContext 

func (page *UsagesLimitsPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (UsagesLimitsPage) NotDone 

func (page UsagesLimitsPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (UsagesLimitsPage) Response 

func (page UsagesLimitsPage) Response() UsagesLimits

Response returns the raw server response from the last page request.

func (UsagesLimitsPage) Values 

func (page UsagesLimitsPage) Values() []CurrentUsagesBase

Values returns the slice of values for the current page or nil if there are no values.

type UsagesObject 

type UsagesObject struct {
	// Value - The usages value.
	Value *int32 `json:"value,omitempty"`
	// UsagesType - Possible values include: 'UsagesTypesIndividual', 'UsagesTypesCombined'
	UsagesType UsagesTypes `json:"usagesType,omitempty"`
}

UsagesObject the resource usages value.

type UsagesProperties 

type UsagesProperties struct {
	// Usages - The quota limit properties for this resource.
	Usages *UsagesObject `json:"usages,omitempty"`
	// Unit - READ-ONLY;  The units for the quota usage, such as Count and Bytes. When requesting quota, use the **unit** value returned in the GET response in the request body of your PUT operation.
	Unit *string `json:"unit,omitempty"`
	// Name - Resource name provided by the resource provider. Use this property name when requesting quota.
	Name *ResourceName `json:"name,omitempty"`
	// ResourceType - The name of the resource type.
	ResourceType *string `json:"resourceType,omitempty"`
	// QuotaPeriod - READ-ONLY; The time period for the summary of the quota usage values. For example:
	// *P1D (per one day)
	// *PT1M (per one minute)
	// *PT1S (per one second).
	// This parameter is optional because it is not relevant for all resources such as compute.
	QuotaPeriod *string `json:"quotaPeriod,omitempty"`
	// IsQuotaApplicable - READ-ONLY; States if quota can be requested for this resource.
	IsQuotaApplicable *bool `json:"isQuotaApplicable,omitempty"`
	// Properties - Additional properties for the specific resource provider.
	Properties interface{} `json:"properties,omitempty"`
}

UsagesProperties usage properties for the specified resource.

func (UsagesProperties) MarshalJSON 

func (up UsagesProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UsagesProperties.

type UsagesTypes 

type UsagesTypes string

UsagesTypes enumerates the values for usages types. 

const (
	// UsagesTypesCombined ...
	UsagesTypesCombined UsagesTypes = "Combined"
	// UsagesTypesIndividual ...
	UsagesTypesIndividual UsagesTypes = "Individual"
)

func PossibleUsagesTypesValues 

func PossibleUsagesTypesValues() []UsagesTypes

PossibleUsagesTypesValues returns an array of possible values for the UsagesTypes const type.

Source Files

View all Source files

Directories

Path Synopsis

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.