Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ title: Understanding the SecretManagement module
---
# Understanding the SecretManagement module

[!INCLUDE[secrets-modules-deprecated](../../../includes/secret-modules-deprecated.md)]

The purpose of the **SecretManagement** module is to provide secure storage and access of secrets
through registered extension vaults. The registered extension vaults are PowerShell modules that
conform to **SecretManagement** module requirements. The extension vaults perform the actual work of
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
---
description: How to install and use the SecretManagement and SecretStore modules
ms.date: 11/10/2023
ms.date: 06/22/2026
title: Get started with the SecretStore module
---
# Get started with the SecretStore module

[!INCLUDE[secrets-modules-deprecated](../../../includes/secret-modules-deprecated.md)]

The **SecretManagement** and **SecretStore** modules are available from the PowerShell Gallery and
can be installed using **PowerShellGet** commands.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
---
description: Explains how to manage a local SecretStore vault
ms.date: 06/28/2023
ms.date: 06/22/2026
title: Managing a SecretStore vault
---
# Managing a SecretStore vault

[!INCLUDE[secrets-modules-deprecated](../../../includes/secret-modules-deprecated.md)]

The **SecretStore** module is an extension vault for the PowerShell **SecretManagement** module. It
stores secrets, locally, in files for the current user account context, and uses .NET crypto APIs to
encrypt file contents. The **SecretStore** module has several configuration options. In the default
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
---
description: This article explains how to use an Azure Key Vault module, as a SecretManagement extension vault, in an automation scenario to securely retrieve and use passwords or other secret material.
ms.date: 12/05/2023
ms.date: 06/22/2026
title: Use Azure Key Vault in automation
---
# Use Azure Key Vault in automation

[!INCLUDE[secrets-modules-deprecated](../../../includes/secret-modules-deprecated.md)]

This article provides an example for using Azure Key Vault in an automation scenario. Azure Key
Vault provides you a way to securely store and retrieve the passwords, tokens and other secrets,
that are stored outside of the local machine, and use them in your automation pipeline.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
---
description: This article explains how to use a SecretStore vault in an automation scenario to securely retrieve an use passwords or other secret material.
ms.date: 03/06/2024
ms.date: 06/22/2026
title: Use the SecretStore in automation
---
# Use the SecretStore in automation

[!INCLUDE[secrets-modules-deprecated](../../../includes/secret-modules-deprecated.md)]

This article provides an example for using a **Microsoft.PowerShell.SecretStore** vault in an
automation scenario. A **SecretStore** vault provides you a way to securely store and retrieve the
passwords, tokens and other secrets you need to use in your automation pipeline on the local
Expand Down
4 changes: 3 additions & 1 deletion reference/docs-conceptual/SecretManagement/overview.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
---
description: Overview of the SecretManagement and SecretStore modules
ms.date: 06/28/2023
ms.date: 06/22/2026
title: Overview of the SecretManagement and SecretStore modules
---
# Overview of the SecretManagement and SecretStore modules

[!INCLUDE[secrets-modules-deprecated](../../includes/secret-modules-deprecated.md)]

The **SecretManagement** module helps users manage secrets by providing a common set of cmdlets that
interface with secrets vaults. **SecretManagement** provides an extensible model where local and
remote vaults can be registered for use. This allows you to separate the specific details for
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
---
description: This article explains the security of the features of the SecretManagement and SecretStore modules.
ms.date: 06/28/2023
ms.date: 06/22/2026
title: Understanding the security features of SecretManagement and SecretStore
---
# Understanding the security features of SecretManagement and SecretStore

[!INCLUDE[secrets-modules-deprecated](../../includes/secret-modules-deprecated.md)]

