PSJobProxy.Create Method

Reference

Definition

Namespace:: System.Management.Automation

Assembly:: System.Management.Automation.dll

Package:: Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0

Package:: Microsoft.WSMan.Runtime v6.1.0

Package:: Microsoft.WSMan.Runtime v6.2.0

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.

Overloads

Create(Runspace)	Queries the runspace for jobs and constructs a collection of job proxies to interact with them.
Create(RunspacePool)	Queries the runspace for jobs and constructs a collection of job proxies to interact with them.
Create(Runspace, Hashtable)	Queries the runspace for jobs and constructs a collection of job proxies to interact with them.
Create(RunspacePool, Hashtable)	Queries the runspace for jobs and constructs a collection of job proxies to interact with them.
Create(Runspace, Hashtable, Boolean)	Queries the runspace for jobs and constructs a collection of job proxies to interact with them.
Create(RunspacePool, Hashtable, Boolean)	Queries the runspace for jobs and constructs a collection of job proxies to interact with them.
Create(Runspace, Hashtable, EventHandler<JobDataAddedEventArgs>, EventHandler<JobStateEventArgs>)	Queries the runspace for jobs and constructs a collection of job proxies to interact with them.
Create(RunspacePool, Hashtable, EventHandler<JobDataAddedEventArgs>, EventHandler<JobStateEventArgs>)	Queries the runspace for jobs and constructs a collection of job proxies to interact with them.

Create(Runspace)

Queries the runspace for jobs and constructs a collection of job proxies to interact with them.

public:
 static System::Collections::Generic::ICollection<System::Management::Automation::PSJobProxy ^> ^ Create(System::Management::Automation::Runspaces::Runspace ^ runspace);

public static System.Collections.Generic.ICollection<System.Management.Automation.PSJobProxy> Create (System.Management.Automation.Runspaces.Runspace runspace);

static member Create : System.Management.Automation.Runspaces.Runspace -> System.Collections.Generic.ICollection<System.Management.Automation.PSJobProxy>

Public Shared Function Create (runspace As Runspace) As ICollection(Of PSJobProxy)

Parameters

runspace: Runspace

Runspace containing the jobs to base the proxy on.

Returns

ICollection<PSJobProxy>

A collection of job proxies that represent the jobs collected based on the filter.

Applies to

Create(RunspacePool)

Queries the runspace for jobs and constructs a collection of job proxies to interact with them.

public:
 static System::Collections::Generic::ICollection<System::Management::Automation::PSJobProxy ^> ^ Create(System::Management::Automation::Runspaces::RunspacePool ^ runspacePool);

public static System.Collections.Generic.ICollection<System.Management.Automation.PSJobProxy> Create (System.Management.Automation.Runspaces.RunspacePool runspacePool);

static member Create : System.Management.Automation.Runspaces.RunspacePool -> System.Collections.Generic.ICollection<System.Management.Automation.PSJobProxy>

Public Shared Function Create (runspacePool As RunspacePool) As ICollection(Of PSJobProxy)

Parameters

runspacePool: RunspacePool

RunspacePool containing the jobs to base the proxy on.

Returns

ICollection<PSJobProxy>

A collection of job proxies that represent the jobs collected based on the filter.

Applies to

Create(Runspace, Hashtable)

Queries the runspace for jobs and constructs a collection of job proxies to interact with them.

public:
 static System::Collections::Generic::ICollection<System::Management::Automation::PSJobProxy ^> ^ Create(System::Management::Automation::Runspaces::Runspace ^ runspace, System::Collections::Hashtable ^ filter);

public static System.Collections.Generic.ICollection<System.Management.Automation.PSJobProxy> Create (System.Management.Automation.Runspaces.Runspace runspace, System.Collections.Hashtable filter);

static member Create : System.Management.Automation.Runspaces.Runspace * System.Collections.Hashtable -> System.Collections.Generic.ICollection<System.Management.Automation.PSJobProxy>

Public Shared Function Create (runspace As Runspace, filter As Hashtable) As ICollection(Of PSJobProxy)

Parameters

runspace: Runspace

Runspace containing the jobs to base the proxy on.

filter: Hashtable

Hashtable to use for the Get-Job -filter command.

Returns

ICollection<PSJobProxy>

A collection of job proxies that represent the jobs collected based on the filter.

Applies to

Create(RunspacePool, Hashtable)

