group_quota_location_settings

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

Overview

Name	group_quota_location_settings
Type	Resource
Id	azure.quota.group_quota_location_settings

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, resourceProviderName, location		Gets the GroupQuotas enforcement settings for the ResourceProvider/location. The locations, where GroupQuota enforcement is not enabled will return Not Found.
list	select	managementGroupId, groupQuotaName, resourceProviderName		Returns only the list of the Azure regions settings, where the GroupQuotas enforcement is enabled. The locations not included in GroupQuota Enforcement will not be listed, the regions in failed status with listed as status Failed.
create_or_update	insert	managementGroupId, groupQuotaName, resourceProviderName, location		Enables the GroupQuotas enforcement for the resource provider and the location specified. The resource provider will start using the group quotas as the overall quota for the subscriptions included in the GroupQuota. The subscriptions cannot request quota at subscription level. The subscriptions share the GroupQuotaLimits assigned to the GroupQuota. If the GroupQuotaLimits is used, then submit a groupQuotaLimit request for the specific resource - provider/location/resource. Once the GroupQuota Enforcement is enabled then, it cannot be deleted or reverted back. To disable GroupQuota Enforcement - 1. Remove all the subscriptions from the groupQuota using the delete API for Subscriptions (Check the example - GroupQuotaSubscriptions_Delete). 2. Ten delete the GroupQuota (Check the example - GroupQuotas_Delete).
update	update	managementGroupId, groupQuotaName, resourceProviderName, location		Enables the GroupQuotas enforcement for the resource provider and the location specified. The resource provider will start using the group quotas as the overall quota for the subscriptions included in the GroupQuota. The subscriptions cannot request quota at subscription level. The subscriptions share the GroupQuotaLimits assigned to the GroupQuota. If the GroupQuotaLimits is used, then submit a groupQuotaLimit request for the specific resource - provider/location/resource. Once the GroupQuota Enforcement is enabled then, it cannot be deleted or reverted back. To disable GroupQuota Enforcement - 1. Remove all the subscriptions from the groupQuota using the delete API for Subscriptions (Check the example - GroupQuotaSubscriptions_Delete). 2. Ten delete the GroupQuota (Check the example - GroupQuotas_Delete).

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.
location	string	The name of the Azure region.
managementGroupId	string	Management Group Id.
resourceProviderName	string	The resource provider name, such as - Microsoft.Compute. Currently only Microsoft.Compute resource provider supports this API.

SELECT examples

get

Gets the GroupQuotas enforcement settings for the ResourceProvider/location. The locations, where GroupQuota enforcement is not enabled will return Not Found.

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

list

Returns only the list of the Azure regions settings, where the GroupQuotas enforcement is enabled. The locations not included in GroupQuota Enforcement will not be listed, the regions in failed status with listed as status Failed.

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

INSERT examples

create_or_update

Enables the GroupQuotas enforcement for the resource provider and the location specified. The resource provider will start using the group quotas as the overall quota for the subscriptions included in the GroupQuota. The subscriptions cannot request quota at subscription level.
The subscriptions share the GroupQuotaLimits assigned to the GroupQuota. If the GroupQuotaLimits is used, then submit a groupQuotaLimit request for the specific resource - provider/location/resource.
Once the GroupQuota Enforcement is enabled then, it cannot be deleted or reverted back. To disable GroupQuota Enforcement -
1. Remove all the subscriptions from the groupQuota using the delete API for Subscriptions (Check the example - GroupQuotaSubscriptions_Delete).
2. Ten delete the GroupQuota (Check the example - GroupQuotas_Delete).

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

Manifest

# Description fields are for documentation purposes
- name: group_quota_location_settings
  props:
    - name: managementGroupId
      value: string
      description: Required parameter for the group_quota_location_settings resource.
    - name: groupQuotaName
      value: string
      description: Required parameter for the group_quota_location_settings resource.
    - name: resourceProviderName
      value: string
      description: Required parameter for the group_quota_location_settings resource.
    - name: location
      value: string
      description: Required parameter for the group_quota_location_settings resource.
    - name: properties
      value: object

UPDATE examples

update

Enables the GroupQuotas enforcement for the resource provider and the location specified. The resource provider will start using the group quotas as the overall quota for the subscriptions included in the GroupQuota. The subscriptions cannot request quota at subscription level.
The subscriptions share the GroupQuotaLimits assigned to the GroupQuota. If the GroupQuotaLimits is used, then submit a groupQuotaLimit request for the specific resource - provider/location/resource.
Once the GroupQuota Enforcement is enabled then, it cannot be deleted or reverted back. To disable GroupQuota Enforcement -
1. Remove all the subscriptions from the groupQuota using the delete API for Subscriptions (Check the example - GroupQuotaSubscriptions_Delete).
2. Ten delete the GroupQuota (Check the example - GroupQuotas_Delete).

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