quotas

Creates, updates, deletes, gets or lists a quotas resource.

Overview

Name	quotas
Type	Resource
Id	azure.quota.quotas

Fields

The following fields are returned by SELECT queries:

get

OK. The quota information will be returned in the response with pagination.

Name	Datatype	Description
id	string	The resource ID.
name	string	The resource name.
properties	object	Quota properties for the specified resource, based on the API called, Quotas or Usages.
type	string	The resource type.

list

OK. Quota information will be returned in the response with pagination.

Name	Datatype	Description
id	string	The resource ID.
name	string	The resource name.
properties	object	Quota properties for the specified resource, based on the API called, Quotas or Usages.
type	string	The resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceName, scope		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	select	scope		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.
create_or_update	insert	resourceName, scope		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. 2. Use this PUT operation to update the quota limit. Please check the URI in location header for the detailed status of the request.
update	update	resourceName, scope		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. 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

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resourceName	string	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	string	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.

SELECT examples

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.

SELECT
id,
name,
properties,
type
FROM azure.quota.quotas
WHERE resourceName = '{{ resourceName }}' -- required
AND scope = '{{ scope }}' -- required
;

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.

SELECT
id,
name,
properties,
type
FROM azure.quota.quotas
WHERE scope = '{{ scope }}' -- required
;

INSERT examples

create_or_update

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.
2. Use this PUT operation to update the quota limit. Please check the URI in location header for the detailed status of the request.

INSERT INTO azure.quota.quotas (
data__properties,
resourceName,
scope
)
SELECT 
'{{ properties }}',
'{{ resourceName }}',
'{{ scope }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: quotas
  props:
    - name: resourceName
      value: string
      description: Required parameter for the quotas resource.
    - name: scope
      value: string
      description: Required parameter for the quotas resource.
    - name: properties
      value: object
      description: |
        Quota properties for the specified resource, based on the API called, Quotas or Usages.

UPDATE examples

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.
2. Use this PUT operation to update the quota limit. Please check the URI in location header for the detailed status of the request.

UPDATE azure.quota.quotas
SET 
data__properties = '{{ properties }}'
WHERE 
resourceName = '{{ resourceName }}' --required
AND scope = '{{ scope }}' --required
RETURNING
id,
name,
properties,
type;