usages

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

Overview

Name	usages
Type	Resource
Id	azure.quota.usages

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.
isQuotaApplicable	boolean	States if quota can be requested for this resource.
properties	object	Additional properties for the specific resource provider.
quotaPeriod	string	The time period for the summary of the quota usage values. For example: *P1D (per one day) *PT1M (per one minute) *PT1S (per one second). This parameter is optional because it is not relevant for all resources such as compute.
resourceType	string	The name of the resource type. Optional field.
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 units for the quota usage, such as Count and Bytes. When requesting quota, use the unit value returned in the GET response in the request body of your PUT operation.
usages	object	The quota limit properties for this resource.

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.
isQuotaApplicable	boolean	States if quota can be requested for this resource.
properties	object	Additional properties for the specific resource provider.
quotaPeriod	string	The time period for the summary of the quota usage values. For example: *P1D (per one day) *PT1M (per one minute) *PT1S (per one second). This parameter is optional because it is not relevant for all resources such as compute.
resourceType	string	The name of the resource type. Optional field.
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 units for the quota usage, such as Count and Bytes. When requesting quota, use the unit value returned in the GET response in the request body of your PUT operation.
usages	object	The quota limit properties for this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_name, scope		Get the current usage of a resource.
list	select	scope		Get a list of current usage for all resources for the scope specified.

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
resource_name	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. Required.
scope	string	The fully qualified Azure Resource manager identifier of the resource. Required.

SELECT examples

get

Get the current usage of a resource.

SELECT
id,
name,
isQuotaApplicable,
properties,
quotaPeriod,
resourceType,
systemData,
type,
unit,
usages
FROM azure.quota.usages
WHERE resource_name = '{{ resource_name }}' -- required
AND scope = '{{ scope }}' -- required
;

list

Get a list of current usage for all resources for the scope specified.

SELECT
id,
name,
isQuotaApplicable,
properties,
quotaPeriod,
resourceType,
systemData,
type,
unit,
usages
FROM azure.quota.usages
WHERE scope = '{{ scope }}' -- required
;