Applies to: Exchange Server 2013
Topic Last Modified: 2012-07-12
Use the Get-RMSTemplate cmdlet to retrieve the current list of active rights policy templates from the Active Directory Rights Management Services (AD RMS) deployment for the organization.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Get-RMSTemplate [-Organization
<OrganizationIdParameter>] [-DomainController <Fqdn>]
[-Identity <RmsTemplateIdParameter>] [-ResultSize
<Unlimited>] [-TrustedPublishingDomain
<RmsTrustedPublishingDomainIdParameter>] [-Type <Archived
| Distributed | All>]
|
Examples
EXAMPLE 1
This example retrieves all RMS templates available from the RMS deployment.
 Copy Code |
|
|---|---|
Get-RMSTemplate -ResultSize unlimited |
|
EXAMPLE 2
This example retrieves the Company Confidential RMS template.
| Copy Code |
|
|---|---|
Get-RMSTemplate -Identity "Company Confidential" |
|
Detailed Description
 Note: |
|---|
| The Get-RMSTemplate cmdlet doesn't return any active rights policy templates if internal licensing isn't enabled. Use the Get-IRMConfiguration cmdlet to check the InternalLicensingEnabled parameter. |
You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Information Rights Management (IRM) configuration" entry in the Messaging Policy and Compliance Permissions topic.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory. |
|
Identity |
Optional |
Microsoft.Exchange.Configuration.Tasks.RmsTemplateIdParameter |
The Identity parameter specifies the name of the RMS template. |
|
Organization |
Optional |
Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter |
The Organization parameter is reserved for internal Microsoft use. |
|
ResultSize |
Optional |
Microsoft.Exchange.Data.Unlimited |
The ResultSize parameter specifies the maximum number of
results to return. The default value is |
|
TrustedPublishingDomain |
Optional |
Microsoft.Exchange.Configuration.Tasks.RmsTrustedPublishingDomainIdParameter |
This parameter applies to objects in the cloud-based service. It isn’t available for on-premises deployments. The TrustedPublishingDomain parameter specifies the trusted publishing domain you want to search for RMS templates. You can use any value that uniquely identifies the trusted publishing domain, for example:
|
|
Type |
Optional |
Microsoft.Exchange.Security.RightsManagement.RmsTemplateType |
This parameter applies to objects in the cloud-based service. It isn’t available for on-premises deployments. The Type parameter specifies the type of RMS template. Use one of the following values:
|
Input Types
To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.
Return Types
To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.