Get-Secret
Localiza e devolve um segredo pelo nome dos cofres registados.
Sintaxe
NameParameterSet (Predefinição)
Get-Secret
[-Name] <String>
[[-Vault] <String>]
[-AsPlainText]
[<CommonParameters>]
InfoParameterSet
Get-Secret
[-InputObject] <SecretInformation>
[-AsPlainText]
[<CommonParameters>]
Description
Este cmdlet localiza e retorna o primeiro segredo que corresponde ao nome fornecido. Se um nome de cofre for especificado, somente esse cofre será pesquisado. Caso contrário, ele pesquisa todos os cofres e retorna o primeiro resultado correspondente. Se o registro do vault tiver um vault padrão, o cmdlet pesquisará esse vault antes de qualquer outro vault registrado. Os segredos que são tipos String ou SecureString são retornados como objetos SecureString por padrão.
Exemplos
Exemplo 1
Get-Secret -Name Secret1 -Vault CredMan
Get-Secret -Name Secret1 -Vault CredMan -AsPlainText
System.Security.SecureString
PlainTextSecretString
Este exemplo procura um segredo com o nome Secret1, que é um segredo do tipo String . O primeiro comando retorna o segredo como um objeto SecureString . O segundo comando usa o parâmetro AsPlainText para retornar o segredo como um objeto String , exibindo no console como texto sem formatação.
Exemplo 2
Get-SecretInfo -Name Secret2 -Vault SecretStore |
Get-Secret -AsPlainText
Este exemplo recupera informações secretas para o segredo nomeado Secret2 no cofre chamado SecretStore. Em seguida, envia o resultado através do pipeline para Get-Secret, que procura o segredo e o devolve como texto simples.
Parâmetros
-AsPlainText
Especifica que um segredo cujo tipo é String ou SecureString deve ser retornado como um String (em texto sem formatação) em vez de um SecureString. Se o segredo que está sendo recuperado não for um String ou SecureString, esse parâmetro não terá efeito.
Atenção
Para garantir a segurança, você deve evitar o uso de cadeias de caracteres de texto sem formatação sempre que possível.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Default value: | False |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-InputObject
Especifica um objeto SecretInformation que representa um segredo do vault em vez de especificar os parâmetros Name e Vault . Você pode obter um objeto SecretInformation com o Get-SecretInfo cmdlet.
Propriedades dos parâmetros
| Tipo: | Microsoft.PowerShell.SecretManagement.SecretInformation |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
InfoParameterSet
| Position: | 0 |
| Obrigatório: | True |
| Valor do pipeline: | True |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-Name
Especifica o nome do segredo a ser recuperado. Caracteres curinga não são permitidos.
Propriedades dos parâmetros
| Tipo: | String |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
NameParameterSet
| Position: | 0 |
| Obrigatório: | True |
| Valor do pipeline: | True |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-Vault
Especifica o nome do cofre registrado do qual recuperar o segredo. Se nenhum nome de cofre for especificado, todos os cofres registrados serão pesquisados. Se o registro do vault tiver um vault padrão e esse parâmetro não for especificado, o vault padrão será pesquisado antes dos outros vaults registrados.
Propriedades dos parâmetros
| Tipo: | String |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
NameParameterSet
| Position: | 1 |
| 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.
