System.Management.Automation.Runspaces Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Classes
AliasPropertyData |
AliasPropertyData represents a AliasProperty definition. |
AssemblyConfigurationEntry |
Configuration data for assemblies. |
CmdletConfigurationEntry |
Class to define configuration data for cmdlets |
CodeMethodData |
CodeMethodData represents a CodeMethodData definition. |
CodePropertyData |
CodePropertyData represents a CodeProperty definition. |
Command |
Defines a Command object which can be added to Pipeline object for invocation. |
CommandCollection |
Defines a collection of Commands. This collection is used by Pipeline to define elements of pipeline. |
CommandParameter |
Define a parameter for Command |
CommandParameterCollection |
Defines a collection of parameters. |
ConstrainedSessionStateEntry |
Class to constrain session state entries. |
ContainerConnectionInfo |
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. |
FormatConfigurationEntry |
Defines class for type configuration entry. |
FormatTable |
A class that keeps the information from format.ps1xml files in a cache table. |
FormatTableLoadException |
This exception is used by Formattable constructor to indicate errors occurred during construction time. |
InitialSessionState |
Allows you to define the set of elements that should be present when Session State is created. |
InitialSessionStateEntry |
Baseclass for defining elements that can be added to an InitialSessionState object. |
InitialSessionStateEntryCollection<T> | |
InvalidPipelineStateException |
Defines exception which is thrown when state of the pipeline is different from expected state. |
InvalidRunspacePoolStateException |
Exception thrown when state of the runspace pool is different from expected state of runspace pool. |
InvalidRunspaceStateException |
Exception thrown when state of the runspace is different from expected state of runspace. |
MemberSetData |
MemberSetData represents a MemberSet definition. |
NamedPipeConnectionInfo |
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. |
NotePropertyData |
NotePropertyData represents a NoteProperty definition. |
Pipeline |
Defines a class which can be used to invoke a pipeline of commands. |
PipelineReader<T> |
PipelineReader provides asynchronous access to the stream of objects emitted by a Pipeline. |
PipelineStateEventArgs |
Event arguments passed to PipelineStateEvent handlers StateChanged event. |
PipelineStateInfo |
Type which has information about PipelineState and Exception associated with PipelineState. |
PipelineWriter |
PipelineWriter allows the caller to provide an asynchronous stream of objects as input to a Pipeline. |
PowerShellProcessInstance |
This class represents a PowerShell process that is used for an out-of-process remote Runspace. |
PropertySetData |
PropertySetData represent a PropertySet definition. |
ProviderConfigurationEntry |
Define class for provider configuration entry |
PSConsoleLoadException |
Defines exception thrown when a PSSnapin was not able to load into current runspace. |
PSSession |
Class that exposes read only properties and which conveys information about a remote runspace object to the user. The class serves the following purpose: 1. Exposes useful information to the user as properties 2. Shields the remote runspace object from directly being exposed to the user. This way, the user will not be able to directly act upon the object, but instead will have to use the remoting cmdlets. This will prevent any unpredictable behavior. |
PSSnapInException |
Defines exception thrown when a PSSnapin was not able to load into current runspace. |
RemotingDebugRecord |
Debug record containing origin information. |
RemotingErrorRecord |
Error record in remoting cases. |
RemotingInformationRecord |
Information record containing origin information. |
RemotingProgressRecord |
Progress record containing origin information. |
RemotingVerboseRecord |
Verbose record containing origin information. |
RemotingWarningRecord |
Warning record containing origin information. |
Runspace |
Public interface to PowerShell Runtime. Provides APIs for creating pipelines, access session state etc. |
RunspaceAttribute |
Defines the attribute used to designate a cmdlet parameter as one that should accept runspaces. |
RunspaceAvailabilityEventArgs |
Defines the event arguments passed to the AvailabilityChanged AvailabilityChanged event. |
RunspaceConfiguration |
Defines configuration information for runspace. |
RunspaceConfigurationAttributeException |
Defines exception thrown when runspace configuration attribute is not defined correctly. |
RunspaceConfigurationEntry |
Define class for runspace configuration entry. |
RunspaceConfigurationEntryCollection<T> |
Define class for runspace configuration entry collection. |
RunspaceConfigurationTypeAttribute |
Define the class for runspace configuration type attribute. |
RunspaceConfigurationTypeException |
Define class for runspace configuration type. |
RunspaceConnectionInfo |
Class which defines connection path to a remote runspace that needs to be created. Transport specific connection paths will be derived from this. |
RunspaceFactory |
Defines a factory class for creating Runspace objects. |
RunspaceOpenModuleLoadException |
Defines the exception thrown an error loading modules occurs while opening the runspace. It contains a list of all of the module errors that have occurred. |
RunspacePool |
Public interface which supports pooling PowerShell Runspaces. |
RunspacePoolStateChangedEventArgs |
Event arguments passed to runspacepool state change handlers StateChanged event. |
RunspaceStateEventArgs |
Defines Event arguments passed to RunspaceStateEvent handler StateChanged event. |
RunspaceStateInfo |
Defines type which has information about RunspaceState and Exception associated with RunspaceState. |
ScriptConfigurationEntry |
Define class for script configuration entry |
ScriptMethodData |
ScriptMethodData represents a ScriptMethod definition. |
ScriptPropertyData |
ScriptPropertyData represents a ScriptProperty definition. |
SessionStateAliasEntry | |
SessionStateApplicationEntry | |
SessionStateAssemblyEntry |
An assembly to load for this sessionstate... |
SessionStateCmdletEntry |
List a cmdlet to add to this session state entry. |
SessionStateCommandEntry |
Command class so that all the commands can derive off this one. Adds the flexibility of adding additional derived class, such as ProxyCommand for Exchange. Derived classes - Alias, Application, Cmdlet, Function, Script. |
SessionStateFormatEntry |
Format file configuration entry... |
SessionStateFunctionEntry | |
SessionStateProviderEntry | |
SessionStateProxy |
This class provides subset of functionality provided by session state. |
SessionStateScriptEntry | |
SessionStateTypeEntry |
Type file configuration entry... |
SessionStateVariableEntry | |
SessionStateWorkflowEntry | |
SSHConnectionInfo |
Class used to create a connection through an SSH.exe client to a remote host machine. Connection information includes SSH target (user name and host machine) along with client key used for key based user authorization. |
TypeConfigurationEntry |
Defines class for type configuration entry. |
TypeData |
TypeData represent a Type Definition. |
TypeMemberData |
TypeMemberData is the base class for type members. The type members derived from this class are: NotePropertyData, AliasPropertyData, ScriptPropertyData, CodePropertyData, ScriptMethodData, CodeMethodData. |
TypeTable |
A class that keeps the information from types.ps1xml files in a cache table. |
TypeTableLoadException |
This exception is used by TypeTable constructor to indicate errors occurred during construction time. |
VMConnectionInfo |
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. |
WSManConnectionInfo |
Class which defines path to a remote runspace that need to be created. |
Enums
AuthenticationMechanism |
Different Authentication Mechanisms supported by New-Runspace command to connect to remote server. |
OutputBufferingMode |
WSManTransportManager supports disconnected PowerShell sessions. When a remote PS session server is in disconnected state, output from the running command pipeline is cached on the server. This enum determines what the server does when the cache is full. |
PipelineResultTypes |
Enum defining the types of streams coming out of a pipeline. |
PipelineState |
Enumerated type defining the state 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 a connection info |
PSThreadOptions |
These options control whether a new thread is created when a command is executed within a runspace. |
RunspaceAvailability |
Enum to indicate whether a Runspace is busy or available. |
RunspaceCapability |
Defines runspace capabilities. |
RunspacePoolAvailability |
Defines runspace pool availability. |
RunspacePoolCapability |
Defines runspace capabilities. |
RunspacePoolState |
Defines various states of a runspace pool. |
RunspaceState |
Defines various states of runspace. |
TargetMachineType |
Computer target type. |