group_quota_limits_request

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

Overview

Name	group_quota_limits_request
Type	Resource
Id	azure.quota.group_quota_limits_request

Fields

The following fields are returned by SELECT queries:

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.
faultCode	string	Details of the failure.
provisioningState	string	Request status. Known values are: "Accepted", "Created", "Invalid", "Succeeded", "Escalated", "Failed", "InProgress", and "Canceled". (Accepted, Created, Invalid, Succeeded, Escalated, Failed, InProgress, Canceled)
requestSubmitTime	string (date-time)	The request submission time. The date conforms to the following format specified by the ISO 8601 standard: yyyy-MM-ddTHH:mm:ssZ.
requestedResource	object	Requested Resource.
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".

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.
faultCode	string	Details of the failure.
provisioningState	string	Request status. Known values are: "Accepted", "Created", "Invalid", "Succeeded", "Escalated", "Failed", "InProgress", and "Canceled". (Accepted, Created, Invalid, Succeeded, Escalated, Failed, InProgress, Canceled)
requestSubmitTime	string (date-time)	The request submission time. The date conforms to the following format specified by the ISO 8601 standard: yyyy-MM-ddTHH:mm:ssZ.
requestedResource	object	Requested Resource.
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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	management_group_id, group_quota_name, resource_provider_name, $filter		Get API to check the status of a GroupQuota request by requestId.
get	select	management_group_id, group_quota_name, request_id		Get API to check the status of a GroupQuota request by requestId.
update	update	management_group_id, group_quota_name, resource_provider_name, location		Create the GroupQuota requests for a specific ResourceProvider/Location/Resource. The resourceName properties are specified in the request body. Only 1 resource quota can be requested. Please note that patch request creates a new groupQuota request. Use the polling API - OperationsStatus URI specified in Azure-AsyncOperation header field, with retry-after duration in seconds to check the intermediate status. This API provides the finals status with the request details and status.

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
$filter	string	| Field | Supported operators \r\n|---------------------|------------------------\n\r\n location eq {location} and resource eq {resourceName}\n Example: $filter=location eq eastus and resourceName eq cores. Required.
group_quota_name	string	The GroupQuota name. The name should be unique for the provided context tenantId/MgId. Required.
location	string	The name of the Azure region. Required.
management_group_id	string	The management group ID. Required.
request_id	string	Request Id. Required.
resource_provider_name	string	The resource provider name, such as - Microsoft.Compute. Currently only Microsoft.Compute resource provider supports this API. Required.

SELECT examples

list

Get API to check the status of a GroupQuota request by requestId.

SELECT
id,
name,
faultCode,
provisioningState,
requestSubmitTime,
requestedResource,
systemData,
type
FROM azure.quota.group_quota_limits_request
WHERE management_group_id = '{{ management_group_id }}' -- required
AND group_quota_name = '{{ group_quota_name }}' -- required
AND resource_provider_name = '{{ resource_provider_name }}' -- required
AND $filter = '{{ $filter }}' -- required
;

get

Get API to check the status of a GroupQuota request by requestId.

SELECT
id,
name,
faultCode,
provisioningState,
requestSubmitTime,
requestedResource,
systemData,
type
FROM azure.quota.group_quota_limits_request
WHERE management_group_id = '{{ management_group_id }}' -- required
AND group_quota_name = '{{ group_quota_name }}' -- required
AND request_id = '{{ request_id }}' -- required
;

UPDATE examples

update

Create the GroupQuota requests for a specific ResourceProvider/Location/Resource. The resourceName properties are specified in the request body. Only 1 resource quota can be requested. Please note that patch request creates a new groupQuota request. Use the polling API - OperationsStatus URI specified in Azure-AsyncOperation header field, with retry-after duration in seconds to check the intermediate status. This API provides the finals status with the request details and status.

UPDATE azure.quota.group_quota_limits_request
SET 
properties = '{{ properties }}'
WHERE 
management_group_id = '{{ management_group_id }}' --required
AND group_quota_name = '{{ group_quota_name }}' --required
AND resource_provider_name = '{{ resource_provider_name }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
properties,
systemData,
type;