group_quotas

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

Overview

Name	group_quotas
Type	Resource
Id	azure.quota.group_quotas

Fields

The following fields are returned by SELECT queries:

get

OK.

Name	Datatype	Description
properties	object	Properties and filters for ShareQuota. The request parameter is optional, if there are no filters specified. (title: Properties)

list

OK.

Name	Datatype	Description
properties	object	Properties and filters for ShareQuota. The request parameter is optional, if there are no filters specified. (title: Properties)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	managementGroupId, groupQuotaName		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	managementGroupId, groupQuotaName		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.
update	update	managementGroupId, groupQuotaName		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.
delete	delete	managementGroupId, groupQuotaName		Deletes the GroupQuotas for the name passed. All the remaining shareQuota in the GroupQuotas will be lost.

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
groupQuotaName	string	The GroupQuota name. The name should be unique for the provided context tenantId/MgId.
managementGroupId	string	Management Group Id.

SELECT examples

get

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.

SELECT
properties
FROM azure.quota.group_quotas
WHERE managementGroupId = '{{ managementGroupId }}' -- required
AND groupQuotaName = '{{ groupQuotaName }}' -- required
;

list

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.

SELECT
properties
FROM azure.quota.group_quotas
WHERE managementGroupId = '{{ managementGroupId }}' -- required
;

INSERT examples

create_or_update

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.

INSERT INTO azure.quota.group_quotas (
data__properties,
managementGroupId,
groupQuotaName
)
SELECT 
'{{ properties }}',
'{{ managementGroupId }}',
'{{ groupQuotaName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: group_quotas
  props:
    - name: managementGroupId
      value: string
      description: Required parameter for the group_quotas resource.
    - name: groupQuotaName
      value: string
      description: Required parameter for the group_quotas resource.
    - name: properties
      value: object
      description: |
        Properties and filters for ShareQuota. The request parameter is optional, if there are no filters specified.

UPDATE examples

update

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.

UPDATE azure.quota.group_quotas
SET 
data__properties = '{{ properties }}'
WHERE 
managementGroupId = '{{ managementGroupId }}' --required
AND groupQuotaName = '{{ groupQuotaName }}' --required
RETURNING
properties;

DELETE examples

delete

Deletes the GroupQuotas for the name passed. All the remaining shareQuota in the GroupQuotas will be lost.

DELETE FROM azure.quota.group_quotas
WHERE managementGroupId = '{{ managementGroupId }}' --required
AND groupQuotaName = '{{ groupQuotaName }}' --required
;