Get PSProfileSecret

Get-PSProfileSecret

SYNOPSIS

Gets a Secret from the $PSProfile.Vault.

SYNTAX

Get-PSProfileSecret [[-Name] <String>] [-AsPlainText] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Gets a Secret from the $PSProfile.Vault.

EXAMPLES

EXAMPLE 1

Get-PSProfileSecret -Name MyApiKey

Gets the Secret named 'MyApiKey' from the $PSProfile.Vault.

PARAMETERS

-Name

The name of the Secret you would like to retrieve from the Vault. If excluded, returns the entire Vault contents.

Type: String
Parameter Sets: (All)
Aliases:

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

-AsPlainText

If $true and Confirm:$true, returns the decrypted password if the secret is a PSCredential object or the plain-text string if a SecureString. Requires confirmation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Force

If $true and AsPlainText is $true, bypasses Confirm prompt and returns the plain-text password or decrypted SecureString.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

RELATED LINKS