Microsoft.PowerShell.SecretManagement

PowerShell SecretManagement module provides a convenient way for a user to store and retrieve secrets. The secrets are stored in SecretManagement extension vaults. An extension vault is a PowerShell module that has been registered to SecretManagement, and exports five module functions required by SecretManagement. An extension vault can store secrets locally or remotely. Extension vaults are registered to the current logged in user context, and will be available only to that user.

Note

This module is supported under traditional Microsoft support agreements, including paid support, Microsoft Enterprise Agreements, and Microsoft Software Assurance. You can also pay for assisted support for PowerShell by filing a support request for your problem. Please file issues in the source repository using the This product button in the Feedback section at the bottom of the page.

Microsoft.PowerShell.SecretManagement

Get-Secret

Finds and returns a secret by name from registered vaults.

Get-SecretInfo

Finds and returns secret metadata information of one or more secrets.

Get-SecretVault

Finds and returns registered vault information.

Register-SecretVault

Registers a SecretManagement extension vault module for the current user.

Remove-Secret

Removes a secret from a specified registered extension vault.

Set-Secret

Adds a secret to a SecretManagement registered vault.

Set-SecretInfo

Adds or replaces additional secret metadata to a secret currently stored in a vault.

Set-SecretVaultDefault

Sets the provided vault name as the default vault for the current user.

Test-SecretVault

Runs an extension vault self test.

Unregister-SecretVault

Un-registers an extension vault from SecretManagement for the current user.