PowerShell Genie

Set-Variable

Use Set-Variable to create or change a variable, with control over its scope and options.

Command 2 min read Windows PowerShell 5.1 and PowerShell 7

Documentation: Microsoft Learn — Set-Variable

Written and tested by Dhrub Bharali · Updated

Syntax

1PS> Set-Variable [-Name] <String[]> [[-Value] <object>] [-Description <String>] [-Option <ScopedItemOptions>] [-Force] [-Scope <String>] [-PassThru] [<CommonParameters>]
See the command anatomy

Read the command and its supplied arguments. This example requires real PowerShell or its module; this diagram does not execute it.

Set-Variable [-Name] <String[]> [[-Value] <object>] [-Description <String>] [-Option <ScopedItemOptions>] [-Force] [-Scope <String>] [-PassThru] [<CommonParameters>]
  1. Stage 1Set-Variable-Name -Value -Description -Option -Force -Scope -PassThru

    Try it

    Windows PowerShell

    PowerShell example · browser support is limited.

    Execution scope: The full example below requires PowerShell outside this browser. You can edit this runner to use the supported practice commands; unsupported syntax returns an explanation.

    Interactive simulation · fictional data

    Examples

    Set-Variable -Name retryCount

    1PS> Set-Variable -Name retryCount -Value 3 -PassThru | Select-Object Name, Value
    Show reference output

    Sample output · fictional data, shaped like the real thing

    Name        Value
----        -----
retryCount  3

    Set-Variable -Name maxSize

    1PS> Set-Variable -Name maxSize -Value 100 -Option ReadOnly -PassThru | Select-Object Name, Value, Options
    Show reference output

    Sample output · fictional data, shaped like the real thing

    Name     Value  Options
----     -----  -------
maxSize  100    ReadOnly

    Set-Variable -Name logPath

    1PS> Set-Variable -Name logPath -Value 'C:\Temp\run.log' -Description 'where this script writes' -PassThru | Select-Object Name, Description
    Show reference output

    Sample output · fictional data, shaped like the real thing

    Name     Description
----     -----------
logPath  where this script writes

    Parameters

    Parameter definitions:

    • -Name
    • -Value
    • -Description
    • -Option
    • -Force
    • -Scope
    • -PassThru

    Set-Variable on Microsoft Learn

    Practical use and troubleshooting

    Practical scenario: Use Set-Variable when you need to create or change a variable, with control over its scope and options. Start with one identified target and inspect the returned values before extending the operation to a list. Keep the identity in your report so you can trace each result back to the object or path that produced it.

    Common error and fix: A read-only or constant variable can reject assignment. Inspect its Options first and use a new variable name when the existing binding is not intended to change. In an unattended script, capture this failure with its original error record and record which target failed. An empty result and an unsuccessful query must remain distinguishable in the final report.

    See also: Get-Variable. Get-Variable reads variable metadata or values; Set-Variable assigns or changes a variable. Choose the scope deliberately when a function and its caller use the same variable name. Read the linked command before substituting it; similar names do not imply identical inputs or output.

    Set-Variable reference on Microsoft Learn

    Recap

    Set-Variable Use Set-Variable to create or change a variable, with control over its scope and options.

    Next: Get-Variable
    Genie guideSet-Variable

    Use Set-Variable to create or change a variable, with control over its scope and options. The console below is pre-loaded — run it, then change a value and run it again.

    Explore PowerShell Genie

    Related