System.Management.Automation.Runspaces Namespace

 

Updated: April 27, 2016

Applies To: Windows PowerShell

The System.Management.Automation.Runspaces namespace contains the classes, enumerations, and interfaces used to create an individual runspace or a pool of runspaces. In Windows PowerShell 1.0, a single runspace is the operating environment in which one or more pipelines invoke cmdlets. In Windows PowerShell 2.0, a runspace or a pool of runspaces is the operating environment where the command pipeline of the PowerShell object is invoked.

ClassDescription
System_CAPS_pubclassAliasPropertyData

Represents an alias property definition. This class cannot be inherited. Introduced in Windows PowerShell 3.0.

System_CAPS_pubclassAssemblyConfigurationEntry

Represents an assembly for a runspace configuration.

System_CAPS_pubclassCmdletConfigurationEntry

Represents a cmdlet for a runspace configuration.

System_CAPS_pubclassCodeMethodData

Represents a code method definition. This class cannot be inherited. Introduced in Windows PowerShell 3.0.

System_CAPS_pubclassCodePropertyData

Represents a code property definition. This class cannot be inherited. Introduced in Windows PowerShell 3.0.

System_CAPS_pubclassCommand

Defines a command that contains a single cmdlet or script. The Command object is used by the PowerShell and Pipeline objects to define a single command.

System_CAPS_pubclassCommandCollection

Represents a collection of Command objects. This class cannot be inherited.

System_CAPS_pubclassCommandParameter

Represents a parameter of a Command object.

System_CAPS_pubclassCommandParameterCollection

Represents a collection of command parameters. This class cannot be inherited.

System_CAPS_pubclassConstrainedSessionStateEntry

Serves as a base class for those session state entries that can be specified as public or private entries when added to an InitialSessionState object. This includes entries for commands, providers, and variables. This class is introduced in Windows PowerShell 2.0.

System_CAPS_pubclassContainerConnectionInfo

The class that contains connection information for a remote session between a local container host and container. For Windows Server container, the transport is based on named pipe for now. For Hyper-V container, the transport is based on Hyper-V socket.

System_CAPS_pubclassFormatConfigurationEntry

Represents a format data file for a runspace configuration. This class cannot be inherited.

System_CAPS_pubclassFormatTable

A class that keeps the information from format.ps1xml files in a cache table

System_CAPS_pubclassFormatTableLoadException

This exception is used by Formattable constructor to indicate errors occured during construction time.

System_CAPS_pubclassInitialSessionState

Represents a session state configuration that is used when a runspace is opened. The elements specified here, such as different types of commands, providers, and variables, are accessible each time a runspace that uses this configuration is opened. This class is introduced in Windows PowerShell 2.0.

System_CAPS_pubclassInitialSessionStateEntry

Serves as a base class for all session state entry classes. Session state entries are added to an InitialSessionState object through their appropriate properties. This class is introduced in Windows PowerShell 2.0.

System_CAPS_pubclassInitialSessionStateEntryCollection<T>

Provides a collection of session state entries, such as commands, types, formats, and variables, for an InitialSessionState object. This class cannot be inherited. This class is introduced in Windows PowerShell 2.0.

System_CAPS_pubclassInvalidPipelineStateException

Exception thrown when the pipeline is in a state that is not valid for the requested action.

System_CAPS_pubclassInvalidRunspacePoolStateException

Exception thrown when an operation is requested and the state of the runspace pool is different from the expected state of runspace pool. This class is introduced in Windows PowerShell 2.0.

System_CAPS_pubclassInvalidRunspaceStateException

Exception thrown when the runspace is in a state that is not valid for the requested action.

System_CAPS_pubclassMemberSetData

MemberSetData represents a MemberSet definition

System_CAPS_pubclassNamedPipeConnectionInfo

Class used to create an Out-Of-Process Runspace/RunspacePool between two local processes using a named pipe for IPC. This class does not have a dependency on WSMan and is used to implement the PowerShell attach-to-process feature.

