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
@@ -1,7 +1,7 @@
---
external help file: Microsoft.PowerShell.SecretManagement.dll-Help.xml
Module Name: Microsoft.PowerShell.SecretManagement
ms.date: 05/31/2022
ms.date: 05/23/2025
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 Down Expand Up @@ -55,7 +55,8 @@ console as plain text.
### Example 2

```powershell
Get-SecretInfo -Name Secret2 -Vault SecretStore | Get-Secret -AsPlainText
Get-SecretInfo -Name Secret2 -Vault SecretStore |
Get-Secret -AsPlainText
```

This example retrieves secret information for the secret named `Secret2` in the vault named
Expand All @@ -67,20 +68,20 @@ secret and returns it as plain text.
### -AsPlainText

Specifies that a secret whose type is **String** or **SecureString** should be returned as a
**String** (in plain text) instead of a **SecureString**. If the secret being retrieved is not a
**String** (in plain text) instead of a **SecureString**. If the secret being retrieved isn't a
**String** or **SecureString**, this parameter has no effect.

> [!CAUTION]
> To ensure security, you should avoid using plaintext strings whenever possible.

```yaml
Type: SwitchParameter
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
Expand All @@ -92,7 +93,7 @@ Specifies a **SecretInformation** object representing a vault secret instead of
`Get-SecretInfo` cmdlet.

```yaml
Type: SecretInformation
Type: Microsoft.PowerShell.SecretManagement.SecretInformation
Parameter Sets: InfoParameterSet
Aliases:

Expand All @@ -105,10 +106,10 @@ Accept wildcard characters: False

### -Name

Specifies the name of the secret to retrieve. Wildcard characters are not permitted.
Specifies the name of the secret to retrieve. Wildcard characters aren't permitted.

```yaml
Type: String
Type: System.String
Parameter Sets: NameParameterSet
Aliases:

Expand All @@ -123,11 +124,11 @@ Accept wildcard characters: False

Specifies the name of the registered vault to retrieve the secret from. If no vault name is
specified, then all registered vaults are searched. If the vault registry has a default vault and
this parameter is not specified, then the default vault is searched before the other registered
this parameter isn't specified, then the default vault is searched before the other registered
vaults.

```yaml
Type: String
Type: System.String
Parameter Sets: NameParameterSet
Aliases:

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/31/2022
ms.date: 05/23/2025
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 Down Expand Up @@ -81,10 +81,10 @@ hashtable show every valid type metadata values can be:
Specifies the name of a secret. This cmdlet only gets metadata for secrets that have the specified
name. Enter a name or name pattern. Wildcard characters are permitted.

If the **Name** parameter is not specified, this cmdlet returns the metadata for all stored secrets.
If the **Name** parameter isn't specified, this cmdlet returns the metadata for all stored secrets.

```yaml
Type: String
Type: System.String
Parameter Sets: (All)
Aliases:

Expand All @@ -97,13 +97,13 @@ Accept wildcard characters: True

### -Vault

Specifies the name of a vault to search for secret metadata. Wildcard characters are not permitted.
Specifies the name of a vault to search for secret metadata. Wildcard characters aren't permitted.

If the **Vault** parameter is not specified, this cmdlet searches for metadata in all registered
If the **Vault** parameter isn't specified, this cmdlet searches for metadata in all registered
vaults.

```yaml
Type: String
Type: System.String
Parameter Sets: (All)
Aliases:

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/31/2022
ms.date: 05/23/2025
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 Down Expand Up @@ -64,11 +64,11 @@ This example shows additional information about the `LocalStore` vault.
Specifies the name of a vault. This cmdlet only gets information for vaults that have the specified
name. Enter a name or name pattern. Wildcard characters are permitted.

If the **Name** parameter is not specified, this cmdlet returns the information for all registered
If the **Name** parameter isn't specified, this cmdlet returns the information for all registered
vaults.

