PolicyAssignmentCollection.GetAllAsync Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.Resources
Assembly:
Azure.ResourceManager.dll
Package:
Azure.ResourceManager v1.13.0
Package:
Azure.ResourceManager v1.12.0-beta.1
Source:
PolicyAssignmentCollection.cs
Source:
PolicyAssignmentCollection.cs

This operation retrieves the list of all policy assignments associated with the given resource group in 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 resource group, including those that apply directly or apply from containing scopes, as well as any applied to resources contained within the resource group. If $filter=atScope() is provided, the returned list includes all policy assignments that apply to the resource group, which is everything in the unfiltered list except those applied to resources contained within the resource group. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the resource 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 resource group.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/policyAssignments
  • Operation Id: PolicyAssignments_ListForResourceGroup
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/policyAssignments
  • Operation Id: PolicyAssignments_ListForResource
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
  • Request Path: /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Authorization/policyAssignments
  • Operation Id: PolicyAssignments_ListForManagementGroup
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyAssignments
  • Operation Id: PolicyAssignments_List
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
public virtual Azure.AsyncPageable<Azure.ResourceManager.Resources.PolicyAssignmentResource> GetAllAsync (string filter = default, int? top = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetAllAsync : string * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Resources.PolicyAssignmentResource>
override this.GetAllAsync : string * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Resources.PolicyAssignmentResource>
Public Overridable Function GetAllAsync (Optional filter As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of PolicyAssignmentResource)

Parameters

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 to use.

Returns

AsyncPageable<PolicyAssignmentResource>

An async collection of PolicyAssignmentResource that may take multiple service requests to iterate over.

Applies to