Skip to content

Get-Runspace.md

Latest commit

 

History

History
167 lines (120 loc) · 3.76 KB

Get-Runspace.md

File metadata and controls

167 lines (120 loc) · 3.76 KB
external help file Microsoft.PowerShell.Commands.Utility.dll-Help.xml
Locale en-US
Module Name Microsoft.PowerShell.Utility
ms.date 12/12/2022
online version https://learn.microsoft.com/powershell/module/microsoft.powershell.utility/get-runspace?view=powershell-7.6&WT.mc_id=ps-gethelp
schema 2.0.0
title Get-Runspace

Get-Runspace

SYNOPSIS

Gets active runspaces within a PowerShell host process.

SYNTAX

NameParameterSet (Default)

Get-Runspace [[-Name] <String[]>] [<CommonParameters>]

IdParameterSet

Get-Runspace [-Id] <Int32[]> [<CommonParameters>]

InstanceIdParameterSet

Get-Runspace [-InstanceId] <Guid[]> [<CommonParameters>]

DESCRIPTION

The Get-Runspace cmdlet gets active runspaces in a PowerShell host process.

EXAMPLES

Example 1: Get runspaces

Get-Runspace
Id Name            ComputerName    Type          State         Availability
 -- ----            ------------    ----          -----         ------------
  1 Runspace1       localhost       Local         Opened        Busy
  2 Runspace2       localhost       Local         Opened        Available
  3 Runspace3       localhost       Local         Opened        Available

Example 2: Get runspace by Id

Get-Runspace -Id 2
Id Name            ComputerName    Type          State         Availability
 -- ----            ------------    ----          -----         ------------
  2 Runspace2       localhost       Local         Opened        Available

Example 3: Get runspace by Name

Get-Runspace -Name Runspace1
Id Name            ComputerName    Type          State         Availability
 -- ----            ------------    ----          -----         ------------
  1 Runspace1       localhost       Local         Opened        Busy

Example 4: Get runspace by InstanceId

In this example, we identify an available runspace using the Name parameter and store the return object to the variable $activeRunspace. This allows you to use the properties of the Runspace in subsequent runs of Get-Runspace.

$activeRunspace = Get-Runspace -Name Runspace1
Get-Runspace -InstanceId $activeRunspace.InstanceId
Id Name            ComputerName    Type          State         Availability
 -- ----            ------------    ----          -----         ------------
  1 Runspace1       localhost       Local         Opened        Busy

PARAMETERS

-Id

Specifies the Id of a runspace

Type: System.Int32[]
Parameter Sets: IdParameterSet
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-InstanceId

Specifies the instance ID GUID of a running job.

Type: System.Guid[]
Parameter Sets: InstanceIdParameterSet
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

Specifies the Name of a runspace

Type: System.String[]
Parameter Sets: NameParameterSet
Aliases:

Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

System.Management.Automation.Runspaces.Runspace

This cmdlet returns a Runspace. You can pipe the results of a Get-Runspace command to Debug-Runspace.

NOTES

RELATED LINKS

Debug-Runspace