Azure Batch Connector 1.0.0.0
The Azure Batch Connector lets you list Azure Batch jobs and add tasks to an Azure Batch job.
Note: This Connector supports Azure Connection configuration options.
Prerequisites
- RunMyJobs 9.2.9 or later.
- Connection Management Extension 1.0.0.4 or later. This will be installed or updated automatically if necessary when you install the Azure Batch Connector.
- Azure Connections Extension 1.0.0.3 or later. This will be installed or updated automatically if necessary when you install the Azure Batch Connector.
- Privileges Required to Use Azure Connections Extension
- Privileges Required to Use the Azure Batch Connector
Contents
| Object Type | Name |
|---|---|
| Application | GLOBAL.Redwood.REDWOOD.AzureBatch |
| Constraint Definition | REDWOOD.Redwood_AzureBatchConnectionConstraint |
| Constraint Definition | REDWOOD.Redwood_AzureBatchPoolConstraint |
| Extension Point | REDWOOD.Redwood_AzureBatchConnection |
| Job Definition | REDWOOD.Redwood_Azure_Batch_AddTask_Template |
| Job Definition | REDWOOD.Redwood_Azure_Batch_Listjobs |
| Job Definition Type | REDWOOD.Redwood_AzureBatch |
| Library | REDWOOD.Redwood_AzureBatch |
Setup
To install the Azure Batch Connector, click its tile in the Catalog, select the version you want, and then click Install <version number>.
Job Definitions
Redwood_Azure_Batch_Listjobs
Lists available Azure Batch jobs.
Parameters
| Tab | Name | Description | Documentation | Data Type | Direction | Default Expression | Values |
|---|---|---|---|---|---|---|---|
| Parameters | connection
|
Connection | The Connection for Azure Batch. | String | In |
|
|
| Parameters | poolFilter
|
Pool ID filter | Only include jobs that have a pool matching this filter. | String | In |
|
|
| Parameters | jobFilter
|
Job ID filter | This filter can be used to limit the jobs returned to those with a name matches the filter. Wildcards * and ? are supported. If omitted, all jobs from the batch account will be returned. | String | In |
|
|
| Parameters | jobstateFilter
|
Job State filter | Only include jobs that have a job state matching this filter. | String | In |
|
Active, Completed, Deleting, Disabled, Disabling, Enabling, Terminating |
| Parameters | listing
|
Job Listing | Information about the Azure Batch jobs matching the filters. | Table | Out |
Redwood_Azure_Batch_AddTask_Template
Template to add a new task to an existing Azure Batch job and monitor it until completion.
Parameters
| Tab | Name | Description | Documentation | Data Type | Direction | Default Expression | Values |
|---|---|---|---|---|---|---|---|
| Parameters | connection
|
Connection | The Connection for Azure Batch. | String | In |
|
|
| Parameters | jobID
|
Job ID | Unique Identifier of the job you wish to add the task under. | String | In |
|
|
| Parameters | taskID
|
Task ID | Unique Identifier of the task. | String | In |
|
|
| Parameters | taskDisplayName
|
Task Display Name | A display name for the task. It does not need to be unique and can contain only Unicode characters up to a maximum length of 1024. | String | In |
|
|
| Parameters | restartable
|
Show Restart Options | Creates an Operator Message if the task fails and attaches it to the Job, allowing the user to restart it. | String | In | N
|
Y=Yes, N=No |
| Parameters | downloadLogs
|
Download Logs | Download task logs once the task completes? | String | In | No
|
Yes, No, On Failure |
Procedures
Adding Tasks to an Azure Batch Job
Typically, an Azure Batch job has multiple associated tasks. To easily add tasks to an Azure Batch job:
-
Right-click the Redwood_Azure_Batch_AddTask_Template Job Definition and choose New (from Template) from the context menu. The New Job Definition screen displays.
-
Choose a Partition.
-
Enter a Name.
-
Delete the default Folder value (if any) and substitute your own Folder name if desired.
-
By default, the Source field for the template contains the following code, with references to the included taskID and taskDisplayName Parameters:
Copy{
"id": "${taskID}",
"displayName":"${taskDisplayName}",
"commandLine": "<Put your commandline here>"
}You can use the supplied Parameters and create your own. For example, you could create a commandLine Parameter and modify the last line of the Source code like so:
"commandLine": "${commandLine}" -
In the Parameters tab, enter any Default Expressions you want to use. When specifying the Connection value, use the format
EXTCONNECTION:<partition>.<connection name>. -
Save and then submit the new Job Definition.
Listing Azure Batch Jobs
The Redwood_Azure_Batch_Listjobs Job Definition lets you fetch a particular list of Azure Batch jobs based on the filtering criteria you supply in the three filter fields. The list of jobs is returned as an RTX file containing the following fields:
-
Key
-
Id (task ID)
-
DisplayName
-
State
-
MaxParallelTasks
-
OnAllTasksComplete
-
OnTaskFailure
Within a Workflow, you can pass this RTX file to another Job Call, such as Redwood_Azure_Batch_EnableJob, and map the returned Id value to the Task ID field.