QuotaOperations interface
Interface representing a Quota operations.
Properties
| create |
Create or update the quota limit for the specified resource with the requested value. To update the quota, follow these steps:
|
| 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. |
| 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. |
| update | Update the quota limit for a specific resource to the specified value:
|
Property Details
createOrUpdate
Create or update the quota limit for the specified resource with the requested value. To update the quota, follow these steps:
- 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.
- Use this PUT operation to update the quota limit. Please check the URI in location header for the detailed status of the request.
createOrUpdate: (resourceName: string, scope: string, createQuotaRequest: CurrentQuotaLimitBase, options?: QuotaCreateOrUpdateOptionalParams) => PollerLike<OperationState<CurrentQuotaLimitBase>, CurrentQuotaLimitBase>
Property Value
(resourceName: string, scope: string, createQuotaRequest: CurrentQuotaLimitBase, options?: QuotaCreateOrUpdateOptionalParams) => PollerLike<OperationState<CurrentQuotaLimitBase>, CurrentQuotaLimitBase>
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.
get: (resourceName: string, scope: string, options?: QuotaGetOptionalParams) => Promise<CurrentQuotaLimitBase>
Property Value
(resourceName: string, scope: string, options?: QuotaGetOptionalParams) => Promise<CurrentQuotaLimitBase>
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.
list: (scope: string, options?: QuotaListOptionalParams) => PagedAsyncIterableIterator<CurrentQuotaLimitBase, CurrentQuotaLimitBase[], PageSettings>
Property Value
(scope: string, options?: QuotaListOptionalParams) => PagedAsyncIterableIterator<CurrentQuotaLimitBase, CurrentQuotaLimitBase[], PageSettings>
update
Update the quota limit for a specific resource to the specified value:
- 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.
- Use this PUT operation to update the quota limit. Please check the URI in location header for the detailed status of the request.
update: (resourceName: string, scope: string, createQuotaRequest: CurrentQuotaLimitBase, options?: QuotaUpdateOptionalParams) => PollerLike<OperationState<CurrentQuotaLimitBase>, CurrentQuotaLimitBase>
Property Value
(resourceName: string, scope: string, createQuotaRequest: CurrentQuotaLimitBase, options?: QuotaUpdateOptionalParams) => PollerLike<OperationState<CurrentQuotaLimitBase>, CurrentQuotaLimitBase>