group_quota_subscription_allocation_request

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

Overview

Name	group_quota_subscription_allocation_request
Type	Resource
Id	azure.quota.group_quota_subscription_allocation_request

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.
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	The new quota request allocated to subscription.
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".

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	The new quota request allocated to subscription.
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
get	select	management_group_id, group_quota_name, resource_provider_name, allocation_id, subscription_id		Get the quota allocation request status for the subscriptionId by allocationId.
list	select	management_group_id, group_quota_name, resource_provider_name, subscription_id, $filter		Get all the quotaAllocationRequests for a resourceProvider/location. The filter paramter for location is required.
update	update	management_group_id, group_quota_name, resource_provider_name, location, subscription_id		Request to assign quota from group quota to a specific Subscription. The assign GroupQuota to subscriptions or reduce the quota allocated to subscription to give back the unused quota ( quota >= usages) to the groupQuota. So, this API can be used to assign Quota to subscriptions and assign back unused quota to group quota, which can be assigned to another subscriptions in the GroupQuota. User can collect unused quotas from multiple subscriptions within the groupQuota and assign the groupQuota to the subscription, where it's needed.

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 |---------------------|------------------------ location eq {location} Example: $filter=location eq eastus. Required.
allocation_id	string	Request Id. 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.
resource_provider_name	string	The resource provider name, such as - Microsoft.Compute. Currently only Microsoft.Compute resource provider supports this API. Required.
subscription_id	string

SELECT examples

get

Get the quota allocation request status for the subscriptionId by allocationId.

SELECT
id,
name,
faultCode,
provisioningState,
requestSubmitTime,
requestedResource,
systemData,
type
FROM azure.quota.group_quota_subscription_allocation_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 allocation_id = '{{ allocation_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get all the quotaAllocationRequests for a resourceProvider/location. The filter paramter for location is required.

SELECT
id,
name,
faultCode,
provisioningState,
requestSubmitTime,
requestedResource,
systemData,
type
FROM azure.quota.group_quota_subscription_allocation_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 subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}' -- required
;

UPDATE examples

update

Request to assign quota from group quota to a specific Subscription. The assign GroupQuota to subscriptions or reduce the quota allocated to subscription to give back the unused quota ( quota >= usages) to the groupQuota. So, this API can be used to assign Quota to subscriptions and assign back unused quota to group quota, which can be assigned to another subscriptions in the GroupQuota. User can collect unused quotas from multiple subscriptions within the groupQuota and assign the groupQuota to the subscription, where it's needed.

UPDATE azure.quota.group_quota_subscription_allocation_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
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;