GetChildItem GetChildItem GetChildItem GetChildItem Class

Definition

Activity to invoke the Microsoft.PowerShell.Management\Get-ChildItem command in a Workflow.

public ref class GetChildItem sealed : Microsoft::PowerShell::Activities::PSRemotingActivity
public sealed class GetChildItem : Microsoft.PowerShell.Activities.PSRemotingActivity
type GetChildItem = class
    inherit PSRemotingActivity
Public NotInheritable Class GetChildItem
Inherits PSRemotingActivity
Inheritance

Constructors

GetChildItem() GetChildItem() GetChildItem() GetChildItem()

Gets the display name of the command invoked by this activity.

Properties

AppendOutput AppendOutput AppendOutput AppendOutput

Determines whether to append output to Result.

(Inherited from PipelineEnabledActivity)
Attributes Attributes Attributes Attributes

Provides access to the Attributes parameter.

CanInduceIdle CanInduceIdle CanInduceIdle CanInduceIdle

In order for an activity to go idle, 'CanInduceIdle' should be true.

(Inherited from PSActivity)
Debug Debug Debug Debug

Determines whether to emit debug output of the activity.

(Inherited from PSActivity)
DefiningModule DefiningModule DefiningModule DefiningModule

If an activity needs to load a module before it can execute, override this member to return the name of that module.

(Inherited from PSActivity)
Depth Depth Depth Depth

Provides access to the Depth parameter.

Directory Directory Directory Directory

Provides access to the Directory parameter.

ErrorAction ErrorAction ErrorAction ErrorAction

Determines how errors should be handled by the activity.

(Inherited from PSActivity)
Exclude Exclude Exclude Exclude

Provides access to the Exclude parameter.

File File File File

Provides access to the File parameter.

Filter Filter Filter Filter

Provides access to the Filter parameter.

Force Force Force Force

Provides access to the Force parameter.

Hidden Hidden Hidden Hidden

Provides access to the Hidden parameter.

Include Include Include Include

Provides access to the Include parameter.

InformationAction InformationAction InformationAction InformationAction

Determines how information records should be handled by the activity.

(Inherited from PSActivity)
Input Input Input Input

The Input stream for the activity.

(Inherited from PipelineEnabledActivity)
LiteralPath LiteralPath LiteralPath LiteralPath

Provides access to the LiteralPath parameter.

MergeErrorToOutput MergeErrorToOutput MergeErrorToOutput MergeErrorToOutput

Determines whether to merge error data to the output stream

(Inherited from PSActivity)
Name Name Name Name

Provides access to the Name parameter.

ParameterDefaults ParameterDefaults ParameterDefaults ParameterDefaults

Provides access to the parameter defaults dictionary

(Inherited from PSActivity)
Path Path Path Path

Provides access to the Path parameter.

PSActionRetryCount PSActionRetryCount PSActionRetryCount PSActionRetryCount

Defines the number of retries that the activity will make when it encounters an error during execution of its action. The default is to not retry.

(Inherited from PSActivity)
PSActionRetryIntervalSec PSActionRetryIntervalSec PSActionRetryIntervalSec PSActionRetryIntervalSec

Defines the delay, in seconds, between action retry attempts. The default is one second.

(Inherited from PSActivity)
PSActionRunningTimeoutSec PSActionRunningTimeoutSec PSActionRunningTimeoutSec PSActionRunningTimeoutSec

Defines the maximum amount of time, in seconds, that this activity may run. The default is unlimited.

(Inherited from PSActivity)
PSAllowRedirection PSAllowRedirection PSAllowRedirection PSAllowRedirection

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

(Inherited from PSRemotingActivity)
PSApplicationName PSApplicationName PSApplicationName PSApplicationName

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

(Inherited from PSRemotingActivity)
PSAuthentication PSAuthentication PSAuthentication PSAuthentication

Defines the authentication type to be used in the remote connection.

(Inherited from PSRemotingActivity)
PSCertificateThumbprint PSCertificateThumbprint PSCertificateThumbprint PSCertificateThumbprint

Defines the certificate thumbprint to be used in the remote connection.

(Inherited from PSRemotingActivity)
PSCommandName PSCommandName PSCommandName PSCommandName

Gets the fully qualified name of the command invoked by this activity.

PSComputerName PSComputerName PSComputerName PSComputerName

The computer name to invoke this activity on.

(Inherited from PSRemotingActivity)
PSConfigurationName PSConfigurationName PSConfigurationName PSConfigurationName

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

