Share via


ManagementGroupPolicySetDefinitionCollection Class

Definition

A class representing a collection of ManagementGroupPolicySetDefinitionResource and their operations. Each ManagementGroupPolicySetDefinitionResource in the collection will belong to the same instance of ManagementGroupResource. To get a ManagementGroupPolicySetDefinitionCollection instance call the GetManagementGroupPolicySetDefinitions method from an instance of ManagementGroupResource.

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

Constructors

ManagementGroupPolicySetDefinitionCollection()

Initializes a new instance of the ManagementGroupPolicySetDefinitionCollection 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, String, PolicySetDefinitionData, CancellationToken)

This operation creates or updates a policy set definition in the given management group with the given name.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}
  • Operation Id: PolicySetDefinitions_CreateOrUpdateAtManagementGroup
  • Default Api Version: 2021-06-01
  • Resource: ManagementGroupPolicySetDefinitionResource
CreateOrUpdateAsync(WaitUntil, String, PolicySetDefinitionData, CancellationToken)

This operation creates or updates a policy set definition in the given management group with the given name.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}
  • Operation Id: PolicySetDefinitions_CreateOrUpdateAtManagementGroup
  • Default Api Version: 2021-06-01
  • Resource: ManagementGroupPolicySetDefinitionResource
Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}
  • Operation Id: PolicySetDefinitions_GetAtManagementGroup
  • Default Api Version: 2021-06-01
  • Resource: ManagementGroupPolicySetDefinitionResource
ExistsAsync(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}
  • Operation Id: PolicySetDefinitions_GetAtManagementGroup
  • Default Api Version: 2021-06-01
  • Resource: ManagementGroupPolicySetDefinitionResource
Get(String, CancellationToken)

This operation retrieves the policy set definition in the given management group with the given name.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}
  • Operation Id: PolicySetDefinitions_GetAtManagementGroup
  • Default Api Version: 2021-06-01
  • Resource: ManagementGroupPolicySetDefinitionResource
GetAll(String, Nullable<Int32>, CancellationToken)

This operation retrieves a list of all the policy set definitions in a given management group that match the optional given $filter. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, the unfiltered list includes all policy set definitions associated with the management group, including those that apply directly or from management groups that contain the given management group. If $filter=atExactScope() is provided, the returned list only includes all policy set definitions that at the given management group. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy set definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn and Custom. If $filter='category -eq {value}' is provided, the returned list only includes all policy set definitions whose category match the {value}.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policySetDefinitions
  • Operation Id: PolicySetDefinitions_ListByManagementGroup
  • Default Api Version: 2021-06-01
  • Resource: ManagementGroupPolicySetDefinitionResource
GetAllAsync(String, Nullable<Int32>, CancellationToken)

This operation retrieves a list of all the policy set definitions in a given management group that match the optional given $filter. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, the unfiltered list includes all policy set definitions associated with the management group, including those that apply directly or from management groups that contain the given management group. If $filter=atExactScope() is provided, the returned list only includes all policy set definitions that at the given management group. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy set definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn and Custom. If $filter='category -eq {value}' is provided, the returned list only includes all policy set definitions whose category match the {value}.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policySetDefinitions
  • Operation Id: PolicySetDefinitions_ListByManagementGroup
  • Default Api Version: 2021-06-01
  • Resource: ManagementGroupPolicySetDefinitionResource
GetAsync(String, CancellationToken)

This operation retrieves the policy set definition in the given management group with the given name.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}
  • Operation Id: PolicySetDefinitions_GetAtManagementGroup
  • Default Api Version: 2021-06-01
  • Resource: ManagementGroupPolicySetDefinitionResource
GetIfExists(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}
  • Operation Id: PolicySetDefinitions_GetAtManagementGroup
  • Default Api Version: 2021-06-01
  • Resource: ManagementGroupPolicySetDefinitionResource
GetIfExistsAsync(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}
  • Operation Id: PolicySetDefinitions_GetAtManagementGroup
  • Default Api Version: 2021-06-01
  • Resource: ManagementGroupPolicySetDefinitionResource
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<ManagementGroupPolicySetDefinitionResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<ManagementGroupPolicySetDefinitionResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to