group_quota_subscriptions

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

Overview

Name	group_quota_subscriptions
Type	Resource
Id	azure.quota.group_quota_subscriptions

Fields

The following fields are returned by SELECT queries:

get

OK.

Name	Datatype	Description
properties	object

list

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, groupQuotaName, subscriptionId		Returns the subscriptionIds along with its provisioning state for being associated with the GroupQuota. If the subscription is not a member of GroupQuota, it will return 404, else 200.
list	select	managementGroupId, groupQuotaName		Returns a list of the subscriptionIds associated with the GroupQuotas.
create_or_update	insert	managementGroupId, groupQuotaName, subscriptionId		Adds a subscription to GroupQuotas. The subscriptions will be validated based on the additionalAttributes defined in the GroupQuota. The additionalAttributes works as filter for the subscriptions, which can be included in the GroupQuotas. The request's TenantId is validated against the subscription's TenantId.
update	update	managementGroupId, groupQuotaName, subscriptionId		Updates the GroupQuotas with the subscription to add to the subscriptions list. The subscriptions will be validated if additionalAttributes are defined in the GroupQuota. The request's TenantId is validated against the subscription's TenantId.
delete	delete	managementGroupId, groupQuotaName, subscriptionId		Removes the subscription from GroupQuotas. The request's TenantId is validated against the subscription's TenantId.

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.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Returns the subscriptionIds along with its provisioning state for being associated with the GroupQuota. If the subscription is not a member of GroupQuota, it will return 404, else 200.

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

list

Returns a list of the subscriptionIds associated with the GroupQuotas.

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

INSERT examples

create_or_update

Adds a subscription to GroupQuotas. The subscriptions will be validated based on the additionalAttributes defined in the GroupQuota. The additionalAttributes works as filter for the subscriptions, which can be included in the GroupQuotas. The request's TenantId is validated against the subscription's TenantId.

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

Manifest

# Description fields are for documentation purposes
- name: group_quota_subscriptions
  props:
    - name: managementGroupId
      value: string
      description: Required parameter for the group_quota_subscriptions resource.
    - name: groupQuotaName
      value: string
      description: Required parameter for the group_quota_subscriptions resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the group_quota_subscriptions resource.

UPDATE examples

update

Updates the GroupQuotas with the subscription to add to the subscriptions list. The subscriptions will be validated if additionalAttributes are defined in the GroupQuota. The request's TenantId is validated against the subscription's TenantId.

UPDATE azure.quota.group_quota_subscriptions
SET 
-- No updatable properties
WHERE 
managementGroupId = '{{ managementGroupId }}' --required
AND groupQuotaName = '{{ groupQuotaName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
properties;

DELETE examples

delete

Removes the subscription from GroupQuotas. The request's TenantId is validated against the subscription's TenantId.

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