Set-AipServiceKeyProperties
Azure Information Protection のテナント キー オブジェクトのプロパティを更新します。
構文
Default (既定)
Set-AipServiceKeyProperties
[-Force]
-KeyIdentifier <String>
-Active <Boolean>
[-WhatIf]
[-Confirm]
[-RefreshSlcName]
[<CommonParameters>]
説明
Set-AipServiceKeyProperties コマンドレットは、テナントの指定したキー オブジェクトのアーカイブ済み状態をアクティブに変更します。 アクティブなテナント キーは一度に 1 つだけ存在できるため、以前にアクティブだったテナント キーは自動的に [アーカイブ済み] に設定されます。
Azure Information Protection の新しいユーザーは、識別されたテナント キーをすぐに使用してコンテンツを保護します。 サービスの既存のユーザーは、以前にアクティブだったテナント キーから新しくアクティブなテナント キーに徐々に移行します。この移行が完了するまでに数週間かかる場合があります。 ユーザー環境 (ブートストラップとも呼ばれます) を再初期化することで、クライアントで強制的に更新を行うことができます。 以前にアクティブなテナント キーで保護されたドキュメントとファイルは、現在アーカイブされているテナント キーを使用して、承認されたユーザーから引き続きアクセスできます。
テナント キー オブジェクトの状態を [アクティブ] に設定すると、新しくアクティブなテナント キーを持つすべての保護テンプレートも再署名されます。 これは時間のかかる操作になる可能性があるため、特に多くの保護テンプレートがある場合は、この操作を頻繁に実行しないことをお勧めします。
このコマンドレットを実行するには、Active に設定するテナント キー オブジェクトの KeyIdentifier を指定する必要があります。 この値を取得するには、Get-AipServiceKeys コマンドレットを使用します。
AD RMS からの移行中でない限り、不適切なレベルの保護と見なされる 1024 ビット RSA キーをアクティブ化しないでください。 Microsoft は、1024 ビット RSA キーなどの下位のキー長の使用と、SHA-1 などの不適切なレベルの保護を提供するプロトコルの関連する使用を保証していません。 キーの長さを大きくすることをお勧めします。
注
このコマンドレットを使用して、アーカイブするアクティブな状態を変更することはできません。 状態が [アーカイブ済み] のテナント キー オブジェクトを設定するには、別のテナント キー オブジェクトを [アクティブ] に設定する必要があります。
テナント キーの詳細については、「Azure Information Protection テナント キーの計画と実装」を参照してください。
例
例 1: テナント キー オブジェクトの状態をアクティブに変更する
PS C:\> Set-AipServiceKeyProperties -Force -KeyIdentifier "c0f102b3-02cc-4816-b732-fcee73edd0e6" -Active $True
このコマンドは、テナント キー オブジェクトの状態を
コマンドは Force パラメーターを指定するため、確認を求めるメッセージは表示されません。
例 2: テナントのフレンドリ名を反映するように SLC を更新する
PS C:\> Set-AipServiceKeyProperties -KeyIdentifier "c0f102b3-02cc-4816-b732-fcee73edd0e6" -RefreshSlcName
このコマンドは、Azure Active Directory から現在のテナントフレンドリ名を取得し、ユーザー キーに同じ名前が反映されるように SLC を更新します。
パラメーター
-Active
テナント キー オブジェクトの状態を設定します。
このパラメーターは、
パラメーターのプロパティ
| 型: | Boolean |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Force
ユーザーの確認を求めずにコマンドを強制的に実行します。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-KeyIdentifier
テナント キー オブジェクトのキー識別子を指定します。 この値を取得するには、Get-AipServiceKeys
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-RefreshSlcName
テナントフレンドリ名を反映するようにユーザー キー (SLC) を更新します。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。