Share via

ManagementGroupPolicySetDefinitionCollection.GetAllAsync Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.Resources
Assembly:
Azure.ResourceManager.dll
Package:
Azure.ResourceManager v1.12.0
Package:
Azure.ResourceManager v1.12.0-beta.1
Source:
ManagementGroupPolicySetDefinitionCollection.cs
Source:
ManagementGroupPolicySetDefinitionCollection.cs

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
public virtual Azure.AsyncPageable<Azure.ResourceManager.Resources.ManagementGroupPolicySetDefinitionResource> GetAllAsync (string filter = default, int? top = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetAllAsync : string * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Resources.ManagementGroupPolicySetDefinitionResource>
override this.GetAllAsync : string * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Resources.ManagementGroupPolicySetDefinitionResource>
Public Overridable Function GetAllAsync (Optional filter As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of ManagementGroupPolicySetDefinitionResource)

Parameters

filter
String

The filter to apply on the operation. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, no filtering is performed. If $filter=atExactScope() is provided, the returned list only includes all policy set definitions that at the given scope. 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, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy set definitions whose category match the {value}.

top
Nullable<Int32>

Maximum number of records to return. When the $top filter is not provided, it will return 500 records.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

AsyncPageable<ManagementGroupPolicySetDefinitionResource>

An async collection of ManagementGroupPolicySetDefinitionResource that may take multiple service requests to iterate over.

Applies to