Queries the runspace for jobs and constructs a collection of job proxies to interact with them.

public:
 static System::Collections::Generic::ICollection<System::Management::Automation::PSJobProxy ^> ^ Create(System::Management::Automation::Runspaces::RunspacePool ^ runspacePool, System::Collections::Hashtable ^ filter);

public static System.Collections.Generic.ICollection<System.Management.Automation.PSJobProxy> Create (System.Management.Automation.Runspaces.RunspacePool runspacePool, System.Collections.Hashtable filter);

static member Create : System.Management.Automation.Runspaces.RunspacePool * System.Collections.Hashtable -> System.Collections.Generic.ICollection<System.Management.Automation.PSJobProxy>

Public Shared Function Create (runspacePool As RunspacePool, filter As Hashtable) As ICollection(Of PSJobProxy)

Parameters

runspacePool: RunspacePool

RunspacePool containing the jobs to base the proxy on.

filter: Hashtable

Hashtable to use for the Get-Job -filter command.

Returns

ICollection<PSJobProxy>

A collection of job proxies that represent the jobs collected based on the filter.

Applies to

Create(Runspace, Hashtable, Boolean)

Queries the runspace for jobs and constructs a collection of job proxies to interact with them.

public:
 static System::Collections::Generic::ICollection<System::Management::Automation::PSJobProxy ^> ^ Create(System::Management::Automation::Runspaces::Runspace ^ runspace, System::Collections::Hashtable ^ filter, bool receiveImmediately);

public static System.Collections.Generic.ICollection<System.Management.Automation.PSJobProxy> Create (System.Management.Automation.Runspaces.Runspace runspace, System.Collections.Hashtable filter, bool receiveImmediately);

static member Create : System.Management.Automation.Runspaces.Runspace * System.Collections.Hashtable * bool -> System.Collections.Generic.ICollection<System.Management.Automation.PSJobProxy>

Public Shared Function Create (runspace As Runspace, filter As Hashtable, receiveImmediately As Boolean) As ICollection(Of PSJobProxy)

Parameters

runspace: Runspace

Runspace containing the jobs to base the proxy on.

filter: Hashtable

Hashtable to use for the Get-Job -filter command.

receiveImmediately: Boolean

If true, the data streaming will start immediately. If false, the user must call "ReceiveJob()" to start data streaming.

Returns

ICollection<PSJobProxy>

A collection of job proxies that represent the jobs collected based on the filter.

Applies to

Create(RunspacePool, Hashtable, Boolean)

Queries the runspace for jobs and constructs a collection of job proxies to interact with them.

public:
 static System::Collections::Generic::ICollection<System::Management::Automation::PSJobProxy ^> ^ Create(System::Management::Automation::Runspaces::RunspacePool ^ runspacePool, System::Collections::Hashtable ^ filter, bool receiveImmediately);

public static System.Collections.Generic.ICollection<System.Management.Automation.PSJobProxy> Create (System.Management.Automation.Runspaces.RunspacePool runspacePool, System.Collections.Hashtable filter, bool receiveImmediately);

static member Create : System.Management.Automation.Runspaces.RunspacePool * System.Collections.Hashtable * bool -> System.Collections.Generic.ICollection<System.Management.Automation.PSJobProxy>

Public Shared Function Create (runspacePool As RunspacePool, filter As Hashtable, receiveImmediately As Boolean) As ICollection(Of PSJobProxy)

Parameters

runspacePool: RunspacePool

RunspacePool containing the jobs to base the proxy on.

filter: Hashtable

Hashtable to use for the Get-Job -filter command.

receiveImmediately: Boolean

If true, the data streaming will start immediately. If false, the user must call "ReceiveJob()" to start data streaming.

Returns

ICollection<PSJobProxy>

A collection of job proxies that represent the jobs collected based on the filter.

Applies to

Create(Runspace, Hashtable, EventHandler<JobDataAddedEventArgs>, EventHandler<JobStateEventArgs>)

Queries the runspace for jobs and constructs a collection of job proxies to interact with them.

public:
 static System::Collections::Generic::ICollection<System::Management::Automation::PSJobProxy ^> ^ Create(System::Management::Automation::Runspaces::Runspace ^ runspace, System::Collections::Hashtable ^ filter, EventHandler<System::Management::Automation::JobDataAddedEventArgs ^> ^ dataAdded, EventHandler<System::Management::Automation::JobStateEventArgs ^> ^ stateChanged);

