group_quota_subscription_allocation_requests
Creates, updates, deletes, gets or lists a group_quota_subscription_allocation_requests
resource.
Overview
Name | group_quota_subscription_allocation_requests |
Type | Resource |
Id | azure.quota.group_quota_subscription_allocation_requests |
Fields
The following fields are returned by SELECT
queries:
- get
- list
Name | Datatype | Description |
---|---|---|
properties | object |
OK.
Name | Datatype | Description |
---|---|---|
properties | object |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get | select | managementGroupId , subscriptionId , groupQuotaName , allocationId | Get the quota allocation request status for the subscriptionId by allocationId. | |
list | select | managementGroupId , subscriptionId , groupQuotaName , resourceProviderName , $filter | Get all the quotaAllocationRequests for a resourceProvider/location. The filter paramter for location is required. | |
create_or_update | insert | managementGroupId , subscriptionId , groupQuotaName , resourceProviderName , resourceName | 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. | |
update | update | managementGroupId , subscriptionId , groupQuotaName , resourceProviderName , resourceName | 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 |
allocationId | string | Request Id. |
groupQuotaName | string | The GroupQuota name. The name should be unique for the provided context tenantId/MgId. |
managementGroupId | string | Management Group Id. |
resourceName | string | Resource name. |
resourceProviderName | string | The resource provider name, such as - Microsoft.Compute. Currently only Microsoft.Compute resource provider supports this API. |
subscriptionId | string (uuid) | The ID of the target subscription. The value must be an UUID. |
SELECT
examples
- get
- list
Get the quota allocation request status for the subscriptionId by allocationId.
SELECT
properties
FROM azure.quota.group_quota_subscription_allocation_requests
WHERE managementGroupId = '{{ managementGroupId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND groupQuotaName = '{{ groupQuotaName }}' -- required
AND allocationId = '{{ allocationId }}' -- required
;
Get all the quotaAllocationRequests for a resourceProvider/location. The filter paramter for location is required.
SELECT
properties
FROM azure.quota.group_quota_subscription_allocation_requests
WHERE managementGroupId = '{{ managementGroupId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND groupQuotaName = '{{ groupQuotaName }}' -- required
AND resourceProviderName = '{{ resourceProviderName }}' -- required
AND $filter = '{{ $filter }}' -- required
;
INSERT
examples
- create_or_update
- Manifest
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.
INSERT INTO azure.quota.group_quota_subscription_allocation_requests (
data__properties,
managementGroupId,
subscriptionId,
groupQuotaName,
resourceProviderName,
resourceName
)
SELECT
'{{ properties }}',
'{{ managementGroupId }}',
'{{ subscriptionId }}',
'{{ groupQuotaName }}',
'{{ resourceProviderName }}',
'{{ resourceName }}'
RETURNING
properties
;
# Description fields are for documentation purposes
- name: group_quota_subscription_allocation_requests
props:
- name: managementGroupId
value: string
description: Required parameter for the group_quota_subscription_allocation_requests resource.
- name: subscriptionId
value: string (uuid)
description: Required parameter for the group_quota_subscription_allocation_requests resource.
- name: groupQuotaName
value: string
description: Required parameter for the group_quota_subscription_allocation_requests resource.
- name: resourceProviderName
value: string
description: Required parameter for the group_quota_subscription_allocation_requests resource.
- name: resourceName
value: string
description: Required parameter for the group_quota_subscription_allocation_requests resource.
- name: properties
value: object
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_requests
SET
data__properties = '{{ properties }}'
WHERE
managementGroupId = '{{ managementGroupId }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND groupQuotaName = '{{ groupQuotaName }}' --required
AND resourceProviderName = '{{ resourceProviderName }}' --required
AND resourceName = '{{ resourceName }}' --required
RETURNING
properties;