Set-AipServiceKeyProperties
更新 Azure 資訊保護的租使用者密鑰物件屬性。
語法
Set-AipServiceKeyProperties
[-Force]
-KeyIdentifier <String>
-Active <Boolean>
[-WhatIf]
[-Confirm]
[-RefreshSlcName]
[<CommonParameters>]
Description
Set-AipServiceKeyProperties Cmdlet 會將租使用者指定之密鑰物件的封存狀態變更為作用中。 因為一次只能有一個作用中的租使用者密鑰,因此先前作用中的租使用者密鑰會自動設定為 [封存]。
Azure 資訊保護的新使用者會立即使用識別的租使用者密鑰來保護內容。 服務的現有用戶會逐漸從先前的作用中租使用者密鑰轉換至新作用中的租使用者密鑰,而這個錯開的轉換可能需要數周的時間才能完成。 您可以藉由重新初始化使用者環境(也稱為啟動載入)來強制更新用戶端。 使用先前使用中租使用者密鑰保護的檔和檔案,現在使用封存的租使用者密鑰,仍可供已授權的使用者存取。
將租使用者金鑰物件狀態設定為 [作用中] 也會使用新作用中的租使用者密鑰來重新簽署所有保護範本。 由於這可以是耗時的作業,特別是如果您有許多保護範本,因此不建議您經常執行此作業。
若要執行此 Cmdlet,您必須為要設定為 Active 的租使用者密鑰物件指定 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
此命令會將租使用者密鑰物件的狀態從
因為命令會指定 Force 參數,因此命令不會提示您進行確認。
範例 2:重新整理 SLC 以反映租用戶易記名稱
PS C:\> Set-AipServiceKeyProperties -KeyIdentifier "c0f102b3-02cc-4816-b732-fcee73edd0e6" -RefreshSlcName
此命令會從 Azure Active Directory 擷取目前的租用戶易記名稱,並更新 SLC,讓使用者密鑰反映相同的名稱。
參數
-Active
設定租使用者金鑰物件的狀態。
此參數只能與 $True的值搭配使用,其會將狀態設定為 Active。 如果您要將租使用者金鑰物件的狀態變更為 Archived,則必須將另一個租使用者金鑰物件設定為 Active。
類型: | Boolean |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-Confirm
在執行 Cmdlet 之前,提示您進行確認。
類型: | SwitchParameter |
別名: | cf |
Position: | Named |
預設值: | False |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-Force
強制命令執行,而不要求使用者確認。
類型: | SwitchParameter |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-KeyIdentifier
指定租使用者金鑰物件的金鑰標識碼。 您可以執行 get-AipServiceKeys 來取得此值。
類型: | String |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-RefreshSlcName
重新整理使用者金鑰 (SLC) 以反映租使用者易記的名稱。
類型: | SwitchParameter |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-WhatIf
顯示 Cmdlet 執行時會發生什麼事。 Cmdlet 未執行。
類型: | SwitchParameter |
別名: | wi |
Position: | Named |
預設值: | False |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |