Test-SecretVault

Module:: Microsoft.PowerShell.SecretManagement Module

Runs an extension vault self test.

Syntax

Default (Default)

Test-SecretVault
    [[-Name] <String[]>]
    [<CommonParameters>]

Description

Important

The PowerShell team has decided that Secret modules are is feature complete and will no longer be actively developed. The modules will continue to be supported for security and critical bug fixes. The code repository will be archived.

The latest versions published are:

The nature of secrets has fundamentally changed since this project was designed. Passwordless authentication methods such as passkeys, single sign-on, and federated credential systems such as Microsoft Entra ID, biometrics, and hardware security keys are the future.

This cmdlet runs an extension vault self-test, by running the internal vault Test-SecretVault command. It returns $true if all tests succeeded, and $false otherwise. Information on failing tests is written to the error stream as error records. For more information during the test run use the Verbose parameter.

Examples

Example 1

PS C:\> Test-SecretVault -Name CredMan -Verbose
VERBOSE: Invoking command Test-SecretVault on module Microsoft.PowerShell.CredManStore.Extension
VERBOSE: Vault CredMan succeeded validation test
True

This example runs the self-tests on the CredMan extension vault. All tests succeeded.

Parameters

-Name

Specifies the name of one or more vaults to test. Enter a name or name pattern. Wildcard characters (*) are permitted.

If the Name parameter isn't specified, this cmdlet runs the tests for all registered vaults.

Parameter properties

Type:	String[]
Default value:	None
Supports wildcards:	True
DontShow:	False

Parameter sets

(All)

Position:	1
Mandatory:	False
Value from pipeline:	True
Value from pipeline by property name:	True
Value from remaining arguments:	False

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.