Remove-ContextVault¶
SYNOPSIS¶
Removes a context vault.
SYNTAX¶
By Name¶
Remove-ContextVault -Name <String[]> [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]
As ContextVault¶
Remove-ContextVault -InputObject <ContextVault[]> [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION¶
Removes an existing context vault and all its context data. This operation is irreversible and will delete all contexts stored in the vault.
EXAMPLES¶
EXAMPLE 1¶
Remove-ContextVault -Name 'OldModule'
Removes the 'OldModule' vault and all its contexts.
PARAMETERS¶
-Name¶
The name of the vault to remove.
Type: String[]
Parameter Sets: By Name
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: True
-InputObject¶
The vault object to remove.
Type: ContextVault[]
Parameter Sets: As ContextVault
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
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¶
NOTES¶
RELATED LINKS¶
https://psmodule.io/Context/Functions/Vault/Remove-ContextVault/