quota

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

Overview

Name	quota
Type	Resource
Id	azure.reservations.quota

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
currentValue	integer	Current usage value for the resource.
limit	integer	Quota properties.
properties	object	Additional properties for the specified resource provider.
quotaPeriod	string	The time period over which the quota usage values are summarized. For example, P1D (per one day), PT1M (per one minute), and PT1S (per one second). This parameter is optional because, for some resources such as compute, the time period is irrelevant.
resourceType	string	The name of the resource type. Known values are: "standard", "dedicated", "lowPriority", "shared", and "serviceSpecific". (standard, dedicated, lowPriority, shared, serviceSpecific)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
unit	string	The limit units, such as count and bytes. Use the unit field provided in the response of the GET quota operation.

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
currentValue	integer	Current usage value for the resource.
limit	integer	Quota properties.
properties	object	Additional properties for the specified resource provider.
quotaPeriod	string	The time period over which the quota usage values are summarized. For example, P1D (per one day), PT1M (per one minute), and PT1S (per one second). This parameter is optional because, for some resources such as compute, the time period is irrelevant.
resourceType	string	The name of the resource type. Known values are: "standard", "dedicated", "lowPriority", "shared", and "serviceSpecific". (standard, dedicated, lowPriority, shared, serviceSpecific)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
unit	string	The limit units, such as count and bytes. Use the unit field provided in the response of the GET quota operation.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscription_id, provider_id, location, resource_name		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	select	subscription_id, provider_id, location		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.
create_or_update	insert	subscription_id, provider_id, location, resource_name		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.
update	update	subscription_id, provider_id, location, resource_name		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.
create_or_update	replace	subscription_id, provider_id, location, resource_name		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.

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
location	string	Azure region. Required.
provider_id	string	Azure resource provider ID. Required.
resource_name	string	The resource name for a resource provider, such as SKU name for Microsoft.Compute, Sku or TotalLowPriorityCores for Microsoft.MachineLearningServices. Required.
subscription_id	string	The ID of the target subscription. The value must be an UUID. Required.

SELECT examples

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.

SELECT
id,
name,
currentValue,
limit,
properties,
quotaPeriod,
resourceType,
systemData,
type,
unit
FROM azure.reservations.quota
WHERE subscription_id = '{{ subscription_id }}' -- required
AND provider_id = '{{ provider_id }}' -- required
AND location = '{{ location }}' -- required
AND resource_name = '{{ resource_name }}' -- required
;

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.

SELECT
id,
name,
currentValue,
limit,
properties,
quotaPeriod,
resourceType,
systemData,
type,
unit
FROM azure.reservations.quota
WHERE subscription_id = '{{ subscription_id }}' -- required
AND provider_id = '{{ provider_id }}' -- required
AND location = '{{ location }}' -- required
;

INSERT examples

create_or_update

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.

INSERT INTO azure.reservations.quota (
properties,
subscription_id,
provider_id,
location,
resource_name
)
SELECT 
'{{ properties }}',
'{{ subscription_id }}',
'{{ provider_id }}',
'{{ location }}',
'{{ resource_name }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: quota
props:
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the quota resource.
  - name: provider_id
    value: "{{ provider_id }}"
    description: Required parameter for the quota resource.
  - name: location
    value: "{{ location }}"
    description: Required parameter for the quota resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the quota resource.
  - name: properties
    description: |
      Quota properties for the resource.
    value:
      limit: {{ limit }}
      currentValue: {{ currentValue }}
      unit: "{{ unit }}"
      name:
        value: "{{ value }}"
        localizedValue: "{{ localizedValue }}"
      resourceType: "{{ resourceType }}"
      quotaPeriod: "{{ quotaPeriod }}"
      properties: "{{ properties }}"

UPDATE examples

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 azure.reservations.quota
SET 
properties = '{{ properties }}'
WHERE 
subscription_id = '{{ subscription_id }}' --required
AND provider_id = '{{ provider_id }}' --required
AND location = '{{ location }}' --required
AND resource_name = '{{ resource_name }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

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.

REPLACE azure.reservations.quota
SET 
properties = '{{ properties }}'
WHERE 
subscription_id = '{{ subscription_id }}' --required
AND provider_id = '{{ provider_id }}' --required
AND location = '{{ location }}' --required
AND resource_name = '{{ resource_name }}' --required
RETURNING
id,
name,
properties,
systemData,
type;