Register-SecretVault

Referência

Módulo:: Microsoft.PowerShell.SecretManagement

Registra um módulo do cofre de extensão SecretManagement para o usuário atual.

Syntax

Register-SecretVault
        [-ModuleName] <String>
        [[-Name] <String>]
        [-VaultParameters <Hashtable>]
        [-DefaultVault]
        [-AllowClobber]
        [-PassThru]
        [-Description <String>]
        [-WhatIf]
        [-Confirm]
        [<CommonParameters>]

Description

Esse cmdlet adiciona um cofre de extensão SecretManagement ao registro do cofre do usuário atual. Um cofre de extensões é um módulo do PowerShell que está em conformidade com o formato do cofre de extensão necessário. Esse cmdlet verifica se o módulo especificado atende aos requisitos de conformidade antes de adicioná-lo ao registro do cofre de extensões. Os cofres de extensão são registrados para o usuário atual e não afetam outros registros do cofre de usuários.

O primeiro cofre registrado com esse cmdlet é definido automaticamente como o cofre padrão, mesmo que o parâmetro DefaultVault não seja especificado.

Exemplos

Exemplo 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

Este exemplo registra um cofre de extensão Microsoft.PowerShell.SecretStore para o usuário atual. Ele usa o parâmetro DefaultVault para tornar o cofre registrado o cofre padrão para o usuário. Get-SecretVault lista todos os cofres registrados para o usuário, verificando se o cofre foi registrado e definido como o cofre padrão.

Exemplo 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

Este exemplo registra um cofre de extensão Az.KeyVault para o usuário atual. O módulo Az.KeyVault precisa ser instalado anteriormente. Para o VaultParameters:

AZKVaultNameespecifica o nome do Key Vault no Azure
SubscriptionIdespecifica a ID da assinatura em que o Key Vault é criado em

Parâmetros

-AllowClobber

Se especificado, permite que o cmdlet substitua um cofre de extensão registrado existente com o mesmo nome.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultVault

Se especificado, define o novo cofre de extensão como o cofre padrão para o usuário atual.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

Descreve o cofre. Esse valor está incluído nas informações do registro do cofre.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ModuleName

Especifica o nome do módulo do PowerShell que implementa o cofre de extensão. Insira o nome de um módulo ou o caminho para o módulo. Se você especificar um nome, o PowerShell o procurará nos caminhos de módulo conhecidos. Se você especificar um caminho, o PowerShell pesquisa esse caminho para o módulo.

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

Especifica o nome do cofre de extensão. Se nenhum nome for especificado, o nome do módulo será usado como o nome do cofre.

Type:	String
Position:	0
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PassThru

Indica que o cmdlet deve retornar o objeto SecretVaultInfo para o cofre de extensão registrado com êxito. Por padrão, esse cmdlet não retorna nenhuma saída.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VaultParameters

Especifica um objeto Hashtable que contém pares chave-valor opcionais usados como parâmetros pelo cofre de extensão. Esses parâmetros são opcionais. Consulte a documentação do módulo de extensão do cofre para ver quais valores são necessários.

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Entradas

None

Saídas