Register-SecretVault
Registra um módulo de cofre de extensão SecretManagement para o usuário atual.
Sintaxe
Default (Predefinição)
Register-SecretVault
[-ModuleName] <String>
[[-Name] <String>]
[-VaultParameters <Hashtable>]
[-DefaultVault]
[-AllowClobber]
[-PassThru]
[-Description <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Descrição
Importante
A equipa PowerShell decidiu que os módulos Secret são completos em funcionalidades e deixarão de ser desenvolvidos ativamente. Os módulos continuarão a ser suportados para correções de segurança e bugs críticos. O repositório de código foi arquivado.
As versões mais recentes publicadas são:
A natureza dos segredos mudou fundamentalmente desde que este projeto foi concebido. Métodos de autenticação sem palavra-passe, como chaves de acesso, login único e sistemas federados de credenciais, como o Microsoft Entra ID, biometria e chaves de segurança de hardware, são o futuro.
Este cmdlet adiciona um cofre de extensão SecretManagement ao registro do cofre do usuário atual. Um cofre de extensão é um módulo do PowerShell que está em conformidade com o formato de cofre de extensão necessário. Este 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 do cofre do 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ã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 Az.KeyVault cofre de extensão para o usuário atual. O módulo Az.KeyVault precisa ser instalado antes. Para o VaultParameters:
-
AZKVaultNameespecifica o nome do Cofre da Chave no Azure -
SubscriptionIdespecifica o ID da assinatura em que o Cofre da Chave é criado
Parâmetros
-AllowClobber
Se especificado, permite que o cmdlet substitua um cofre de extensão registrado existente com o mesmo nome.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Valor predefinido: | False |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Posto: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-Confirm
Solicita confirmação antes de executar o cmdlet.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Valor predefinido: | False |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
| Aliases: | Cf. |
Conjuntos de parâmetros
(All)
| Posto: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-DefaultVault
Se especificado, define o novo cofre de extensão como o cofre padrão para o usuário atual.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Valor predefinido: | False |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Posto: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-Description
Descreve o cofre. Esse valor está incluído nas informações do Registro do vault.
Propriedades dos parâmetros
| Tipo: | String |
| Valor predefinido: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Posto: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-ModuleName
Especifica o nome do módulo do PowerShell que implementa o cofre de extensão. Digite 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 procurará esse caminho para o módulo.
Propriedades dos parâmetros
| Tipo: | String |
| Valor predefinido: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Posto: | 1 |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | 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 vault.
Propriedades dos parâmetros
| Tipo: | String |
| Valor predefinido: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Posto: | 0 |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | 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 dos parâmetros
| Tipo: | SwitchParameter |
| Valor predefinido: | False |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Posto: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-VaultParameters
Especifica um objeto Hashtable contendo pares chave-valor opcionais usados como parâmetros pelo cofre de extensão. Estes parâmetros são opcionais. Consulte a documentação do módulo de extensão do vault para ver quais valores são necessários.
Propriedades dos parâmetros
| Tipo: | Hashtable |
| Valor predefinido: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Posto: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Valor predefinido: | False |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
| Aliases: | Wi |
Conjuntos de parâmetros
(All)
| Posto: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | 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.