Export (0) Print
Expand All

Set-SPSiteSubscriptionIRMConfig

SharePoint 2013

Published: July 16, 2012

Applies to:  SharePoint Server 2013 Enterprise 

Sets the Information Rights Management (IRM) settings.

Set-SPSiteSubscriptionIRMConfig [-Identity] <SPSiteSubscriptionPipeBind> -IrmEnabled <SwitchParameter> [-AssignmentCollection <SPAssignmentCollection>] [-CertificateServerUrl <Uri>] [-Confirm [<SwitchParameter>]] [-PassThru <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.SharePoint.PowerShell.SPSiteSubscriptionPipeBind

Specifies a site subscription for a particular tenant.

IrmEnabled

Required

System.Management.Automation.SwitchParameter

Specifies whether IRM is enabled in the tenant.

The default value is false.

AssignmentCollection

Optional

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

noteNote:

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

CertificateServerUrl

Optional

System.Uri

Specifies the address of the RMS certificate server to use for the tenant.

Confirm

Optional

System.Management.Automation.SwitchParameter

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

PassThru

Optional

System.Management.Automation.SwitchParameter

Specifies that the output object can be passed through the pipeline.

WhatIf

Optional

System.Management.Automation.SwitchParameter

Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters

Detailed Description

Use the Identity parameter of the Set-SPSiteSubscriptionIRMConfig cmdlet to set the IRM setting for a specified tenant.

Input Types

Return Types

--------------EXAMPLE 1------------

site = Get-SPSite  HYPERLINK "http://<myspserver>" http:// <myspserver>
$subscription = $site.SiteSubscription
Set-SPSiteSubscriptionIRMConfig -Identity $subscription –IrmEnabled –CertificateServerUrl http:// <rmsserver>

This example enables IRM for the tenant and configures it to use the specified RMS server.

--------------EXAMPLE 2------------

site = Get-SPSite  HYPERLINK "http://myspserver" http:// <myspserver>
$subscription = $site.SiteSubscription
Set- SPSiteSubscriptionIRMConfig -Identity $subscription –IrmEnabled:$false

This example disables IRM for the tenant.

Change History

Date Description

July 16, 2012

Initial publication

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