< Back

Get-AMWorkflowVariable

Sat Jan 11, 2020 2:47 am

NAME Get-AMWorkflowVariable



SYNOPSIS

Gets a list of variables within a workflow.





SYNTAX

Get-AMWorkflowVariable [[-InputObject] <Object>] [[-Name] <String>] [[-InitialValue] <String>] [[-DataType]

{Variable | Array | Dataset}] [[-VariableType] {Auto | Text | Number}] [<CommonParameters>]





DESCRIPTION

Get-AMWorkflowVariable retrieves variables for a workflow.





PARAMETERS

-InputObject <Object>

The object to retrieve variables from.



Required? false

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Name <String>

Search on the name of the variable. Wildcards are accepted.



Required? false

Position? 2

Default value *

Accept pipeline input? false

Accept wildcard characters? false



-InitialValue <String>

Search on the initial value of the variable. Wildcards are accepted.



Required? false

Position? 3

Default value *

Accept pipeline input? false

Accept wildcard characters? false



-DataType

Filter on the data type of the variable.



Required? false

Position? 4

Default value

Accept pipeline input? false

Accept wildcard characters? false



-VariableType

Filter on the type of variable.



Required? false

Position? 5

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

The following AutoMate object types can be queried by this function:

Workflow





OUTPUTS

WorkflowVariable





-------------------------- EXAMPLE 1 --------------------------



PS C:\\># Get variables in workflow "FTP Files"



Get-AMWorkflow "FTP Files" | Get-AMWorkflowVariable











RELATED LINKS

https://github.com/AutomatePS/AutomatePS