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:

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.
`enforcedGroupName`	`string`	The name of the group that is enforced.
`enforcementEnabled`	`string`	Is the GroupQuota Enforcement enabled for the Azure region. Known values are: "Enabled", "Disabled", and "NotAvailable". (Enabled, Disabled, NotAvailable)
`faultCode`	`string`	Details of the failure.
`provisioningState`	`string`	Request status. Known values are: "Accepted", "Created", "Invalid", "Succeeded", "Escalated", "Failed", "InProgress", and "Canceled". (Accepted, Created, Invalid, Succeeded, Escalated, Failed, InProgress, Canceled)
`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	Description
`get`	`select`	`management_group_id`, `group_quota_name`, `resource_provider_name`, `location`	Gets the GroupQuotas enforcement settings for the ResourceProvider/location. The locations, where GroupQuota enforcement is not enabled will return Not Found.
`create_or_update`	`insert`	`management_group_id`, `group_quota_name`, `resource_provider_name`, `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 since it is now part of an enforced group. 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. Then delete the GroupQuota (Check the example - GroupQuotas_Delete).
`update`	`update`	`management_group_id`, `group_quota_name`, `resource_provider_name`, `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 since it is now part of an enforced group. 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).
`create_or_update`	`replace`	`management_group_id`, `group_quota_name`, `resource_provider_name`, `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 since it is now part of an enforced group. 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. Then 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
`group_quota_name`	`string`	The GroupQuota name. The name should be unique for the provided context tenantId/MgId. Required.
`location`	`string`	The name of the Azure region. Required.
`management_group_id`	`string`	The management group ID. Required.
`resource_provider_name`	`string`	The resource provider name, such as - Microsoft.Compute. Currently only Microsoft.Compute resource provider supports this API. Required.

`SELECT` examples

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

SELECT
id,
name,
enforcedGroupName,
enforcementEnabled,
faultCode,
provisioningState,
systemData,
type
FROM azure.quota.group_quota_location_settings
WHERE management_group_id = '{{ management_group_id }}' -- required
AND group_quota_name = '{{ group_quota_name }}' -- required
AND resource_provider_name = '{{ resource_provider_name }}' -- required
AND location = '{{ location }}' -- required
;

`INSERT` examples

create_or_update
Manifest

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 since it is now part of an enforced group. 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. Then delete the GroupQuota (Check the example - GroupQuotas_Delete).

INSERT INTO azure.quota.group_quota_location_settings (
properties,
management_group_id,
group_quota_name,
resource_provider_name,
location
)
SELECT 
'{{ properties }}',
'{{ management_group_id }}',
'{{ group_quota_name }}',
'{{ resource_provider_name }}',
'{{ location }}'
RETURNING
id,
name,
properties,
systemData,
type
;

# Description fields are for documentation purposes
- name: group_quota_location_settings
props:
  - name: management_group_id
    value: "{{ management_group_id }}"
    description: Required parameter for the group_quota_location_settings resource.
  - name: group_quota_name
    value: "{{ group_quota_name }}"
    description: Required parameter for the group_quota_location_settings resource.
  - name: resource_provider_name
    value: "{{ resource_provider_name }}"
    description: Required parameter for the group_quota_location_settings resource.
  - name: location
    value: "{{ location }}"
    description: Required parameter for the group_quota_location_settings resource.
  - name: properties
    description: |
      :vartype properties: ~azure.mgmt.quota.models.GroupQuotasEnforcementStatusProperties
    value:
      enforcementEnabled: "{{ enforcementEnabled }}"
      enforcedGroupName: "{{ enforcedGroupName }}"
      provisioningState: "{{ provisioningState }}"
      faultCode: "{{ faultCode }}"

`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 since it is now part of an enforced group. 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 
properties = '{{ properties }}'
WHERE 
management_group_id = '{{ management_group_id }}' --required
AND group_quota_name = '{{ group_quota_name }}' --required
AND resource_provider_name = '{{ resource_provider_name }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

`REPLACE` examples

create_or_update

REPLACE azure.quota.group_quota_location_settings
SET 
properties = '{{ properties }}'
WHERE 
management_group_id = '{{ management_group_id }}' --required
AND group_quota_name = '{{ group_quota_name }}' --required
AND resource_provider_name = '{{ resource_provider_name }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

REPLACE examples​