Register-SecretVault
註冊目前使用者的 SecretManagement 擴充功能保存庫模組。
語法
Default (預設值)
Register-SecretVault
[-ModuleName] <String>
[[-Name] <String>]
[-VaultParameters <Hashtable>]
[-DefaultVault]
[-AllowClobber]
[-PassThru]
[-Description <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
此 Cmdlet 會將 SecretManagement 擴充功能保存庫新增至目前使用者的保存庫登錄。 擴充功能保存庫是符合所需擴充保存庫格式的 PowerShell 模組。 此 Cmdlet 會先確認指定的模組符合一致性需求,再將它新增至擴充保存庫登錄。 擴展保險庫註冊到當前使用者,不會影響其他使用者保險庫註冊。
使用此 cmdlet 註冊的第一個保管庫會自動定義為預設保管庫,即使未指定 DefaultVault 參數也是如此。
範例
範例 1
Register-SecretVault -Name LocalStore -ModuleName Microsoft.PowerShell.SecretStore -DefaultVault
Get-SecretVault
VaultName ModuleName IsDefaultVault
--------- ---------- --------------
CredMan Microsoft.PowerShell.CredManStore False
LocalStore Microsoft.PowerShell.SecretStore True
此範例會為目前用戶註冊 Microsoft.PowerShell.SecretStore 擴充功能保存庫。
它會使用 DefaultVault 參數,將已註冊的保存庫設為用戶的默認保存庫。
Get-SecretVault 會列出使用者的所有已註冊保存庫,確認保存庫已註冊並設定為預設保存庫。
範例 2
$parameters = @{
Name = 'Azure'
ModuleName = 'Az.KeyVault'
VaultParameters = @{
AZKVaultName = 'AzureKeyVault'
SubscriptionId = (Get-AzContext).Subscription.Id
}
DefaultVault = $true
}
Register-SecretVault @parameters
Get-SecretVault
Name ModuleName IsDefaultVault
---- ---------- --------------
Azure Az.KeyVault True
此範例會為目前用戶註冊 Az.KeyVault 擴充功能保存庫。 必須先在先前安裝 az.KeyVault 模組。 針對 VaultParameters:
-
AZKVaultName 指定 Azure 上的 Key Vault 名稱
-
SubscriptionId 指定在 中建立 Key Vault 的訂用帳戶標識碼
參數
-AllowClobber
如果指定,則允許 Cmdlet 以相同名稱覆寫現有的已註冊擴充功能保存庫。
參數屬性
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Confirm
在執行 Cmdlet 之前,提示您進行確認。
參數屬性
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-DefaultVault
如果指定,請將新的擴充功能保存庫設定為目前用戶的預設保存庫。
參數屬性
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Description
描述保存庫。 此值包含在保存庫登錄資訊中。
參數屬性
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-ModuleName
指定實作擴充保存庫的PowerShell模組名稱。 輸入模組的名稱或模組的路徑。 如果您指定名稱,PowerShell 會在已知的模組路徑中搜尋它。 如果您指定路徑,PowerShell 會搜尋該模組的路徑。
參數屬性
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 1 |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Name
指定擴充功能保存庫的名稱。 如果未指定名稱,則會使用模組名稱作為保存庫名稱。
參數屬性
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 0 |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-PassThru
指出 Cmdlet 應該針對成功註冊的擴充保存庫傳回 SecretVaultInfo 物件。 默認情況下,此 cmdlet 不返回任何輸出。
參數屬性
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-VaultParameters
指定 Hashtable 物件,其中包含擴充保存庫用來做為參數的選擇性索引鍵/值組。 這些參數是選擇性的。 請參閱保存庫擴充模組的檔,以查看需要哪些值。
參數屬性
| 類型: | Hashtable
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-WhatIf
顯示 Cmdlet 執行時會發生什麼事。 該 Cmdlet 未被執行。
參數屬性
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
CommonParameters
此 Cmdlet 支援一般參數:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊,請參閱 about_CommonParameters。
None
輸出
None