Get-PSSMSecret

SecretManagement: Retrieves a secret from a registered vault

Script

#Requires -Version 5.1
#Requires -Modules Microsoft.PowerShell.SecretManagement, Microsoft.PowerShell.SecretStore

[CmdletBinding()]
Param(
    [Parameter(Mandatory = $true)]
    [string]$SecretName,

    [securestring]$StorePassword,
    [string]$VaultName,
    [switch]$AsPlainText
)

Process {
    try {
        if ($null -ne $StorePassword) { Unlock-SecretStore -Password $StorePassword -ErrorAction Stop }
        $cmdArgs = @{ ErrorAction = 'Stop'; Name = $SecretName; AsPlainText = $AsPlainText }
        if ($PSBoundParameters.ContainsKey('VaultName')) { $cmdArgs.Add('Vault', $VaultName) }
        $sec = Get-Secret @cmdArgs -ErrorAction Stop
        if ($null -ne $sec) { [PSCustomObject]@{ Timestamp = Get-Date -Format "yyyy-MM-dd HH:mm:ss"; SecretName = $SecretName; Value = $sec.ToString() } }
    }
    catch { throw }
}

Customize

SecretName string

Name of the secret to retrieve

StorePassword securestring

Password to unlock the SecretStore if required

VaultName string

Name of the vault to search

AsPlainText switch

Off

Return the secret as a plain text string