Register-SecretVault

Ссылка

Модуль:: Microsoft.PowerShell.SecretManagement

Регистрирует модуль хранилища расширений 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указывает имя Key Vault в Azure.
SubscriptionIdуказывает идентификатор подписки, в которой создается Key Vault

Параметры

-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

Выходные данные