(Inherited from PSRemotingActivity)
PSConnectionRetryCount PSConnectionRetryCount PSConnectionRetryCount PSConnectionRetryCount

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

(Inherited from PSRemotingActivity)
PSConnectionRetryIntervalSec PSConnectionRetryIntervalSec PSConnectionRetryIntervalSec PSConnectionRetryIntervalSec

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

(Inherited from PSRemotingActivity)
PSConnectionUri PSConnectionUri PSConnectionUri PSConnectionUri

Defines the fully-qualified remote URI to connect to. When specified, the PSComputerName, PSApplicationName, PSConfigurationName, and PSPort are not used.

(Inherited from PSRemotingActivity)
PSCredential PSCredential PSCredential PSCredential

Defines the credential to use in the remote connection.

(Inherited from PSRemotingActivity)
PSDebug PSDebug PSDebug PSDebug

The Debug stream / collection for the activity.

(Inherited from PSActivity)
PSDefiningModule PSDefiningModule PSDefiningModule PSDefiningModule

Returns the module defining the command called by this activity. It may be null.

(Inherited from PSActivity)
PSDisableSerialization PSDisableSerialization PSDisableSerialization PSDisableSerialization

Forces the activity to return non-serialized objects. Resulting objects have functional methods and properties (as opposed to serialized versions of them), but will not survive persistence when the Workflow crashes or is persisted.

(Inherited from PSActivity)
PSError PSError PSError PSError

The Error stream / collection for the activity.

(Inherited from PSActivity)
PSInformation PSInformation PSInformation PSInformation

The Information stream / collection for the activity.

(Inherited from PSActivity)
PSPersist PSPersist PSPersist PSPersist

Forces the activity to not call the persist functionality, which will be responsible for persisting the workflow state onto the disk.

(Inherited from PSActivity)
PSPort PSPort PSPort PSPort

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

(Inherited from PSRemotingActivity)
PSProgress PSProgress PSProgress PSProgress

The Progress stream / collection for the activity.

(Inherited from PSActivity)
PSProgressMessage PSProgressMessage PSProgressMessage PSProgressMessage

In addition to the display name PSProgress Message will provide the way to append the additional information into the activity progress message like branch name or iteration number in case of parallel foreach.

(Inherited from PSActivity)
PSRemotingBehavior PSRemotingBehavior PSRemotingBehavior PSRemotingBehavior

Defines the remoting behavior to use when invoking this activity.

(Inherited from PSRemotingActivity)
PSRequiredModules PSRequiredModules PSRequiredModules PSRequiredModules

This the list of module names (or paths) that are required to run this Activity successfully. The default is null.

(Inherited from PSActivity)
PSSessionOption PSSessionOption PSSessionOption PSSessionOption

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

(Inherited from PSRemotingActivity)
PSUseSsl PSUseSsl PSUseSsl PSUseSsl

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

(Inherited from PSRemotingActivity)
PSVerbose PSVerbose PSVerbose PSVerbose

The Verbose stream / collection for the activity.

(Inherited from PSActivity)
PSWarning PSWarning PSWarning PSWarning

The Warning stream / collection for the activity.

(Inherited from PSActivity)
ReadOnly ReadOnly ReadOnly ReadOnly

Provides access to the ReadOnly parameter.

Recurse Recurse Recurse Recurse

Provides access to the Recurse parameter.

Result Result Result Result

The output stream from the activity

(Inherited from PipelineEnabledActivity)
SupportsCustomRemoting SupportsCustomRemoting SupportsCustomRemoting SupportsCustomRemoting

Declares whether this command supports its own custom remoting. Commands that support their own custom remoting should return TRUE from this property, and use the PSComputerName parameter as required when the 'PSRemotingBehavior' argument is set to 'Custom'.

(Inherited from PSRemotingActivity)
System System System System

Provides access to the System parameter.

Tracer Tracer Tracer Tracer

Tracer initialization.

(Inherited from PSActivity)
UpdatePreferenceVariable UpdatePreferenceVariable UpdatePreferenceVariable UpdatePreferenceVariable

Indicates if preference variables need to be updated

(Inherited from PSActivity)
UseDefaultInput UseDefaultInput UseDefaultInput UseDefaultInput

Determines whether to connect the input stream for this activity.

(Inherited from PipelineEnabledActivity)
Verbose Verbose Verbose Verbose

Determines whether to emit verbose output of the activity.

(Inherited from PSActivity)
WarningAction WarningAction WarningAction WarningAction

Determines how warnings should be handled by the activity.

(Inherited from PSActivity)

Methods

ActivityEndPersistence(NativeActivityContext) ActivityEndPersistence(NativeActivityContext) ActivityEndPersistence(NativeActivityContext) ActivityEndPersistence(NativeActivityContext)

The method is override-able by the drived classes in case they would like to implement different logic at the end of persistence. The default behavior would be to schedule the 'Persist' activity if the PSPersist flag is true or Host is asking for it.

(Inherited from PSActivity)
CacheMetadata(NativeActivityMetadata) CacheMetadata(NativeActivityMetadata) CacheMetadata(NativeActivityMetadata) CacheMetadata(NativeActivityMetadata)

Retrieves the stream and ubiquitous parameter information from the hosting application. These must be passed in as "Streams" and "UbiquitousParameters", respectively.

(Inherited from PSActivity)
Cancel(NativeActivityContext) Cancel(NativeActivityContext) Cancel(NativeActivityContext) Cancel(NativeActivityContext)

Cancel the running activity

(Inherited from PSActivity)
Execute(NativeActivityContext) Execute(NativeActivityContext) Execute(NativeActivityContext) Execute(NativeActivityContext)

Begins the execution of the activity.

(Inherited from PSActivity)
GetActivityArguments() GetActivityArguments() GetActivityArguments() GetActivityArguments()

Retrievs all of the default arguments from the type and its parents.

(Inherited from PSActivity)
GetImplementation(NativeActivityContext) GetImplementation(NativeActivityContext) GetImplementation(NativeActivityContext) GetImplementation(NativeActivityContext)

Prepare commands that use PSRP for remoting...

(Inherited from PSRemotingActivity)
GetIsComputerNameSpecified(ActivityContext) GetIsComputerNameSpecified(ActivityContext) GetIsComputerNameSpecified(ActivityContext) GetIsComputerNameSpecified(ActivityContext)

Returns TRUE if the PSComputerName argument has been specified, and contains at least one target.

(Inherited from PSRemotingActivity)
GetPowerShell(NativeActivityContext) GetPowerShell(NativeActivityContext) GetPowerShell(NativeActivityContext) GetPowerShell(NativeActivityContext)

The method for derived activities to return a configured instance of System.Management.Automation.PowerShell. The implementor should have added all of the commands and parameters required to launch their command through the standard AddCommand() and AddParameter() methods. Derived activites should not manage the Runspace property directly, as the PSActivity class configures the runspace afterward to enable remote connections.

(Inherited from PSActivity)
GetRunInProc(ActivityContext) GetRunInProc(ActivityContext) GetRunInProc(ActivityContext) GetRunInProc(ActivityContext)

Determine if this activity should be run in or out of process when run locally/

(Inherited from PSActivity)
PrepareSession(ActivityImplementationContext) PrepareSession(ActivityImplementationContext) PrepareSession(ActivityImplementationContext) PrepareSession(ActivityImplementationContext)

The method for derived activities to customize the runspace of a System.Management.Automation.PowerShell instance that the runtime has prepared for them. If the command needs any workflow-specific information during this PrepareSession call, it should be stored in ActivityImplementationContext.WorkflowContext during the GetCommand preparation phase.

(Inherited from PSActivity)
UpdateImplementationContextForLocalExecution(ActivityImplementationContext, ActivityContext) UpdateImplementationContextForLocalExecution(ActivityImplementationContext, ActivityContext) UpdateImplementationContextForLocalExecution(ActivityImplementationContext, ActivityContext) UpdateImplementationContextForLocalExecution(ActivityImplementationContext, ActivityContext)

Updates the ImplementationContext returned from GetPowerShell() to support local execution against the host's runspace pool.

(Inherited from PSActivity)
WriteProgressRecord(NativeActivityContext, PSDataCollection<ProgressRecord>, String, ProgressRecordType) WriteProgressRecord(NativeActivityContext, PSDataCollection<ProgressRecord>, String, ProgressRecordType) WriteProgressRecord(NativeActivityContext, PSDataCollection<ProgressRecord>, String, ProgressRecordType) WriteProgressRecord(NativeActivityContext, PSDataCollection<ProgressRecord>, String, ProgressRecordType)

Write a progress record fo the current activity

(Inherited from PSActivity)

Applies to