PolicyDefinitionsOperationsExtensions.ListBuiltInAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Retrieve built-in policy definitions
public static System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ResourceManager.Models.PolicyDefinition>> ListBuiltInAsync (this Microsoft.Azure.Management.ResourceManager.IPolicyDefinitionsOperations operations, string filter = default, int? top = default, System.Threading.CancellationToken cancellationToken = default);static member ListBuiltInAsync : Microsoft.Azure.Management.ResourceManager.IPolicyDefinitionsOperations * string * Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ResourceManager.Models.PolicyDefinition>><Extension()>
Public Function ListBuiltInAsync (operations As IPolicyDefinitionsOperations, Optional filter As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IPage(Of PolicyDefinition))Parameters
- operations
- IPolicyDefinitionsOperations
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 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}.
Maximum number of records to return. When the $top filter is not provided, it will return 500 records.
- cancellationToken
- CancellationToken
The cancellation token.
Returns
Remarks
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}.
