Reset-ContextVault

SYNOPSIS

Resets a context vault.

SYNTAX

By Name

Reset-ContextVault [-Name <String[]>] [-PassThru] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

As ContextVault

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

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

-Name

The name of the vault to reset.

Type: String[]
Parameter Sets: By Name
Aliases:

Required: False
Position: Named
Default value: *
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: True

-InputObject

The vault object to reset.

Type: ContextVault[]
Parameter Sets: As ContextVault
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-PassThru

Pass the context through the pipeline.

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

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

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

[ContextVault]

NOTES

RELATED LINKS

https://psmodule.io/Context/Functions/Vault/Reset-ContextVault/