Register-SecretVault

Referência

Módulo:: Microsoft.PowerShell.SecretManagement

Regista um módulo do cofre de extensões SecretManagement para o utilizador atual.

Syntax

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

Description

Este cmdlet adiciona um cofre de extensão SecretManagement ao registo do cofre do utilizador atual. Um cofre de extensões é um módulo do PowerShell que está em conformidade com o formato do cofre de extensões necessário. Este cmdlet verifica se o módulo especificado cumpre os requisitos de conformidade antes de o adicionar ao registo do cofre de extensões. Os cofres de extensões são registados no utilizador atual e não afetam outros registos do cofre de utilizadores.

O primeiro cofre registado com este cmdlet é definido automaticamente como o cofre predefinido, 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 regista um cofre de extensões Microsoft.PowerShell.SecretStore para o utilizador atual. Utiliza o parâmetro DefaultVault para tornar o cofre registado no cofre predefinido para o utilizador. Get-SecretVault lista todos os cofres registados para o utilizador, verificando se o cofre foi registado e definido como o cofre predefinido.

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 regista um cofre de extensões Az.KeyVault para o utilizador atual. O módulo Az.KeyVault tem de ser instalado anteriormente. Para os Parâmetros do Cofre:

AZKVaultNameespecifica o nome do Key Vault no Azure
SubscriptionIdespecifica o ID da subscrição na qual o Key Vault é criado

Parâmetros

-AllowClobber

Se especificado, permite que o cmdlet substitua um cofre de extensões registado existente pelo mesmo nome.

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

-Confirm

Solicita a 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ões como o cofre predefinido para o utilizador atual.

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

-Description

Descreve o cofre. Este valor está incluído nas informações do registo 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ões. Introduza o nome de um módulo ou o caminho para o módulo. Se especificar um nome, o PowerShell procura-o nos caminhos conhecidos do módulo. Se especificar um caminho, o PowerShell procura 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ões. Se não for especificado nenhum nome, o nome do módulo é utilizado 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 devolver o objeto SecretVaultInfo para o cofre de extensões registado com êxito. Por predefinição, este cmdlet não devolve 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 utilizados como parâmetros pelo cofre de extensões. Estes parâmetros são opcionais. Consulte a documentação do módulo de extensão do cofre para ver que valores são necessários.

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

-WhatIf

Apresenta o que aconteceria mediante a execução do cmdlet. 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