TenantPolicyDefinitionCollection.GetAll Method

  • Reference

Definition

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

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

Pageable<TenantPolicyDefinitionResource>

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

Applies to