System_CAPS_pubclassNotePropertyData

Represents a note property definition. This class cannot be inherited. Introduced in Windows PowerShell 3.0.

System_CAPS_pubclassPipeline

Represents the base functionality of a pipeline that can be used to invoke commands.

System_CAPS_pubclassPipelineReader<T>

Provides asynchronous access to the stream of objects emitted by the Pipeline object.

System_CAPS_pubclassPipelineStateEventArgs

Provides data for the StateChanged event. This class cannot be inherited.

System_CAPS_pubclassPipelineStateInfo

Provides information about the state of the pipeline. This class cannot be inherited.

System_CAPS_pubclassPipelineWriter

Provides an asynchronous stream of objects as input to a Pipeline object.

System_CAPS_pubclassPowerShellProcessInstance

Represents an instance of a Windows PowerShell process. This class cannot be inherited. Introduced in Windows PowerShell 3.0.

System_CAPS_pubclassPropertySetData

Represents a property set definition. This class cannot be inherited. Introduced in Windows PowerShell 3.0.

System_CAPS_pubclassProviderConfigurationEntry

Represents a provider for a runspace configuration. This class cannot be inherited.

System_CAPS_pubclassPSConsoleLoadException

Exception thrown when the console cannot be loaded when the runspace is created.

System_CAPS_pubclassPSSession

Provides information about a Windows PowerShell session on a local or remote computer. This object is returned by the New-PSSession and Get-PSSession cmdlets, and is used by the Enter-PsSession and Exit-PsSession cmdlets to specify a session.

System_CAPS_pubclassPSSnapInException

Exception thrown when a Windows PowerShell snap-in cannot be loaded into the current runspace.

System_CAPS_pubclassRemotingDebugRecord

Represents a debug record that contains origin information. Introduced in Windows PowerShell 3.0.

System_CAPS_pubclassRemotingErrorRecord

Represents an error record that is used by remote runspaces to wrap local error records. This class is introduced in Windows PowerShell 2.0.

System_CAPS_pubclassRemotingInformationRecord

Information record containing origin information

System_CAPS_pubclassRemotingProgressRecord

Represents a progress record that contains origin information. Introduced in Windows PowerShell 3.0.

System_CAPS_pubclassRemotingVerboseRecord

Represents a verbose record that contains origin information. Introduced in Windows PowerShell 3.0.

System_CAPS_pubclassRemotingWarningRecord

Represents a warning record that contains origin information. Introduced in Windows PowerShell 3.0.

System_CAPS_pubclassRunspace

Represents the runspace that is the operating environment for command pipelines. This class provides methods for opening the runspace, creating single and nested pipelines for the runspace, and closing the runspace.

System_CAPS_pubclassRunspaceAvailabilityEventArgs

Provides data for the AvailabilityChanged event. This class is introduced in Windows PowerShell 2.0.

System_CAPS_pubclassRunspaceConfiguration

Defines the configurable information for a single runspace. Runspace configuration information defines the behavior of the Windows PowerShell shell at run time.

System_CAPS_pubclassRunspaceConfigurationAttributeException

The exception that is thrown when the type name specified by the RunspaceConfigurationTypeAttribute attribute does not exist in the assembly or the type is not derived from the RunspaceConfiguration class.

System_CAPS_pubclassRunspaceConfigurationEntry

Serves as the base class for the runspace configuration entry classes that are derived internally by Windows PowerShell (for more information, see Inheritance Hierarchy). Developers should not derive from this class.

System_CAPS_pubclassRunspaceConfigurationEntryCollection<T>

Represents a collection of runspace configuration entries. This class cannot be inherited.

System_CAPS_pubclassRunspaceConfigurationTypeAttribute

Identifies an assembly, cmdlet, Windows PowerShell provider, or script as an element of a runspace configuration. This class cannot be inherited.

System_CAPS_pubclassRunspaceConfigurationTypeException

