System.Management.Automation.Runspaces Namespace
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
This 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 PowerShellobject is invoked.
Classes
| Class | Description |
|---|---|
| AliasPropertyData | Represents an AliasProperty definition. |
| AssemblyConfigurationEntry | Represents an assembly for a runspace configuration. |
| CmdletConfigurationEntry | Represents a cmdlet for a runspace configuration. |
| CodeMethodData | CodeMethodData represents a CodeMethodData definition |
| CodePropertyData | Represents a CodeProperty definition. |
| Command | 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. |
| CommandCollection | Represents a collection of Command objects. |
| CommandParameter | Represents a parameter of a Command object. |
| CommandParameterCollection | Represents a collection of command parameters. |
| ConstrainedSessionStateEntry | 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. |
| FormatConfigurationEntry | Represents a format data file for a runspace configuration. |
| FormatTable | Provides information supplied by formatting files (format.ps1xml) in a cache table. This class is introduced in Windows PowerShell 2.0. |
| FormatTableLoadException | The exception thrown when attempting to construct a FormatTable object. This class is introduced in Windows PowerShell 2.0. |
| InitialSessionState | 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. |
| InitialSessionStateEntry | 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. |
| InitialSessionStateEntryCollection | Provides a collection of session state entries, such as commands, types, formats, and variables, for an InitialSessionState object. This class is introduced in Windows PowerShell 2.0. |
| InvalidPipelineStateException | Exception thrown when the pipeline is in a state that is not valid for the requested action. |
| InvalidRunspacePoolStateException | 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. |
| InvalidRunspaceStateException | Exception thrown when the runspace is in a state that is not valid for the requested action. |
| NotePropertyData | NotePropertyData represents a NoteProperty definition |
| Pipeline | Represents a pipeline that can be used to invoke commands. |
| PipelineReader | Provides asynchronous access to the stream of objects emitted by the Pipeline object. |
| PipelineStateEventArgs | Defines the arguments for events that are passed to PipelineStateEvent handlers. |
| PipelineStateInfo | Provides information about the state of the pipeline. |
| PipelineWriter | Provides an asynchronous stream of objects as input to a Pipeline object. |
| PowerShellProcessInstance | |
| PropertySetData | PropertySetData represent a PropertySet definition |
| ProviderConfigurationEntry | Represents a provider for a runspace configuration. |
| PSConsoleLoadException | Exception thrown when the console cannot be loaded when the runspace is created. |
| PSSession | 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. |
| PSSnapInException | Exception thrown when a Windows PowerShell snap-in cannot be loaded into the current runspace. |
| RemotingDebugRecord | Debug record containing origin information. |
| RemotingErrorRecord | An error record used by remote runspaces to wrap local error records. This class is introduced in Windows PowerShell 2.0. |
| RemotingProgressRecord | Progress record containing origin information. |
| RemotingVerboseRecord | Verbose record containing origin information. |
| RemotingWarningRecord | Warning record containing origin information. |
| Runspace | 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. |
| RunspaceAvailabilityEventArgs | Defines the event arguments passed to the AvailabilityChanged event. This class is introduced in Windows PowerShell 2.0. |
| RunspaceConfiguration | Defines the configurable information for a single runspace. Runspace configuration information defines the behavior of the Windows PowerShell shell at run time. |
| RunspaceConfigurationAttributeException | Exception 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. |
| RunspaceConfigurationEntry | 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. |
| RunspaceConfigurationEntryCollection | Represents a collection of runspace configuration entries. |
| RunspaceConfigurationTypeAttribute | Identifies an assembly, cmdlet, Windows PowerShell provider, or script as an element of a runspace configuration. |
| RunspaceConfigurationTypeException | The exception 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. |
| RunspaceConnectionInfo | 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. |
| RunspaceFactory | Provides a means to create a single runspace or a pool of runspaces. |
| RunspaceOpenModuleLoadException | Exception 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. |
| RunspacePool | 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. |
| RunspacePoolStateChangedEventArgs | Provides the arguments that are passed to event handlers for runspace pool state changes. This class is introduced in Windows PowerShell 2.0. |
| RunspaceStateEventArgs | Defines the event arguments passed to the RunspaceStateEvent handler by the StateChanged event. |
| RunspaceStateInfo | Provides information about the current state of the runspace. |
| ScriptConfigurationEntry | Represents a script for a runspace configuration. |
| ScriptMethodData | Represents a ScriptMethod definition. |
| ScriptPropertyData | Represents a ScriptProperty definition. |
| SessionStateAliasEntry | 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. |
| SessionStateApplicationEntry | 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. |
| SessionStateAssemblyEntry | 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. |
| SessionStateCmdletEntry | 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. |
| SessionStateCommandEntry | 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. |
| SessionStateFormatEntry | 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. |
| SessionStateFunctionEntry | 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 is introduced in Windows PowerShell 2.0. |
| SessionStateProviderEntry | 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. |
| SessionStateProxy | Provides methods to get and set variables in the session state. |
| SessionStateScriptEntry | 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. |
| SessionStateTypeEntry | 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 a Types.ps1xml file or a types table. This class is introduced in Windows PowerShell 2.0. |
| SessionStateVariableEntry | 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. |
| TypeConfigurationEntry | Represents a type data file for a runspace configuration. |
| TypeData | Represents a Type Definition. |
| TypeMemberData | The base class for type members. The type members derived from this class are: NotePropertyData, AliasPropertyData, ScriptPropertyData, CodePropertyData, ScriptMethodData, CodeMethodData |
| TypeTable | Provides .NET Framework type information that is supplied by type.ps1xml files. This class is introduced in Windows PowerShell 2.0. |
| TypeTableLoadException | Exception thrown if errors occur when attempting to construct a TypeTable object. This class is introduced in Windows PowerShell 2.0. |
| WSManConnectionInfo | 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. |
Enumerations
| Enumeration | Description |
|---|---|
| AuthenticationMechanism | Defines the types of authentication used to create a PSSession on a computer. This class is introduced in Windows PowerShell 2.0. |
| OutputBufferingMode | |
| PipelineResultTypes | Defines the types of output streams for the pipeline. |
| PipelineState | Defines the states of the pipeline. |
| PSSessionConfigurationAccessMode | Specify the type of access mode that should be used when creating a session configuration |
| PSSessionType | Specifies the type of session configuration that should be used for creating connection information. |
| PSThreadOptions | Defines how threads are created and used when a command is executed within a runspace. This enumeration is introduced in Windows PowerShell 2.0. |
| RunspaceAvailability | Defines the availability of a runspace, such as is it available or busy. This enumeration is introduced in Windows PowerShell 2.0. |
| RunspaceCapability | |
| RunspacePoolAvailability | |
| RunspacePoolCapability | |
| RunspacePoolState | 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. |
| RunspaceState | Defines the various states of the runspace. |
Send comments about this topic to Microsoft.