< Back
Remove-AzureRmPolicyAssignment
Post
NAME Remove-AzureRmPolicyAssignment
SYNOPSIS
Removes a policy assignment.
SYNTAX
Remove-AzureRmPolicyAssignment [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] -Id <String> [-InformationAction
<ActionPreference>] [-InformationVariable <String>] [-Pre] [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-AzureRmPolicyAssignment [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] -Name <String> [-Pre] -Scope <String> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-AzureRmPolicyAssignment cmdlet removes the specified policy assignment.
PARAMETERS
-ApiVersion <String>
Specifies the version of the resource provider API to use. If you do not specify a version, this cmdlet uses the latest available version.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Id <String>
Specifies the fully qualified resource ID for the policy assignment that this cmdlet removes.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-InformationAction <ActionPreference>
Specifies how this cmdlet responds to an information event.
The acceptable values for this parameter are:
- Continue
- Ignore
- Inquire
- SilentlyContinue
- Stop
- Suspend
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InformationVariable <String>
Specifies an information variable.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the policy assignment that this cmdlet removes.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Pre [<SwitchParameter>]
Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Scope <String>
Specifies the scope at which the policy is applied.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
System.Boolean
NOTES
Example 1: Remove policy assignment by name and scope
PS C:\\>$ResourceGroup = Get-AzureRmResourceGroup -Name "ResourceGroup11"
PS C:\\> Remove-AzureRmPolicyAssignment -Name "PolicyAssignment07" -Scope $ResourceGroup.ResourceId -Force
The first command gets a resource group named ResourceGroup11 by using the Get-AzureRMResourceGroup cmdlet. The command stores that object in the
$ResourceGroup variable.
The second command removes the policy assignment named PolicyAssignment07 that was assigned at a resource group level. The ResourceId property of
$ResourceGroup identifies the resource group.
Example 2: Remove policy assignment by ID
PS C:\\>$ResourceGroup = Get-AzureRmResourceGroup -Name "ResourceGroup11"
PS C:\\> $PolicyAssignment = Get-AzureRmPolicyAssignment -Name "PolicyAssignment07" -Scope $ResourceGroup.ResourceId
PS C:\\> Remove-AzureRmPolicyAssignment -Id $PolicyAssignment.ResourceId -Force
The first command gets a resource group named ResourceGroup11, and then stores that object in the $ResourceGroup variable.
The second command gets the policy assignment at a resource group level, and then stores it in the $PolicyAssignment variable. The ResourceId
property of $ResourceGroup identifies the resource group.
The final command removes the policy assignment that the ResourceId property of $PolicyAssignment identifies.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... assignment
Get-AzureRmPolicyAssignment
New-AzureRmPolicyAssignment
Set-AzureRmPolicyAssignment
SYNOPSIS
Removes a policy assignment.
SYNTAX
Remove-AzureRmPolicyAssignment [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] -Id <String> [-InformationAction
<ActionPreference>] [-InformationVariable <String>] [-Pre] [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-AzureRmPolicyAssignment [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] -Name <String> [-Pre] -Scope <String> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-AzureRmPolicyAssignment cmdlet removes the specified policy assignment.
PARAMETERS
-ApiVersion <String>
Specifies the version of the resource provider API to use. If you do not specify a version, this cmdlet uses the latest available version.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Id <String>
Specifies the fully qualified resource ID for the policy assignment that this cmdlet removes.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-InformationAction <ActionPreference>
Specifies how this cmdlet responds to an information event.
The acceptable values for this parameter are:
- Continue
- Ignore
- Inquire
- SilentlyContinue
- Stop
- Suspend
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InformationVariable <String>
Specifies an information variable.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the policy assignment that this cmdlet removes.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Pre [<SwitchParameter>]
Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Scope <String>
Specifies the scope at which the policy is applied.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
System.Boolean
NOTES
Example 1: Remove policy assignment by name and scope
PS C:\\>$ResourceGroup = Get-AzureRmResourceGroup -Name "ResourceGroup11"
PS C:\\> Remove-AzureRmPolicyAssignment -Name "PolicyAssignment07" -Scope $ResourceGroup.ResourceId -Force
The first command gets a resource group named ResourceGroup11 by using the Get-AzureRMResourceGroup cmdlet. The command stores that object in the
$ResourceGroup variable.
The second command removes the policy assignment named PolicyAssignment07 that was assigned at a resource group level. The ResourceId property of
$ResourceGroup identifies the resource group.
Example 2: Remove policy assignment by ID
PS C:\\>$ResourceGroup = Get-AzureRmResourceGroup -Name "ResourceGroup11"
PS C:\\> $PolicyAssignment = Get-AzureRmPolicyAssignment -Name "PolicyAssignment07" -Scope $ResourceGroup.ResourceId
PS C:\\> Remove-AzureRmPolicyAssignment -Id $PolicyAssignment.ResourceId -Force
The first command gets a resource group named ResourceGroup11, and then stores that object in the $ResourceGroup variable.
The second command gets the policy assignment at a resource group level, and then stores it in the $PolicyAssignment variable. The ResourceId
property of $ResourceGroup identifies the resource group.
The final command removes the policy assignment that the ResourceId property of $PolicyAssignment identifies.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... assignment
Get-AzureRmPolicyAssignment
New-AzureRmPolicyAssignment
Set-AzureRmPolicyAssignment