Set-AipServiceKeyProperties

Azure Information Protectionのテナント キー オブジェクトのプロパティを更新します。

構文

Set-AipServiceKeyProperties
   [-Force]
   -KeyIdentifier <String>
   -Active <Boolean>
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

Set-AipServiceKeyProperties コマンドレットは、テナントがアクティブになる特定のキー オブジェクトのアーカイブ済み状態を変更します。 アクティブなテナント キーは一度に 1 つしか存在できないため、以前にアクティブだったテナント キーは自動的にアーカイブ済みに設定されます。

Azure Information Protectionの新しいユーザーは、識別されたテナント キーをすぐに使用してコンテンツを保護します。 サービスの既存のユーザーは、以前にアクティブだったテナント キーから新しくアクティブなテナント キーに徐々に移行します。この時間差移行の完了には数週間かかる場合があります。 ユーザー環境 (ブートストラップとも呼ばれます) を再初期化することで、クライアントに対して強制的に更新を行うことができます。 以前にアクティブだったテナント キーで保護されたドキュメントとファイルは、現在アーカイブされているテナント キーを使用して、承認されたユーザーから引き続きアクセスできます。

テナント キー オブジェクトの状態を [アクティブ] に設定すると、新しくアクティブなテナント キーを持つすべての保護テンプレートも削除されます。 これは時間のかかる操作になる可能性があるため、特に多くの保護テンプレートがある場合は、この操作を頻繁に実行することはお勧めしません。

このコマンドレットを実行するには、Active に設定するテナント キー オブジェクトの KeyIdentifier を指定する必要があります。 この値を取得するには、 Get-AipServiceKeys コマンドレットを 使用します。

AD RMS からの移行中でない限り、不適切なレベルの保護と見なされる 1024 ビット RSA キーをアクティブ化しないでください。 Microsoft は、1024 ビット RSA キーなどの低いキー長の使用と、SHA-1 などの不適切なレベルの保護を提供するプロトコルの関連する使用を推奨しません。 キーの長さを大きくすることをお勧めします。

Note

このコマンドレットを使用して、アーカイブするアクティブな状態を変更することはできません。 アーカイブ済みの状態にテナント キー オブジェクトを設定するには、別のテナント キー オブジェクトを Active に設定する必要があります。

テナント キーの詳細については、「Azure Information Protection テナント キーの計画と実装」を参照してください。

例 1: テナント キー オブジェクトの状態をアクティブに変更する

PS C:\> Set-AipServiceKeyProperties -Force -KeyIdentifier "c0f102b3-02cc-4816-b732-fcee73edd0e6" -Active $True

このコマンドは、テナント キー オブジェクトの状態を [アーカイブ済み] から [アクティブ] に変更します。 KeyIdentifier パラメーターは、変更するテナント キー オブジェクトを識別し、この値は Get-AipServiceKeys を実行して見つけることができます。 以前に 状態が Active だったテナント キー オブジェクトは、自動的に アーカイブ済みに設定されます。

このコマンドは Force パラメーターを指定するため、確認を求めるメッセージは表示されません。

パラメーター

-Active

テナント キー オブジェクトの状態を設定します。

このパラメーターは、状態をアクティブに設定する$Trueの値でのみ使用できます。 テナント キー オブジェクトの状態を アーカイブ済みに変更する場合は、別のテナント キー オブジェクトを Active に設定する必要があります。

Type:Boolean
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

ユーザーに確認せずに、直ちにコマンドを実行します。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-KeyIdentifier

テナント キー オブジェクトのキー識別子を指定します。 この値を取得するには、 Get-AipServiceKeys を実行します。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False