Remove-​Azure​Rm​Policy​Definition

Removes a policy definition.

Syntax

Remove-AzureRmPolicyDefinition
      [-ApiVersion <String>]
      [-Force]
      -Id <String>
      [-InformationAction <ActionPreference>]
      [-InformationVariable <String>]
      [-Pre]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]
Remove-AzureRmPolicyDefinition
      [-ApiVersion <String>]
      [-Force]
      [-InformationAction <ActionPreference>]
      [-InformationVariable <String>]
      -Name <String>
      [-Pre]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Description

The Remove-AzureRmPolicyDefinition cmdlet removes a policy definition.

Examples

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.

Required Parameters

-Id

Specifies the fully qualified resource ID for the policy definition that this cmdlet removes.

Type:String
Aliases:ResourceId
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Name

Specifies the name of the policy definition that this cmdlet removes.

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

Optional Parameters

-ApiVersion

Specifies the version of the resource provider API to use. If you do not specify a version, this cmdlet uses the latest available version.

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

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-Force

Forces the command to run without asking for user confirmation.

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

Specifies how this cmdlet responds to an information event.

The acceptable values for this parameter are:

  • Continue
  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationVariable

Specifies an information variable.

Type:String
Aliases:iv
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Pre

Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use.

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

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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