Share via

Export-AipServiceTemplate

  • Reference
Module:
AIPService

Exports the properties of a protection template from Azure Information Protection to a file.

Syntax

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

Description

The Export-AipServiceTemplate cmdlet exports all the properties of a protection template from Azure Information Protection to a file. You can then import the template to another tenant using Azure Information Protection, or you can edit the exported template 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 protection templates in the Azure portal, you must use PowerShell to export and import these templates.

Tip

Consider using this cmdlet as a way to back up your protection 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-AipServiceTemplate cmdlet to get the GUIDs of all templates.

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

Using the Azure Information Protection unified labeling client?

The Azure Information Protection unified labeling client uses protection templates indirectly. If you have the unified labeling client, we recommend that you use label-based cmdlets instead of modifying your protection templates directly.

For more information, see Create and publish sensitivity labels in the Microsoft 365 documentation.

Examples

Example 1: Export a template

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

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

Parameters

-Force

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

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

-Path

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

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

-TemplateId

Specifies the GUID of a protection template.

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