Get-AzPolicyAssignment
Gets policy assignments.
Syntax
Get-AzPolicyAssignment
[-BackwardCompatible]
[-DefaultProfile <PSObject>]
[<CommonParameters>] Get-AzPolicyAssignment
-Name <String>
[-Scope <String>]
[-BackwardCompatible]
[-DefaultProfile <PSObject>]
[<CommonParameters>] Get-AzPolicyAssignment
[-Scope <String>]
-PolicyDefinitionId <String>
[-BackwardCompatible]
[-DefaultProfile <PSObject>]
[<CommonParameters>] Get-AzPolicyAssignment
[-Scope <String>]
[-IncludeDescendent]
[-BackwardCompatible]
[-DefaultProfile <PSObject>]
[<CommonParameters>] Get-AzPolicyAssignment
-Scope <String>
[-BackwardCompatible]
[-DefaultProfile <PSObject>]
[<CommonParameters>] Get-AzPolicyAssignment
-Id <String>
[-BackwardCompatible]
[-DefaultProfile <PSObject>]
[<CommonParameters>] Description
The Get-AzPolicyAssignment cmdlet gets all policy assignments or particular assignments. Identify a policy assignment to get by name and scope or by ID.
Examples
Example 1: Get all policy assignments
Get-AzPolicyAssignmentThis command gets all the policy assignments.
Example 2: Get a specific policy assignment
$ResourceGroup = Get-AzResourceGroup -Name 'ResourceGroup11'
Get-AzPolicyAssignment -Name 'PolicyAssignment07' -Scope $ResourceGroup.ResourceIdThe first command gets a resource group named ResourceGroup11 by using the Get-AzResourceGroup cmdlet and stores it in the $ResourceGroup variable. The second command gets the policy assignment named PolicyAssignment07 for the scope that the ResourceId property of $ResourceGroup identifies.
Example 3: Get all policy assignments assigned to a management group
$mgId = 'myManagementGroup'
Get-AzPolicyAssignment -Scope '/providers/Microsoft.Management/managementgroups/$mgId'The first command specifies the ID of the management group to query. The second command gets all of the policy assignments that are assigned to the management group with ID 'myManagementGroup'.
Example 4: Get the scope, policy set definition identifier, and display name of all policy assignments formatted as a list
Get-AzPolicyAssignment | Select-Object -Property Scope, PolicyDefinitionID, DisplayName | Format-ListThis command is useful when you need to find the reader-friendly DisplayName property of an Azure Policy assignment.
Example 5: [Backcompat] Get the scope, policy set definition identifier, and display name of all policy assignments formatted as a list
Get-AzPolicyAssignment -BackwardCompatible | Select-Object -ExpandProperty properties | Select-Object -Property Scope, PolicyDefinitionID, DisplayName | Format-ListThis command is useful when you need to find the reader-friendly DisplayName property of an Azure Policy assignment.
Parameters
-BackwardCompatible
Causes cmdlet to return artifacts using legacy format placing policy-specific properties in a property bag object.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
| Type: | PSObject |
| Aliases: | AzureRMContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Id
The ID of the policy assignment to get. Use the format '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'.
| Type: | String |
| Aliases: | ResourceId, PolicyAssignmentId |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-IncludeDescendent
Causes the list of returned policy assignments to include all assignments related to the given scope, including those from ancestor scopes and those from descendent scopes. If not provided, only assignments at and above the given scope are included.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
The name of the policy assignment to get.
| Type: | String |
| Aliases: | PolicyAssignmentName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PolicyDefinitionId
Get all policy assignments that target the given policy definition [fully qualified] ID.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Scope
The scope of the policy assignment. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Inputs
Outputs
Azure PowerShell