Get-Secret
Localiza e retorna um segredo por nome de cofres registrados.
Sintaxe
NameParameterSet (Padrão)
Get-Secret
[-Name] <String>
[[-Vault] <String>]
[-AsPlainText]
[<CommonParameters>]
InfoParameterSet
Get-Secret
[-InputObject] <SecretInformation>
[-AsPlainText]
[<CommonParameters>]
Description
Esse 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 cofre tiver um cofre padrão, o cmdlet pesquisará esse cofre antes de qualquer outro cofre registrado. Os segredos que são de cadeia de caracteres ou tipos de 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 pesquisa um segredo com o nome Secret1, que é um segredo do tipo de cadeia de caracteres. 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 de cadeia de caracteres, 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 chamado Secret2 no cofre chamado SecretStore. Em seguida, ele envia o resultado por meio do pipeline para Get-Secret, que pesquisa o segredo e o retorna como texto sem formatação.
Parâmetros
-AsPlainText
Especifica que um segredo cujo tipo é de cadeia de caracteres ou SecureString deve ser retornado como um de cadeia de caracteres (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.
Cuidado
Para garantir a segurança, você deve evitar o uso de cadeias de caracteres de texto sem formatação sempre que possível.
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 |
-InputObject
Especifica um objeto SecretInformation que representa um segredo do cofre em vez de especificar os parâmetros Name e Vault. Você pode obter um objeto SecretInformation com o cmdlet Get-SecretInfo.
Propriedades do parâmetro
| Tipo: | Microsoft.PowerShell.SecretManagement.SecretInformation |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
InfoParameterSet
| Cargo: | 0 |
| Obrigatório: | True |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Name
Especifica o nome do segredo a ser recuperado. Não são permitidos caracteres curinga.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
NameParameterSet
| Cargo: | 0 |
| Obrigatório: | True |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | 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 cofre tiver um cofre padrão e esse parâmetro não for especificado, o cofre padrão será pesquisado antes dos outros cofres registrados.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
NameParameterSet
| Cargo: | 1 |
| 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.
