PolicyAssignmentsOperationsExtensions.ListForManagementGroupAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Management.ResourceManager

Assembly:: Microsoft.Azure.Management.ResourceManager.dll

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

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.

Retrieves all policy assignments that apply to a management group.

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

static member ListForManagementGroupAsync : Microsoft.Azure.Management.ResourceManager.IPolicyAssignmentsOperations * string * string * Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ResourceManager.Models.PolicyAssignment>>

<Extension()>
Public Function ListForManagementGroupAsync (operations As IPolicyAssignmentsOperations, managementGroupId As String, Optional filter As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IPage(Of PolicyAssignment))

Parameters

operations: IPolicyAssignmentsOperations

The operations group for this extension method.

managementGroupId: String

The ID of the management group.

filter: String

The filter to apply on the operation. Valid values for $filter are: 'atScope()', 'atExactScope()' or 'policyDefinitionId eq '{value}''. If $filter is not provided, no filtering is performed. If $filter=atScope() is provided, the returned list only includes all policy assignments that apply to the scope, which is everything in the unfiltered list except those applied to sub scopes contained within the given scope. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the given scope. If $filter=policyDefinitionId eq '{value}' is provided, the returned list includes all policy assignments of the policy definition whose id is {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<PolicyAssignment>>

Remarks

This operation retrieves the list of all policy assignments applicable to the management group that match the given $filter. Valid values for $filter are: 'atScope()', 'atExactScope()' or 'policyDefinitionId eq '{value}''. If $filter=atScope() is provided, the returned list includes all policy assignments that are assigned to the management group or the management group's ancestors. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the management group. If $filter=policyDefinitionId eq '{value}' is provided, the returned list includes all policy assignments of the policy definition whose id is {value} that apply to the management group.

Applies to

Share via