Set-SecretVaultDefault

Set-SecretVaultDefault
    [-Name] <String>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Set-SecretVaultDefault
    [-SecretVault] <SecretVaultInfo>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Set-SecretVaultDefault
    [-ClearDefault]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

This cmdlet updates the vault registry to set the provided vault name as the default vault. Only one registered vault can be the default vault.

PS C:\> Get-SecretVault

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

PS C:\> Set-SecretVaultDefault -Name CredMan
PS C:\> Get-SecretVault

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

PS C:\> Set-SecretVaultDefault -ClearDefault
PS C:\> Get-SecretVault

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

This example shows how to set and unset the default vault for the current user. The first command gets information about all registered vaults and shows that the LocalStore is the default vault for the user. The second command makes the CredMan vault the default vault. The third command shows that the CredMan vault is now default, and LocalStore vault is no longer default. The fourth command uses the ClearDefault parameter to remove the default designation from any registered vault. The last command shows that there is no default 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.