Get-SecretVault

Reference

Module:: Microsoft.PowerShell.SecretManagement

Finds and returns registered vault information.

Syntax

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 is not specified, this cmdlet returns the information for all registered vaults.

Type:	String[]
Position:	0
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

Inputs

None

Outputs

Microsoft.PowerShell.SecretManagement.SecretVaultInfo

Share via