ReceiveJobCommand Class

Definition

Namespace:

Microsoft.PowerShell.Commands

Assembly:

System.Management.Automation.dll

Package:

System.Management.Automation v7.4.0

Cmdlet used for receiving results from job object. This cmdlet is intended to have a slightly different behavior in the following two cases: 1. The job object to receive results from is a PSRemotingJob In this case, the cmdlet can use two additional parameters to filter results - ComputerName and Runspace The parameters help filter out results for a specified computer or runspace from the job object

          $job = Start-PSJob -Command 'get-process' -ComputerName server1, server2
          Receive-PSJob -Job $job -ComputerName server1

          $job = Start-PSJob -Command 'get-process' -Session $r1, $r2
          Receive-PSJob -Job $job -Session $r1

    2. The job object to receive results is a PSJob (or derivative
       other than PSRemotingJob)
         In this case, the user cannot will use the location parameter
         to do any filtering and will not have ComputerName and Runspace
         parameters

         $job = Get-WMIObject '....' -AsJob
         Receive-PSJob -Job $job -Location "Server2"

         The following will result in an error:

         $job = Get-WMIObject '....' -AsJob
         Receive-PSJob -Job $job -ComputerName "Server2"
         The parameter ComputerName cannot be used with jobs which are
         not PSRemotingJob.

public ref class ReceiveJobCommand : Microsoft::PowerShell::Commands::JobCmdletBase, IDisposable

