< Back
Get-AadrmTemplate
Post
NAME Get-AadrmTemplate
SYNOPSIS
Gets a list of Rights Management templates.
SYNTAX
Get-AadrmTemplate [-TemplateId <Guid>] [<CommonParameters>]
DESCRIPTION
The Get-AadrmTemplate cmdlet gets all existing or selected templates from the active Azure Rights Management
tenant. Use the TemplateID parameter to get a specific template. If you do not specify the TemplateId , all
templates are retrieved.
Similar configuration information can also be viewed in the Azure portal, but this cmdlet also returns the
template GUID that isn't available in the portal.
The cmdlet output is a list of template objects that contain all the template properties that you can use for
further processing. The output of this command displays the template GUID, name, and description in the current
locale. For additional template properties, such as usage rights and whether the template is published or
archived, use the Get-AadrmTemplateProperty cmdlets.
For more information about custom templates, including how to configure them in the Azure portal, see Configuring
and managing templates for Azure Information Protection
(https://docs.microsoft.com/information- ... -templates).
PARAMETERS
-TemplateId <Guid>
Specifies the GUID of an Rights Management template.
Required? false
Position? named
Default value None
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 (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
TemplateID
Specifies the GUID of the template to get.
OUTPUTS
This cmdlet outputs a list comprising all templates for the tenant, or for a selected template.
If no name is defined for a template in the current locale, "No name defined in language-code" is returned as
the name for that template.
If no description is defined for a template in the current locale, "No description defined in language-code"
is returned as the description for that template.
NOTES
----------------- Example 1: Get all templates -----------------
PS C:\\> Get-AadrmTemplate
This command gets all templates for your tenant, so you can get the template ID that you want to use, by
identifying the template by its name and description.
-------------- Example 2: Get a specific template --------------
PS C:\\> Get-AadrmTemplate -TemplateId 28168524-29c3-44f1-9e11-ea6c60bb6428
This command gets a specific template, specified by its template ID (GUID), so that you can confirm from its name
and description that it is the template that you want to use.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkID=400626
Add-AadrmTemplate
Export-AadrmTemplate
Import-AadrmTemplate
Remove-AadrmTemplate
SYNOPSIS
Gets a list of Rights Management templates.
SYNTAX
Get-AadrmTemplate [-TemplateId <Guid>] [<CommonParameters>]
DESCRIPTION
The Get-AadrmTemplate cmdlet gets all existing or selected templates from the active Azure Rights Management
tenant. Use the TemplateID parameter to get a specific template. If you do not specify the TemplateId , all
templates are retrieved.
Similar configuration information can also be viewed in the Azure portal, but this cmdlet also returns the
template GUID that isn't available in the portal.
The cmdlet output is a list of template objects that contain all the template properties that you can use for
further processing. The output of this command displays the template GUID, name, and description in the current
locale. For additional template properties, such as usage rights and whether the template is published or
archived, use the Get-AadrmTemplateProperty cmdlets.
For more information about custom templates, including how to configure them in the Azure portal, see Configuring
and managing templates for Azure Information Protection
(https://docs.microsoft.com/information- ... -templates).
PARAMETERS
-TemplateId <Guid>
Specifies the GUID of an Rights Management template.
Required? false
Position? named
Default value None
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 (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
TemplateID
Specifies the GUID of the template to get.
OUTPUTS
This cmdlet outputs a list comprising all templates for the tenant, or for a selected template.
If no name is defined for a template in the current locale, "No name defined in language-code" is returned as
the name for that template.
If no description is defined for a template in the current locale, "No description defined in language-code"
is returned as the description for that template.
NOTES
----------------- Example 1: Get all templates -----------------
PS C:\\> Get-AadrmTemplate
This command gets all templates for your tenant, so you can get the template ID that you want to use, by
identifying the template by its name and description.
-------------- Example 2: Get a specific template --------------
PS C:\\> Get-AadrmTemplate -TemplateId 28168524-29c3-44f1-9e11-ea6c60bb6428
This command gets a specific template, specified by its template ID (GUID), so that you can confirm from its name
and description that it is the template that you want to use.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkID=400626
Add-AadrmTemplate
Export-AadrmTemplate
Import-AadrmTemplate
Remove-AadrmTemplate