TenantPolicyDefinitionCollection.GetAllAsync Method

Definition

This operation retrieves a list of all the built-in policy definitions that match the optional given $filter. If $filter='policyType -eq {value}' is provided, the returned list only includes all built-in policy 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 built-in policy definitions whose category match the {value}.

  • Request Path: /providers/Microsoft.Authorization/policyDefinitions
  • Operation Id: PolicyDefinitions_ListBuiltIn
  • Default Api Version: 2021-06-01
  • Resource: TenantPolicyDefinitionResource
public virtual Azure.AsyncPageable<Azure.ResourceManager.Resources.TenantPolicyDefinitionResource> 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.TenantPolicyDefinitionResource>
override this.GetAllAsync : string * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Resources.TenantPolicyDefinitionResource>
Public Overridable Function GetAllAsync (Optional filter As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of TenantPolicyDefinitionResource)

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 definitions that at the given scope. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy 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 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

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

Applies to