Set-SPIRMSettings
Sets the Information Rights Management (IRM) settings.
Syntax
UseSpecifiedCertificateUrl
Set-SPIRMSettings
-CertificateServerUrl <Uri>
[-IrmEnabled]
[-AssignmentCollection <SPAssignmentCollection>]
[-CertificatePassword <SecureString>]
[-Confirm]
[-ServiceAuthenticationCertificate <X509Certificate2>]
[-SubscriptionScopeSettingsEnabled]
[-WhatIf]
[-UseOauth]
[<CommonParameters>]
UseServiceDiscovery
Set-SPIRMSettings
[-IrmEnabled]
[-AssignmentCollection <SPAssignmentCollection>]
[-CertificatePassword <SecureString>]
[-Confirm]
[-ServiceAuthenticationCertificate <X509Certificate2>]
[-SubscriptionScopeSettingsEnabled]
[-UseActiveDirectoryDiscovery]
[-WhatIf]
[-UseOauth]
[<CommonParameters>]
Description
This cmdlet contains more than one parameter set. You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see Cmdlet parameter sets.
Use the Set-SPIRMSettings cmdlet to set the Information Rights Management (IRM) settings for the 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
Set-SPIRMSettings -RmsEnabled -UseActiveDirectoryDiscovery
This example enables IRM for the farm and configures it to use the default RMS server configured in Active Directory.
EXAMPLE 2
Set-SPIRMSettings -RmsEnabled -CertificateServerUrl https://myrmsserver
This example enables IRM for the farm and specifies the URL of the RMS server to use.
EXAMPLE 3
site = Get-SPSite http://myspserver
$subscription = $site.SiteSubscription
Set-SPIRMSettings -SiteSubscription $subscription -RmsEnabled -CertificateServerUrl https://myrmsserver
This example enables IRM for the specified tenant and specifies the URL of the RMS server to use.
EXAMPLE 4
Set-SPIRMSettings -RmsEnabled:$false
This example disables IRM for the farm.
Parameters
-AssignmentCollection
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
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.
Parameter properties
| Type: | SPAssignmentCollection |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-CertificatePassword
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the password to access the Service Authentication Certificate. This password is required in order to install the certificate in the machine certificate store.
Parameter properties
| Type: | SecureString |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-CertificateServerUrl
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the address of the RMS certificate server to use for the tenant.
Parameter properties
| Type: | Uri |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
UseSpecifiedCertificateUrl
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Prompts you for confirmation before executing the command.
For more information, type the following command: get-help about_commonparameters
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-IrmEnabled
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies whether or not IRM is enabled in the tenant.
The default value is false.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ServiceAuthenticationCertificate
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the service authentication certificate.
If the parameter is specified and not null, the authentication certificate is used when connecting from this farm to the RMS server. If the parameter is not specified, the local farm connects to RMS server using integrated windows authentication.
Parameter properties
| Type: | X509Certificate2 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SubscriptionScopeSettingsEnabled
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies whether or not IRM can be configured at the site subscription scope.
Site subscriptions can only configure custom IRM settings if IRM is enabled at the Farm scope.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UseActiveDirectoryDiscovery
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies whether or not the RMS service should be used for discovery that will determine the address of the RMS server in the ___domain.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
UseServiceDiscovery
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UseOauth
Applicable: SharePoint Server 2016, SharePoint Server 2019
Specifies whether OAuth should be used.
The valid values are True and False.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
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
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.