en-US/Microsoft.PowerShell.SecretManagement.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-Secret</command:name> <command:verb>Get</command:verb> <command:noun>Secret</command:noun> <maml:description> <maml:para>Finds and returns a secret by name from registered vaults.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet finds and returns the first secret that matches the provided name. If a vault name is specified, then only that vault will be searched. Otherwise, all vaults are searched and the first found result is returned. If a 'Default' vault is specified, then that vault is searched before any other registered vault. Secrets that are string or SecureString types are returned as SecureString objects by default. Unless the '-AsPlainText' parameter switch is used, in which case the secret is returned as a String type in plain text.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Secret</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>InputObject</maml:name> <maml:Description> <maml:para>SecretInformation object that describes a vault secret.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecretInformation</command:parameterValue> <dev:type> <maml:name>SecretInformation</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AsPlainText</maml:name> <maml:Description> <maml:para>Switch parameter that when used returns either a string or SecureString secret type as a String type (in plain text). If the secret being retrieved is not of string or SecureString type, this switch parameter has no effect.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-Secret</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the secret to be retrieved. Wild card characters are not allowed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Vault</maml:name> <maml:Description> <maml:para>Optional name of the registered vault to retrieve the secret from. If no vault name is specified, then all registered vaults are searched.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AsPlainText</maml:name> <maml:Description> <maml:para>Switch parameter that when used returns either a string or SecureString secret type as a String type (in plain text). If the secret being retrieved is not of string or SecureString type, this switch parameter has no effect.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AsPlainText</maml:name> <maml:Description> <maml:para>Switch parameter that when used returns either a string or SecureString secret type as a String type (in plain text). If the secret being retrieved is not of string or SecureString type, this switch parameter has no effect.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>InputObject</maml:name> <maml:Description> <maml:para>SecretInformation object that describes a vault secret.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecretInformation</command:parameterValue> <dev:type> <maml:name>SecretInformation</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the secret to be retrieved. Wild card characters are not allowed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Vault</maml:name> <maml:Description> <maml:para>Optional name of the registered vault to retrieve the secret from. If no vault name is specified, then all registered vaults are searched.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.PowerShell.SecretManagement.SecretInformation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-Secret -Name Secret1 -Vault CredMan System.Security.SecureString PS C:\> Get-Secret -Name Secret1 -Vault CredMan -AsPlainText PlainTextSecretString</dev:code> <dev:remarks> <maml:para>This example searches for a secret with the name 'Secret1', which is a String type secret. The first time returns the secret as a SecureString object. The second time uses the '-AsPlainText' and so the secret string is returned as a string object, and is displayed in plain text.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-SecretInfo -Name Secret2 -Vault SecretStore | Get-Secret -AsPlainText</dev:code> <dev:remarks> <maml:para>This example retrieves secret information for the secret named 'Secret2' and then pipe the result to `Get-Secret`. The secret is then looked up in the SecretStore vault and returned as plain text.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SecretInfo</command:name> <command:verb>Get</command:verb> <command:noun>SecretInfo</command:noun> <maml:description> <maml:para>Finds and returns secret metadata information of one or more secrets.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet finds and returns secret metadata for secrets with names that match the provided 'Name'. The 'Name' parameter argument can include wildcards for the search. If no 'Name' parameter argument is provided then metadata for all secrets is returned. The search is performed over all registered vaults, unless a specific vault name is specified. Secret metadata consists of the secret name, secret type, and vault name.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SecretInfo</maml:name> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>This parameter takes a String argument, including wildcard characters. It is used to filter the search results that match on secret names the provided name pattern. If no 'Name' parameter argument is provided, then all stored secret metadata is returned.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Vault</maml:name> <maml:Description> <maml:para>Optional parameter which takes a String argument that specifies a single vault to search.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>This parameter takes a String argument, including wildcard characters. It is used to filter the search results that match on secret names the provided name pattern. If no 'Name' parameter argument is provided, then all stored secret metadata is returned.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Vault</maml:name> <maml:Description> <maml:para>Optional parameter which takes a String argument that specifies a single vault to search.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.PowerShell.SecretManagement.SecretInformation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-SecretInfo -Name * Name Type VaultName ---- ---- --------- Secret1 String LocalStore Secret2 ByteArray LocalStore Secret3 SecureString LocalStore Secret4 PSCredential LocalStore Secret5 Hashtable LocalStore Secret6 ByteArray CredMan</dev:code> <dev:remarks> <maml:para>This example runs the command with the 'Name' parameter argument being a single wildcard character. So all metadata for all stored secrets is returned. There are two registered vaults, LocalStore and CredMan. There are six secrets metadata information returned over the two vaults.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SecretVault</command:name> <command:verb>Get</command:verb> <command:noun>SecretVault</command:noun> <maml:description> <maml:para>Finds and returns registered vault information.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet finds and returns information of registered vaults. It takes an array of vault name strings, which can contain wildcard characters. If no 'Name' parameter is specified, all registered vault information is returned. The registered vault information includes the vault name, vault implementing module name, and optional default parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SecretVault</maml:name> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>This parameter takes a String argument, including wildcard characters. It is used to filter the search results on vault names that match the provided name pattern.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>This parameter takes a String argument, including wildcard characters. It is used to filter the search results on vault names that match the provided name pattern.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.PowerShell.SecretManagement.SecretVaultInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-SecretVault VaultName ModuleName IsDefaultVault --------- ---------- -------------- CredMan Microsoft.PowerShell.CredManStore False LocalStore Microsoft.PowerShell.SecretStore True</dev:code> <dev:remarks> <maml:para>This example runs the command without any parameter arguments, and so returns information on all registered vaults. The 'LocalStore' vault is shown to be set as the default vault.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Register-SecretVault</command:name> <command:verb>Register</command:verb> <command:noun>SecretVault</command:noun> <maml:description> <maml:para>Registers a SecretManagement extension vault module for the current user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet adds a provided SecretManagement extension vault module to the current user vault registry. An extension vault module is a PowerShell module that conforms to the required extension vault format. This cmdlet will first verify that the provided module meets conformance requirements, and then add it to the extension vault registry. Extension vaults are registered to the current user and do not affect other user vault registrations.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Register-SecretVault</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the extension vault to be registered. If no name is provide, the module name will be used.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ModuleName</maml:name> <maml:Description> <maml:para>Name of the PowerShell module that implements the extension vault. It can be a simple name, in which case PowerShell will search for it in its known module paths. Alternatively, a pathname can be provided and PowerShell will look in the specific path for the module.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllowClobber</maml:name> <maml:Description> <maml:para>When used this parameter will overwrite an existing registered extension vault with the same name.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DefaultVault</maml:name> <maml:Description> <maml:para>This parameter switch makes the new extension vault the default vault for the current user.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>This parameter takes a description string that is included in the vault registry information.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>When used this parameter will return the SecretVaultInfo object for the successfully registered extension vault.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>VaultParameters</maml:name> <maml:Description> <maml:para>This takes a hashtable object that contains optional parameter name-value pairs needed by the extension vault. These optional parameters are provided to the extension vault when invoked.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllowClobber</maml:name> <maml:Description> <maml:para>When used this parameter will overwrite an existing registered extension vault with the same name.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DefaultVault</maml:name> <maml:Description> <maml:para>This parameter switch makes the new extension vault the default vault for the current user.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:Description> <maml:para>This parameter takes a description string that is included in the vault registry information.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ModuleName</maml:name> <maml:Description> <maml:para>Name of the PowerShell module that implements the extension vault. It can be a simple name, in which case PowerShell will search for it in its known module paths. Alternatively, a pathname can be provided and PowerShell will look in the specific path for the module.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the extension vault to be registered. If no name is provide, the module name will be used.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>When used this parameter will return the SecretVaultInfo object for the successfully registered extension vault.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>VaultParameters</maml:name> <maml:Description> <maml:para>This takes a hashtable object that contains optional parameter name-value pairs needed by the extension vault. These optional parameters are provided to the extension vault when invoked.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Register-SecretVault -Name LocalStore -ModuleName Microsoft.PowerShell.SecretStore -DefaultVault PS C:\> Get-SecretVault VaultName ModuleName IsDefaultVault --------- ---------- -------------- CredMan Microsoft.PowerShell.CredManStore False LocalStore Microsoft.PowerShell.SecretStore True</dev:code> <dev:remarks> <maml:para>This example registers the Microsoft.PowerShell.SecretStore extension vault module for the current user. The 'Microsoft.PowerShell.SecretStore' is installed in a known PowerShell module path, so just the module name is needed. It uses the 'DefaultVault' parameter switch to make it the default module for the user. The 'Get-SecretVault' command is run next to list all registered vaults for the user, and verifies the vault was registered and set as the default vault.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-Secret</command:name> <command:verb>Remove</command:verb> <command:noun>Secret</command:noun> <maml:description> <maml:para>Removes a secret from a specified registered extension vault.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet will remove a secret by name from a registered extension vault. Both the secret name and extension vault name must be provided.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-Secret</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>InputObject</maml:name> <maml:Description> <maml:para>SecretInformation object that describes a vault secret.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecretInformation</command:parameterValue> <dev:type> <maml:name>SecretInformation</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-Secret</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the secret to remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Vault</maml:name> <maml:Description> <maml:para>Name of the vault from which the secret is to be removed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>InputObject</maml:name> <maml:Description> <maml:para>SecretInformation object that describes a vault secret.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecretInformation</command:parameterValue> <dev:type> <maml:name>SecretInformation</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the secret to remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Vault</maml:name> <maml:Description> <maml:para>Name of the vault from which the secret is to be removed.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Microsoft.PowerShell.SecretManagement.SecretInformation</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-Secret -Name secretTest -Vault CredMan PS C:\> Get-Secret -Name secretTest -Vault CredMan Get-Secret: The secret secretTest was not found.</dev:code> <dev:remarks> <maml:para>This example runs the command to remove the secret 'secretTest' from the CredMan vault. The 'Get-Secret' command is next run to verify the secret no longer exists in the vault.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-SecretInfo -Name Secret2 -Vault CredMan | Remove-Secret PS C:\> Get-Secret -Name Secret2 -Vault CredMan Get-Secret: The secret Secret2 was not found.</dev:code> <dev:remarks> <maml:para>This example first obtains secret information for the 'Secret2' secret and pipes the results to this command. `Remove-Secret` then removes the secret from the vault using the piped in secret information.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-Secret</command:name> <command:verb>Set</command:verb> <command:noun>Secret</command:noun> <maml:description> <maml:para>Adds a secret to a SecretManagement registered vault.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet adds a secret value by name to SecretManagement. If no vault name is specified, then the secret will be added to the default vault. If an existing secret by the same name exists, it will be overwritten with the new value unless the 'NoClobber' parameter switch is used. Additional data can be included with the secret through the `-Metadata` parameter, if supported by the extension vault. If the extension vault does not support metadata then an error will be generated and the operation will fail. Metadata is not required to be stored securely, and should not contain sensitive information. The secret value must be one of five supported types:</maml:para> <maml:para>- byte[]</maml:para> <maml:para>- String</maml:para> <maml:para>- SecureString</maml:para> <maml:para>- PSCredential</maml:para> <maml:para>- Hashtable</maml:para> <maml:para></maml:para> <maml:para>The default parameter set takes a SecureString object. So if the command is run without specifying the secret value, the user will be safely prompted to enter a SecureString which cannot be seen on the console.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-Secret</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of secret to add.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>SecureStringSecret</maml:name> <maml:Description> <maml:para>A secret SecretString object to be added.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Vault</maml:name> <maml:Description> <maml:para>Optional name of vault to which the secret is added. If omitted, the secret will be added to the default vault.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Metadata</maml:name> <maml:Description> <maml:para>Hashtable containing Name/Value pair that are stored in the vault. The specified extension vault may not support secret metadata, in which case the `Set-Secret` operation will fail. The metadata Name/Value value type must be one of the following: - string</maml:para> <maml:para>- int</maml:para> <maml:para>- DateTime</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoClobber</maml:name> <maml:Description> <maml:para>When used this parameter will cause an error if the secret name already exists.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-Secret</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of secret to add.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Secret</maml:name> <maml:Description> <maml:para>A secret value to be added. The object type must be one of the supported types.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Vault</maml:name> <maml:Description> <maml:para>Optional name of vault to which the secret is added. If omitted, the secret will be added to the default vault.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Metadata</maml:name> <maml:Description> <maml:para>Hashtable containing Name/Value pair that are stored in the vault. The specified extension vault may not support secret metadata, in which case the `Set-Secret` operation will fail. The metadata Name/Value value type must be one of the following: - string</maml:para> <maml:para>- int</maml:para> <maml:para>- DateTime</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoClobber</maml:name> <maml:Description> <maml:para>When used this parameter will cause an error if the secret name already exists.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-Secret</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of secret to add.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>SecretInfo</maml:name> <maml:Description> <maml:para>A SecretInformation object describing a stored secret returned by `Get-SecretInfo`. This allows moving secrets from one extension vault to another.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecretInformation</command:parameterValue> <dev:type> <maml:name>SecretInformation</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Vault</maml:name> <maml:Description> <maml:para>Optional name of vault to which the secret is added. If omitted, the secret will be added to the default vault.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoClobber</maml:name> <maml:Description> <maml:para>When used this parameter will cause an error if the secret name already exists.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Metadata</maml:name> <maml:Description> <maml:para>Hashtable containing Name/Value pair that are stored in the vault. The specified extension vault may not support secret metadata, in which case the `Set-Secret` operation will fail. The metadata Name/Value value type must be one of the following: - string</maml:para> <maml:para>- int</maml:para> <maml:para>- DateTime</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of secret to add.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoClobber</maml:name> <maml:Description> <maml:para>When used this parameter will cause an error if the secret name already exists.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Secret</maml:name> <maml:Description> <maml:para>A secret value to be added. The object type must be one of the supported types.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>SecretInfo</maml:name> <maml:Description> <maml:para>A SecretInformation object describing a stored secret returned by `Get-SecretInfo`. This allows moving secrets from one extension vault to another.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecretInformation</command:parameterValue> <dev:type> <maml:name>SecretInformation</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>SecureStringSecret</maml:name> <maml:Description> <maml:para>A secret SecretString object to be added.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Vault</maml:name> <maml:Description> <maml:para>Optional name of vault to which the secret is added. If omitted, the secret will be added to the default vault.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Security.SecureString</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Set-Secret -Name Secret1 -Secret "SecretValue" PS C:\> Get-Secret -Name Secret1 System.Security.SecureString</dev:code> <dev:remarks> <maml:para>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 default vault. Next, the 'Get-Secret' command is run to verify the added secret.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Set-Secret -Name Secret2 -Vault LocalStore cmdlet Set-Secret at command pipeline position 1 Supply values for the following parameters: SecureStringSecret: *********** PS C:\> Get-Secret -Name Secret2 System.Security.SecureString</dev:code> <dev:remarks> <maml:para>This example adds a secret named 'Secret2' to the LocalStore vault. Since no secret value was provided, the user is prompted for a SecureString value. The console hides the string value as it is typed. Next, the 'Get-Secret' command is run to verify the secret was added.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Set-Secret -Name TargetSecret -Secret $targetToken -Vault LocalStore -Metadata @{ Expiration = ([datetime]::new(2022, 5, 1)) } PS C:\> Get-SecretInfo -Name TargetSecret | Select-Object Name,Metadata Name Metadata ---- -------- TargetSecret {[Expiration, 5/1/2022 12:00:00 AM]}</dev:code> <dev:remarks> <maml:para>This example adds a secret named 'TargetSecret' to the LocalStore vault, along with extra metadata indicating the secret expiration date. The metadata is retrieved using the `Get-SecretInfo` cmdlet. </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:\> Set-Secret -Name PublishSecret -Secret $targetToken -Vault LocalStore2 -Metadata @{ Expiration = ([datetime]::new(2022, 5, 1)) } Set-Secret: Cannot store secret PublishSecret. Vault LocalStore2 does not support secret metadata.</dev:code> <dev:remarks> <maml:para>This example adds a secret named 'PublishSecret' to the LocalStore2 vault, along with extra metadata. However, vault LocalStore2 does not support secret metadata and the operation fails with error. </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-Secret</command:name> <command:verb>Set</command:verb> <command:noun>Secret</command:noun> <maml:description> <maml:para>Adds or replaces additional secret metadata to a secret currently stored in a vault.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet adds additional secret metadata to a currently store secret. Metadata support is an optional feature for an extension vault. An error will be thrown if a vault does not support secret metadata. Metadata is a Hashtable object containing Name/Value pairs. The value type is restricted to the following:</maml:para> <maml:para>- string</maml:para> <maml:para>- int</maml:para> <maml:para>- DateTime</maml:para> <maml:para></maml:para> <maml:para>Metadata is not stored securely in a vault. Metadata should not contain sensitive information. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-Secret</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of secret for which the metadata is added</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Metadata</maml:name> <maml:Description> <maml:para>Hashtable containing Name/Value pair that are stored in the vault. The specified extension vault may not support secret metadata, in which case the operation will fail. The metadata Name/Value value type must be one of the following: - string</maml:para> <maml:para>- int</maml:para> <maml:para>- DateTime</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Vault</maml:name> <maml:Description> <maml:para>Optional name of vault to which the secret is added. If omitted, the secret will be added to the default vault.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Metadata</maml:name> <maml:Description> <maml:para>Hashtable containing Name/Value pair that are stored in the vault. The specified extension vault may not support secret metadata, in which case the operation will fail. The metadata Name/Value value type must be one of the following: - string</maml:para> <maml:para>- int</maml:para> <maml:para>- DateTime</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of secret for which the metadata is added</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Vault</maml:name> <maml:Description> <maml:para>Optional name of vault to which the secret is added. If omitted, the secret will be added to the default vault.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Set-SecretInfo -Name Secret1 -Vault Vault1 -Metadata @{ Expiration = ([datetime]::new(2022, 5, 1)) } PS C:\> Get-SecretInfo -Name Secret1 -Vault Vault1 | Select-Object Name,Metadata Name Metadata ---- -------- Secret1 {[Expiration, 5/1/2022 12:00:00 AM]}</dev:code> <dev:remarks> <maml:para>This example adds metadata to the 'Secret1' secret stored in 'Vault1' vault. The metadata is then retrieved for 'Secret1' using the `Get-SecretInfo` command.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Set-SecretInfo -Name Secret2 -Vault Vault2 -Metadata @{ Expiration = ([datetime]::new(2022, 5, 1)) } Set-SecretInfo: Cannot set secret metadata Secret2. Vault Vault2 does not support secret metadata.</dev:code> <dev:remarks> <maml:para>This example adds metadata to the 'Secret2' secret stored in 'Vault2' vault. However, Vault2 does not support metadata and an error is generated.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-SecretVaultDefault</command:name> <command:verb>Set</command:verb> <command:noun>SecretVaultDefault</command:noun> <maml:description> <maml:para>Sets the provided vault name as the default vault for the current user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet updates the vault registry to indicate the provided vault name as the default vault. Only one registered vault can be the default vault. If this cmdlet is run without specifying the 'Name' parameter, then no registered vault is the default vault.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-SecretVaultDefault</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ClearDefault</maml:name> <maml:Description> <maml:para>Makes no registered vault the default vault.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-SecretVaultDefault</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of registered vault to be made the default vault.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-SecretVaultDefault</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SecretVault</maml:name> <maml:Description> <maml:para>A SecretVaultInfo object that represents the registered vault to be made the default vault.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecretVaultInfo</command:parameterValue> <dev:type> <maml:name>SecretVaultInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ClearDefault</maml:name> <maml:Description> <maml:para>Makes no registered vault the default vault.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of registered vault to be made the default vault.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SecretVault</maml:name> <maml:Description> <maml:para>A SecretVaultInfo object that represents the registered vault to be made the default vault.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecretVaultInfo</command:parameterValue> <dev:type> <maml:name>SecretVaultInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-SecretVault VaultName ModuleName IsDefaultVault --------- ---------- -------------- CredMan Microsoft.PowerShell.CredManStore False LocalStore Microsoft.PowerShell.SecretStore True PS C:\> Set-SecretVaultDefault -Name CredMan PS C:\> Get-SecretVault VaultName ModuleName IsDefaultVault --------- ---------- -------------- CredMan Microsoft.PowerShell.CredManStore True LocalStore Microsoft.PowerShell.SecretStore False PS C:\> Set-SecretVaultDefault PS C:\> Get-SecretVault VaultName ModuleName IsDefaultVault --------- ---------- -------------- CredMan Microsoft.PowerShell.CredManStore False LocalStore Microsoft.PowerShell.SecretStore False</dev:code> <dev:remarks> <maml:para>This cmdlet first runs 'Get-SecretVault' command to get all registered vault information, and shows that the 'LocalStore' is currently the default vault for the user. Next, the 'Set-SecretVaultDefault' command is run to make the 'CredMan' vault the default vault. The 'Get-SecretVault' command is run a second time to verify 'CredMan' vault is now default, and 'LocalStore' vault is no longer default. Finally, the 'Set-SecretVaultDefault' command is run with no 'Name' parameter, to remove the default designation from any registered vault. The 'Get-SecretVault' is run once again to verify there is no default vault.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-SecretVault</command:name> <command:verb>Test</command:verb> <command:noun>SecretVault</command:noun> <maml:description> <maml:para>Runs an extension vault self test.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet runs an extension vault self test, by running the internal vault 'Test-SecretVault' command. It will return 'True' if all tests succeeded, and 'False' otherwise. Information on failing tests will be written to the error stream as error records. For more information during the test run use the `-Verbose` command switch.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-SecretVault</maml:name> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="1" aliases="none"> <maml:name>Vault</maml:name> <maml:Description> <maml:para>Name of vault to run self tests on.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="1" aliases="none"> <maml:name>Vault</maml:name> <maml:Description> <maml:para>Name of vault to run self tests on.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>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</dev:code> <dev:remarks> <maml:para>This example runs self tests on the 'CredMan' extension vault. All tests succeeded so no errors are written and 'True' is returned.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Unregister-SecretVault</command:name> <command:verb>Unregister</command:verb> <command:noun>SecretVault</command:noun> <maml:description> <maml:para>Un-registers an extension vault from SecretManagement for the current user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet un-registers the specified extension vault. Once un-registered, the vault is no longer available to SecretManagement, for the current user.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Unregister-SecretVault</maml:name> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the vault to un-register.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Unregister-SecretVault</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>SecretVault</maml:name> <maml:Description> <maml:para>SecretVaultInfo object, returned by 'Get-SecretVault' cmdlet. This can alternately be used to indicate a vault to be un-registered.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecretVaultInfo</command:parameterValue> <dev:type> <maml:name>SecretVaultInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="true" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Name of the vault to un-register.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">string[]</command:parameterValue> <dev:type> <maml:name>string[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>SecretVault</maml:name> <maml:Description> <maml:para>SecretVaultInfo object, returned by 'Get-SecretVault' cmdlet. This can alternately be used to indicate a vault to be un-registered.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecretVaultInfo</command:parameterValue> <dev:type> <maml:name>SecretVaultInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.PowerShell.SecretManagement.SecretVaultInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-SecretVault VaultName ModuleName IsDefaultVault --------- ---------- -------------- CredMan Microsoft.PowerShell.CredManStore False LocalStore Microsoft.PowerShell.SecretStore True PS C:\> Unregister-SecretVault LocalStore PS C:\> Get-SecretVault VaultName ModuleName IsDefaultVault --------- ---------- -------------- CredMan Microsoft.PowerShell.CredManStore False PS C:\> Get-Secret -Name Secret5 Get-Secret: The secret Secret5 was not found. PS C:\> Register-SecretVault -Name SecretStore -ModuleName Microsoft.PowerShell.SecretStore -DefaultVault PS C:\> Get-SecretVault VaultName ModuleName IsDefaultVault --------- ---------- -------------- CredMan Microsoft.PowerShell.CredManStore False SecretStore Microsoft.PowerShell.SecretStore True PS C:\> Get-Secret -Name Secret5 System.Security.SecureString</dev:code> <dev:remarks> <maml:para>In this example, 'Get-SecretVault' command is run to see what vaults are registered for the current user. Next, the 'LocalStore' vault is un-registered. 'Get-SecretVault' command is run again to verify the vault no longer appears in the registry. An attempt is made to retrieve 'Secret5', but it is not found since its vault was un-registered. The vault is re-registered, under a different name, and set to be the default vault. 'Get-SecretVault' is run again to verify the newly registered vault. Finally, the 'Secret5' secret is retrieved successfully from the new default vault.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-SecretVault | Unregister-SecretVault PS C:\> Get-SecretVault PS C:\></dev:code> <dev:remarks> <maml:para>In this example, 'Get-SecretVault' output is piped to this 'Unregister-SecretVault' cmdlet to un-register all extension vaults for the current user. Next, 'Get-SecretVault' is run again to show that no vaults are registered.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |