Skip to content

Commit f2d3f6a

Browse files
authored
📝 Add parameter descriptions
1 parent cb59180 commit f2d3f6a

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

Save-Secret.ps1

+11
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,28 @@ Stores the token from the clipboard.
1414
#Requires -Version 7
1515
#Requires -Modules Microsoft.PowerShell.SecretManagement,Microsoft.PowerShell.SecretStore
1616
[CmdletBinding()] Param(
17+
# Specifies the name of the secret to add metadata to. Wildcard characters (`*`) are not permitted.
1718
[Parameter(Position=0,Mandatory=$true)][string] $Name,
19+
# Specifies the value of the secret.
1820
[Parameter(ParameterSetName='Secret',Position=1,Mandatory=$true)][securestring] $Secret,
21+
# Title metadata field.
1922
[string] $Title,
23+
# Description metadata field.
2024
[string] $Description,
25+
# Note metadata field.
2126
[string] $Note,
27+
# Uri metadata field.
2228
[uri] $Uri,
29+
# Created date/time metadata field.
2330
[datetime] $Created = (Get-Date),
31+
# Expiration date/time metadata field.
2432
[datetime] $Expires,
33+
# Specifies the type to interpret the text on the clipboard as for use as the secret value.
2534
[Parameter(ParameterSetName='Paste',Mandatory=$true)]
2635
[ValidateSet('string','securestring','bytes','hexbytes')][string] $Paste,
36+
# Specifies the username to combine with the clipboard text as a password to store as a credential secret.
2737
[Parameter(ParameterSetName='PasteForUser',Mandatory=$true)][string] $PasteForUser,
38+
# Specifies the encoding to read the clipboard as, into a byte array secret.
2839
[Parameter(ParameterSetName='PasteTextBytes',Mandatory=$true)][Text.Encoding] $PasteTextBytes
2940
)
3041
$clipboard = Get-Clipboard |Out-String

0 commit comments

Comments
 (0)