The exception that is thrown when the .NET Framework type name does not exist in the assembly or was not specified by the RunspaceConfigurationTypeAttribute attribute, or the type is not derived from the RunspaceConfiguration class.

System_CAPS_pubclassRunspaceConnectionInfo

Provides information about the connection used for opening the runspace on a computer, such as the name of the computer where the runspace is opened, the port used to make the connection, and the uniform resource identifier (URI) of the connection. This class is introduced in Windows PowerShell 2.0.

System_CAPS_pubclassRunspaceFactory

Provides a means to create a single runspace or a pool of runspaces.

System_CAPS_pubclassRunspaceOpenModuleLoadException

The exception that is thrown when an error occurs when loading a module while the runspace is being opened. This exception contains a list of all of the module errors that occurred.

System_CAPS_pubclassRunspacePool

Maintains a group of runspaces that have the same characteristics and can be opened and closed on an as-needed basis. Runspace pools can be used to execute multiple commands concurrently, with each command invoked in a different runspace. This class is introduced in Windows PowerShell 2.0.

System_CAPS_pubclassRunspacePoolStateChangedEventArgs

Provides data for the RunspacePool.StateChanged event. This class is introduced in Windows PowerShell 2.0.

System_CAPS_pubclassRunspaceStateEventArgs

Provides data for the StateChanged event.

System_CAPS_pubclassRunspaceStateInfo

Provides information about the current state of the runspace.

System_CAPS_pubclassScriptConfigurationEntry

Represents a script for a runspace configuration. This class cannot be inherited.

System_CAPS_pubclassScriptMethodData

Represents a script method definition. This class cannot be inherited. Introduced in Windows PowerShell 3.0.

System_CAPS_pubclassScriptPropertyData

Represents a script property definition. This class cannot be inherited. Introduced in Windows PowerShell 3.0.

System_CAPS_pubclassSessionStateAliasEntry

Defines an alias for an initial session state configuration. The initial session state of a runspace defines the elements, such as aliases, that are available when the runspace is opened. This class is introduced in Windows PowerShell 2.0.

System_CAPS_pubclassSessionStateApplicationEntry

Defines an application for an initial session state configuration. The initial session state of a runspace defines the elements, such as applications, that are available when the runspace is opened. This class is introduced in Windows PowerShell 2.0.

System_CAPS_pubclassSessionStateAssemblyEntry

Defines an assembly for an initial session state configuration. The initial session state of a runspace defines the elements, such as assemblies, that are available when the runspace is opened. This class is introduced in Windows PowerShell 2.0.

System_CAPS_pubclassSessionStateCmdletEntry

Defines a cmdlet for an initial session state configuration. The initial session state of a runspace defines the elements, such as cmdlets, that are available when the runspace is opened. This class is introduced in Windows PowerShell 2.0.

System_CAPS_pubclassSessionStateCommandEntry

Serves as a base class for session state entries that specify cmdlets, scripts, functions, aliases, and applications. This class is introduced in Windows PowerShell 2.0.

System_CAPS_pubclassSessionStateFormatEntry

Defines a display format for a .NET Framework type of an initial session state configuration. This class is used to specify formatting information that is loaded when a runspace that uses this session state configuration is opened. This class is introduced in Windows PowerShell 2.0.

System_CAPS_pubclassSessionStateFunctionEntry

Defines a function for an initial session state configuration. The initial session state of a runspace defines the elements, such as functions, that are available when the runspace is opened. This class cannot be inherited. This class is introduced in Windows PowerShell 2.0.

System_CAPS_pubclassSessionStateProviderEntry

Defines a provider for an initial session state configuration. The initial session state of a runspace defines the elements, such as providers, that are available when the runspace is opened. This class is introduced in Windows PowerShell 2.0.

System_CAPS_pubclassSessionStateProxy

Provides methods to get and set variables in the session state.

System_CAPS_pubclassSessionStateScriptEntry

Defines a script for an initial session state configuration. The initial session state of a runspace defines the elements, such as scripts, that are available when the runspace is opened. This class is introduced in Windows PowerShell 2.0.

