Edit

Share via


Get-SecretVault

Finds and returns registered vault information.

Syntax

Default (Default)

Get-SecretVault
    [[-Name] <String[]>]
    [<CommonParameters>]

Description

This cmdlet finds and returns information about registered vaults. By default, it returns information for every registered vault.

Examples

Example 1

Get-SecretVault
VaultName  ModuleName                        IsDefaultVault
---------  ----------                        --------------
CredMan    Microsoft.PowerShell.CredManStore False
LocalStore Microsoft.PowerShell.SecretStore  True

This example runs the command without any parameters to return information on all registered vaults. The LocalStore vault is shown to be set as the default vault.

Example 2

Get-SecretVault -Name LocalStore | Format-List -Property *
Name            : LocalStore
ModuleName      : Microsoft.PowerShell.SecretStore
ModulePath      : C:\Users\User01\Documents\PowerShell\Modules\Microsoft.PowerShell.SecretStore
Description     : Personal secrets for non-production use.
VaultParameters : {}
IsDefault       : True

This example shows additional information about the LocalStore vault.

Parameters

-Name

Specifies the name of a vault. This cmdlet only gets information for vaults that have the specified name. Enter a name or name pattern. Wildcard characters are permitted.

If the Name parameter isn't specified, this cmdlet returns the information for all registered vaults.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:True
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

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

Inputs

None

Outputs

Microsoft.PowerShell.SecretManagement.SecretVaultInfo