Export-​Aadrm​Template

Exports the properties of a rights policy template to a file.

Syntax

Export-AadrmTemplate
      [-Force]
      -Path <String>
      -TemplateId <Guid>
      [<CommonParameters>]

Description

The Export-AadrmTemplate cmdlet exports all the properties of a Rights Management template to a file. You can then import the template to another Azure Rights Management tenant or you can edit it and import it back to the original tenant. You can use this technique to perform bulk edits of complex properties in templates, such as multilingual names and descriptions.

Although you can configure Rights Management templates in the Azure classic portal, you must use PowerShell to export and import these templates.

Tip: Consider using this cmdlet as a way to back up your custom templates, so that you can revert to a known-good version if required.

The export process does not automatically append a file name extension, so you can specify a file name extension to match the application that you will use to view and edit the resulting data.

You can use the Get-AadrmTemplate cmdlet to get the GUIDs of all templates.

For more information about custom templates, including how to configure them in the Azure classic portal, see Configuring custom templates for the Azure Rights Management service.

Examples

Example 1: Export a template

PS C:\>Export-AadrmTemplate -Path "C:\MyTemplates\MyTemplateFile.xml" -TemplateId 28168524-29c3-44f1-9e11-ea6c60bb6428

This command exports the specified template to the file named MyTemplateFile.xml.

Required Parameters

-Path

Specifies the path to the location where you want to save the file.

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

Specifies the GUID of an Rights Management template.

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

Optional Parameters

-Force

Indicates that the cmdlet overwrites an existing template file that has the same path.

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