Remove-AadrmTemplate

Deletes a Rights Management rights policy template.

Syntax

Remove-AadrmTemplate
      -TemplateId <Guid>
      [<CommonParameters>]

Description

Note

This cmdlet from the AADRM module is now deprecated. After July 15, 2020, this cmdlet name will be supported only as an alias to its replacement in the AIPService module.

For more information, see the overview page.

The Remove-AadrmTemplate cmdlet deletes an Azure Rights Management protection template.

You can delete only custom templates. You can set default templates to an archived state but you cannot delete them.

Although you can configure Rights Management templates in the Azure portal, you must use PowerShell to remove these templates.

To ensure that previously protected content can be opened and used as intended by administrators, we usually advise against deleting templates. As a best practice, delete templates only if you are sure they were not used to protect documents or emails in production. Users who are super users can continue to access content that was previously protected with a template that is now deleted. For more information about super users, see Configuring super users for Azure Rights Management and discovery services or data recovery.

This cmdlet requires the template ID, which you can get with the Get-AadrmTemplate cmdlet.

This cmdlet performs the following operations:

  • Displays the template properties.

  • Warns that all content protected with this template may become inaccessible.

  • Asks to confirm whether to proceed.

  • Calls the service to remove the template with the specified GUID.

For more information about custom templates, including how to configure them in the Azure portal, see Configuring and managing templates for Azure Information Protection.

Examples

Example 1: Delete a template

PS C:\>Remove-AadrmTemplate -TemplateId 36546649-4944-4462-a409-74373a67b6dd

This command deletes the specified template.

Parameters

-TemplateId

Specifies the GUID of the Rights Management template.

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