PolicyDefinitionsOperationsExtensions.ListBuiltIn Method

Definition

Namespace:

Microsoft.Azure.Management.ResourceManager

Assembly:

Microsoft.Azure.Management.ResourceManager.dll

Package:

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

Retrieve built-in policy definitions

public static Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ResourceManager.Models.PolicyDefinition> ListBuiltIn (this Microsoft.Azure.Management.ResourceManager.IPolicyDefinitionsOperations operations, string filter = default, int? top = default);

static member ListBuiltIn : Microsoft.Azure.Management.ResourceManager.IPolicyDefinitionsOperations * string * Nullable<int> -> Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ResourceManager.Models.PolicyDefinition>

<Extension()>
Public Function ListBuiltIn (operations As IPolicyDefinitionsOperations, Optional filter As String = Nothing, Optional top As Nullable(Of Integer) = Nothing) As 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}.

top

Nullable<Int32>

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

Returns

IPage<PolicyDefinition>

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}.