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

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.
provisioningState	string	Status of this subscriptionId being associated with the GroupQuotasEntity. Known values are: "Accepted", "Created", "Invalid", "Succeeded", "Escalated", "Failed", "InProgress", and "Canceled". (Accepted, Created, Invalid, Succeeded, Escalated, Failed, InProgress, Canceled)
subscriptionId	string	An Azure subscriptionId.
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.
provisioningState	string	Status of this subscriptionId being associated with the GroupQuotasEntity. Known values are: "Accepted", "Created", "Invalid", "Succeeded", "Escalated", "Failed", "InProgress", and "Canceled". (Accepted, Created, Invalid, Succeeded, Escalated, Failed, InProgress, Canceled)
subscriptionId	string	An Azure subscriptionId.
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, subscription_id		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	management_group_id, group_quota_name		Returns a list of the subscriptionIds associated with the GroupQuotas.
create_or_update	insert	management_group_id, group_quota_name, subscription_id		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	management_group_id, group_quota_name, subscription_id		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.
create_or_update	replace	management_group_id, group_quota_name, subscription_id		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.
delete	delete	management_group_id, group_quota_name, subscription_id		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
group_quota_name	string	The GroupQuota name. The name should be unique for the provided context tenantId/MgId. Required.
management_group_id	string	The management group ID. Required.
subscription_id	string

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
id,
name,
provisioningState,
subscriptionId,
systemData,
type
FROM azure.quota.group_quota_subscriptions
WHERE management_group_id = '{{ management_group_id }}' -- required
AND group_quota_name = '{{ group_quota_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Returns a list of the subscriptionIds associated with the GroupQuotas.

SELECT
id,
name,
provisioningState,
subscriptionId,
systemData,
type
FROM azure.quota.group_quota_subscriptions
WHERE management_group_id = '{{ management_group_id }}' -- required
AND group_quota_name = '{{ group_quota_name }}' -- 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 (
management_group_id,
group_quota_name,
subscription_id
)
SELECT 
'{{ management_group_id }}',
'{{ group_quota_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: group_quota_subscriptions
props:
  - name: management_group_id
    value: "{{ management_group_id }}"
    description: Required parameter for the group_quota_subscriptions resource.
  - name: group_quota_name
    value: "{{ group_quota_name }}"
    description: Required parameter for the group_quota_subscriptions resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    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 
management_group_id = '{{ management_group_id }}' --required
AND group_quota_name = '{{ group_quota_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE 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.

REPLACE azure.quota.group_quota_subscriptions
SET 
-- No updatable properties
WHERE 
management_group_id = '{{ management_group_id }}' --required
AND group_quota_name = '{{ group_quota_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

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 management_group_id = '{{ management_group_id }}' --required
AND group_quota_name = '{{ group_quota_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;