ResourcesPolicyExtensions.GetPolicyAssignments 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.
Overloads
| Name | Description |
|---|---|
| GetPolicyAssignments(ArmClient, ResourceIdentifier) |
Gets a collection of PolicyAssignmentCollection objects within the specified scope. <item> Mocking. To mock this method, please mock GetPolicyAssignments(ResourceIdentifier) instead. </item> |
| GetPolicyAssignments(ManagementGroupResource, String, String, Nullable<Int32>, CancellationToken) |
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. <item> Mocking. To mock this method, please mock GetPolicyAssignments(String, String, Nullable<Int32>, CancellationToken) instead. </item> |
| GetPolicyAssignments(ResourceGroupResource, String, String, Nullable<Int32>, CancellationToken) |
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. <item> Mocking. To mock this method, please mock GetPolicyAssignments(String, String, Nullable<Int32>, CancellationToken) instead. </item> |
| GetPolicyAssignments(SubscriptionResource, String, String, Nullable<Int32>, CancellationToken) |
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}. <item> Mocking. To mock this method, please mock GetPolicyAssignments(String, String, Nullable<Int32>, CancellationToken) instead. </item> |
| GetPolicyAssignments(ResourceGroupResource, String, String, String, String, String, String, Nullable<Int32>, CancellationToken) |
This operation retrieves the list of all policy assignments associated with the specified resource in the given resource group and 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, including those that apply directly or from all containing scopes, as well as any applied to resources contained within the resource. If $filter=atScope() is provided, the returned list includes all policy assignments that apply to the resource, which is everything in the unfiltered list except those applied to resources contained within the resource. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the resource level. 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. Three parameters plus the resource name are used to identify a specific resource. If the resource is not part of a parent resource (the more common case), the parent resource path should not be provided (or provided as ''). For example a web app could be specified as ({resourceProviderNamespace} == 'Microsoft.Web', {parentResourcePath} == '', {resourceType} == 'sites', {resourceName} == 'MyWebApp'). If the resource is part of a parent resource, then all parameters should be provided. For example a virtual machine DNS name could be specified as ({resourceProviderNamespace} == 'Microsoft.Compute', {parentResourcePath} == 'virtualMachines/MyVirtualMachine', {resourceType} == 'domainNames', {resourceName} == 'MyComputerName'). A convenient alternative to providing the namespace and type name separately is to provide both in the {resourceType} parameter, format: ({resourceProviderNamespace} == '', {parentResourcePath} == '', {resourceType} == 'Microsoft.Web/sites', {resourceName} == 'MyWebApp'). <item> Mocking. To mock this method, please mock GetPolicyAssignments(String, String, String, String, String, String, Nullable<Int32>, CancellationToken) instead. </item> |
GetPolicyAssignments(ArmClient, ResourceIdentifier)
- Source:
- ResourcesPolicyExtensions.cs
Gets a collection of PolicyAssignmentCollection objects within the specified scope. <item> Mocking. To mock this method, please mock GetPolicyAssignments(ResourceIdentifier) instead. </item>
public static Azure.ResourceManager.Resources.Policy.PolicyAssignmentCollection GetPolicyAssignments(this Azure.ResourceManager.ArmClient client, Azure.Core.ResourceIdentifier scope);static member GetPolicyAssignments : Azure.ResourceManager.ArmClient * Azure.Core.ResourceIdentifier -> Azure.ResourceManager.Resources.Policy.PolicyAssignmentCollection<Extension()>
Public Function GetPolicyAssignments (client As ArmClient, scope As ResourceIdentifier) As PolicyAssignmentCollectionParameters
- scope
- ResourceIdentifier
The scope of the resource collection to get.
Returns
Returns a collection of PolicyAssignmentResource objects.
Exceptions
client is null.
Applies to
GetPolicyAssignments(ManagementGroupResource, String, String, Nullable<Int32>, CancellationToken)
- Source:
- ResourcesPolicyExtensions.cs
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. <item> Mocking. To mock this method, please mock GetPolicyAssignments(String, String, Nullable<Int32>, CancellationToken) instead. </item>
public static Azure.Pageable<Azure.ResourceManager.Resources.Policy.PolicyAssignmentResource> GetPolicyAssignments(this Azure.ResourceManager.ManagementGroups.ManagementGroupResource managementGroupResource, string filter = default, string expand = default, int? top = default, System.Threading.CancellationToken cancellationToken = default);static member GetPolicyAssignments : Azure.ResourceManager.ManagementGroups.ManagementGroupResource * string * string * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.Resources.Policy.PolicyAssignmentResource><Extension()>
Public Function GetPolicyAssignments (managementGroupResource As ManagementGroupResource, Optional filter As String = Nothing, Optional expand As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of PolicyAssignmentResource)Parameters
- managementGroupResource
- ManagementGroupResource
The ManagementGroupResource the method will execute against.
- 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}.
- expand
- String
Comma-separated list of additional properties to be included in the response. Supported values are 'LatestDefinitionVersion, EffectiveDefinitionVersion'.
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
A collection of PolicyAssignmentResource that may take multiple service requests to iterate over.
Exceptions
managementGroupResource is null.
Applies to
GetPolicyAssignments(ResourceGroupResource, String, String, Nullable<Int32>, CancellationToken)
- Source:
- ResourcesPolicyExtensions.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. <item> Mocking. To mock this method, please mock GetPolicyAssignments(String, String, Nullable<Int32>, CancellationToken) instead. </item>
public static Azure.Pageable<Azure.ResourceManager.Resources.Policy.PolicyAssignmentResource> GetPolicyAssignments(this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string filter = default, string expand = default, int? top = default, System.Threading.CancellationToken cancellationToken = default);static member GetPolicyAssignments : Azure.ResourceManager.Resources.ResourceGroupResource * string * string * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.Resources.Policy.PolicyAssignmentResource><Extension()>
Public Function GetPolicyAssignments (resourceGroupResource As ResourceGroupResource, Optional filter As String = Nothing, Optional expand As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of PolicyAssignmentResource)Parameters
- resourceGroupResource
- ResourceGroupResource
The ResourceGroupResource the method will execute against.
- 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}.
- expand
- String
Comma-separated list of additional properties to be included in the response. Supported values are 'LatestDefinitionVersion, EffectiveDefinitionVersion'.
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
A collection of PolicyAssignmentResource that may take multiple service requests to iterate over.
Exceptions
resourceGroupResource is null.
Applies to
GetPolicyAssignments(SubscriptionResource, String, String, Nullable<Int32>, CancellationToken)
- Source:
- ResourcesPolicyExtensions.cs
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}. <item> Mocking. To mock this method, please mock GetPolicyAssignments(String, String, Nullable<Int32>, CancellationToken) instead. </item>
public static Azure.Pageable<Azure.ResourceManager.Resources.Policy.PolicyAssignmentResource> GetPolicyAssignments(this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, string filter = default, string expand = default, int? top = default, System.Threading.CancellationToken cancellationToken = default);static member GetPolicyAssignments : Azure.ResourceManager.Resources.SubscriptionResource * string * string * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.Resources.Policy.PolicyAssignmentResource><Extension()>
Public Function GetPolicyAssignments (subscriptionResource As SubscriptionResource, Optional filter As String = Nothing, Optional expand As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of PolicyAssignmentResource)Parameters
- subscriptionResource
- SubscriptionResource
The SubscriptionResource the method will execute against.
- 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}.
- expand
- String
Comma-separated list of additional properties to be included in the response. Supported values are 'LatestDefinitionVersion, EffectiveDefinitionVersion'.
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
A collection of PolicyAssignmentResource that may take multiple service requests to iterate over.
Exceptions
subscriptionResource is null.
Applies to
GetPolicyAssignments(ResourceGroupResource, String, String, String, String, String, String, Nullable<Int32>, CancellationToken)
- Source:
- ResourcesPolicyExtensions.cs
This operation retrieves the list of all policy assignments associated with the specified resource in the given resource group and 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, including those that apply directly or from all containing scopes, as well as any applied to resources contained within the resource. If $filter=atScope() is provided, the returned list includes all policy assignments that apply to the resource, which is everything in the unfiltered list except those applied to resources contained within the resource. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the resource level. 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. Three parameters plus the resource name are used to identify a specific resource. If the resource is not part of a parent resource (the more common case), the parent resource path should not be provided (or provided as ''). For example a web app could be specified as ({resourceProviderNamespace} == 'Microsoft.Web', {parentResourcePath} == '', {resourceType} == 'sites', {resourceName} == 'MyWebApp'). If the resource is part of a parent resource, then all parameters should be provided. For example a virtual machine DNS name could be specified as ({resourceProviderNamespace} == 'Microsoft.Compute', {parentResourcePath} == 'virtualMachines/MyVirtualMachine', {resourceType} == 'domainNames', {resourceName} == 'MyComputerName'). A convenient alternative to providing the namespace and type name separately is to provide both in the {resourceType} parameter, format: ({resourceProviderNamespace} == '', {parentResourcePath} == '', {resourceType} == 'Microsoft.Web/sites', {resourceName} == 'MyWebApp'). <item> Mocking. To mock this method, please mock GetPolicyAssignments(String, String, String, String, String, String, Nullable<Int32>, CancellationToken) instead. </item>
public static Azure.Pageable<Azure.ResourceManager.Resources.Policy.PolicyAssignmentResource> GetPolicyAssignments(this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string resourceProviderNamespace, string parentResourcePath, string resourceType, string resourceName, string filter = default, string expand = default, int? top = default, System.Threading.CancellationToken cancellationToken = default);static member GetPolicyAssignments : Azure.ResourceManager.Resources.ResourceGroupResource * string * string * string * string * string * string * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.Resources.Policy.PolicyAssignmentResource><Extension()>
Public Function GetPolicyAssignments (resourceGroupResource As ResourceGroupResource, resourceProviderNamespace As String, parentResourcePath As String, resourceType As String, resourceName As String, Optional filter As String = Nothing, Optional expand As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of PolicyAssignmentResource)Parameters
- resourceGroupResource
- ResourceGroupResource
The ResourceGroupResource the method will execute against.
- resourceProviderNamespace
- String
The namespace of the resource provider. For example, the namespace of a virtual machine is Microsoft.Compute (from Microsoft.Compute/virtualMachines).
- parentResourcePath
- String
The parent resource path. Use empty string if there is none.
- resourceType
- String
The resource type name. For example the type name of a web app is 'sites' (from Microsoft.Web/sites).
- resourceName
- String
The name of the resource.
- 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}.
- expand
- String
Comma-separated list of additional properties to be included in the response. Supported values are 'LatestDefinitionVersion, EffectiveDefinitionVersion'.
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
A collection of PolicyAssignmentResource that may take multiple service requests to iterate over.
Exceptions
resourceGroupResource is null.
