Expand Minimize

System.Management.Automation.Runspaces Namespace

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
AliasPropertyDataRepresents an alias property definition. This class cannot be inherited.
AssemblyConfigurationEntryRepresents an assembly for a runspace configuration.
CmdletConfigurationEntryRepresents a cmdlet for a runspace configuration.
CodeMethodDataRepresents a code method definition. This class cannot be inherited.
CodePropertyDataRepresents a code property definition. This class cannot be inherited.
CommandDefines 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.
CommandCollectionRepresents a collection of Command objects. This class cannot be inherited.
CommandParameterRepresents a parameter of a Command object.
CommandParameterCollectionRepresents a collection of command parameters. This class cannot be inherited.
ConstrainedSessionStateEntryServes 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.
FormatConfigurationEntryRepresents a format data file for a runspace configuration. This class cannot be inherited.
FormatTableProvides information supplied by formatting files (format.ps1xml) in a cache table. This class cannot be inherited. This class is introduced in Windows PowerShell 2.0.
FormatTableLoadExceptionThe exception thrown when attempting to construct a FormatTable object. This class is introduced in Windows PowerShell 2.0.
InitialSessionStateRepresents 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.
InitialSessionStateEntryServes 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.
InitialSessionStateEntryCollectionProvides 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.
InvalidPipelineStateExceptionException thrown when the pipeline is in a state that is not valid for the requested action.
InvalidRunspacePoolStateExceptionException 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.
InvalidRunspaceStateExceptionException thrown when the runspace is in a state that is not valid for the requested action.
NotePropertyDataRepresents a note property definition. This class cannot be inherited.
PipelineRepresents the base functionality of a pipeline that can be used to invoke commands.
PipelineReaderProvides asynchronous access to the stream of objects emitted by the Pipeline object.
PipelineStateEventArgsProvides data for the StateChanged event. This class cannot be inherited.
PipelineStateInfoProvides information about the state of the pipeline. This class cannot be inherited.
PipelineWriterProvides an asynchronous stream of objects as input to a Pipeline object.
PowerShellProcessInstanceRepresents an instance of a Windows PowerShell process. This class cannot be inherited.
PropertySetDataRepresents a property set definition. This class cannot be inherited.
ProviderConfigurationEntryRepresents a provider for a runspace configuration. This class cannot be inherited.
PSConsoleLoadExceptionException thrown when the console cannot be loaded when the runspace is created.
PSSessionProvides 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.
PSSnapInExceptionException thrown when a Windows PowerShell snap-in cannot be loaded into the current runspace.
RemotingDebugRecordRepresents a debug record that contains origin information.
RemotingErrorRecordRepresents an error record that is used by remote runspaces to wrap local error records. This class is introduced in Windows PowerShell 2.0.
RemotingProgressRecordRepresents a progress record that contains origin information.
RemotingVerboseRecordRepresents a verbose record that contains origin information.
RemotingWarningRecordRepresents a warning record that contains origin information.
RunspaceRepresents 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.
RunspaceAvailabilityEventArgsProvides data for the AvailabilityChanged event. This class is introduced in Windows PowerShell 2.0.
RunspaceConfigurationDefines the configurable information for a single runspace. Runspace configuration information defines the behavior of the Windows PowerShell shell at run time.
RunspaceConfigurationAttributeExceptionThe 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.
RunspaceConfigurationEntryServes 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.
RunspaceConfigurationEntryCollectionRepresents a collection of runspace configuration entries. This class cannot be inherited.
RunspaceConfigurationTypeAttributeIdentifies an assembly, cmdlet, Windows PowerShell provider, or script as an element of a runspace configuration. This class cannot be inherited.
RunspaceConfigurationTypeExceptionThe 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.
RunspaceConnectionInfoProvides 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.
RunspaceFactoryProvides a means to create a single runspace or a pool of runspaces.
RunspaceOpenModuleLoadExceptionThe 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.
RunspacePoolMaintains 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.
RunspacePoolStateChangedEventArgsProvides data for the RunspacePool.StateChanged event. This class is introduced in Windows PowerShell 2.0.
RunspaceStateEventArgsProvides data for the StateChanged event.
RunspaceStateInfoProvides information about the current state of the runspace.
ScriptConfigurationEntryRepresents a script for a runspace configuration. This class cannot be inherited.
ScriptMethodDataRepresents a script method definition. This class cannot be inherited.
ScriptPropertyDataRepresents a script property definition. This class cannot be inherited.
SessionStateAliasEntryDefines 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.
SessionStateApplicationEntryDefines 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.
SessionStateAssemblyEntryDefines 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.
SessionStateCmdletEntryDefines 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.
SessionStateCommandEntryServes 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.
SessionStateFormatEntryDefines 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.
SessionStateFunctionEntryDefines 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.
SessionStateProviderEntryDefines 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.
SessionStateProxyProvides methods to get and set variables in the session state.
SessionStateScriptEntryDefines 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.
SessionStateTypeEntryDefines 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.
SessionStateVariableEntryDefines 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.
SessionStateWorkflowEntryRepresents a session state entry for a workflow. This class cannot be inherited.
TypeConfigurationEntryRepresents a type data file for a runspace configuration. This class cannot be inherited.
TypeDataRepresents a type definition. This class cannot be inherited.
TypeMemberDataRepresents the base functionality for type members.
TypeTableProvides .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.
TypeTableLoadExceptionException thrown if errors occur when attempting to construct a TypeTable object. This class is introduced in Windows PowerShell 2.0.
WSManConnectionInfoProvides 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
AuthenticationMechanismDefines the types of authentication used to create a PSSession on a computer. This class is introduced in Windows PowerShell 2.0.
OutputBufferingModeDescribes the behavior of a Web Services for Management protocol (WSMan) server if the output cache for the running command pipeline is full.
PipelineResultTypesDefines the types of output streams for the pipeline.
PipelineStateDefines the states of the pipeline.
PSSessionConfigurationAccessModeDescribes the type of access mode that should be used when creating a session configuration.
PSSessionTypeDescribes the type of session configuration that should be used for creating connection information.
PSThreadOptionsDefines how threads are created and used when a command is executed within a runspace. This enumeration is introduced in Windows PowerShell 2.0.
RunspaceAvailabilityDefines the availability of a runspace, such as is it available or busy. This enumeration is introduced in Windows PowerShell 2.0.
RunspaceCapabilityDescribes the capabilities of a runspace.
RunspacePoolAvailabilitySpecifies the availability of a runspace pool.
RunspacePoolCapabilityDescribes the capabilities of a runspace pool.
RunspacePoolStateDefines 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.
RunspaceStateDefines the various states of the runspace.

Send comments about this topic to Microsoft.
Show:
© 2014 Microsoft