Share via


PolicyAssignmentsOperationsExtensions.ListAsync Method

Definition

Retrieves all policy assignments that apply to a subscription.

public static System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ResourceManager.Models.PolicyAssignment>> ListAsync (this Microsoft.Azure.Management.ResourceManager.IPolicyAssignmentsOperations operations, Microsoft.Rest.Azure.OData.ODataQuery<Microsoft.Azure.Management.ResourceManager.Models.PolicyAssignment> odataQuery = default, System.Threading.CancellationToken cancellationToken = default);
static member ListAsync : Microsoft.Azure.Management.ResourceManager.IPolicyAssignmentsOperations * Microsoft.Rest.Azure.OData.ODataQuery<Microsoft.Azure.Management.ResourceManager.Models.PolicyAssignment> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ResourceManager.Models.PolicyAssignment>>
<Extension()>
Public Function ListAsync (operations As IPolicyAssignmentsOperations, Optional odataQuery As ODataQuery(Of PolicyAssignment) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IPage(Of PolicyAssignment))

Parameters

operations
IPolicyAssignmentsOperations

The operations group for this extension method.

odataQuery
ODataQuery<PolicyAssignment>

OData parameters to apply to the operation.

cancellationToken
CancellationToken

The cancellation token.

Returns

Remarks

This operation retrieves the list of all policy assignments associated with the given subscription that match the optional given $filter. Valid values for $filter are: 'atScope()', 'atExactScope()' or 'policyDefinitionId eq '{value}''. If $filter is not provided, the unfiltered list includes all policy assignments associated with the subscription, including those that apply directly or from management groups that contain the given subscription, as well as any applied to objects contained within the subscription. If $filter=atScope() is provided, the returned list includes all policy assignments that apply to the subscription, which is everything in the unfiltered list except those applied to objects contained within the subscription. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the subscription. If $filter=policyDefinitionId eq '{value}' is provided, the returned list includes all policy assignments of the policy definition whose id is {value}.

Applies to