BatchTaskCountsResult

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-batch/json-schema/microsoft-azure-batch-batch-task-counts-result-schema.json",
  "title": "BatchTaskCountsResult",
  "description": "The Task and TaskSlot counts for a Job.",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_superseded/microsoft-azure-batch-jobs-api-openapi.yml#/components/schemas/BatchTaskCountsResult",
  "type": "object",
  "properties": {
    "taskCounts": {
      "$ref": "#/$defs/BatchTaskCounts",
      "description": "The number of Tasks per state."
    },
    "taskSlotCounts": {
      "$ref": "#/$defs/BatchTaskSlotCounts",
      "description": "The number of TaskSlots required by Tasks per state."
    }
  },
  "required": [
    "taskCounts",
    "taskSlotCounts"
  ],
  "$defs": {
    "BatchTaskCounts": {
      "type": "object",
      "description": "The Task counts for a Job.",
      "properties": {
        "active": {
          "type": "integer",
          "format": "int32",
          "description": "The number of Tasks in the active state."
        },
        "running": {
          "type": "integer",
          "format": "int32",
          "description": "The number of Tasks in the running or preparing state."
        },
        "completed": {
          "type": "integer",
          "format": "int32",
          "description": "The number of Tasks in the completed state."
        },
        "succeeded": {
          "type": "integer",
          "format": "int32",
          "description": "The number of Tasks which succeeded. A Task succeeds if its result (found in the executionInfo property) is 'success'."
        },
        "failed": {
          "type": "integer",
          "format": "int32",
          "description": "The number of Tasks which failed. A Task fails if its result (found in the executionInfo property) is 'failure'."
        }
      },
      "required": [
        "active",
        "running",
        "completed",
        "succeeded",
        "failed"
      ]
    },
    "BatchTaskSlotCounts": {
      "type": "object",
      "description": "The TaskSlot counts for a Job.",
      "properties": {
        "active": {
          "type": "integer",
          "format": "int32",
          "description": "The number of TaskSlots for active Tasks."
        },
        "running": {
          "type": "integer",
          "format": "int32",
          "description": "The number of TaskSlots for running Tasks."
        },
        "completed": {
          "type": "integer",
          "format": "int32",
          "description": "The number of TaskSlots for completed Tasks."
        },
        "succeeded": {
          "type": "integer",
          "format": "int32",
          "description": "The number of TaskSlots for succeeded Tasks."
        },
        "failed": {
          "type": "integer",
          "format": "int32",
          "description": "The number of TaskSlots for failed Tasks."
        }
      },
      "required": [
        "active",
        "running",
        "completed",
        "succeeded",
        "failed"
      ]
    }
  }
}