public static System.Collections.Generic.ICollection<System.Management.Automation.PSJobProxy> Create (System.Management.Automation.Runspaces.Runspace runspace, System.Collections.Hashtable filter, EventHandler<System.Management.Automation.JobDataAddedEventArgs> dataAdded, EventHandler<System.Management.Automation.JobStateEventArgs> stateChanged);

static member Create : System.Management.Automation.Runspaces.Runspace * System.Collections.Hashtable * EventHandler<System.Management.Automation.JobDataAddedEventArgs> * EventHandler<System.Management.Automation.JobStateEventArgs> -> System.Collections.Generic.ICollection<System.Management.Automation.PSJobProxy>

Public Shared Function Create (runspace As Runspace, filter As Hashtable, dataAdded As EventHandler(Of JobDataAddedEventArgs), stateChanged As EventHandler(Of JobStateEventArgs)) As ICollection(Of PSJobProxy)

Parameters

runspace: Runspace

Runspace containing the jobs to base the proxy on.

filter: Hashtable

Hashtable to use for the Get-Job -filter command.

dataAdded: EventHandler<JobDataAddedEventArgs>

Handler to subscribe to any child job data added events.

stateChanged: EventHandler<JobStateEventArgs>

Handler to subscribe to any child job state changed events.

Returns

ICollection<PSJobProxy>

A collection of job proxies that represent the jobs collected based on the filter.

Applies to

Create(RunspacePool, Hashtable, EventHandler<JobDataAddedEventArgs>, EventHandler<JobStateEventArgs>)

Queries the runspace for jobs and constructs a collection of job proxies to interact with them.

public:
 static System::Collections::Generic::ICollection<System::Management::Automation::PSJobProxy ^> ^ Create(System::Management::Automation::Runspaces::RunspacePool ^ runspacePool, System::Collections::Hashtable ^ filter, EventHandler<System::Management::Automation::JobDataAddedEventArgs ^> ^ dataAdded, EventHandler<System::Management::Automation::JobStateEventArgs ^> ^ stateChanged);

public static System.Collections.Generic.ICollection<System.Management.Automation.PSJobProxy> Create (System.Management.Automation.Runspaces.RunspacePool runspacePool, System.Collections.Hashtable filter, EventHandler<System.Management.Automation.JobDataAddedEventArgs> dataAdded, EventHandler<System.Management.Automation.JobStateEventArgs> stateChanged);

static member Create : System.Management.Automation.Runspaces.RunspacePool * System.Collections.Hashtable * EventHandler<System.Management.Automation.JobDataAddedEventArgs> * EventHandler<System.Management.Automation.JobStateEventArgs> -> System.Collections.Generic.ICollection<System.Management.Automation.PSJobProxy>

Public Shared Function Create (runspacePool As RunspacePool, filter As Hashtable, dataAdded As EventHandler(Of JobDataAddedEventArgs), stateChanged As EventHandler(Of JobStateEventArgs)) As ICollection(Of PSJobProxy)

Parameters

runspacePool: RunspacePool

RunspacePool containing the jobs to base the proxy on.

filter: Hashtable

Hashtable to use for the Get-Job -filter command.

dataAdded: EventHandler<JobDataAddedEventArgs>

Handler to subscribe to any child job data added events.

stateChanged: EventHandler<JobStateEventArgs>

Handler to subscribe to any child job state changed events.

Returns

ICollection<PSJobProxy>

A collection of job proxies that represent the jobs collected based on the filter.

Applies to

Share via

PSJobProxy.Create Method

Definition

Overloads

Create(Runspace)

Parameters

Returns

Applies to

Create(RunspacePool)

Parameters

Returns

Applies to

Create(Runspace, Hashtable)

Parameters

Returns

Applies to

Create(RunspacePool, Hashtable)

Parameters

Returns

Applies to

Create(Runspace, Hashtable, Boolean)

Parameters

Returns

Applies to

Create(RunspacePool, Hashtable, Boolean)

Parameters

Returns

Applies to

Create(Runspace, Hashtable, EventHandler<JobDataAddedEventArgs>, EventHandler<JobStateEventArgs>)

Parameters

Returns

Applies to

Create(RunspacePool, Hashtable, EventHandler<JobDataAddedEventArgs>, EventHandler<JobStateEventArgs>)

Parameters

Returns

Applies to

Additional resources