Get-AzPolicyExemption

Reference

Module:: Az.Resources

Gets policy exemptions.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

Get-AzPolicyExemption
   [-Name <String>]
   [-Scope <String>]
   [-PolicyAssignmentIdFilter <String>]
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzPolicyExemption
   [-Scope <String>]
   [-IncludeDescendent]
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzPolicyExemption
   -Id <String>
   [-PolicyAssignmentIdFilter <String>]
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzPolicyExemption cmdlet gets all policy exemptions or particular exemptions. Identify a policy exemption to get by name and scope or by ID.

Examples

Example 1 Get all policy exemptions

PS C:\> Get-AzPolicyExemption

This command gets all the policy exemptions.

Example 2: Get a specific policy exemption

PS C:\> $ResourceGroup = Get-AzResourceGroup -Name 'ResourceGroup11'
PS C:\> Get-AzPolicyExemption -Name 'PolicyExemption07' -Scope $ResourceGroup.ResourceId

The 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 exemption named PolicyExemption07 for the scope that the ResourceId property of $ResourceGroup identifies.

Example 3: Get all policy exemptions associated with a policy assignment

PS C:\> $Assignment = Get-AzPolicyAssignment -Name 'PolicyAssignment07'
PS C:\> Get-AzPolicyExemption -PolicyAssignmentIdFilter $Assignment.ResourceId

The first command gets a policy assignment named PolicyAssignment07. The second command gets all of the policy exemptions that are assigned with the policy assignment.

Parameters

-ApiVersion

When set, indicates the version of the resource provider API to use. If not specified, the API version is automatically determined as the latest available.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Id

The fully qualified policy exemption ID to get, including the scope, e.g. /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Authorization/policyExemptions/{policyExemptionName}.

Type:	String
Aliases:	ResourceId
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-IncludeDescendent

Causes the list of returned policy exemptions to include all exemptions related to the given scope, including those from ancestor scopes and those from descendent scopes.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

The name of the policy exemption to get.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-PolicyAssignmentIdFilter

Limits the list of returned policy exemptions to those assigning the policy assignment identified by this fully qualified Id.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-Pre

When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Scope

The scope of the policy exemption to get, e.g. /providers/managementGroups/{managementGroupName}, defaults to current subscription.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

Inputs

String

SwitchParameter

Outputs

PsPolicyExemption