Set-SPIRMSettings
配置信息权限管理 (IRM) 设置。
语法
Set-SPIRMSettings
-CertificateServerUrl <Uri>
[-IrmEnabled]
[-AssignmentCollection <SPAssignmentCollection>]
[-CertificatePassword <SecureString>]
[-Confirm]
[-ServiceAuthenticationCertificate <X509Certificate2>]
[-SubscriptionScopeSettingsEnabled]
[-WhatIf]
[-UseOauth]
[<CommonParameters>]
Set-SPIRMSettings
[-IrmEnabled]
[-AssignmentCollection <SPAssignmentCollection>]
[-CertificatePassword <SecureString>]
[-Confirm]
[-ServiceAuthenticationCertificate <X509Certificate2>]
[-SubscriptionScopeSettingsEnabled]
[-UseActiveDirectoryDiscovery]
[-WhatIf]
[-UseOauth]
[<CommonParameters>]
说明
此 cmdlet 包含多个参数集。 只能使用一个参数集中的参数,而不能结合使用不同参数集中的参数。 若要详细了解如何使用参数集,请参阅 Cmdlet 参数集。
Set-SPIRMSettings
使用 cmdlet 设置租户的信息权限管理 (IRM) 设置。
有关适用于 SharePoint 产品的 Windows PowerShell 的权限和最新信息,请参阅 SharePoint Server cmdlet。
示例
--------------示例 1------------
Set-SPIRMSettings -RmsEnabled -UseActiveDirectoryDiscovery
此示例为服务器场启用 IRM 并将其配置为使用 Active Directory 中配置的默认 RMS 服务器。
--------------示例 2------------
Set-SPIRMSettings -RmsEnabled -CertificateServerUrl https://myrmsserver
此示例为服务器场启用 IRM 并指定要使用的 RMS 服务器的 URL。
--------------示例 3------------
site = Get-SPSite http://myspserver
$subscription = $site.SiteSubscription
Set-SPIRMSettings -SiteSubscription $subscription -RmsEnabled -CertificateServerUrl https://myrmsserver
此示例为指定租户启用 IRM 并指定要使用的 RMS 服务器的 URL。
--------------示例 4------------
Set-SPIRMSettings -RmsEnabled:$false
此示例为服务器场禁用 IRM。
参数
-AssignmentCollection
管理对象以便正确进行处理。 使用 SPWeb 或 SPSite 等对象可能会耗用大量内存,而且在 Windows PowerShell 脚本中使用这些对象需要正确管理内存。 通过使用 SPAssignment 对象,可以将对象分配给变量,然后在不需要这些对象时对它们进行处理,以释放内存。 在使用 SPWeb、SPSite 或 SPSiteAdministration 对象时,如果不使用分配集合或 Global 参数,则会自动处理这些对象。
使用全局参数时,所有对象均包含在全局存储中。
如果未立即使用对象,或未通过使用 Stop-SPAssignment
命令来处理对象,则可能会发生内存不足的情况。
Type: | SPAssignmentCollection |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Applies to: | SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-CertificatePassword
指定用于访问服务身份验证证书的密码。 必须有此密码才能在计算机证书存储中安装该证书。
Type: | SecureString |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-CertificateServerUrl
指定要用于租户的 RMS 证书服务器的地址。
Type: | Uri |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-Confirm
执行命令前,看到确认提示。
有关详细信息,请键入以下命令:get-help about_commonparameters
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-IrmEnabled
指定租户中是否启用 IRM。
默认值为 false。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-ServiceAuthenticationCertificate
指定服务身份验证证书。
如果指定此参数且其不为空,则在从此服务器场连接到 RMS 服务器时将使用该身份验证证书。 如果未指定此参数,则本地服务器场使用集成 Windows 身份验证连接到 RMS 服务器。
Type: | X509Certificate2 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-SubscriptionScopeSettingsEnabled
指定是否可在网站订阅范围内配置 IRM。
仅当在服务器场范围启用 IRM 时,网站订阅才能配置自定义 IRM 设置。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-UseActiveDirectoryDiscovery
指定是否应将 RMS 服务用于发现功能,该功能将确定 RMS 服务器在域中的地址。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-UseOauth
指定是否应使用 OAuth。
有效值为 True 和 False。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | SharePoint Server 2016, SharePoint Server 2019 |
-WhatIf
显示一条描述命令作用的消息,而不执行命令。
有关详细信息,请键入以下命令:get-help about_commonparameters
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |