Windows desktop applications
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

PSWorkflowRuntimeVariable Enumeration

 

Updated: April 27, 2016

Applies To: Windows PowerShell

Describes values that are used to indicate the type of a runtime variable that is being retrieved in a Windows PowerShell workflow process. Introduced in Windows PowerShell 3.0.

Namespace:   Microsoft.PowerShell.Activities
Assembly:  Microsoft.PowerShell.Activities (in Microsoft.PowerShell.Activities.dll)

public enum PSWorkflowRuntimeVariable

Member nameDescription
All

Return all values as a hashtable.

ErrorAction

How errors should be handled by the activity.

InformationAction

How Information messages should be handled by the activity.

Input

The Input stream for the activity.

JobCommandName

The name of the command run by the job.

JobId

Identifies of the job.

JobInstanceId

The global identifier for the job instance.

JobName

The friendly name for the job.

Other

Tell the activity to look for a custom string

ParentCommandName

The name of the command run by the parent job.

ParentJobId

Identifies of the parent job.

ParentJobInstanceId

The global identifier of the parent job instance.

ParentJobName

The name of the parent job.

PSAllowRedirection

Whether to allow redirection by the remote computer. The default is false.

PSApplicationName

The remote application name to connect to. The default is "wsman".

PSAuthentication

The authentication type to be used in the remote connection.

PSAuthenticationLevel

The authentication level to be used with the WMI connection.

PSCertificateThumbprint

The certificate thumbprint to be used in the remote connection.

PSComputerName

The computer name to invoke this activity on.

PSConfigurationName

The remote configuration name to connect to. The default is "Microsoft.PowerShell".

PSConnectionRetryCount

The number of retries that the activity will make to connect to a remote machine when it encounters an error.

PSConnectionRetryIntervalSec

The delay, in seconds, between connection retry attempts. The default is one second.

PSConnectionUri

The fully-qualified remote URI to connect to.

PSCredential

The credential to use in the remote connection.

PSCulture

Windows PowerShell culture.

PSElapsedTimeoutSec

The timeout for the elapsed time the workflow is allowed to run.

PSPersist

Whether to force the activity to persist the workflow state onto the disk.

PSPort

The port to use in a remote connection attempt. The default is: HTTP: 5985, HTTPS: 5986.

PSPrivateMetadata

Private metadata fields.

PSRunningTimeoutSec

The timeout for the actual running time of the workflow, not including time when it is paused or persisted.

PSSenderInfo

A PSSenderInfo Class object that provides information about the connection.

PSSessionOption

Defines any session options to be used in the remote connection.

PSUICulture

Windows PowerShell user information culture.

PSUseSsl

Whether to use SSL in the connection attempt. The default is false.

PSVersionTable

Windows PowerShell version table.

PSWorkflowRoot

The module path of the workflow.

Verbose

Whether to emit verbose output of the activity.

WarningAction

How warnings should be handled by the activity.

WorkflowInstanceId

The workflow instance Id.

If the enumeration value is Other, the type of the runtime variable is not included in this enumeration.

Return to top
Show:
© 2016 Microsoft