Unregister-SecretVault

Unregister-SecretVault
    [-Name] <String[]>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Unregister-SecretVault
    [-SecretVault] <SecretVaultInfo>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

This cmdlet un-registers the specified extension vault. Once un-registered, the vault is no longer available to SecretManagement for the current user.

PS C:\> Get-SecretVault

VaultName  ModuleName                        IsDefaultVault
---------  ----------                        --------------
CredMan    Microsoft.PowerShell.CredManStore False
LocalStore Microsoft.PowerShell.SecretStore  True

PS C:\> Unregister-SecretVault LocalStore
PS C:\> Get-SecretVault

VaultName ModuleName                        IsDefaultVault
--------- ----------                        --------------
CredMan   Microsoft.PowerShell.CredManStore False

PS C:\> Get-Secret -Name Secret5
Get-Secret: The secret Secret5 wasn't found.

PS C:\> Register-SecretVault -Name SecretStore -ModuleName Microsoft.PowerShell.SecretStore -DefaultVault
PS C:\> Get-SecretVault

VaultName   ModuleName                        IsDefaultVault
---------   ----------                        --------------
CredMan     Microsoft.PowerShell.CredManStore False
SecretStore Microsoft.PowerShell.SecretStore  True

PS C:\> Get-Secret -Name Secret5
System.Security.SecureString

The first command lists the registered vaults for the current user. The second command un-registers the LocalStore vault. The third command verifies that the vault no longer appears in the registry. The fourth command attempts to retrieve Secret5, but it's not found since its vault was un-registered. The fifth command re-registers the vault under a different name and sets it as the user's default vault. The sixth command verifies that the vault has been re-registered as SecretStore and is the default vault. Finally, the last command retrieves Secret5 from the re-registered vault.

PS C:\> Get-SecretVault | Unregister-SecretVault
PS C:\> Get-SecretVault

This example un-registers all extension vaults for the current user. The second command shows that no vaults are registered.

This example un-registers all extension vaults for the current user. Get-SecretVault retrieves all registered vaults for the current user and sends the result through the pipeline to Unregister-SecretVault. Get-SecretVault shows that the secret no longer exists in the vault.

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.