QuotaOperations interface

Package:
@azure/arm-reservations

Interface representing a Quota operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginUpdate
beginUpdateAndWait
createOrUpdate

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.
get

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

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.
update

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.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginUpdate

Warning

This API is now deprecated.

use update instead

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

Property Value

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

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

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

Property Value

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

createOrUpdate

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.
createOrUpdate: (subscriptionId: string, providerId: string, location: string, resourceName: string, createQuotaRequest: CurrentQuotaLimitBase, options?: QuotaCreateOrUpdateOptionalParams) => PollerLike<OperationState<CurrentQuotaLimitBase>, CurrentQuotaLimitBase>

Property Value

(subscriptionId: string, providerId: string, location: string, resourceName: string, createQuotaRequest: CurrentQuotaLimitBase, options?: QuotaCreateOrUpdateOptionalParams) => PollerLike<OperationState<CurrentQuotaLimitBase>, CurrentQuotaLimitBase>

get

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.

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

Property Value

(subscriptionId: string, providerId: string, location: string, resourceName: string, options?: QuotaGetOptionalParams) => Promise<CurrentQuotaLimitBase>

list

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.

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

Property Value

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

update

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.

update: (subscriptionId: string, providerId: string, location: string, resourceName: string, createQuotaRequest: CurrentQuotaLimitBase, options?: QuotaUpdateOptionalParams) => PollerLike<OperationState<CurrentQuotaLimitBase>, CurrentQuotaLimitBase>

Property Value

(subscriptionId: string, providerId: string, location: string, resourceName: string, createQuotaRequest: CurrentQuotaLimitBase, options?: QuotaUpdateOptionalParams) => PollerLike<OperationState<CurrentQuotaLimitBase>, CurrentQuotaLimitBase>