.png)
Set-RMSTemplate
Applies to: Exchange Server 2013
Topic Last Modified: 2012-09-17
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.
For information about the parameter sets in the Syntax section below, see Syntax.
Set-RMSTemplate -Identity <RmsTemplateIdParameter> -Type <Archived | Distributed | All> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Organization <OrganizationIdParameter>] [-WhatIf [<SwitchParameter>]]
This example changes the RMS template Contoso Confidential from Distributed to Archived. This prevents future use of Contoso Confidential for encryption, but allows access to existing content that's rights-protected by Contoso Confidential.
Set-RMSTemplate "Contoso Confidential" -Type Archived
RMS templates exist in one or more trusted publishing domains (TPDs) that have been imported from an on-premises server running Active Directory Rights Management Services (AD RMS).
| 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:
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:
The default type for imported RMS templates is |
| 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. |
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.
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.
