Share via


GroupQuotaEnforcementCollection Class

Definition

A class representing a collection of GroupQuotaEnforcementResource and their operations. Each GroupQuotaEnforcementResource in the collection will belong to the same instance of GroupQuotaEntityResource. To get a GroupQuotaEnforcementCollection instance call the GetGroupQuotaEnforcements method from an instance of GroupQuotaEntityResource.

public class GroupQuotaEnforcementCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.Quota.GroupQuotaEnforcementResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Quota.GroupQuotaEnforcementResource>
type GroupQuotaEnforcementCollection = class
    inherit ArmCollection
    interface seq<GroupQuotaEnforcementResource>
    interface IEnumerable
    interface IAsyncEnumerable<GroupQuotaEnforcementResource>
Public Class GroupQuotaEnforcementCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of GroupQuotaEnforcementResource), IEnumerable(Of GroupQuotaEnforcementResource)
Inheritance
GroupQuotaEnforcementCollection
Implements

Constructors

GroupQuotaEnforcementCollection()

Initializes a new instance of the GroupQuotaEnforcementCollection class for mocking.

Properties

Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmCollection)
Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmCollection)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmCollection)
Id

Gets the resource identifier.

(Inherited from ArmCollection)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmCollection)

Methods

CreateOrUpdate(WaitUntil, AzureLocation, GroupQuotaEnforcementData, CancellationToken)

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).
  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/locationSettings/{location}
  • Operation Id: GroupQuotaLocationSettings_CreateOrUpdate
  • Default Api Version: 2023-06-01-preview
  • Resource: GroupQuotaEnforcementResource
CreateOrUpdateAsync(WaitUntil, AzureLocation, GroupQuotaEnforcementData, CancellationToken)

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).
  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/locationSettings/{location}
  • Operation Id: GroupQuotaLocationSettings_CreateOrUpdate
  • Default Api Version: 2023-06-01-preview
  • Resource: GroupQuotaEnforcementResource
Exists(AzureLocation, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/locationSettings/{location}
  • Operation Id: GroupQuotaLocationSettings_Get
  • Default Api Version: 2023-06-01-preview
  • Resource: GroupQuotaEnforcementResource
ExistsAsync(AzureLocation, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/locationSettings/{location}
  • Operation Id: GroupQuotaLocationSettings_Get
  • Default Api Version: 2023-06-01-preview
  • Resource: GroupQuotaEnforcementResource
Get(AzureLocation, CancellationToken)

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

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/locationSettings/{location}
  • Operation Id: GroupQuotaLocationSettings_Get
  • Default Api Version: 2023-06-01-preview
  • Resource: GroupQuotaEnforcementResource
GetAll(CancellationToken)

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.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/locationSettings
  • Operation Id: GroupQuotaLocationSettings_List
  • Default Api Version: 2023-06-01-preview
  • Resource: GroupQuotaEnforcementResource
GetAllAsync(CancellationToken)

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.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/locationSettings
  • Operation Id: GroupQuotaLocationSettings_List
  • Default Api Version: 2023-06-01-preview
  • Resource: GroupQuotaEnforcementResource
GetAsync(AzureLocation, CancellationToken)

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

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/locationSettings/{location}
  • Operation Id: GroupQuotaLocationSettings_Get
  • Default Api Version: 2023-06-01-preview
  • Resource: GroupQuotaEnforcementResource
GetIfExists(AzureLocation, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/locationSettings/{location}
  • Operation Id: GroupQuotaLocationSettings_Get
  • Default Api Version: 2023-06-01-preview
  • Resource: GroupQuotaEnforcementResource
GetIfExistsAsync(AzureLocation, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Quota/groupQuotas/{groupQuotaName}/resourceProviders/{resourceProviderName}/locationSettings/{location}
  • Operation Id: GroupQuotaLocationSettings_Get
  • Default Api Version: 2023-06-01-preview
  • Resource: GroupQuotaEnforcementResource
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmCollection)

Explicit Interface Implementations

IAsyncEnumerable<GroupQuotaEnforcementResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<GroupQuotaEnforcementResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to