The security of **SecretManagement** is dependent on the extension vaults it hosts. These vaults
perform the actual functions of storing and retrieving the secrets. **SecretManagement** does not
return secrets as plain text by default. By default, any text secrets are returned as
Expand Down
6 changes: 3 additions & 3 deletions reference/docs-conceptual/overview.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: This documentation set contains reference for modules published and maintained by the PowerShell team, but aren't part of the PowerShell package.
ms.date: 05/05/2026
ms.date: 06/22/2026
title: PowerShell utility modules
---
# PowerShell utility modules
Expand All @@ -12,13 +12,13 @@ level of support for each module varies. For more details, see the landing page

This documentation set contains cmdlet reference for the following modules.

- [Microsoft.PowerShell.SecretManagement][03]
- [Microsoft.PowerShell.SecretStore][04]
- [PlatyPS][05]
- [PSScriptAnalyzer][06]

Deprecated modules

- [Microsoft.PowerShell.SecretManagement][03]
- [Microsoft.PowerShell.SecretStore][04]
- [Microsoft.PowerShell.Crescendo][02] - **Deprecated May 2026**
- [AIShell][01] - **Deprecated January 2026**

Expand Down
24 changes: 24 additions & 0 deletions reference/includes/secret-modules-deprecated.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
author: sdwheeler
ms.author: sewhee
ms.date: 06/22/2026
ms.topic: include
---
<!-- markdownlint-disable first-line-h1 -->