```yaml
Type: String[]
Type: System.String[]
Parameter Sets: (All)
Aliases:

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: 08/26/2024
ms.date: 05/23/2025
Download Help Link: https://aka.ms/ps-modules-help
Help Version: 0.1.0.0
Locale: en-US
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/31/2022
ms.date: 05/23/2025
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 @@ -24,11 +24,11 @@ Register-SecretVault [-ModuleName] <String> [[-Name] <String>] [-VaultParameters
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
extension vault registry. Extension vaults are registered to the current user and do not affect
extension vault registry. Extension vaults are registered to the current user and don't affect
other user vault registrations.

The first vault registered with this cmdlet is automatically defined as the default vault even if
the **DefaultVault** parameter is not specified.
the **DefaultVault** parameter isn't specified.

## EXAMPLES

Expand Down Expand Up @@ -88,7 +88,7 @@ If specified, allows the cmdlet to overwrite an existing registered extension va
name.

```yaml
Type: SwitchParameter
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Expand All @@ -104,13 +104,13 @@ Accept wildcard characters: False
If specified, sets the new extension vault as the default vault for the current user.

```yaml
Type: SwitchParameter
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
Expand All @@ -120,7 +120,7 @@ Accept wildcard characters: False
Describes the vault. This value is included in the vault registry information.

```yaml
Type: String
Type: System.String
Parameter Sets: (All)
Aliases:

Expand All @@ -138,7 +138,7 @@ module or the path to the module. If you specify a name, PowerShell searches for
module paths. If you specify a path, PowerShell searches that path for the module.

```yaml
Type: String
Type: System.String
Parameter Sets: (All)
Aliases:

Expand All @@ -155,7 +155,7 @@ Specifies the name of the extension vault. If no name is specified, the module n
vault name.

```yaml
Type: String
Type: System.String
Parameter Sets: (All)
Aliases:

Expand All @@ -169,10 +169,10 @@ Accept wildcard characters: False
### -PassThru

Indicates that the cmdlet should return the **SecretVaultInfo** object for the successfully
registered extension vault. By default this cmdlet does not return any output.
registered extension vault. By default this cmdlet doesn't return any output.

```yaml
Type: SwitchParameter
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Expand All @@ -190,7 +190,7 @@ extension vault. These parameters are optional. Consult the documentation of the
module to see what values are required.

```yaml
Type: Hashtable
Type: System.Collections.Hashtable
Parameter Sets: (All)
Aliases:

Expand All @@ -206,29 +206,29 @@ Accept wildcard characters: False
Prompts you for confirmation before running the cmdlet.

```yaml
Type: SwitchParameter
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```

### -WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.
Shows what would happen if the cmdlet runs. The cmdlet isn't run.

```yaml
Type: SwitchParameter
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
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/31/2022
ms.date: 05/23/2025
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 Down Expand Up @@ -40,7 +40,7 @@ Get-Secret -Name secretTest -Vault CredMan
```

```output
Get-Secret: The secret secretTest was not found.
Get-Secret: The secret secretTest wasn't found.
```

This example removes the `secretTest` secret from the `CredMan` vault. The `Get-Secret` command
Expand All @@ -54,7 +54,7 @@ Get-Secret -Name Secret2 -Vault CredMan
```

```output
Get-Secret: The secret Secret2 was not found.
Get-Secret: The secret Secret2 wasn't found.
```

This example removes the `Secret2` secret from the `CredMan` vault. `Get-SecretInfo` retrieves the
Expand All @@ -68,7 +68,7 @@ information for the secret and sends the result through the pipeline to `Remove-
Specifies a **SecretInformation** object that describes a vault secret.

```yaml
Type: SecretInformation
Type: Microsoft.PowerShell.SecretManagement.SecretInformation
Parameter Sets: InfoParameterSet
Aliases:

Expand All @@ -81,10 +81,10 @@ Accept wildcard characters: False

### -Name

Specifies the name of the secret to remove. Wildcard characters (`*`) are not permitted.
Specifies the name of the secret to remove. Wildcard characters (`*`) aren't permitted.

```yaml
Type: String
Type: System.String
Parameter Sets: NameParameterSet
Aliases:

Expand All @@ -97,11 +97,11 @@ Accept wildcard characters: False

### -Vault

Specifies the name of the vault to remove the secret from. Wildcard characters (`*`) are not
Specifies the name of the vault to remove the secret from. Wildcard characters (`*`) aren't
permitted.

```yaml
Type: String
Type: System.String
Parameter Sets: NameParameterSet
Aliases:

Expand All @@ -117,29 +117,29 @@ Accept wildcard characters: False
Prompts you for confirmation before running the cmdlet.

```yaml
Type: SwitchParameter
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```

### -WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.
Shows what would happen if the cmdlet runs. The cmdlet isn't run.

```yaml
Type: SwitchParameter
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```
Expand Down
Loading
Loading