group_quotas
Creates, updates, deletes, gets or lists a group_quotas
resource.
Overview
Name | group_quotas |
Type | Resource |
Id | azure.quota.group_quotas |
Fields
- vw_group_quotas
- group_quotas
Name | Datatype | Description |
---|---|---|
additional_attributes | text | field from the properties object |
display_name | text | field from the properties object |
groupQuotaName | text | field from the properties object |
managementGroupId | text | field from the properties object |
provisioning_state | text | field from the properties object |
Name | Datatype | Description |
---|---|---|
properties | object | Properties and filters for ShareQuota. The request parameter is optional, if there are no filters specified. |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
get | SELECT | groupQuotaName, managementGroupId | Gets the GroupQuotas for the name passed. It will return the GroupQuotas properties only. The details on group quota can be access from the group quota APIs. |
list | SELECT | managementGroupId | Lists GroupQuotas for the scope passed. It will return the GroupQuotas QuotaEntity properties only.The details on group quota can be access from the group quota APIs. |
create_or_update | INSERT | groupQuotaName, managementGroupId | Creates a new GroupQuota for the name passed. A RequestId will be returned by the Service. The status can be polled periodically. The status Async polling is using standards defined at - https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/async-api-reference.md#asynchronous-operations. Use the OperationsStatus URI provided in Azure-AsyncOperation header, the duration will be specified in retry-after header. Once the operation gets to terminal state - Succeeded | Failed, then the URI will change to Get URI and full details can be checked. |
delete | DELETE | groupQuotaName, managementGroupId | Deletes the GroupQuotas for the name passed. All the remaining shareQuota in the GroupQuotas will be lost. |
update | UPDATE | groupQuotaName, managementGroupId | Updates the GroupQuotas for the name passed. A GroupQuotas RequestId will be returned by the Service. The status can be polled periodically. The status Async polling is using standards defined at - https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/async-api-reference.md#asynchronous-operations. Use the OperationsStatus URI provided in Azure-AsyncOperation header, the duration will be specified in retry-after header. Once the operation gets to terminal state - Succeeded | Failed, then the URI will change to Get URI and full details can be checked. |
Any change in the filters will be applicable to the future quota assignments, existing quota allocated to subscriptions from the GroupQuotas remains unchanged. |
SELECT
examples
Lists GroupQuotas for the scope passed. It will return the GroupQuotas QuotaEntity properties only.The details on group quota can be access from the group quota APIs.
- vw_group_quotas
- group_quotas
SELECT
additional_attributes,
display_name,
groupQuotaName,
managementGroupId,
provisioning_state
FROM azure.quota.vw_group_quotas
WHERE managementGroupId = '{{ managementGroupId }}';
SELECT
properties
FROM azure.quota.group_quotas
WHERE managementGroupId = '{{ managementGroupId }}';
INSERT
example
Use the following StackQL query and manifest file to create a new group_quotas
resource.
- All Properties
- Manifest
/*+ create */
INSERT INTO azure.quota.group_quotas (
groupQuotaName,
managementGroupId,
properties
)
SELECT
'{{ groupQuotaName }}',
'{{ managementGroupId }}',
'{{ properties }}'
;
- name: your_resource_model_name
props:
- name: properties
value:
- name: displayName
value: string
- name: additionalAttributes
value:
- name: groupId
value:
- name: groupingIdType
value: []
- name: value
value: string
- name: environment
value: []
- name: provisioningState
value: []
UPDATE
example
Updates a group_quotas
resource.
/*+ update */
UPDATE azure.quota.group_quotas
SET
properties = '{{ properties }}'
WHERE
groupQuotaName = '{{ groupQuotaName }}'
AND managementGroupId = '{{ managementGroupId }}';
DELETE
example
Deletes the specified group_quotas
resource.
/*+ delete */
DELETE FROM azure.quota.group_quotas
WHERE groupQuotaName = '{{ groupQuotaName }}'
AND managementGroupId = '{{ managementGroupId }}';