Parsing a Powershell variable

by

What you’re showing is the stringified form of a custom object, which uses a hashtable-like textual representation.

That custom object’s definition looks something like this:

# Construct a custom object with .ResourceType, .Id, and .Name properties.
$response = [pscustomobject] @{
  ResourceType="UserStory"
  Id = 202847
  Name="Professional Lines: 2,800,000 Policy Aggregate Limit update"
}

If you include this variable in an expandable string (interpolating string), you’ll get the representation in your question[1] – note that you’ll get the same representation if you pass the object to the Write-Host cmdlet[2], as well as even with default output formatting if [pscustomobject] instances are nested in property values:

# Note the enclosing "..."
PS> "$response"

@{ResourceType=UserStory; Id=202847; Name=Professional Lines: 2,800,000 Policy Aggregate Limit update}

# Custom object nested in a property value:
PS> [pscustomobject] @{ foo = [pscustomobject] @{ bar="baz" } }

foo
---
@{bar=baz}

Note that without the enclosing "...", you’d get a nicer, tabular representation, courtesy of PowerShell’s output-formatting system.

PS> $response  # direct output of the object

ResourceType     Id Name
------------     -- ----
UserStory    202847 Professional Lines: 2,800,000 Policy Aggregate Limit update

Assuming $response is actually still a custom object, and not a string representation of it, you can simply access the custom object’s properties to build your string, again using an expandable string:

PS> "TP Id:$($response.Id) $($response.Name)"
TP Id:202847 Professional Lines: 2,800,000 Policy Aggregate Limit update

Note the need to use $(...) around the property references – see this answer for a summary of PowerShell’s string-expansion rules.

An alternative approach is to use the -f operator, which uses formatting strings like the .NET String.Format() method:

PS> 'TP ID:{0} {1}' -f $response.Id, $response.Name
TP ID:202847 Professional Lines: 2,800,000 Policy Aggregate Limit update

[1] You can also obtain this representation by calling .psobject.ToString() on a custom object; curiously, just .ToString() doesn’t work, as of PowerShell Core 6.1.0; this surprising discrepancy is discussed in this GitHub issue.

[2] Do note that Write-Host‘s purpose is to provide for-display-only (to-host) output, which bypasses PowerShell’s success output stream, and thereby the ability to capture or redirect its output – see this answer for more information.

More Related Contents:

  1. String handling from Powershell script
  2. Powershell script to delete 15 days old .txt files [duplicate]
  3. How to create a zip archive with PowerShell?
  4. How to run an EXE file in PowerShell with parameters with spaces and quotes
  5. Use PowerShell to run virus scan on multiple servers
  6. Unable to access UNC Paths in Powershell remote session
  7. Fastest Way to get a uniquely index item from the property of an array
  8. PowerShell IE9 ComObject has all null properties after navigating to webpage
  9. PowerShell script runs when pasted into the PowerShell window, but not when run from shortcut
  10. save PSCredential in the file
  11. How do I write a PowerShell script that accepts pipeline input?
  12. PowerShell’s Invoke-RestMethod equivalent of curl -u (Basic Authentication)
  13. How do I Start a job of a function i just defined?
  14. Remove files and foldes on Azure before a new deploy from VSTS
  15. try, catch doesent seem to work
  16. Specifying *.xls filter in Get-ChildItem also returns *.xlsx results
  17. Inserting a date into SQL
  18. Prompt for user input in PowerShell
  19. Run a [Code] or PowerShell script in Inno Setup compiler
  20. Replacing a string with a variable in Get-ADGroup
  21. Create an incrementing variable from 2 variables in PowerShell
  22. Can the following Nested foreach loop be simplified in PowerShell?
  23. Add Write-Progress to Get-Job/Wait-Job
  24. Powershell with exchange– How do I append all verbose output to a file
  25. How to handle command-line arguments in PowerShell
  26. How to send email with PowerShell
  27. How to split string by string in Powershell
  28. Powershell: Colon in commandlet parameters
  29. Passing PowerShell variables into a script block
  30. powershell function switch param with string array

Leave a Comment