< Back
Remove-AzureRmPolicyDefinition
Post
NAME Remove-AzureRmPolicyDefinition
SYNOPSIS
Removes a policy definition.
SYNTAX
Remove-AzureRmPolicyDefinition [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-Force] -Id <String> [-InformationAction
<ActionPreference>] [-InformationVariable <String>] [-Pre] [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-AzureRmPolicyDefinition [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-Force] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] -Name <String> [-Pre] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-AzureRmPolicyDefinition cmdlet removes a policy definition.
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
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Id <String>
Specifies the fully qualified resource ID for the policy definition 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 definition 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
-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 the policy definition by name
PS C:\\>Remove-AzureRmPolicyDefinition -Name "VMPolicyDefinition"
This command removes the specified policy definition.
Example 2: Remove policy definition by resource ID
PS C:\\>$PolicyDefinition = Get-AzureRmPolicyDefinition -Name "VMPolicyDefinition"
PS C:\\> Remove-AzureRmPolicyDefinition -Id $PolicyDefinition.ResourceId -Force
The first command gets a policy definition named VMPolicyDefinition by using the Get-AzureRmPolicyDefinition cmdlet. The command stores it in the
$PolicyDefinition variable.
The second command removes the policy definition identified by the ResourceId property of $PolicyDefinition.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... definition
Get-AzureRmPolicyDefinition
New-AzureRmPolicyDefinition
Set-AzureRmPolicyDefinition
SYNOPSIS
Removes a policy definition.
SYNTAX
Remove-AzureRmPolicyDefinition [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-Force] -Id <String> [-InformationAction
<ActionPreference>] [-InformationVariable <String>] [-Pre] [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-AzureRmPolicyDefinition [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-Force] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] -Name <String> [-Pre] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-AzureRmPolicyDefinition cmdlet removes a policy definition.
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
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Id <String>
Specifies the fully qualified resource ID for the policy definition 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 definition 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
-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 the policy definition by name
PS C:\\>Remove-AzureRmPolicyDefinition -Name "VMPolicyDefinition"
This command removes the specified policy definition.
Example 2: Remove policy definition by resource ID
PS C:\\>$PolicyDefinition = Get-AzureRmPolicyDefinition -Name "VMPolicyDefinition"
PS C:\\> Remove-AzureRmPolicyDefinition -Id $PolicyDefinition.ResourceId -Force
The first command gets a policy definition named VMPolicyDefinition by using the Get-AzureRmPolicyDefinition cmdlet. The command stores it in the
$PolicyDefinition variable.
The second command removes the policy definition identified by the ResourceId property of $PolicyDefinition.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... definition
Get-AzureRmPolicyDefinition
New-AzureRmPolicyDefinition
Set-AzureRmPolicyDefinition