Set-SPIRMSettings
Information Rights Management (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>]説明
このコマンドレットには、複数のパラメーター セットが含まれています。 使用できるのは、1 つのパラメーター セットのパラメーターだけであり、異なるパラメーター セットのパラメーターを組み合わせることはできません。 パラメーター セットの使用法に関する詳しい情報については、「コマンドレットのパラメーター セット」を参照してください。
コマンドレットを Set-SPIRMSettings 使用して、テナントの Information Rights Management (IRM) 設定を設定します。
Windows PowerShell for SharePoint 製品のアクセス許可と最新情報については、「SharePoint Server コマンドレット」のオンライン ドキュメントをご覧ください。
例
-------------- 例 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 オブジェクトを使用して、変数へのオブジェクトの割り当てとオブジェクトの破棄を行うことができます。 割り当てコレクションまたは Global パラメーターが使用されていない場合、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
サービス認証証明書を指定します。
このパラメーターに null でない値を指定した場合は、このファームから 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 |