Quota interface

Package:

@azure/arm-reservations

Interface representing a Quota.

Methods

beginCreateOrUpdate(string, string, string, string, CurrentQuotaLimitBase, QuotaCreateOrUpdateOptionalParams)	Create or update the quota (service limits) of a resource to the requested value. Steps: Make the Get request to get the quota information for specific resource. To increase the quota, update the limit field in the response from Get request to new value. Submit the JSON to the quota request API to update the quota. The Create quota request may be constructed as follows. The PUT operation can be used to update the quota.
beginCreateOrUpdateAndWait(string, string, string, string, CurrentQuotaLimitBase, QuotaCreateOrUpdateOptionalParams)	Create or update the quota (service limits) of a resource to the requested value. Steps: Make the Get request to get the quota information for specific resource. To increase the quota, update the limit field in the response from Get request to new value. Submit the JSON to the quota request API to update the quota. The Create quota request may be constructed as follows. The PUT operation can be used to update the quota.
beginUpdate(string, string, string, string, CurrentQuotaLimitBase, QuotaUpdateOptionalParams)	Update the quota (service limits) of this resource to the requested value. • To get the quota information for specific resource, send a GET request. • To increase the quota, update the limit field from the GET response to a new value. • To update the quota value, submit the JSON response to the quota request API to update the quota. • To update the quota. use the PATCH operation.
beginUpdateAndWait(string, string, string, string, CurrentQuotaLimitBase, QuotaUpdateOptionalParams)	Update the quota (service limits) of this resource to the requested value. • To get the quota information for specific resource, send a GET request. • To increase the quota, update the limit field from the GET response to a new value. • To update the quota value, submit the JSON response to the quota request API to update the quota. • To update the quota. use the PATCH operation.
get(string, string, string, string, QuotaGetOptionalParams)	Get the current quota (service limit) and usage of a resource. You can use the response from the GET operation to submit quota update request.
list(string, string, string, QuotaListOptionalParams)	Gets a list of current quotas (service limits) and usage for all resources. The response from the list quota operation can be leveraged to request quota updates.

Method Details

beginCreateOrUpdate(string, string, string, string, CurrentQuotaLimitBase, QuotaCreateOrUpdateOptionalParams)

Create or update the quota (service limits) of a resource to the requested value. Steps:

1. Make the Get request to get the quota information for specific resource.
2. To increase the quota, update the limit field in the response from Get request to new value.
3. Submit the JSON to the quota request API to update the quota. The Create quota request may be constructed as follows. The PUT operation can be used to update the quota.

