diff --git a/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Get-Secret.md b/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Get-Secret.md index 2112e3b..495868c 100644 --- a/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Get-Secret.md +++ b/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Get-Secret.md @@ -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 --- @@ -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 @@ -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 ``` @@ -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: @@ -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: @@ -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: diff --git a/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Get-SecretInfo.md b/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Get-SecretInfo.md index c6ce50c..ee8fd51 100644 --- a/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Get-SecretInfo.md +++ b/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Get-SecretInfo.md @@ -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 --- @@ -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: @@ -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: diff --git a/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Get-SecretVault.md b/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Get-SecretVault.md index d2ad140..5550aa9 100644 --- a/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Get-SecretVault.md +++ b/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Get-SecretVault.md @@ -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 --- @@ -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: diff --git a/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Microsoft.PowerShell.SecretManagement.md b/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Microsoft.PowerShell.SecretManagement.md index 3e9f0f3..2833afe 100644 --- a/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Microsoft.PowerShell.SecretManagement.md +++ b/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Microsoft.PowerShell.SecretManagement.md @@ -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 diff --git a/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Register-SecretVault.md b/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Register-SecretVault.md index e088881..c5ff83a 100644 --- a/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Register-SecretVault.md +++ b/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Register-SecretVault.md @@ -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 --- @@ -24,11 +24,11 @@ Register-SecretVault [-ModuleName] [[-Name] ] [-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 @@ -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: @@ -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 ``` @@ -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: @@ -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: @@ -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: @@ -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: @@ -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: @@ -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 ``` diff --git a/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Remove-Secret.md b/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Remove-Secret.md index b79410a..d5e6f0f 100644 --- a/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Remove-Secret.md +++ b/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Remove-Secret.md @@ -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 --- @@ -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 @@ -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 @@ -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: @@ -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: @@ -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: @@ -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 ``` diff --git a/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Set-Secret.md b/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Set-Secret.md index 2192dc6..fb4a3ce 100644 --- a/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Set-Secret.md +++ b/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Set-Secret.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.PowerShell.SecretManagement.dll-Help.xml Module Name: Microsoft.PowerShell.SecretManagement -ms.date: 01/29/2025 +ms.date: 05/23/2025 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 --- @@ -41,7 +41,8 @@ added to the default vault. If a secret with that name exists, it's overwritten. can be included with the secret if supported by the extension vault. The default parameter set takes a **SecureString** object. If you run the command without specifying -the secret value, the cmdlet prompts you to enter a **SecureString**. The text of the string isn't visible in the console. +the secret value, the cmdlet prompts you to enter a **SecureString**. The text of the string isn't +visible in the console. ## EXAMPLES @@ -57,8 +58,8 @@ System.Security.SecureString ``` This example adds a secret named `Secret1` with a plain text value of `SecretValue`. Since no vault -name was specified, the secret is added to the current user's default vault. `Get-Secret` shows -the secret was added. +name was specified, the secret is added to the current user's default vault. `Get-Secret` shows the +secret was added. ### Example 2 @@ -102,7 +103,7 @@ Set-Secret -Name PublishSecret -Secret $targetToken -Vault LocalStore2 -Metadata ``` ```output -Set-Secret: Cannot store secret PublishSecret. Vault LocalStore2 does not support secret metadata. +Set-Secret: Can't store secret PublishSecret. Vault LocalStore2 doesn't support secret metadata. ``` This example adds a secret named `PublishSecret` to the `LocalStore2` vault with extra metadata. @@ -124,7 +125,7 @@ the following types: Metadata isn't stored securely in a vault. Metadata shouldn't contain sensitive information. ```yaml -Type: Hashtable +Type: System.Collections.Hashtable Parameter Sets: SecureStringParameterSet, ObjectParameterSet Aliases: @@ -140,7 +141,7 @@ Accept wildcard characters: False Specifies the name of the secret to add or update. Wildcard characters (`*`) aren't permitted. ```yaml -Type: String +Type: System.String Parameter Sets: SecureStringParameterSet, ObjectParameterSet Aliases: @@ -157,13 +158,13 @@ Causes the command to return an error if a secret with the same name already exi default, this cmdlet updates the secret with the new value if it already exists. ```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 ``` @@ -179,7 +180,7 @@ Specifies the value of the secret. The object must be one of the supported types - **Hashtable** ```yaml -Type: Object +Type: System.Object Parameter Sets: ObjectParameterSet Aliases: @@ -196,7 +197,7 @@ Specifies a **SecretInformation** object describing a stored secret returned by This enables copying secrets from one extension vault to another. ```yaml -Type: SecretInformation +Type: Microsoft.PowerShell.SecretManagement.SecretInformation Parameter Sets: SecretInfoParameterSet Aliases: @@ -212,7 +213,7 @@ Accept wildcard characters: False Specifies the value of the secret as a **SecretString** object. ```yaml -Type: SecureString +Type: System.Security.SecureString Parameter Sets: SecureStringParameterSet Aliases: @@ -229,11 +230,11 @@ Specifies the name of the vault to add or update the secret in. Wildcard charact permitted. By default, the secret is added or updated in the current user's default vault. ```yaml -Type: String +Type: System.String Parameter Sets: SecureStringParameterSet, ObjectParameterSet Aliases: -Required: False (SecureStringParameterSet, ObjectParameterSet), True (SecretInfoParameterSet) +Required: False Position: 2 Default value: None Accept pipeline input: False @@ -245,13 +246,13 @@ 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 ``` @@ -261,13 +262,13 @@ Accept wildcard characters: False 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 ``` diff --git a/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Set-SecretInfo.md b/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Set-SecretInfo.md index 64f0c8e..4ea32be 100644 --- a/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Set-SecretInfo.md +++ b/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Set-SecretInfo.md @@ -1,54 +1,49 @@ --- 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/set-secretinfo?view=ps-modules&wt.mc_id=ps-gethelp schema: 2.0.0 --- -# Set-Secret +# Set-SecretInfo ## SYNOPSIS Adds or replaces additional secret metadata to a secret currently stored in a vault. ## SYNTAX -### SecureStringParameterSet (Default) +### NameParameterSet (Default) ``` -Set-Secret [-Name] -SecureStringSecret [[-Vault] ] - [[-Metadata] ] [-NoClobber] [-WhatIf] [-Confirm] [] +Set-SecretInfo [-Name] [-Metadata] [[-Vault] ] + [-WhatIf] [-Confirm] [] ``` -### ObjectParameterSet +### InfoParameterSet ``` -Set-Secret [-Name] -Secret [[-Vault] ] [[-Metadata] ] - [-NoClobber] [-WhatIf] [-Confirm] [] -``` - -### SecretInfoParameterSet - -``` -Set-Secret -SecretInfo [-Vault] [-NoClobber] [-WhatIf] [-Confirm] - [] +Set-SecretInfo [-Metadata] -InputObject + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -This cmdlet adds additional metadata information to a stored secret. Metadata support is an optional -feature for an extension vault. If a vault does not support secret metadata, the cmdlet returns an -error. - -Metadata is not stored securely in a vault. Metadata should not contain sensitive information. +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 +unencrypted. You shouldn't store sensitive information in the metadata. ## EXAMPLES ### Example 1 ```powershell -Set-SecretInfo -Name Secret1 -Vault Vault1 -Metadata @{ Expiration = ([datetime]::new(2022, 5, 1)) } -Get-SecretInfo -Name Secret1 -Vault Vault1 | Select-Object Name,Metadata +Set-SecretInfo -Name Secret1 -Vault Vault1 -Metadata @{ + Expiration = ([datetime]::new(2022, 5, 1)) +} +Get-SecretInfo -Name Secret1 -Vault Vault1 | + Select-Object Name,Metadata ``` ```output @@ -63,89 +58,37 @@ retrieves the metadata for `Secret1` to show the added metadata. ### Example 2 ```powershell -Set-SecretInfo -Name Secret2 -Vault Vault2 -Metadata @{ Expiration = ([datetime]::new(2022, 5, 1)) } +Set-SecretInfo -Name Secret2 -Vault Vault2 -Metadata @{ + Expiration = ([datetime]::new(2022, 5, 1)) +} ``` ```output -Set-SecretInfo: Cannot set secret metadata Secret2. Vault Vault2 does not support secret metadata. +Set-SecretInfo: Can't set secret metadata Secret2. Vault Vault2 doesn't support secret metadata. ``` This example adds metadata to the `Secret2` secret stored in `Vault2` vault. However, `Vault2` does not support metadata. The command fails and returns an error. -## PARAMETERS - -### -Metadata - -Specifies a **Hashtable** containing key-value pairs to associate with the secret in the vault. The -specified extension vault may not support secret metadata. If the vault does not support metadata, -the operation fails and returns an error. The values of any metadata in the hashtable must be one of -the following types: - -- **string** -- **int** -- **DateTime** - -Metadata is not stored securely in a vault. Metadata should not contain sensitive information. - -```yaml -Type: Hashtable -Parameter Sets: SecureStringParameterSet, ObjectParameterSet -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### Example 3 -### -Name - -Specifies the name of the secret to add metadata to. Wildcard characters (`*`) are not permitted. - -```yaml -Type: String -Parameter Sets: SecureStringParameterSet, ObjectParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False +```powershell +Get-SecretInfo -Name Secret3 | + Set-SecretInfo -Metadata @{ Created = (Get-Date) } ``` -### -NoClobber - -Indicates that the command should error if a secret with the same name already exists in the vault. -By default, this cmdlet updates the secret with the new value if it already exists. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +This example pipes a **SecretInformation** object to the `Set-SecretInfo` command and adds metadata +to the associated secret. -### -Secret +## PARAMETERS -Specifies the value of the secret. The object type must be one of the supported types: +### -InputObject -- **Byte[]** -- **String** -- **SecureString** -- **PSCredential** -- **Hashtable** +This parameter takes a **SecretInformation** object that defines the secret to be updated. ```yaml -Type: Object -Parameter Sets: ObjectParameterSet +Type: Microsoft.PowerShell.SecretManagement.SecretInformation +Parameter Sets: InfoParameterSet Aliases: Required: True @@ -155,51 +98,59 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -SecretInfo +### -Metadata -Specifies a **SecretInformation** object describing a stored secret returned by `Get-SecretInfo`. -This enables copying secrets from one extension vault to another. +Specifies a **Hashtable** containing key-value pairs to associate with the secret in the vault. The +specified extension vault may not support secret metadata. If the vault doesn't support metadata, +the operation fails and returns an error. The values of any metadata in the hashtable must be one of +the following types: + +- **string** +- **int** +- **DateTime** + +Metadata isn't stored securely in a vault. Metadata shouldn't contain sensitive information. ```yaml -Type: SecretInformation -Parameter Sets: SecretInfoParameterSet +Type: System.Collections.Hashtable +Parameter Sets: NameParameterSet, System.Collections.Hashtable Aliases: Required: True -Position: Named +Position: 1 Default value: None Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -SecureStringSecret +### -Name -Specifies the value of the secret as a **SecretString** object. +Specifies the name of the secret to add metadata to. Wildcard characters (`*`) aren't permitted. ```yaml -Type: SecureString -Parameter Sets: SecureStringParameterSet +Type: System.String +Parameter Sets: NameParameterSet Aliases: Required: True -Position: Named +Position: 0 Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` ### -Vault Specifies the name of the vault containing the secret to add or update the metadata for. Wildcard -characters (`*`) are not permitted. By default, this cmdlet looks for the secret in the current +characters (`*`) aren't permitted. By default, this cmdlet looks for the secret in the current user's default vault. ```yaml -Type: String -Parameter Sets: SecureStringParameterSet, ObjectParameterSet +Type: System.String +Parameter Sets: NameParameterSet Aliases: -Required: False (SecureStringParameterSet, ObjectParameterSet), True (SecretInfoParameterSet) +Required: False Position: 2 Default value: None Accept pipeline input: False @@ -211,29 +162,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 ``` diff --git a/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Set-SecretVaultDefault.md b/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Set-SecretVaultDefault.md index 4f3a03d..069e6c4 100644 --- a/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Set-SecretVaultDefault.md +++ b/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Set-SecretVaultDefault.md @@ -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/set-secretvaultdefault?view=ps-modules&wt.mc_id=ps-gethelp schema: 2.0.0 --- @@ -79,13 +79,13 @@ registered vault. The last command shows that there is no default vault. Sets the **IsDefault** property to `$false` for all registered vaults. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: ClearParameterSet Aliases: Required: False Position: 0 -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -96,7 +96,7 @@ Specifies the name of a registered vault to set as the default vault. Wildcard c not permitted. ```yaml -Type: String +Type: System.String Parameter Sets: NameParameterSet Aliases: @@ -113,7 +113,7 @@ Specifies a **SecretVaultInfo** object representing the registered vault to set vault. ```yaml -Type: SecretVaultInfo +Type: Microsoft.PowerShell.SecretManagement.SecretVaultInfo Parameter Sets: SecretVaultParameterSet Aliases: @@ -129,29 +129,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 ``` diff --git a/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Test-SecretVault.md b/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Test-SecretVault.md index 2c34f40..9cad9b1 100644 --- a/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Test-SecretVault.md +++ b/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Test-SecretVault.md @@ -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/test-secretvault?view=ps-modules&wt.mc_id=ps-gethelp schema: 2.0.0 --- @@ -14,7 +14,7 @@ Runs an extension vault self test. ## SYNTAX ``` -Test-SecretVault [-Name ] [] +Test-SecretVault [[-Name] ] [] ``` ## DESCRIPTION @@ -44,15 +44,15 @@ This example runs the self-tests on the `CredMan` extension vault. All tests suc Specifies the name of one or more vaults to test. Enter a name or name pattern. Wildcard characters (`*`) are permitted. -If the **Name** parameter is not specified, this cmdlet runs the tests for all registered vaults. +If the **Name** parameter isn't specified, this cmdlet runs the tests for all registered vaults. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: (All) Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: True diff --git a/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Unlock-SecretVault.md b/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Unlock-SecretVault.md index c69987d..bc7c22b 100644 --- a/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Unlock-SecretVault.md +++ b/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Unlock-SecretVault.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.PowerShell.SecretManagement.dll-Help.xml Module Name: Microsoft.PowerShell.SecretManagement -ms.date: 08/26/2024 +ms.date: 05/23/2025 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 --- @@ -50,7 +50,7 @@ Unlock-SecretVault -Name CredMan -Password $SecurePassword ``` ```Output -WARNING: Cannot unlock extension vault 'CredMan': The vault does not support the Unlock-SecretVault +WARNING: Can't unlock extension vault 'CredMan': The vault doesn't support the Unlock-SecretVault function. ``` diff --git a/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Unregister-SecretVault.md b/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Unregister-SecretVault.md index f5ff845..69d536d 100644 --- a/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Unregister-SecretVault.md +++ b/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Unregister-SecretVault.md @@ -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/unregister-secretvault?view=ps-modules&wt.mc_id=ps-gethelp schema: 2.0.0 --- @@ -50,7 +50,7 @@ VaultName ModuleName IsDefaultVault CredMan Microsoft.PowerShell.CredManStore False PS C:\> Get-Secret -Name Secret5 -Get-Secret: The secret Secret5 was not found. +Get-Secret: The secret Secret5 wasn't found. PS C:\> Register-SecretVault -Name SecretStore -ModuleName Microsoft.PowerShell.SecretStore -DefaultVault PS C:\> Get-SecretVault @@ -66,7 +66,7 @@ System.Security.SecureString The first command lists the registered vaults for the current user. The second command un-registers the `LocalStore` vault. The third command verifies that the vault no longer appears in the registry. -The fourth command attempts to retrieve `Secret5`, but it is not found since its vault was +The fourth command attempts to retrieve `Secret5`, but it's not found since its vault was un-registered. The fifth command re-registers the vault under a different name and sets it as the user's default vault. The sixth command verifies that the vault has been re-registered as `SecretStore` and is the default vault. Finally, the last command retrieves `Secret5` from the @@ -95,7 +95,7 @@ Specifies the name of the vault to un-register. Enter a name or name pattern. Wi (`*`) are permitted. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: NameParameterSet Aliases: @@ -111,7 +111,7 @@ Accept wildcard characters: True Specifies a **SecretVaultInfo** object representing the vault to un-register. ```yaml -Type: SecretVaultInfo +Type: Microsoft.PowerShell.SecretManagement.SecretVaultInfo Parameter Sets: SecretVaultParameterSet Aliases: @@ -127,29 +127,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 ``` diff --git a/reference/ps-modules/Microsoft.PowerShell.SecretStore/Get-SecretStoreConfiguration.md b/reference/ps-modules/Microsoft.PowerShell.SecretStore/Get-SecretStoreConfiguration.md index 3378eba..678a629 100644 --- a/reference/ps-modules/Microsoft.PowerShell.SecretStore/Get-SecretStoreConfiguration.md +++ b/reference/ps-modules/Microsoft.PowerShell.SecretStore/Get-SecretStoreConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.PowerShell.SecretStore.dll-Help.xml Module Name: Microsoft.PowerShell.SecretStore -ms.date: 05/31/2022 +ms.date: 05/23/2025 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 --- @@ -33,7 +33,7 @@ PS C:\> Get-SecretStoreConfiguration CurrentUser Password 900 Prompt ``` -This example shows the current configuration for **SecretStore**. It is configured for the current +This example shows the current configuration for **SecretStore**. It's configured for the current user. It requires a password for initial access in a session and prompts the user for it in an interactive session. After fifteen minutes, the password is required again for access. @@ -56,6 +56,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -The `AllUsers` **Scope** is not supported. The **Scope** is always `CurrentUser`. +The `AllUsers` **Scope** isn't supported. The **Scope** is always `CurrentUser`. ## RELATED LINKS diff --git a/reference/ps-modules/Microsoft.PowerShell.SecretStore/Microsoft.PowerShell.SecretStore.md b/reference/ps-modules/Microsoft.PowerShell.SecretStore/Microsoft.PowerShell.SecretStore.md index 22aed43..ea5e76b 100644 --- a/reference/ps-modules/Microsoft.PowerShell.SecretStore/Microsoft.PowerShell.SecretStore.md +++ b/reference/ps-modules/Microsoft.PowerShell.SecretStore/Microsoft.PowerShell.SecretStore.md @@ -1,7 +1,7 @@ --- Module Name: Microsoft.PowerShell.SecretStore Module Guid: 6b983e67-c297-431a-916c-f4ce24dd7bac -ms.date: 05/31/2022 +ms.date: 05/23/2025 Download Help Link: https://aka.ms/ps-modules-help Help Version: 0.1.0.0 Locale: en-US @@ -13,15 +13,6 @@ Locale: en-US Local secure store extension vault for Microsoft.PowerShell.SecretManagement module. -> [!NOTE] -> This module is supported under traditional Microsoft support agreements, including -> [paid support](https://support.microsoft.com/hub/4343728/support-for-business), -> [Microsoft Enterprise Agreements](https://www.microsoft.com/licensing/licensing-programs/enterprise?rtc=1&activetab=enterprise-tab%3aprimaryr2), -> and [Microsoft Software Assurance](https://www.microsoft.com/licensing/licensing-programs/software-assurance-default.aspx). -> You can also pay for [support](https://support.microsoft.com/contactus) 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.SecretStore Cmdlets ### [Get-SecretStoreConfiguration](Get-SecretStoreConfiguration.md) diff --git a/reference/ps-modules/Microsoft.PowerShell.SecretStore/Reset-SecretStore.md b/reference/ps-modules/Microsoft.PowerShell.SecretStore/Reset-SecretStore.md index 048e388..fe71cc5 100644 --- a/reference/ps-modules/Microsoft.PowerShell.SecretStore/Reset-SecretStore.md +++ b/reference/ps-modules/Microsoft.PowerShell.SecretStore/Reset-SecretStore.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.PowerShell.SecretStore.dll-Help.xml Module Name: Microsoft.PowerShell.SecretStore -ms.date: 05/31/2022 +ms.date: 05/23/2025 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.secretstore/reset-secretstore?view=ps-modules&wt.mc_id=ps-gethelp schema: 2.0.0 --- @@ -14,17 +14,17 @@ Resets the SecretStore by deleting all secret data and configuring the store wit ## SYNTAX ``` -Reset-SecretStore [-Scope ] [-Authentication ] [-Password ] - [-PasswordTimeout ] [-Interaction ] [-PassThru] [-Force] [-WhatIf] [-Confirm] - [] +Reset-SecretStore [-Scope ] [-Authentication ] + [-Password ] [-PasswordTimeout ] [-Interaction ] [-PassThru] + [-Force] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION This cmdlet completely resets the **SecretStore** by deleting all secret data it may contain, and -resetting configuration options to their default values. It is intended to be used only if a -required password is lost, or data files become corrupted so that **SecretStore** no longer -functions and secret data cannot be accessed. +resetting configuration options to their default values. It's intended to be used only if a required +password is lost, or data files become corrupted so that **SecretStore** no longer functions and +secret data can't be accessed. The default configuration options can be overridden by specifying individual command configuration option parameters. @@ -39,9 +39,11 @@ WARNING: !!This operation will completely remove all SecretStore module secrets configuration settings to default values!! Reset SecretStore -Are you sure you want to erase all secrets in SecretStore and reset configuration settings to default? +Are you sure you want to erase all secrets in SecretStore and reset configuration +settings to default? [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "N"): Y -Creating a new Microsoft.PowerShell.SecretStore vault. A password is required by the current store configuration. +Creating a new Microsoft.PowerShell.SecretStore vault. A password is required by +the current store configuration. Enter password: ******** Enter password again for verification: @@ -67,10 +69,10 @@ default authentication is `Password`. > [!CAUTION] > Setting the **Authentication** to `None` is less secure than `Password`. Specifying `None` may be -> useful for testing scenarios but should not be used with important secrets. +> useful for testing scenarios but shouldn't be used with important secrets. ```yaml -Type: Authenticate +Type: Microsoft.PowerShell.SecretStore.Authenticate Parameter Sets: (All) Aliases: Accepted values: None, Password @@ -88,7 +90,7 @@ Indicates that the cmdlet should reset the **SecretStore** without prompting. By warns about the impact of resetting the **SecretStore** and prompts the user for confirmation. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -103,12 +105,12 @@ Accept wildcard characters: False Specifies whether the **SecretStore** should prompt a user when they access it. If the value is `Prompt`, the user is prompted for their password in interactive sessions when required. If the -value is `None`, the user is not prompted for a password. If the value is `None` and a password is +value is `None`, the user isn't prompted for a password. If the value is `None` and a password is required, the cmdlet requiring the password throws a **Microsoft.PowerShell.SecretStore.PasswordRequiredException** error. ```yaml -Type: Interaction +Type: Microsoft.PowerShell.SecretStore.Interaction Parameter Sets: (All) Aliases: Accepted values: None, Prompt @@ -126,7 +128,7 @@ Indicates that the cmdlet should return the **SecretStore** configuration after default, the cmdlet returns no output. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -141,10 +143,10 @@ Accept wildcard characters: False Specifies the password the **SecretStore** should require for access. If **Authentication** is specified as `None`, the cmdlet returns an error. If **Authentication** is `Password` and this -parameter is not specified, the cmdlet prompts the user to enter the password securely. +parameter isn't specified, the cmdlet prompts the user to enter the password securely. ```yaml -Type: SecureString +Type: System.Security.SecureString Parameter Sets: (All) Aliases: @@ -162,7 +164,7 @@ the timeout value is reached, the current password value is invalidated for the the **SecretStore** after the timeout requires the password again. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: @@ -179,7 +181,7 @@ Specifies the context the **SecretStore** is configured for. Only `CurrentUser` supported. ```yaml -Type: SecureStoreScope +Type: Microsoft.PowerShell.SecretStore.SecureStoreScope Parameter Sets: (All) Aliases: Accepted values: CurrentUser, AllUsers @@ -196,7 +198,7 @@ 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 @@ -209,10 +211,10 @@ 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 diff --git a/reference/ps-modules/Microsoft.PowerShell.SecretStore/Set-SecretStoreConfiguration.md b/reference/ps-modules/Microsoft.PowerShell.SecretStore/Set-SecretStoreConfiguration.md index 4f7570a..c9f6aeb 100644 --- a/reference/ps-modules/Microsoft.PowerShell.SecretStore/Set-SecretStoreConfiguration.md +++ b/reference/ps-modules/Microsoft.PowerShell.SecretStore/Set-SecretStoreConfiguration.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.PowerShell.SecretStore.dll-Help.xml Module Name: Microsoft.PowerShell.SecretStore -ms.date: 05/31/2022 +ms.date: 05/23/2025 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.secretstore/set-secretstoreconfiguration?view=ps-modules&wt.mc_id=ps-gethelp schema: 2.0.0 --- @@ -13,12 +13,11 @@ Configures the **SecretStore**. ## SYNTAX -### PARAMETERSet (Default) - +### ParameterSet (Default) ``` Set-SecretStoreConfiguration [-Scope ] [-Authentication ] - [-PasswordTimeout ] [-Interaction ] [-Password ] [-PassThru] [-WhatIf] - [-Confirm] [] + [-PasswordTimeout ] [-Interaction ] [-Password ] [-PassThru] + [-WhatIf] [-Confirm] [] ``` ### DefaultParameterSet @@ -61,10 +60,10 @@ default authentication is `Password`. > [!CAUTION] > Setting the **Authentication** to `None` is less secure than `Password`. Specifying `None` may be -> useful for testing scenarios but should not be used with important secrets. +> useful for testing scenarios but shouldn't be used with important secrets. ```yaml -Type: Authenticate +Type: Microsoft.PowerShell.SecretStore.Authenticate Parameter Sets: ParameterSet Aliases: @@ -80,7 +79,7 @@ Accept wildcard characters: False Indicates that the **SecretStore** should be set to its default configuration. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: DefaultParameterSet Aliases: @@ -95,12 +94,12 @@ Accept wildcard characters: False Specifies whether the **SecretStore** should prompt a user when they access it. If the value is `Prompt`, the user is prompted for their password in interactive sessions when required. If the -value is `None`, the user is not prompted for a password. If the value is `None` and a password is +value is `None`, the user isn't prompted for a password. If the value is `None` and a password is required, the cmdlet requiring the password throws a **Microsoft.PowerShell.SecretStore.PasswordRequiredException** error. ```yaml -Type: Interaction +Type: Microsoft.PowerShell.SecretStore.Interaction Parameter Sets: ParameterSet Aliases: @@ -117,7 +116,7 @@ Indicates that the cmdlet should return the **SecretStore** configuration after default, the cmdlet returns no output. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: @@ -130,7 +129,7 @@ Accept wildcard characters: False ### -Password -Specifies the password needed to access the **SecretStore**. This parameter cannot be used to change +Specifies the password needed to access the **SecretStore**. This parameter can't be used to change the existing password. To change the existing password, use `Set-SecretStorePassword`. When this parameter is used with the **Authenticate** parameter to change the configuration for @@ -138,11 +137,11 @@ authentication from `None` to `Password`, this parameter's value is set as the n **SecretStore**. When this parameter is used with the **Authenticate** parameter to change the configuration for -authentication from `Password` to `None`, this parameter's value must be the current password for the -**SecretStore**. It is used to authorize the configuration change. +authentication from `Password` to `None`, this parameter's value must be the current password for +the **SecretStore**. It's used to authorize the configuration change. ```yaml -Type: SecureString +Type: System.Security.SecureString Parameter Sets: (All) Aliases: @@ -160,7 +159,7 @@ password. After the timeout has elapsed, the current password value is invalidat Accessing the **SecretStore** after the timeout requires the password again. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: ParameterSet Aliases: @@ -177,7 +176,7 @@ Specifies the context the **SecretStore** is configured for. Only `CurrentUser` supported. ```yaml -Type: SecureStoreScope +Type: Microsoft.PowerShell.SecretStore.SecureStoreScope Parameter Sets: ParameterSet Aliases: Accepted values: CurrentUser, AllUsers @@ -194,7 +193,7 @@ 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 @@ -207,10 +206,10 @@ 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 diff --git a/reference/ps-modules/Microsoft.PowerShell.SecretStore/Set-SecretStorePassword.md b/reference/ps-modules/Microsoft.PowerShell.SecretStore/Set-SecretStorePassword.md index 9830112..7b01c6c 100644 --- a/reference/ps-modules/Microsoft.PowerShell.SecretStore/Set-SecretStorePassword.md +++ b/reference/ps-modules/Microsoft.PowerShell.SecretStore/Set-SecretStorePassword.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.PowerShell.SecretStore.dll-Help.xml Module Name: Microsoft.PowerShell.SecretStore -ms.date: 05/31/2022 +ms.date: 05/23/2025 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.secretstore/set-secretstorepassword?view=ps-modules&wt.mc_id=ps-gethelp schema: 2.0.0 --- @@ -19,8 +19,7 @@ Replaces the current SecretStore password with a new one. Set-SecretStorePassword [] ``` -### PARAMETERSet - +### ParameterSet ``` Set-SecretStorePassword -NewPassword [-Password ] [] ``` @@ -61,12 +60,12 @@ set. ### -NewPassword -Specifies the new password for accessing the **SecretStore**. If this parameter is not specified and +Specifies the new password for accessing the **SecretStore**. If this parameter isn't specified and the cmdlet is run in an interactive session, it prompts the user for the value. If this parameter is not specified and the cmdlet is run in a non-interactive session, it returns an error. ```yaml -Type: SecureString +Type: System.Security.SecureString Parameter Sets: ParameterSet Aliases: @@ -82,16 +81,16 @@ Accept wildcard characters: False Existing password needed to unlock the store. This can be ignored if the store doesn't currently use a password. -Specifies the existing password for accessing the **SecretStore**. If the **SecretStore** is not +Specifies the existing password for accessing the **SecretStore**. If the **SecretStore** isn't configured to require a password, this parameter is ignored. -If the **SecretStore** is configured to require a password, this parameter is not specified, and the +If the **SecretStore** is configured to require a password, this parameter isn't specified, and the cmdlet is run in an interactive session, it prompts the user for the value. If the **SecretStore** -is configured to require a password, this parameter is not specified and the cmdlet is run in a +is configured to require a password, this parameter isn't specified and the cmdlet is run in a non-interactive session, it returns an error. ```yaml -Type: SecureString +Type: System.Security.SecureString Parameter Sets: ParameterSet Aliases: diff --git a/reference/ps-modules/Microsoft.PowerShell.SecretStore/Unlock-SecretStore.md b/reference/ps-modules/Microsoft.PowerShell.SecretStore/Unlock-SecretStore.md index 70020a0..ff35c35 100644 --- a/reference/ps-modules/Microsoft.PowerShell.SecretStore/Unlock-SecretStore.md +++ b/reference/ps-modules/Microsoft.PowerShell.SecretStore/Unlock-SecretStore.md @@ -1,7 +1,7 @@ --- external help file: Microsoft.PowerShell.SecretStore.dll-Help.xml Module Name: Microsoft.PowerShell.SecretStore -ms.date: 05/31/2022 +ms.date: 05/23/2025 online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.secretstore/unlock-secretstore?view=ps-modules&wt.mc_id=ps-gethelp schema: 2.0.0 --- @@ -31,7 +31,7 @@ configured password timeout elapses. ```powershell PS C:\> Get-Secret Secret1 -Vault LocalStore Get-Secret: A valid password is required to access the Microsoft.PowerShell.SecretStore vault. -Get-Secret: The secret Secret1 was not found. +Get-Secret: The secret Secret1 wasn't found. PS C:\> Unlock-SecretStore @@ -45,7 +45,7 @@ System.Security.SecureString In this example, `Get-Secret` fails to retrieve `Secret1` because the **SecretStore** vault is locked. `Unlock-SecretStore` unlocks the vault. The cmdlet prompts for the password because the -**Password** parameter was not specified. With the vault unlocked, `Get-Secret` returns `Secret1` as +**Password** parameter wasn't specified. With the vault unlocked, `Get-Secret` returns `Secret1` as a **SecureString** object. ## PARAMETERS @@ -55,7 +55,7 @@ a **SecureString** object. Specifies the password needed to access the **SecretStore**. ```yaml -Type: SecureString +Type: System.Security.SecureString Parameter Sets: (All) Aliases: @@ -74,7 +74,7 @@ elapsed, the current password value is invalidated for the session. Accessing th after the timeout requires the password again. ```yaml -Type: Int32 +Type: System.Int32 Parameter Sets: (All) Aliases: diff --git a/reference/ps-modules/PlatyPS/About/.markdownlint.json b/reference/ps-modules/platyPS/About/.markdownlint.json similarity index 100% rename from reference/ps-modules/PlatyPS/About/.markdownlint.json rename to reference/ps-modules/platyPS/About/.markdownlint.json diff --git a/reference/ps-modules/PlatyPS/About/.markdownlint.yaml b/reference/ps-modules/platyPS/About/.markdownlint.yaml similarity index 100% rename from reference/ps-modules/PlatyPS/About/.markdownlint.yaml rename to reference/ps-modules/platyPS/About/.markdownlint.yaml diff --git a/reference/ps-modules/PlatyPS/About/about_platyPS.md b/reference/ps-modules/platyPS/About/about_platyPS.md similarity index 100% rename from reference/ps-modules/PlatyPS/About/about_platyPS.md rename to reference/ps-modules/platyPS/About/about_platyPS.md diff --git a/reference/ps-modules/PlatyPS/Get-HelpPreview.md b/reference/ps-modules/platyPS/Get-HelpPreview.md similarity index 100% rename from reference/ps-modules/PlatyPS/Get-HelpPreview.md rename to reference/ps-modules/platyPS/Get-HelpPreview.md diff --git a/reference/ps-modules/PlatyPS/Get-MarkdownMetadata.md b/reference/ps-modules/platyPS/Get-MarkdownMetadata.md similarity index 100% rename from reference/ps-modules/PlatyPS/Get-MarkdownMetadata.md rename to reference/ps-modules/platyPS/Get-MarkdownMetadata.md diff --git a/reference/ps-modules/PlatyPS/Merge-MarkdownHelp.md b/reference/ps-modules/platyPS/Merge-MarkdownHelp.md similarity index 100% rename from reference/ps-modules/PlatyPS/Merge-MarkdownHelp.md rename to reference/ps-modules/platyPS/Merge-MarkdownHelp.md diff --git a/reference/ps-modules/PlatyPS/New-ExternalHelp.md b/reference/ps-modules/platyPS/New-ExternalHelp.md similarity index 100% rename from reference/ps-modules/PlatyPS/New-ExternalHelp.md rename to reference/ps-modules/platyPS/New-ExternalHelp.md diff --git a/reference/ps-modules/PlatyPS/New-ExternalHelpCab.md b/reference/ps-modules/platyPS/New-ExternalHelpCab.md similarity index 100% rename from reference/ps-modules/PlatyPS/New-ExternalHelpCab.md rename to reference/ps-modules/platyPS/New-ExternalHelpCab.md diff --git a/reference/ps-modules/PlatyPS/New-MarkdownAboutHelp.md b/reference/ps-modules/platyPS/New-MarkdownAboutHelp.md similarity index 100% rename from reference/ps-modules/PlatyPS/New-MarkdownAboutHelp.md rename to reference/ps-modules/platyPS/New-MarkdownAboutHelp.md diff --git a/reference/ps-modules/PlatyPS/New-MarkdownHelp.md b/reference/ps-modules/platyPS/New-MarkdownHelp.md similarity index 100% rename from reference/ps-modules/PlatyPS/New-MarkdownHelp.md rename to reference/ps-modules/platyPS/New-MarkdownHelp.md diff --git a/reference/ps-modules/PlatyPS/New-YamlHelp.md b/reference/ps-modules/platyPS/New-YamlHelp.md similarity index 100% rename from reference/ps-modules/PlatyPS/New-YamlHelp.md rename to reference/ps-modules/platyPS/New-YamlHelp.md diff --git a/reference/ps-modules/PlatyPS/Update-MarkdownHelp.md b/reference/ps-modules/platyPS/Update-MarkdownHelp.md similarity index 100% rename from reference/ps-modules/PlatyPS/Update-MarkdownHelp.md rename to reference/ps-modules/platyPS/Update-MarkdownHelp.md diff --git a/reference/ps-modules/PlatyPS/Update-MarkdownHelpModule.md b/reference/ps-modules/platyPS/Update-MarkdownHelpModule.md similarity index 100% rename from reference/ps-modules/PlatyPS/Update-MarkdownHelpModule.md rename to reference/ps-modules/platyPS/Update-MarkdownHelpModule.md diff --git a/reference/ps-modules/PlatyPS/platyPS.md b/reference/ps-modules/platyPS/platyPS.md similarity index 100% rename from reference/ps-modules/PlatyPS/platyPS.md rename to reference/ps-modules/platyPS/platyPS.md