Get-Secret

Módulo:

Microsoft.PowerShell.SecretManagement

Localiza e retorna um segredo por nome de cofres registrados.

Syntax

Get-Secret
   [-Name] <String>
   [[-Vault] <String>]
   [-AsPlainText]
   [<CommonParameters>]

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 pesquisa esse cofre antes de qualquer outro cofre 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 pesquisa um segredo com o nome Secret1, que é um segredo de 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, 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 é String ou SecureString deve ser retornado como uma String (em texto sem formatação) em vez de um SecureString. Se o segredo que está sendo recuperado não for uma String ou SecureString, esse parâmetro não terá efeito.

Cuidado

Para garantir a segurança, você deve evitar usar cadeias de caracteres de texto sem formatação sempre que possível.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	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 Get-SecretInfo cmdlet .

Type:	SecretInformation
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

Especifica o nome do segredo a ser recuperado. Caracteres curinga não são permitidos.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	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.

Type:	String
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Entradas

String

Microsoft.PowerShell.SecretManagement.SecretInformation

Saídas

Object