Get-Secret

Referência

Módulo:: Microsoft.PowerShell.SecretManagement

Localiza e devolve um segredo por nome dos cofres registados.

Syntax

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

Get-Secret
   [-InputObject] <SecretInformation>
   [-AsPlainText]
   [<CommonParameters>]

Description

Este cmdlet localiza e devolve o primeiro segredo que corresponde ao nome fornecido. Se for especificado um nome de cofre, apenas esse cofre é pesquisado. Caso contrário, procura em todos os cofres e devolve o primeiro resultado correspondente. Se o registo do cofre tiver um cofre predefinido, o cmdlet procura nesse cofre antes de qualquer outro cofre registado. Os segredos que são tipos de Cadeia ou SecureString são devolvidos como objetos SecureString por predefiniçã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 Cadeia . O primeiro comando devolve o segredo como um objeto SecureString . O segundo comando utiliza o parâmetro AsPlainText para devolver o segredo como um objeto string , apresentando na consola como texto simples.

Exemplo 2

Get-SecretInfo -Name Secret2 -Vault SecretStore | Get-Secret -AsPlainText

Este exemplo obtém informações secretas para o segredo com o nome Secret2 no cofre com o nome SecretStore. Em seguida, envia o resultado através do pipeline para Get-Secret, que procura o segredo e devolve-o como texto simples.

Parâmetros

-AsPlainText

Especifica que um segredo cujo tipo é Cadeia ou SecureString deve ser devolvido como uma Cadeia (em texto simples) em vez de uma SecureString. Se o segredo que está a ser obtido não for uma Cadeia ou SecureString, este parâmetro não tem qualquer efeito.

Atenção

Para garantir a segurança, deve evitar utilizar cadeias de texto simples 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 Nome e Cofre . 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 obter. Os carateres universais 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 registado a partir do qual obter o segredo. Se não for especificado nenhum nome do cofre, todos os cofres registados serão pesquisados. Se o registo do cofre tiver um cofre predefinido e este parâmetro não for especificado, o cofre predefinido será pesquisado antes dos outros cofres registados.

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

Partilhar via