Performs the same function as the Execute operation with the notable difference that it will perform the windows commands on each individual Partial Deploy file. All of the workflow execution properties available with execute are also available here in addition to the below properties:

PROJECT_TYPE - Partial deploy project type, GENERIC, EBS, MDS etc
OBJECT_TYPE_CODE - Object type for the File.
File level attributes
- FILE_PATH - File path of the partial deploy file. (File Name (with path)) on the partial deployment screen.
- FILE_NAME - File name of the partial deploy file
- FILE_PATH_PREFIX - File path, excluding the file name and extension
- FILE_EXTENSION - File extension on the partial deploy file.
- FILE_HASH - The Hash of the file as generated recorded by FlexDeploy - Added in 5.0.0.4
- FILE_SCM_REVISION - The SCM Revision of the partial deploy file - Added in 5.0.0.4
- SOURCE_FILE - Fully qualified location of the file on the endpoint.
All file attributes defined on Project Files tab are included as well.

File level variable example

Environment Variable	Value if File Name (with path) is /XXHR/publisher/APXSOBLX_1.rtf
FILE_PATH	/XXHR/publisher/APXSOBLX_1.rtf
FILE_NAME	APXSOBLX_1
FILE_PATH_PREFIX	/XXHR/publisher
FILE_EXTENSION	rtf
SOURCE_FILE	<Workflow Execution Temp Directory>/XXHR/publisher/APXSOBLX_1.rtf

Environment/Instance Properties

Property Name	Property Code	Required	Description

Project Properties

Property Name	Property Code	Required	Description
Project File Includes	FD_PARTIAL_FILE_INCLUDES	No	Controls files included in Project Files. Enter expressions separated by ##. Leave empty to select all files. Begin or end the expression with * for simple wildcards. Otherwise, regex is used. (e.g. /java/##.java##person##/java/.[tT]est.\.java)
Project File Excludes	FD_PARTIAL_FILE_EXCLUDES	No	Controls files excluded from Project Files. Enter expressions separated by ##. Leave empty to select all files. Begin or end the expression with * for simple wildcards. Otherwise, regex is used. (e.g. /java/##.java##person##/java/.[tT]est.\.java)

Inputs

Input Name	Input Code	Required	Description
Code Snippet	`FDPWRSHELL_INP_CODE_SNIPPET`	Yes	The cmdlets and/or PowerShell scripts that are to be executed in a Windows environment.
Restrict Environment	`FDPWRSHELL_INP_RESTRICT_ENVIRONMENT`	No	Provide comma-separated instance codes to restrict environment variables in shell to specified instance codes. If no value is provided all properties are available to shell environment.
No Secure Variables	`FDPWRSHELL_INP_NO_SECURE_VARIABLES`	No	Check if you do not want to pass secure/encrypted properties in PowerShell environment.

Outputs

Output Name	Required	Description
User Defined	No	See Special Considerations below.

Artifacts

This operation delegates consumes/produces artifacts decision to the workflow developer. Check Consumes Artifacts on the workflow step editor if this operation requires artifacts to be delivered prior to execution of the script. Check Produces Artifacts on the workflow step editor if this operation creates artifacts. The artifacts folder is available via the FD_ARTIFACTS_DIR variable.

Endpoint Selection

This operation delegates endpoint selection to the workflow developer. The workflow editor will default the selection to "All", which selects all available endpoints associated to the environment instance. Selecting a specific resource will result in selection of endpoints associated to the environment instance which have that resource defined.

Endpoint Execution

This operation delegates endpoint execution to the workflow developer. The workflow editor will default to "Any", which will execute on any one of the selected endpoints, which will be randomly picked from selected endpoints or a specific endpoint where previous step may have executed. Changing this value to "All" to will result in execution on all selected endpoints.

Special Considerations

Environment Variables - to use an input in your code snippet, you must create an environment variable by prefixing the plugin variable with $env: in order for it to be used by Windows PowerShell. This method must also be applied when using any environment variables, such as JAVA_HOME or FD_INSTANCE_CODE. Any number of inputs or properties can be used.

User Inputs

Set-Location -Path $env:filepath

Environment Variables

Get-Item $env:FD_ARTIFACTS_DIR

User defined outputs - an output must be defined in the workflow editor to be accessible. Within your script, use the following built-in function to set the output with the appropriate value and have it returned to the workflow process. Any number of outputs can be used.

setOutput {output name} {output value}
 
Example: setOutput RESULT $env:RESULT_VARIABLE

Outputs are aggregated into a csv list for partial deployments.

The above RESULT example would contain an entry for each file in the object list. [YES, NO]

Indicate file was not processed and should not consider status

# just call ignoreStatus for File that this shell did not process
ignoreStatus

Overriding the file status

There may be cases when you want to manually set the status for any particular file when scripting. The below functions can be utilized to set the status of the file as you see fit:

setObjectResultStatusSuccess
setObjectResultStatusFailed
setObjectResultStatusSkipped
setObjectResultStatusNotAttempted
setObjectResultStatusIgnore

In the case where your Build or Deployment is hanging on your PowerShell plugin step, the most common issue is that the cmdlet you entered requires user input. If this occurs then you need to force the cmdlet to complete without the user input and then re-build or re-deploy.

Stop-AzureRmVM -Name "VirtualMachine3" -ResourceGroupName "ResourceGroup5" -Force

Appendix

A list of available PowerShell cmdlets and their descriptions can be found here.

A list of available Azure PowerShell cmdlets and their descriptions can be found here.

FlexDeploy 5.0.0

partialExecute (PowerShell)