Register-SecretVault

構文

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

-Confirm

-DefaultVault

-Description

-ModuleName

-Name

-PassThru

-VaultParameters

-WhatIf

入力

None

出力

None