Set-SPSiteSubscriptionIRMConfig

Sets the Information Rights Management (IRM) settings.

Syntax

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

Description

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

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.

Examples

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

site = Get-SPSite  HYPERLINK "https://<myspserver>" https:// <myspserver>

C:\PS>$subscription = $site.SiteSubscription

Set-SPSiteSubscriptionIRMConfig -Identity $subscription -IrmEnabled -CertificateServerUrl https:// <rmsserver>

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

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

site = Get-SPSite  HYPERLINK "https://myspserver" https:// <myspserver>

C:\PS>$subscription = $site.SiteSubscription

Set- SPSiteSubscriptionIRMConfig -Identity $subscription -IrmEnabled:$false

This example disables IRM for the tenant.

Parameters

-AssignmentCollection

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.

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.

Type:SPAssignmentCollection
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
-CertificateServerUrl

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

Type:Uri
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName, ByValue)
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
-Confirm

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

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
-Identity

Specifies a site subscription for a particular tenant.

Type:SPSiteSubscriptionPipeBind
Position:1
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
-IrmEnabled

Specifies whether IRM is enabled in the tenant.

The default value is false.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName, ByValue)
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
-PassThru

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

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019