Get-ContextInfo

SYNOPSIS

Retrieves info about a context from a context vault.

SYNTAX

__AllParameterSets

Get-ContextInfo [[-ID] <string[]>] [[-Vault] <string[]>] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases, {{Insert list of aliases}}

DESCRIPTION

Retrieves info about contexts directly from a ContextVault. If no ID is specified, info on all contexts will be returned. Wildcards are supported to match multiple contexts. Only metadata (ID and Path) is returned without decrypting the context contents.

EXAMPLES

EXAMPLE 1

Get-ContextInfo

Output:

ID                 Vault
--                 -----
MySettings         MyVault
MyConfig           MyVault
MySecret           MyVault
Data               MyVault
PSModule.GitHub    MyVault

Retrieves all contexts from the context vault (directly from disk).

EXAMPLE 2

Get-ContextInfo -ID 'MySecret'

Output:

ID   : MySecret
Path : ...\3e223259-f242-4e97-91c8-f0fd054cfea7.json

Retrieves the context called 'MySecret' from the context vault (directly from disk).

EXAMPLE 3

'My*' | Get-ContextInfo

Output:

ID                 Vault
--                 -----
MyConfig           MyVault
MySecret           MyVault
MySettings         MyVault

Retrieves all contexts that start with 'My' from the context vault (directly from disk).

PARAMETERS

-ID

The name of the context to retrieve from the vault. Supports wildcards.

Type: System.String[]
DefaultValue: '*'
SupportsWildcards: true
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Vault

The name of the vault to retrieve context info from. Supports wildcards.

Type: System.String[]
DefaultValue: '*'
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 1
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

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

OUTPUTS

[ContextInfo]

{{ Fill in the Description }}

ContextInfo

{{ Fill in the Description }}

NOTES

Returns a list of context information matching the specified ID or all contexts if no ID is specified. Each context object contains its ID and corresponding path to where the context is stored on disk.

RELATED LINKS