Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel

Table of Contents

...

Template Name

Extension Name

Extension Version

Azure Batch

ue-azure-batch

1.0.0

Refer to Changelog for version history information.

Key Features

Actions:

  • Add an Azure Batch Job to a specific pool of nodes by providing the Azure Batch Job configuration in JSON format.

  • Add a task as part of a specific job & optionally monitor task for completion.

...

The task can optionally be monitored for completion. In that case, Azure is polled every one second by default (can be parameterized by the user) for the task’s execution status.

Configuration examples

User scenario: Add a task and do not wait for its completion.

Image Modified

User scenario: Add a task and wait for its completion.

Image Modified

Action Output

Output Type

Description (Successful Execution)

Example (Successful Execution)

EXTENSION


Standard UC format

The extension output follows the standard UC output format, providing:

  • “exit_code“, “status“ , “status_description“: General info regarding the task execution.

  • “invocation” > “fields”: The task configuration used for this task execution.


Result fields

  • result: The result of querying the newly added task.

{
    "exit_code" : 0,
    "status" : "SUCCESS",
    "status_description" : "Task executed successfully.",
    "invocation" : {
      "fields" : { "..." }
    },
    "result" : {
      "odata.metadata" : "https://batchsimon.westeurope.batch.azure.com/$metadata#tasks/@Element",
      "id" : "random02",
      "url" : "https://testbatch.westeurope.batch.azure.com/jobs/job01/tasks/random01",
      "eTag" : "0x8DB1A58BD1505C7",
      "creationTime" : "2023-03-01T13:27:43.4772935Z",
      "lastModified" : "2023-03-01T13:27:43.4772935Z",
      "state" : "active",
      "stateTransitionTime" : "2023-03-01T13:27:43.4772935Z",
      "commandLine" : "ls -al",
      "userIdentity" : {
        "autoUser" : {
          "scope" : "pool",
          "elevationLevel" : "nonadmin"
        }
      },
      "constraints" : {
        "maxWallClockTime" : "P10675199DT2H48M5.4775807S",
        "retentionTime" : "P7D",
        "maxTaskRetryCount" : 0,
        "requiredSlots" : 1,
        "executionInfo" : {
          "retryCount" : 0,
          "requeueCount" : 0
        }
      }
    }
}

Description (Failed Execution)

Example (Failed Execution)

Standard UC format

  • “exit_code“, “status“ , “status_description“: Will be set according to the specific error happened during the execution. A list of possible values is provided in the extension exit codes table in this document.


Result fields

  • “result“ > “error“: If additional error details can be retrieved when the error occurred, they will be provided in this JSON element.

  • “result“ > “http_code“: If the http error from the error response can be retrieved, it will be provided in this integer element.

{
    "exit_code" : 1,
    "status" : "FAILED",
    "status_description" : "Task execution failed with error: ...",
    "invocation" : {
      "fields" : { "..." }
    },
    "result" : {
      "error" : { "..." },
      "http_code" : 500
    }
}

...

This document references the following documents:

Document Link

Description

Universal Templates

User documentation for creating, working with and understanding Universal Templates and Integrations.

Universal Tasks

User documentation for creating Universal Tasks in the Universal Controller user interface.

Azure Batch Documentation

User Documentation for Microsoft Azure Batch service.

...