[System.Management.Automation.Cmdlet("Receive", "Job", DefaultParameterSetName="Location", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096965", RemotingCapability=System.Management.Automation.RemotingCapability.SupportedByCommand)]
public class ReceiveJobCommand : Microsoft.PowerShell.Commands.JobCmdletBase, IDisposable

[<System.Management.Automation.Cmdlet("Receive", "Job", DefaultParameterSetName="Location", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096965", RemotingCapability=System.Management.Automation.RemotingCapability.SupportedByCommand)>]
type ReceiveJobCommand = class
    inherit JobCmdletBase
    interface IDisposable

Public Class ReceiveJobCommand
Inherits JobCmdletBase
Implements IDisposable

Inheritance

Object

InternalCommand

Cmdlet

PSCmdlet

PSRemotingCmdlet

JobCmdletBase

ReceiveJobCommand

Attributes

CmdletAttribute

Implements

IDisposable

Constructors

ReceiveJobCommand()

Fields

ComputerInstanceIdParameterSet	Computername with session instance ID parameter set. (Inherited from PSRemotingCmdlet)
ComputerNameParameterSet	Computername parameter set. (Inherited from PSRemotingCmdlet)
ContainerIdParameterSet	Container ID parameter set. (Inherited from PSRemotingCmdlet)
DefaultPowerShellRemoteShellAppName	Default application name for the connection uri. (Inherited from PSRemotingCmdlet)
DefaultPowerShellRemoteShellName	Default shellname. (Inherited from PSRemotingCmdlet)
LocationParameterSet
SessionParameterSet	Runspace parameter set. (Inherited from PSRemotingCmdlet)
SSHHostHashParameterSet	SSH host parmeter set supporting hash connection parameters. (Inherited from PSRemotingCmdlet)
SSHHostParameterSet	SSH host parameter set. (Inherited from PSRemotingCmdlet)
UseWindowsPowerShellParameterSet	Parameter set to use Windows PowerShell. (Inherited from PSRemotingCmdlet)
VMIdParameterSet	VM guid parameter set. (Inherited from PSRemotingCmdlet)
VMNameParameterSet	VM name parameter set. (Inherited from PSRemotingCmdlet)

Properties

AutoRemoveJob
Command
CommandOrigin	This property tells you if you were being invoked inside the runspace or if it was an external request. (Inherited from InternalCommand)
CommandRuntime	Holds the command runtime object for this command. This object controls what actually happens when a write is called. (Inherited from Cmdlet)
ComputerName	Name of the computer for which the results needs to be returned.
CurrentPSTransaction	Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction. (Inherited from Cmdlet)
Events	Gets the event manager for the current runspace. (Inherited from PSCmdlet)
Filter
Force
Host	Gets the host interaction APIs. (Inherited from PSCmdlet)
Id	SessionId for which job need to be obtained. (Inherited from JobCmdletBase)
InstanceId	InstanceIds for which job need to be obtained. (Inherited from JobCmdletBase)
InvokeCommand	Provides access to utility routines for executing scripts and creating script blocks. (Inherited from PSCmdlet)
InvokeProvider	Gets the instance of the provider interface APIs for the current runspace. (Inherited from PSCmdlet)
Job	Job object from which specific results need to be extracted.
JobManager	Manager for JobSourceAdapters registered. (Inherited from PSCmdlet)
JobRepository	Repository for jobs. (Inherited from PSCmdlet)
Keep	If the results need to be not removed from the store after being written. Default is results are removed.
Location	Locations for which the results needs to be returned. This will cater to all kinds of jobs and not only remoting jobs.
MyInvocation	Contains information about the identity of this cmdlet and how it was invoked. (Inherited from PSCmdlet)
Name	Name of the jobs to retrieve. (Inherited from JobCmdletBase)
NoRecurse
PagingParameters	If the cmdlet declares paging support (via SupportsPaging), then PagingParameters property contains arguments of the paging parameters. Otherwise PagingParameters property is null. (Inherited from PSCmdlet)
ParameterSetName	The name of the parameter set in effect. (Inherited from PSCmdlet)
Session	Runspaces for which the results needs to be returned.
SessionState	Gets the instance of session state for the current runspace. (Inherited from PSCmdlet)
State
Stopping	Is this command stopping? (Inherited from Cmdlet)
Wait
WriteEvents
WriteJobInResults

Methods

BeginProcessing()
CurrentProviderLocation(String)	(Inherited from PSCmdlet)
Dispose()
Dispose(Boolean)
EndProcessing()	If we are not stopping, continue writing output as and when they are available.
GetResolvedProviderPathFromPSPath(String, ProviderInfo)	(Inherited from PSCmdlet)
GetResourceString(String, String)	Gets the resource string corresponding to baseName and resourceId from the current assembly. You should override this if you require a different behavior. (Inherited from Cmdlet)
GetUnresolvedProviderPathFromPSPath(String)	(Inherited from PSCmdlet)
GetVariableValue(String)	(Inherited from PSCmdlet)
GetVariableValue(String, Object)	(Inherited from PSCmdlet)
Invoke()	Invoke this cmdlet object returning a collection of results. (Inherited from Cmdlet)
Invoke<T>()	Returns a strongly-typed enumerator for the results of this cmdlet. (Inherited from Cmdlet)
ProcessRecord()	Retrieve the results for the specified computers or runspaces.
ResolveAppName(String)	Determines the appname to be used based on the following order: 1. AppName parameter specified 2. DEFAULTREMOTEAPPNAME variable set 3. WSMan. (Inherited from PSRemotingCmdlet)
ResolveComputerName(String)	Resolves a computer name. If its null or empty its assumed to be localhost. (Inherited from PSRemotingCmdlet)
ResolveComputerNames(String[], String[])	Resolve all the machine names provided. Basically, if a machine name is '.' assume localhost. (Inherited from PSRemotingCmdlet)
ResolveShell(String)	Determines the shellname to use based on the following order: 1. ShellName parameter specified 2. DEFAULTREMOTESHELLNAME variable set 3. PowerShell. (Inherited from PSRemotingCmdlet)
ShouldContinue(String, String)	Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant only offers Yes/No, not YesToAll/NoToAll. (Inherited from Cmdlet)
ShouldContinue(String, String, Boolean, Boolean)	Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll. (Inherited from Cmdlet)
ShouldContinue(String, String, Boolean, Boolean, Boolean)	Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll. (Inherited from Cmdlet)
ShouldProcess(String)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. (Inherited from Cmdlet)
ShouldProcess(String, String)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify text for both the target resource and the action. (Inherited from Cmdlet)
ShouldProcess(String, String, String)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify the complete text describing the operation, rather than just the name and action. (Inherited from Cmdlet)
ShouldProcess(String, String, String, ShouldProcessReason)	Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify the complete text describing the operation, rather than just the name and action. (Inherited from Cmdlet)
StopProcessing()	StopProcessing - when the command is stopped, unregister all the event handlers from the jobs and decrement reference for results.
ThrowTerminatingError(ErrorRecord)	Terminate the command and report an error. (Inherited from Cmdlet)
TransactionAvailable()	Returns true if a transaction is available and active. (Inherited from Cmdlet)
WriteCommandDetail(String)	Write text into pipeline execution log. (Inherited from Cmdlet)
WriteDebug(String)	Display debug information. (Inherited from Cmdlet)
WriteError(ErrorRecord)	Internal variant: Writes the specified error to the error pipe. (Inherited from Cmdlet)
WriteInformation(InformationRecord)	Route information to the user or host. (Inherited from Cmdlet)
WriteInformation(Object, String[])	Route information to the user or host. (Inherited from Cmdlet)
WriteObject(Object)	Writes the object to the output pipe. (Inherited from Cmdlet)
WriteObject(Object, Boolean)	Writes one or more objects to the output pipe. If the object is a collection and the enumerateCollection flag is true, the objects in the collection will be written individually. (Inherited from Cmdlet)
WriteProgress(ProgressRecord)	Display progress information. (Inherited from Cmdlet)
WriteVerbose(String)	Display verbose information. (Inherited from Cmdlet)
WriteWarning(String)	Display warning information. (Inherited from Cmdlet)