function beginCreateOrUpdate(subscriptionId: string, providerId: string, location: string, resourceName: string, createQuotaRequest: CurrentQuotaLimitBase, options?: QuotaCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<CurrentQuotaLimitBase>, CurrentQuotaLimitBase>>

Parameters

subscriptionId

string

Azure subscription ID.

providerId

string

Azure resource provider ID.

location

string

Azure region.

resourceName

string

The resource name for a resource provider, such as SKU name for Microsoft.Compute, Sku or TotalLowPriorityCores for Microsoft.MachineLearningServices

createQuotaRequest

CurrentQuotaLimitBase

Quota requests payload.

options

QuotaCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<CurrentQuotaLimitBase>, CurrentQuotaLimitBase>>

beginCreateOrUpdateAndWait(string, string, string, string, CurrentQuotaLimitBase, QuotaCreateOrUpdateOptionalParams)

Create or update the quota (service limits) of a resource to the requested value. Steps:

1. Make the Get request to get the quota information for specific resource.
2. To increase the quota, update the limit field in the response from Get request to new value.
3. Submit the JSON to the quota request API to update the quota. The Create quota request may be constructed as follows. The PUT operation can be used to update the quota.

function beginCreateOrUpdateAndWait(subscriptionId: string, providerId: string, location: string, resourceName: string, createQuotaRequest: CurrentQuotaLimitBase, options?: QuotaCreateOrUpdateOptionalParams): Promise<CurrentQuotaLimitBase>

Parameters

subscriptionId

string

Azure subscription ID.

providerId

string

Azure resource provider ID.

location

string

Azure region.

resourceName

string

The resource name for a resource provider, such as SKU name for Microsoft.Compute, Sku or TotalLowPriorityCores for Microsoft.MachineLearningServices

createQuotaRequest

CurrentQuotaLimitBase

Quota requests payload.

options

QuotaCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<CurrentQuotaLimitBase>

beginUpdate(string, string, string, string, CurrentQuotaLimitBase, QuotaUpdateOptionalParams)

Update the quota (service limits) of this resource to the requested value. • To get the quota information for specific resource, send a GET request. • To increase the quota, update the limit field from the GET response to a new value. • To update the quota value, submit the JSON response to the quota request API to update the quota. • To update the quota. use the PATCH operation.

function beginUpdate(subscriptionId: string, providerId: string, location: string, resourceName: string, createQuotaRequest: CurrentQuotaLimitBase, options?: QuotaUpdateOptionalParams): Promise<SimplePollerLike<OperationState<CurrentQuotaLimitBase>, CurrentQuotaLimitBase>>

Parameters

subscriptionId

string

Azure subscription ID.

providerId

string

Azure resource provider ID.

location

string

Azure region.

resourceName

string

The resource name for a resource provider, such as SKU name for Microsoft.Compute, Sku or TotalLowPriorityCores for Microsoft.MachineLearningServices

createQuotaRequest

CurrentQuotaLimitBase

Payload for the quota request.

options

QuotaUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<CurrentQuotaLimitBase>, CurrentQuotaLimitBase>>

beginUpdateAndWait(string, string, string, string, CurrentQuotaLimitBase, QuotaUpdateOptionalParams)

Update the quota (service limits) of this resource to the requested value. • To get the quota information for specific resource, send a GET request. • To increase the quota, update the limit field from the GET response to a new value. • To update the quota value, submit the JSON response to the quota request API to update the quota. • To update the quota. use the PATCH operation.

function beginUpdateAndWait(subscriptionId: string, providerId: string, location: string, resourceName: string, createQuotaRequest: CurrentQuotaLimitBase, options?: QuotaUpdateOptionalParams): Promise<CurrentQuotaLimitBase>

Parameters

subscriptionId

string

Azure subscription ID.

providerId

string

Azure resource provider ID.

location

string

Azure region.

resourceName

string

The resource name for a resource provider, such as SKU name for Microsoft.Compute, Sku or TotalLowPriorityCores for Microsoft.MachineLearningServices

createQuotaRequest

CurrentQuotaLimitBase

Payload for the quota request.

options

QuotaUpdateOptionalParams

The options parameters.

Returns

Promise<CurrentQuotaLimitBase>

get(string, string, string, string, QuotaGetOptionalParams)

Get the current quota (service limit) and usage of a resource. You can use the response from the GET operation to submit quota update request.

function get(subscriptionId: string, providerId: string, location: string, resourceName: string, options?: QuotaGetOptionalParams): Promise<QuotaGetResponse>

Parameters

subscriptionId

string

Azure subscription ID.

providerId

string

Azure resource provider ID.

location

string

Azure region.

resourceName

string

The resource name for a resource provider, such as SKU name for Microsoft.Compute, Sku or TotalLowPriorityCores for Microsoft.MachineLearningServices

options

QuotaGetOptionalParams

The options parameters.

Returns

Promise<QuotaGetResponse>

list(string, string, string, QuotaListOptionalParams)

Gets a list of current quotas (service limits) and usage for all resources. The response from the list quota operation can be leveraged to request quota updates.

function list(subscriptionId: string, providerId: string, location: string, options?: QuotaListOptionalParams): PagedAsyncIterableIterator<CurrentQuotaLimitBase, CurrentQuotaLimitBase[], PageSettings>

Parameters

subscriptionId

string

Azure subscription ID.

providerId

string

Azure resource provider ID.

location

string

Azure region.

options

QuotaListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<CurrentQuotaLimitBase, CurrentQuotaLimitBase[], PageSettings>