> [!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:
> - [Microsoft.PowerShell.SecretManagement v1.1.2][1.1.2]
> - [Microsoft.PowerShell.SecretStore v1.0.6][1.0.6]
>
> 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.

<!-- link references-->
[1.0.6]: https://www.powershellgallery.com/packages/Microsoft.PowerShell.SecretStore/1.0.6
[1.1.2]: https://www.powershellgallery.com/packages/Microsoft.PowerShell.SecretManagement/1.1.2
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
external help file: Microsoft.PowerShell.SecretManagement.dll-Help.xml
Module Name: Microsoft.PowerShell.SecretManagement
ms.date: 05/23/2025
ms.date: 06/22/2026
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.secretmanagement/get-secret?view=ps-modules&wt.mc_id=ps-gethelp
schema: 2.0.0
---
Expand All @@ -27,6 +27,8 @@ Get-Secret [-InputObject] <SecretInformation> [-AsPlainText] [<CommonParameters>

## DESCRIPTION

[!INCLUDE[secrets-modules-deprecated](../../includes/secret-modules-deprecated.md)]

This cmdlet finds and returns the first secret that matches the provided name. If a vault name is
specified, only that vault is searched. Otherwise, it searches all vaults and returns the first
matching result. If the vault registry has a default vault, the cmdlet searches that vault before
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
external help file: Microsoft.PowerShell.SecretManagement.dll-Help.xml
Module Name: Microsoft.PowerShell.SecretManagement
ms.date: 05/23/2025
ms.date: 06/22/2026
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.secretmanagement/get-secretinfo?view=ps-modules&wt.mc_id=ps-gethelp
schema: 2.0.0
---
Expand All @@ -19,6 +19,8 @@ Get-SecretInfo [[-Name] <String>] [[-Vault] <String>] [<CommonParameters>]

## DESCRIPTION

[!INCLUDE[secrets-modules-deprecated](../../includes/secret-modules-deprecated.md)]

This cmdlet finds and returns information about secrets in registered vaults. By default, it returns
information for every secret in all registered vaults.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
external help file: Microsoft.PowerShell.SecretManagement.dll-Help.xml
Module Name: Microsoft.PowerShell.SecretManagement
ms.date: 05/23/2025
ms.date: 06/22/2026
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.secretmanagement/get-secretvault?view=ps-modules&wt.mc_id=ps-gethelp
schema: 2.0.0
---
Expand All @@ -19,6 +19,8 @@ Get-SecretVault [[-Name] <String[]>] [<CommonParameters>]

## DESCRIPTION

[!INCLUDE[secrets-modules-deprecated](../../includes/secret-modules-deprecated.md)]

This cmdlet finds and returns information about registered vaults. By default, it returns
information for every registered vault.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
Module Name: Microsoft.PowerShell.SecretManagement
Module Guid: a5c858f6-4a8e-41f1-b1ee-0ff8f6ad69d3
ms.date: 05/23/2025
ms.date: 06/22/2026
Download Help Link: https://aka.ms/ps-modules-help
Help Version: 0.1.0.0
Locale: en-US
Expand All @@ -11,6 +11,8 @@ Locale: en-US

## Description

[!INCLUDE[secrets-modules-deprecated](../../includes/secret-modules-deprecated.md)]

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
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
external help file: Microsoft.PowerShell.SecretManagement.dll-Help.xml
Module Name: Microsoft.PowerShell.SecretManagement
ms.date: 05/23/2025
ms.date: 06/22/2026
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.secretmanagement/register-secretvault?view=ps-modules&wt.mc_id=ps-gethelp
schema: 2.0.0
---
Expand All @@ -21,6 +21,8 @@ Register-SecretVault [-ModuleName] <String> [[-Name] <String>] [-VaultParameters

## DESCRIPTION

[!INCLUDE[secrets-modules-deprecated](../../includes/secret-modules-deprecated.md)]

This cmdlet adds a **SecretManagement** extension vault to the current user's vault registry. An
extension vault is a PowerShell module that conforms to the required extension vault format. This
cmdlet verifies that the specified module meets conformance requirements before adding it to the
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
external help file: Microsoft.PowerShell.SecretManagement.dll-Help.xml
Module Name: Microsoft.PowerShell.SecretManagement
ms.date: 05/23/2025
ms.date: 06/22/2026
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.secretmanagement/remove-secret?view=ps-modules&wt.mc_id=ps-gethelp
schema: 2.0.0
---
Expand All @@ -27,6 +27,8 @@ Remove-Secret [-InputObject] <SecretInformation> [-WhatIf] [-Confirm] [<CommonPa

## DESCRIPTION

[!INCLUDE[secrets-modules-deprecated](../../includes/secret-modules-deprecated.md)]

Removes a secret by name from a registered extension vault. Both the secret name and extension vault
name must be provided.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
external help file: Microsoft.PowerShell.SecretManagement.dll-Help.xml
Module Name: Microsoft.PowerShell.SecretManagement
ms.date: 05/23/2025
ms.date: 06/22/2026
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.secretmanagement/set-secret?view=ps-modules&wt.mc_id=ps-gethelp
schema: 2.0.0
---
Expand Down Expand Up @@ -36,6 +36,8 @@ Set-Secret -SecretInfo <SecretInformation> [-Vault] <String> [-NoClobber] [-What

## DESCRIPTION

[!INCLUDE[secrets-modules-deprecated](../../includes/secret-modules-deprecated.md)]

This cmdlet adds a secret value by name to a vault. When no vault name is specified, the secret is
added to the default vault. If a secret with that name exists, it's overwritten. Additional data
can be included with the secret if supported by the extension vault.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
external help file: Microsoft.PowerShell.SecretManagement.dll-Help.xml
Module Name: Microsoft.PowerShell.SecretManagement
ms.date: 05/23/2025
ms.date: 06/22/2026
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.secretmanagement/set-secretinfo?view=ps-modules&wt.mc_id=ps-gethelp
schema: 2.0.0
---
Expand Down Expand Up @@ -29,6 +29,8 @@ Set-SecretInfo [-Metadata] <Hashtable> -InputObject <SecretInformation>

## DESCRIPTION

[!INCLUDE[secrets-modules-deprecated](../../includes/secret-modules-deprecated.md)]

This cmdlet adds additional secret metadata to an existing secret. Metadata support is an optional
feature for an extension vault. The command throws an error if a vault doesn't support secret
metadata. Metadata is a Hashtable object containing Name/Value pairs. The metadata is stored
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
external help file: Microsoft.PowerShell.SecretManagement.dll-Help.xml
Module Name: Microsoft.PowerShell.SecretManagement
ms.date: 05/23/2025
ms.date: 06/22/2026
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.secretmanagement/set-secretvaultdefault?view=ps-modules&wt.mc_id=ps-gethelp
schema: 2.0.0
---
Expand Down Expand Up @@ -33,6 +33,8 @@ Set-SecretVaultDefault [-ClearDefault] [-WhatIf] [-Confirm] [<CommonParameters>]

## DESCRIPTION

[!INCLUDE[secrets-modules-deprecated](../../includes/secret-modules-deprecated.md)]

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.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
external help file: Microsoft.PowerShell.SecretManagement.dll-Help.xml
Module Name: Microsoft.PowerShell.SecretManagement
ms.date: 05/23/2025
ms.date: 06/22/2026
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.secretmanagement/test-secretvault?view=ps-modules&wt.mc_id=ps-gethelp
schema: 2.0.0
---
Expand All @@ -19,6 +19,8 @@ Test-SecretVault [[-Name] <String[]>] [<CommonParameters>]

## DESCRIPTION

[!INCLUDE[secrets-modules-deprecated](../../includes/secret-modules-deprecated.md)]

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
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
external help file: Microsoft.PowerShell.SecretManagement.dll-Help.xml
Module Name: Microsoft.PowerShell.SecretManagement
ms.date: 05/23/2025
ms.date: 06/22/2026
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.secretmanagement/unlock-secretvault?view=ps-modules&wt.mc_id=ps-gethelp
schema: 2.0.0
---
Expand All @@ -19,6 +19,8 @@ Unlock-SecretVault [-Name] <String> [-Password] <SecureString> [<CommonParameter

## DESCRIPTION

[!INCLUDE[secrets-modules-deprecated](../../includes/secret-modules-deprecated.md)]

This cmdlet unlocks an extension vault using the provided **Password**. This allows a vault that
requires password authentication to operate without first having to prompt the user. Not all
extension vaults require password authentication. The cmdlet returns a warning if the extension
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
external help file: Microsoft.PowerShell.SecretManagement.dll-Help.xml
Module Name: Microsoft.PowerShell.SecretManagement
ms.date: 05/23/2025
ms.date: 06/22/2026
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.secretmanagement/unregister-secretvault?view=ps-modules&wt.mc_id=ps-gethelp
schema: 2.0.0
---
Expand All @@ -27,6 +27,8 @@ Unregister-SecretVault [-SecretVault] <SecretVaultInfo> [-WhatIf] [-Confirm] [<C

## DESCRIPTION

[!INCLUDE[secrets-modules-deprecated](../../includes/secret-modules-deprecated.md)]

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

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
external help file: Microsoft.PowerShell.SecretStore.dll-Help.xml
Module Name: Microsoft.PowerShell.SecretStore
ms.date: 05/23/2025
ms.date: 06/22/2026
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.secretstore/get-secretstoreconfiguration?view=ps-modules&wt.mc_id=ps-gethelp
schema: 2.0.0
---
Expand All @@ -19,6 +19,8 @@ Get-SecretStoreConfiguration [<CommonParameters>]

## DESCRIPTION

[!INCLUDE[secrets-modules-deprecated](../../includes/secret-modules-deprecated.md)]

This cmdlet reads the SecretStore configuration file and returns the defined settings.

## EXAMPLES
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
Module Name: Microsoft.PowerShell.SecretStore
Module Guid: 6b983e67-c297-431a-916c-f4ce24dd7bac
ms.date: 05/23/2025
ms.date: 06/22/2026
Download Help Link: https://aka.ms/ps-modules-help
Help Version: 0.1.0.0
Locale: en-US
Expand All @@ -11,6 +11,8 @@ Locale: en-US

## Description

[!INCLUDE[secrets-modules-deprecated](../../includes/secret-modules-deprecated.md)]

Local secure store extension vault for Microsoft.PowerShell.SecretManagement module.

## Microsoft.PowerShell.SecretStore Cmdlets
Expand Down
Loading
Loading