Export (0) Print
Expand All
Expand Minimize

Import-RMSTrustedPublishingDomain

Exchange Online
 

Applies to: Exchange Online

Topic Last Modified: 2013-01-14

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

Use the Import-RMSTrustedPublishingDomain cmdlet to import a trusted publishing domain (TPD) from an on-premises server running Active Directory Rights Management Services (AD RMS) or from RMS Online into your cloud-based organization.

For information about the parameter sets in the Syntax section below, see Syntax.

Import-RMSTrustedPublishingDomain -ExtranetLicensingUrl <Uri> -FileData <Byte[]> -IntranetLicensingUrl <Uri> -Password <SecureString> <COMMON PARAMETERS>
Import-RMSTrustedPublishingDomain -FileData <Byte[]> -Password <SecureString> [-RefreshTemplates <SwitchParameter>] <COMMON PARAMETERS>
Import-RMSTrustedPublishingDomain -ExtranetLicensingUrl <Uri> -FileData <Byte[]> -IntranetLicensingUrl <Uri> -Password <SecureString> [-ExtranetCertificationUrl <Uri>] [-IntranetCertificationUrl <Uri>] <COMMON PARAMETERS>
Import-RMSTrustedPublishingDomain -RMSOnline <SwitchParameter> [-RefreshTemplates <SwitchParameter>] [-RMSOnlineAuthCertSubjectNameOverride <String>] [-RMSOnlineOrgOverride <Guid>] <COMMON PARAMETERS>
Import-RMSTrustedPublishingDomain -RMSOnlineConfig <Byte[]> -RMSOnlineKeys <Hashtable> [-RMSOnlineAuthorTest <Hashtable>] <COMMON PARAMETERS>
COMMON PARAMETERS: -Name <String> [-Confirm [<SwitchParameter>]] [-Default <SwitchParameter>] [-DomainController <Fqdn>] [-Organization <OrganizationIdParameter>] [-WhatIf [<SwitchParameter>]]

This example imports a TPD from an AD RMS server into a cloud-based organization. The TPD uses the following values:

  • Path to exported XML file   C:\My Documents\Contoso.xml

  • Password of exported XML file   Pa$$word1

  • External licensing URL   https://rms.contoso.com/_wmcs/licensing

  • Internal licensing URL   https://RMS01/_wmcs/licensing

  • TPD name   Contoso TPD

Import-RMSTrustedPublishingDomain -Name "Contoso TPD" -FileData $([byte[]](Get-Content -Encoding byte -Path "C:\My Documents\Contoso.xml" -ReadCount 0)) -Password (ConvertTo-SecureString -String 'Pa$$word1' -AstPlainText -Force)-ExtranetLicensingUrl https://rms.contoso.com/_wmcs/licensing -IntranetLicensingUrl https://RMS01/_wmcs/licensing

A TPD contains the settings needed to use RMS features in your organization. For example, users can apply RMS templates to email messages. After you export the TPD from an on-premises AD RMS server to an XML file, you can import the XML file into your cloud-based organization.

NoteNote:
You can import TPDs from AD RMS servers running on all versions of Windows Server 2008 and Windows Server 2003.

If the InternalLicensingEnabled parameter value is $true on the Set-IRMConfiguration cmdlet, all TPDs require a private key. If the InternalLicensingEnabled parameter value is $false, TPDs don't require a private key. However, the only RMS feature available to the organization is Outlook protection rules. Typically, TPDs without private keys are created when the AD RMS server uses a hardware-based cryptographic service provider (CSP) or a custom CSP.

 

Parameter Required Type Description

ExtranetLicensingUrl

Required

System.Uri

The ExtranetLicensingUrl parameter specifies the external licensing URL of the on-premises AD RMS server that's stamped into the publishing license. The publishing license specifies the users that can open the rights-protected content, under which conditions the content may be opened by the user, and the rights that each user will have to the rights-protected content.

By default, the value of the ExtranetLicensingUrl parameter is https://<FQDN>/_wmcs/licensing.

FileData

Required

System.Byte[]

