PolicySetDefinitionsOperationsExtensions.ListBuiltInAsync Method

Definition

Namespace:

Microsoft.Azure.Management.ResourceManager

Assembly:

Microsoft.Azure.Management.ResourceManager.dll

Package:

Microsoft.Azure.Management.ResourceManager v3.17.4-preview

Retrieves built-in policy set definitions.

public static System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ResourceManager.Models.PolicySetDefinition>> ListBuiltInAsync (this Microsoft.Azure.Management.ResourceManager.IPolicySetDefinitionsOperations operations, string filter = default, int? top = default, System.Threading.CancellationToken cancellationToken = default);

static member ListBuiltInAsync : Microsoft.Azure.Management.ResourceManager.IPolicySetDefinitionsOperations * string * Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ResourceManager.Models.PolicySetDefinition>>

<Extension()>
Public Function ListBuiltInAsync (operations As IPolicySetDefinitionsOperations, Optional filter As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IPage(Of PolicySetDefinition))

Parameters

operations

IPolicySetDefinitionsOperations

The operations group for this extension method.

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.

Returns

Task<IPage<PolicySetDefinition>>

Remarks

This operation retrieves a list of all the built-in policy set definitions that match the optional given $filter. If $filter='category -eq {value}' is provided, the returned list only includes all built-in policy set definitions whose category match the {value}.