[This topic is in progress.]

Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2

Topic Last Modified: 2011-05-07

This cmdlet is available only in the cloud-based service.

Use the Set-RMSTemplate cmdlet to modify the properties of an existing rights management services (RMS) template in your organization.

Syntax

Set-RMSTemplate -Identity <RmsTemplateIdParameter> -Type <Archived | Distributed | All> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Organization <OrganizationIdParameter>] [-WhatIf [<SwitchParameter>]]

Detailed Description

RMS templates exist in one or more trusted publishing domains (TPDs) that have been imported from an on-premises server running Microsoft Active Directory Rights Management Services (AD RMS).

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.RmsTemplateIdParameter

The Identity parameter specifies the RMS template. You can use any value that uniquely identifies the RMS template. For example:

  • Name

  • GUID

You can use the Get-RMSTemplate cmdlet to view the RMS templates in your organization.

Type

Required

Microsoft.Exchange.Security.RightsManagement.RmsTemplateType

The Type parameter specifies the type of RMS template. You can specify one of the following values:

  • Archived

  • Distributed

The default type for imported RMS templates is Archived.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is reserved for internal Microsoft use.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

This parameter is reserved for internal Microsoft use.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

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.

Errors

Error Description

 

Examples

EXAMPLE

This example changes the RMS template named "Contoso Confidential" from Distributed to Archived. This prevents future use of "Contoso Confidential" for encryption, but allows access to existing content that is rights-protected by "Contoso Confidential".

Copy Code 
Set-RMSTemplate "Contoso Confidential" -Type Archived