Reset-ContextVault

SYNOPSIS

Resets a context vault.

SYNTAX

By Name

Reset-ContextVault [-Name <string[]>] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

As ContextVault

Reset-ContextVault -InputObject <ContextVault[]> [-PassThru] [-WhatIf] [-Confirm]
 [<CommonParameters>]

ALIASES

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

DESCRIPTION

Resets an existing context vault by deleting all contexts and regenerating the encryption keys. The vault configuration and name are preserved.

EXAMPLES

EXAMPLE 1

Reset-ContextVault -Name 'MyModule'

Resets the 'MyModule' vault, deleting all contexts and regenerating encryption keys.

PARAMETERS

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases:
- cf
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-InputObject

The vault object to reset.

Type: ContextVault[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: As ContextVault
  Position: Named
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Name

The name of the vault to reset.

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

-PassThru

Pass the context through the pipeline.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-WhatIf

Runs the command in a mode that only reports what would happen without performing the actions.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases:
- wi
ParameterSets:
- Name: (All)
  Position: Named
  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

System.String[]

{{ Fill in the Description }}

ContextVault[]

{{ Fill in the Description }}

OUTPUTS

[ContextVault]

{{ Fill in the Description }}

ContextVault

{{ Fill in the Description }}

NOTES

RELATED LINKS