Compartilhar via

Register-SecretVault

Módulo:
Microsoft.PowerShell.SecretManagement Module

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

Sintaxe

Default (Padrão) 

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 de 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ão. Os cofres de extensão são registrados para o usuário atual e não afetam outros registros de cofre de usuário.

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ões 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:

  • AZKVaultName especifica o nome do Key Vault no Azure
  • SubscriptionId especifica a ID da assinatura na qual o Key Vault é criado

Parâmetros

-AllowClobber

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

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Confirm

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

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False
Aliases:cf

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-DefaultVault

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

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Description

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

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes: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.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:1
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes: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.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:0
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes: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.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-VaultParameters

Especifica um objeto Hashtable que contém pares de 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.

Propriedades do parâmetro

Tipo:Hashtable
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-WhatIf

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

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False
Aliases:wi

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

None

Saídas

None