The FileData parameter specifies the XML file you want to import. The XML file contains the TPD you exported from the on-premises AD RMS server.

You need to read the file to a byte-encoded object using the Get-Content cmdlet, for example, -FileData $([byte[]](Get-Content -Encoding byte -Path "C:\My Documents\contoso.xml" -ReadCount 0)).

IntranetLicensingUrl

Required

System.Uri

The IntranetLicensingUrl parameter specifies the internal licensing URL of the on-premises AD RMS server that's stamped into the publishing license. The publishing license specifies the users that can open the rights-protected content, under which conditions the content may be opened by the user, and the rights that each user will have to the rights-protected content.

By default, the value of the IntranetLicensingUrl parameter is https://<server name>/_wmcs/licensing.

Name

Required

System.String

The Name parameter specifies the name of the TPD. If you use the RefreshTemplates parameter, the value must match the name of the previously imported TPD.

Password

Required

System.Security.SecureString

The Password parameter specifies the password of the TPD that you want to import. You must specify the value for this parameter in a secure format, for example, (ConvertTo-SecureString -String '<password>' -AsPlainText -Force).

The password value must match the password in the XML file when you exported the TPD from the on-premises AD RMS server.

RMSOnline

Required

System.Management.Automation.SwitchParameter

The RMSOnline switch specifies that the TPD is imported from RMS Online. This parameter is only available in Microsoft Exchange Online organizations.

RMSOnlineConfig

Required

System.Byte[]

This parameter is reserved for internal Microsoft use.

RMSOnlineKeys

Required

System.Collections.Hashtable

This parameter is reserved for internal Microsoft use.

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.

Default

Optional

System.Management.Automation.SwitchParameter

The Default parameter specifies that this is the default TPD. The default TPD displays RMS templates and provides rights protection to all new content. There can be only one default TPD in an organization.

The first TPD you import into your organization is automatically set as the default.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is reserved for internal Microsoft use.

ExtranetCertificationUrl

Optional

System.Uri

The ExtranetCertificationUrl parameter specifies the external certification URL of the on-premises AD RMS server that's stamped into the Rights Account Certificate (RAC). The RAC establishes a user's identity in the AD RMS system, and is used to decrypt content.

By default, the value of the ExtranetCertificationUrl parameter is https://<FQDN>/_wmcs/certification/servercertification.asmx.

IntranetCertificationUrl

Optional

System.Uri

The IntranetCertificationUrl parameter specifies the internal certification URL of the on-premises AD RMS server that's stamped into the RAC. The RAC establishes a user's identity in the AD RMS system, and is used to decrypt content.

By default, the value of the IntranetCertificationUrl parameter is https://<server name>/_wmcs/certification/servercertification.asmx.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

This parameter is reserved for internal Microsoft use.

RefreshTemplates

Optional

System.Management.Automation.SwitchParameter

The RefreshTemplates parameter specifies whether to update the RMS templates in a previously imported TPD. When you add, modify, or remove RMS templates in a TPD on the AD RMS server, you export the updated TPD to a new XML file, and import the new XML file in your cloud-based organization. The RefreshTemplates parameter uses the following rules:

  • Only the FileData, Password, and Name parameters are required. The value of the Name parameter must match the name of the previously imported TPD.

  • If the new XML file doesn't contain an RMS template that was defined in the previously imported TPD, the RMS template is removed from the cloud-based organization.

  • If the new XML file contains an updated RMS template that was defined in the previously imported TPD, the RMS template settings are updated in the cloud-based organization. However, the RMS template isn't changed from Archived to Distributed or vice versa.

  • If the new XML file contains an RMS template that wasn't imported in the original TPD, the RMS template is added to the cloud-based organization in the Archived state. To make the new RMS template usable, you must change its state from Archived to Distributed using the Set-RMSTemplate cmdlet.

RMSOnlineAuthCertSubjectNameOverride

Optional

System.String

This parameter is reserved for internal Microsoft use.

RMSOnlineAuthorTest

Optional

System.Collections.Hashtable

This parameter is reserved for internal Microsoft use.

RMSOnlineOrgOverride

Optional

System.Guid

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.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft