Custom objects (PSCustomObject) in PowerShell

Introduction

Custom objects let you group related information together in one place. They make data easier to organize and use.

When you want to store multiple pieces of related data like a person's name and age.

When you need to create a simple record or table of information.

When you want to pass structured data between commands or scripts.

When you want to display data in a clear, readable format.

When you want to add custom properties to data for automation tasks.

Syntax

PowerShell

@{ Property1 = 'Value1'; Property2 = 'Value2' } | ForEach-Object { [PSCustomObject]$_ }

Use @{ } to create a hashtable of properties and values.

Pipe the hashtable to ForEach-Object with [PSCustomObject] to create the custom object.

Examples

This creates a custom object with Name and Age properties and shows it.

PowerShell

$person = @{ Name = 'Alice'; Age = 30 } | ForEach-Object { [PSCustomObject]$_ }
$person

This is a shorter way to create a custom object directly from a hashtable.

PowerShell

$car = [PSCustomObject]@{ Make = 'Toyota'; Model = 'Corolla'; Year = 2020 }
$car

Access a property of the custom object using dot notation.

PowerShell

$book = [PSCustomObject]@{ Title = 'PowerShell Guide'; Pages = 250 }
$book.Title

Sample Program

This script creates a custom object for a student with three properties. Then it prints each property clearly.

PowerShell

$student = [PSCustomObject]@{
    Name = 'John Doe'
    Grade = 'A'
    Age = 16
}

Write-Output "Student Info:"
Write-Output "Name: $($student.Name)"
Write-Output "Grade: $($student.Grade)"
Write-Output "Age: $($student.Age)"

Important Notes

You can add as many properties as you want to a PSCustomObject.

Custom objects are great for organizing data in scripts and making output easier to read.

Use dot notation to get or set property values.

Summary

Custom objects group related data with named properties.

Use @{ } with [PSCustomObject] to create them easily.

They help organize and display data clearly in PowerShell scripts.

Practice

1. What is the main purpose of using [PSCustomObject] in PowerShell?

easy

A. To convert strings into numbers

B. To create objects with named properties for organizing related data

C. To create arrays of numbers automatically

D. To run commands faster in PowerShell

Solution

1. Step 1: Understand what [PSCustomObject] does

   [PSCustomObject] creates an object with named properties to hold related data clearly.

2. Step 2: Compare options

   Only "To create objects with named properties for organizing related data" correctly describes this purpose. Other options describe unrelated tasks.

3. Final Answer:

   To create objects with named properties for organizing related data -> Option B

4. Quick Check:

   Purpose of [PSCustomObject] = Organize data [OK]

Hint: Remember: [PSCustomObject] groups data with names [OK]

Common Mistakes:

• Thinking it speeds up command execution
• Confusing with arrays or type conversion
• Assuming it creates numeric sequences

2. Which of the following is the correct syntax to create a custom object with properties Name and Age in PowerShell?

easy

A. [PSCustomObject] @{Name: 'Alice'; Age: 30}

B. @{Name='Alice', Age=30} [PSCustomObject]

C. [PSCustomObject]@{Name='Alice'; Age=30}

D. [PSCustomObject]@{Name='Alice' Age=30}

Solution

1. Step 1: Recall correct syntax for custom object creation

   The correct syntax uses [PSCustomObject]@{PropertyName='Value'; PropertyName2=Value2} with semicolons separating properties.

2. Step 2: Analyze each option

   [PSCustomObject]@{Name='Alice'; Age=30} matches the correct syntax. @{Name='Alice', Age=30} [PSCustomObject] reverses order. [PSCustomObject] @{Name: 'Alice'; Age: 30} uses colons instead of equals. [PSCustomObject]@{Name='Alice' Age=30} misses semicolon between properties.

3. Final Answer:

   [PSCustomObject]@{Name='Alice'; Age=30} -> Option C

4. Quick Check:

   Correct syntax uses semicolons and equals [OK]

Hint: Use semicolons and equals inside @{ } with [PSCustomObject] [OK]

Common Mistakes:

• Using commas instead of semicolons
• Placing [PSCustomObject] after the hashtable
• Using colons instead of equals signs

3. What will be the output of this PowerShell code?

$person = [PSCustomObject]@{Name='Bob'; Age=25}; $person.Name

medium

A. Bob

B. 25

C. @{Name='Bob'; Age=25}

D. Name

Solution

1. Step 1: Understand object creation and property access

   The variable $person holds a custom object with properties Name and Age. Accessing $person.Name returns the value of the Name property.

2. Step 2: Determine the output

   The Name property was set to 'Bob', so the output is 'Bob'.

3. Final Answer:

   Bob -> Option A

4. Quick Check:

   Access property returns its value [OK]

Hint: Access properties with dot notation to get their values [OK]

Common Mistakes:

• Expecting the whole object printed
• Confusing property name with value
• Using wrong property name

4. Identify the error in this PowerShell code:

$obj = [PSCustomObject]@{Name='Eve' Age=28}

medium

A. Missing semicolon between properties inside the hashtable

B. Incorrect use of square brackets around PSCustomObject

C. Property names must be in double quotes

D. Cannot assign numbers as property values

Solution

1. Step 1: Check hashtable property separators

   Properties inside the hashtable must be separated by semicolons. Here, Name='Eve' and Age=28 are missing a semicolon between them.

2. Step 2: Verify other syntax elements

   Square brackets around PSCustomObject are correct. Property names do not require quotes. Numbers can be property values.

3. Final Answer:

   Missing semicolon between properties inside the hashtable -> Option A

4. Quick Check:

   Separate properties with semicolons [OK]

Hint: Separate each property with a semicolon inside @{ } [OK]

Common Mistakes:

• Using commas instead of semicolons
• Adding quotes around property names unnecessarily
• Thinking numbers can't be property values

5. You want to create a list of custom objects representing books with properties Title and Author. Which PowerShell code correctly creates an array of two such objects?

hard

A. [PSCustomObject]@{Title='1984', Author='Orwell'; Title='Dune', Author='Herbert'}

B. [PSCustomObject]@{Title='1984', Author='Orwell'}, [PSCustomObject]@{Title='Dune'; Author='Herbert'}

C. @{Title='1984'; Author='Orwell'}, @{Title='Dune'; Author='Herbert'}

D. @([PSCustomObject]@{Title='1984'; Author='Orwell'}, [PSCustomObject]@{Title='Dune'; Author='Herbert'})

Solution

1. Step 1: Understand how to create multiple custom objects in an array

   Each book must be a separate [PSCustomObject]. To create an array, wrap the objects in @( ) and separate them with commas.

2. Step 2: Analyze each option

   @([PSCustomObject]@{Title='1984'; Author='Orwell'}, [PSCustomObject]@{Title='Dune'; Author='Herbert'}) correctly creates two separate custom objects inside an array. [PSCustomObject]@{Title='1984', Author='Orwell'}, [PSCustomObject]@{Title='Dune'; Author='Herbert'} uses comma instead of semicolon in the first hashtable, causing a syntax error. @{Title='1984'; Author='Orwell'}, @{Title='Dune'; Author='Herbert'} creates hashtables, not custom objects. [PSCustomObject]@{Title='1984', Author='Orwell'; Title='Dune', Author='Herbert'} tries to combine two books in one object incorrectly.

3. Final Answer:

   @([PSCustomObject]@{Title='1984'; Author='Orwell'}, [PSCustomObject]@{Title='Dune'; Author='Herbert'}) -> Option D

4. Quick Check:

   Use array @( ) with separate custom objects [OK]

Hint: Wrap multiple [PSCustomObject]s in @( ) separated by commas [OK]

Common Mistakes:

• Using commas instead of semicolons inside hashtables
• Using hashtables instead of custom objects
• Combining multiple items in one object incorrectly