System_CAPS_pubclassSessionStateTypeEntry

Defines the .NET Framework types for the initial session state configuration of a runspace. This entry, which is loaded when the runspace is opened, can reference strong session state type entry data, a types table, or a Types.ps1xml file. This class is introduced in Windows PowerShell 2.0.

System_CAPS_pubclassSessionStateVariableEntry

Defines a variable for an initial session state configuration. The initial session state of a runspace defines the elements, such as variables, that are available when the runspace is opened. This class is introduced in Windows PowerShell 2.0.

System_CAPS_pubclassSessionStateWorkflowEntry

Represents a session state entry for a workflow. This class cannot be inherited. Introduced in Windows PowerShell 3.0.

System_CAPS_pubclassTypeConfigurationEntry

Represents a type data file for a runspace configuration. This class cannot be inherited.

System_CAPS_pubclassTypeData

Represents a type definition. This class cannot be inherited. Introduced in Windows PowerShell 3.0.

System_CAPS_pubclassTypeMemberData

Represents the base functionality for type members. Introduced in Windows PowerShell 3.0.

System_CAPS_pubclassTypeTable

Provides .NET Framework type information that is supplied by type.ps1xml files. This class cannot be inherited. This class is introduced in Windows PowerShell 2.0.

System_CAPS_pubclassTypeTableLoadException

Exception thrown if errors occur when attempting to construct a TypeTable object. This class is introduced in Windows PowerShell 2.0.

System_CAPS_pubclassVMConnectionInfo

The class that contains connection information for a remote session between a local host and VM. The local host can be a VM in nested scenario.

System_CAPS_pubclassWSManConnectionInfo

Provides the connection information that is needed to connect to a remote runspace. Windows PowerShell uses a Windows Remote Management (WinRM) connection to connect to the computer where the remote runspace is opened. This class is introduced in Windows PowerShell 2.0.

EnumerationDescription
System_CAPS_pubenumAuthenticationMechanism

Defines the types of authentication used to create a PSSession on a computer. This class is introduced in Windows PowerShell 2.0.

System_CAPS_pubenumOutputBufferingMode

Describes the behavior of a Web Services for Management protocol (WSMan) server if the output cache for the running command pipeline is full. Introduced in Windows PowerShell 3.0.

System_CAPS_pubenumPipelineResultTypes

Defines the types of output streams for the pipeline.

System_CAPS_pubenumPipelineState

Defines the states of the pipeline.

System_CAPS_pubenumPSSessionConfigurationAccessMode

Describes the type of access mode that should be used when creating a session configuration. Introduced in Windows PowerShell 3.0.

System_CAPS_pubenumPSSessionType

Describes the type of session configuration that should be used for creating connection information. Introduced in Windows PowerShell 3.0.

System_CAPS_pubenumPSThreadOptions

Defines how threads are created and used when a command is executed within a runspace. This enumeration is introduced in Windows PowerShell 2.0.

System_CAPS_pubenumRunspaceAvailability

Defines the availability of a runspace, such as is it available or busy. This enumeration is introduced in Windows PowerShell 2.0.

System_CAPS_pubenumRunspaceCapability

Describes the capabilities of a runspace. Introduced in Windows PowerShell 3.0.

System_CAPS_pubenumRunspacePoolAvailability

Specifies the availability of a runspace pool. Introduced in Windows PowerShell 3.0.

System_CAPS_pubenumRunspacePoolCapability

Describes the capabilities of a runspace pool. Introduced in Windows PowerShell 3.0.

System_CAPS_pubenumRunspacePoolState

Defines the states of a runspace pool. The runspace pool is used to execute commands concurrently using a set of similarly configured runspaces. This enumeration is introduced in Windows PowerShell 2.0.

System_CAPS_pubenumRunspaceState

Defines the various states of the runspace.

System_CAPS_pubenumTargetMachineType

Describes the computer target type.

Return to top
Show: