Set-AipServiceKeyProperties

更新 Azure 資訊保護租使用者金鑰組象的屬性。

Syntax

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

Description

Set-AipServiceKeyProperties Cmdlet 會將租使用者指定索引鍵物件的 Archived 狀態變更為 [作用中]。 因為一次只能有一個作用中的租使用者金鑰,所以先前的作用中租使用者金鑰會自動設定為 [封存]。

Azure 資訊保護的新使用者會立即使用已識別的租使用者金鑰來保護內容。 服務的現有使用者會逐漸從先前的作用中租使用者金鑰轉換至新作用中的租使用者金鑰,而這項錯開的轉換可能需要幾周的時間才能完成。 您可以重新初始化使用者環境,以強制用戶端更新, (也稱為啟動載入) 。 使用先前作用中租使用者金鑰保護的檔和檔案,現在使用封存的租使用者金鑰,仍可供授權的使用者存取。

將租使用者金鑰組象狀態設定為 [作用中] 也會使用新作用中的租使用者金鑰來重新簽署所有保護範本。 由於這可以是耗時的作業,特別是如果您有許多保護範本,我們建議您經常執行此作業。

若要執行此 Cmdlet,您必須為要設定為 [作用中] 的租使用者金鑰組象指定 KeyIdentifier。 若要取得此值,請使用 Get-AipServiceKeys Cmdlet。

除非您正在從 AD RMS 移轉,否則請勿啟用 1024 位 RSA 金鑰,這被視為保護層級不足。 Microsoft 不會背書使用較低的金鑰長度,例如 1024 位 RSA 金鑰,以及提供不足保護層級的通訊協定相關使用,例如 SHA-1。 建議移至較高的金鑰長度。

注意

您無法使用此 Cmdlet 將 [使用中] 狀態變更為 [封存]。 若要將租使用者金鑰組象設定為 [封存] 狀態,您必須將另一個租使用者金鑰組象設定為 [作用中]。

如需租使用者金鑰的詳細資訊,請參閱規劃和實作 Azure 資訊保護租使用者金鑰

範例

範例 1:將租使用者金鑰組象的狀態變更為作用中

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

此命令會將租使用者金鑰組象的狀態從[封存]變更為[使用中]。KeyIdentifier參數會識別要變更的租使用者金鑰組象,而且執行Get-AipServiceKeys即可找到此值。 先前狀態為 [作用中] 的租使用者金鑰組象會自動設定為 [封存]。

因為命令指定 Force 參數,所以命令不會提示您確認。

參數

-Active

設定租使用者金鑰組象的狀態。

此參數只能與 $True的值搭配使用,這會將狀態設定為 [使用中]。 如果您想要將租使用者金鑰組象的狀態變更為 Archived,則必須將另一個租使用者金鑰組象設定為 [作用中]。

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

-Confirm

在執行 Cmdlet 前提示您確認。

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

顯示執行 Cmdlet 後會發生的情況。 Cmdlet 並不會執行。

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