Register-SecretVault
現在のユーザーの SecretManagement 拡張機能コンテナー モジュールを登録します。
構文
Register-SecretVault
[-ModuleName] <String>
[[-Name] <String>]
[-VaultParameters <Hashtable>]
[-DefaultVault]
[-AllowClobber]
[-PassThru]
[-Description <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 説明
このコマンドレットは、 SecretManagement 拡張機能コンテナーを現在のユーザーのコンテナー レジストリに追加します。 拡張機能コンテナーは、必要な拡張コンテナー形式に準拠した PowerShell モジュールです。 このコマンドレットは、指定したモジュールが拡張機能コンテナー レジストリに追加する前に、準拠要件を満たしていることを確認します。 拡張機能コンテナーは現在のユーザーに登録され、他のユーザー コンテナーの登録には影響しません。
このコマンドレットに登録された最初のコンテナーは、 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が作成されるサブスクリプションの ID を指定します
パラメーター
-AllowClobber
指定した場合、コマンドレットは同じ名前で既存の登録済み拡張コンテナーを上書きできます。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultVault
指定した場合は、新しい拡張機能コンテナーを現在のユーザーの既定のコンテナーとして設定します。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
コンテナーについて説明します。 この値は、コンテナー レジストリ情報に含まれています。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ModuleName
拡張機能コンテナーを実装する PowerShell モジュールの名前を指定します。 モジュールの名前またはモジュールへのパスを入力します。 名前を指定すると、PowerShell は既知のモジュール パスで検索します。 パスを指定すると、PowerShell はそのパスでモジュールを検索します。
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
拡張コンテナーの名前を指定します。 名前が指定されていない場合は、コンテナー名としてモジュール名が使用されます。
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PassThru
コマンドレットが正常に登録された拡張機能コンテナーの SecretVaultInfo オブジェクトを返す必要があることを示します。 既定では、このコマンドレットは出力を返しません。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VaultParameters
拡張コンテナーによってパラメーターとして使用されるオプションのキーと値のペアを含む Hashtable オブジェクトを指定します。 これらのパラメーターは省略可能です。 必要な値を確認するには、コンテナー拡張機能モジュールのドキュメントを参照してください。
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
入力
None
出力
None
PowerShell