BatchJobScheduleCreateOptions

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-batch/json-schema/microsoft-azure-batch-batch-job-schedule-create-options-schema.json",
  "title": "BatchJobScheduleCreateOptions",
  "description": "Parameters for creating an Azure Batch Job Schedule",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_superseded/microsoft-azure-batch-job-schedules-api-openapi.yml#/components/schemas/BatchJobScheduleCreateOptions",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "A string that uniquely identifies the schedule within the Account. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case)."
    },
    "displayName": {
      "type": "string",
      "description": "The display name for the schedule. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024."
    },
    "schedule": {
      "$ref": "#/$defs/BatchJobScheduleConfiguration",
      "description": "The schedule according to which Jobs will be created. All times are fixed respective to UTC and are not impacted by daylight saving time."
    },
    "jobSpecification": {
      "$ref": "#/$defs/BatchJobSpecification",
      "description": "The details of the Jobs to be created on this schedule."
    },
    "metadata": {
      "type": "array",
      "description": "A list of name-value pairs associated with the schedule as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code.",
      "items": {
        "$ref": "#/$defs/BatchMetadataItem"
      }
    }
  },
  "required": [
    "id",
    "schedule",
    "jobSpecification"
  ],
  "$defs": {
    "AutoUserScope": {
      "type": "string",
      "description": "AutoUserScope enums",
      "enum": [
        "task",
        "pool"
      ],
      "x-ms-enum": {
        "name": "AutoUserScope",
        "modelAsString": true,
        "values": [
          {
            "name": "Task",
            "value": "task",
            "description": "Specifies that the service should create a new user for the Task."
          },
          {
            "name": "Pool",
            "value": "pool",
            "description": "Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool."
          }
        ]
      }
    },
    "AutoUserSpecification": {
      "type": "object",
      "description": "Specifies the options for the auto user that runs an Azure Batch Task.",
      "properties": {
        "scope": {
          "$ref": "#/$defs/AutoUserScope",
          "description": "The scope for the auto user. The default value is pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks."
        },
        "elevationLevel": {
          "$ref": "#/$defs/ElevationLevel",
          "description": "The elevation level of the auto user. The default value is nonAdmin."
        }
      }
    },
    "AutomaticOsUpgradePolicy": {
      "type": "object",
      "description": "The configuration parameters used for performing automatic OS upgrade.",
      "properties": {
        "disableAutomaticRollback": {
          "type": "boolean",
          "description": "Whether OS image rollback feature should be disabled."
        },
        "enableAutomaticOSUpgrade": {
          "type": "boolean",
          "description": "Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. <br /><br /> If this is set to true for Windows based pools, [WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/rest/api/batchservice/pools/create-pool#windowsconfiguration) cannot be set to true.",
          "x-ms-client-name": "enableAutomaticOsUpgrade"
        },
        "useRollingUpgradePolicy": {
          "type": "boolean",
          "description": "Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS."
        },
        "osRollingUpgradeDeferral": {
          "type": "boolean",
          "description": "Defer OS upgrades on the TVMs if they are running tasks."
        }
      }
    },
    "AzureBlobFileSystemConfiguration": {
      "type": "object",
      "description": "Information used to connect to an Azure Storage Container using Blobfuse.",
      "properties": {
        "accountName": {
          "type": "string",
          "description": "The Azure Storage Account name."
        },
        "containerName": {
          "type": "string",
          "description": "The Azure Blob Storage Container name."
        },
        "accountKey": {
          "type": "string",
          "format": "password",
          "description": "The Azure Storage Account key. This property is mutually exclusive with both sasKey and identity; exactly one must be specified.",
          "x-ms-secret": true
        },
        "sasKey": {
          "type": "string",
          "format": "password",
          "description": "The Azure Storage SAS token. This property is mutually exclusive with both accountKey and identity; exactly one must be specified.",
          "x-ms-secret": true
        },
        "blobfuseOptions": {
          "type": "string",
          "description": "Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux."
        },
        "relativeMountPath": {
          "type": "string",
          "description": "The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable."
        },
        "identityReference": {
          "$ref": "#/$defs/BatchNodeIdentityReference",
          "description": "The reference to the user assigned identity to use to access containerName. This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified."
        }
      },
      "required": [
        "accountName",
        "containerName",
        "relativeMountPath"
      ]
    },
    "AzureFileShareConfiguration": {
      "type": "object",
      "description": "Information used to connect to an Azure Fileshare.",
      "properties": {
        "accountName": {
          "type": "string",
          "description": "The Azure Storage account name."
        },
        "accountKey": {
          "type": "string",
          "format": "password",
          "description": "The Azure Storage account key.",
          "x-ms-secret": true
        },
        "azureFileUrl": {
          "type": "string",
          "format": "uri",
          "description": "The Azure Files URL. This is of the form 'https://{account}.file.core.windows.net/'."
        },
        "relativeMountPath": {
          "type": "string",
          "description": "The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable."
        },
        "mountOptions": {
          "type": "string",
          "description": "Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux."
        }
      },
      "required": [
        "accountName",
        "accountKey",
        "azureFileUrl",
        "relativeMountPath"
      ]
    },
    "BatchAllTasksCompleteMode": {
      "type": "string",
      "description": "The action the Batch service should take when all Tasks in the Job are in the completed state.",
      "enum": [
        "noaction",
        "terminatejob"
      ],
      "x-ms-enum": {
        "name": "BatchAllTasksCompleteMode",
        "modelAsString": true,
        "values": [
          {
            "name": "NoAction",
            "value": "noaction",
            "description": "Do nothing. The Job remains active unless terminated or disabled by some other means."
          },
          {
            "name": "TerminateJob",
            "value": "terminatejob",
            "description": "Terminate the Job. The Job's terminationReason is set to 'AllTasksComplete'."
          }
        ]
      }
    },
    "BatchApplicationPackageReference": {
      "type": "object",
      "description": "A reference to an Package to be deployed to Compute Nodes.",
      "properties": {
        "applicationId": {
          "type": "string",
          "description": "The ID of the application to deploy. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName})."
        },
        "version": {
          "type": "string",
          "description": "The version of the application to deploy. If omitted, the default version is deployed. If this is omitted on a Pool, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If this is omitted on a Task, and no default version is specified for this application, the Task fails with a pre-processing error."
        }
      },
      "required": [
        "applicationId"
      ]
    },
    "BatchAutoPoolSpecification": {
      "type": "object",
      "description": "Specifies characteristics for a temporary 'auto pool'. The Batch service will\ncreate this auto Pool when the Job is submitted.",
      "properties": {
        "autoPoolIdPrefix": {
          "type": "string",
          "description": "A prefix to be added to the unique identifier when a Pool is automatically created. The Batch service assigns each auto Pool a unique identifier on creation. To distinguish between Pools created for different purposes, you can specify this element to add a prefix to the ID that is assigned. The prefix can be up to 20 characters long."
        },
        "poolLifetimeOption": {
          "$ref": "#/$defs/BatchPoolLifetimeOption",
          "description": "The minimum lifetime of created auto Pools, and how multiple Jobs on a schedule are assigned to Pools."
        },
        "keepAlive": {
          "type": "boolean",
          "description": "Whether to keep an auto Pool alive after its lifetime expires. If false, the Batch service deletes the Pool once its lifetime (as determined by the poolLifetimeOption setting) expires; that is, when the Job or Job Schedule completes. If true, the Batch service does not delete the Pool automatically. It is up to the user to delete auto Pools created with this option."
        },
        "pool": {
          "$ref": "#/$defs/BatchPoolSpecification",
          "description": "The Pool specification for the auto Pool."
        }
      },
      "required": [
        "poolLifetimeOption"
      ]
    },
    "BatchContainerConfiguration": {
      "type": "object",
      "description": "The configuration for container-enabled Pools.",
      "properties": {
        "type": {
          "$ref": "#/$defs/ContainerType",
          "description": "The container technology to be used."
        },
        "containerImageNames": {
          "type": "array",
          "description": "The collection of container Image names. This is the full Image reference, as would be specified to \"docker pull\". An Image will be sourced from the default Docker registry unless the Image is fully qualified with an alternative registry.",
          "items": {
            "type": "string"
          }
        },
        "containerRegistries": {
          "type": "array",
          "description": "Additional private registries from which containers can be pulled. If any Images must be downloaded from a private registry which requires credentials, then those credentials must be provided here.",
          "items": {
            "$ref": "#/$defs/ContainerRegistryReference"
          }
        }
      },
      "required": [
        "type"
      ]
    },
    "BatchDiffDiskSettings": {
      "type": "object",
      "description": "Specifies the ephemeral Disk Settings for the operating system disk used by the\ncompute node (VM).",
      "properties": {
        "placement": {
          "$ref": "#/$defs/DiffDiskPlacement",
          "description": "Specifies the ephemeral disk placement for operating system disk for all VMs in the pool. This property can be used by user in the request to choose the location e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements."
        }
      }
    },
    "BatchInboundNatPool": {
      "type": "object",
      "description": "A inbound NAT Pool that can be used to address specific ports on Compute Nodes\nin a Batch Pool externally.",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the endpoint. The name must be unique within a Batch Pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters.  If any invalid values are provided the request fails with HTTP status code 400."
        },
        "protocol": {
          "$ref": "#/$defs/InboundEndpointProtocol",
          "description": "The protocol of the endpoint."
        },
        "backendPort": {
          "type": "integer",
          "format": "int32",
          "description": "The port number on the Compute Node. This must be unique within a Batch Pool. Acceptable values are between 1 and 65535 except for 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400."
        },
        "frontendPortRangeStart": {
          "type": "integer",
          "format": "int32",
          "description": "The first port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400."
        },
        "frontendPortRangeEnd": {
          "type": "integer",
          "format": "int32",
          "description": "The last port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400."
        },
        "networkSecurityGroupRules": {
          "type": "array",
          "description": "A list of network security group rules that will be applied to the endpoint. The maximum number of rules that can be specified across all the endpoints on a Batch Pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400.",
          "items": {
            "$ref": "#/$defs/NetworkSecurityGroupRule"
          }
        }
      },
      "required": [
        "name",
        "protocol",
        "backendPort",
        "frontendPortRangeStart",
        "frontendPortRangeEnd"
      ]
    },
    "BatchJobConstraints": {
      "type": "object",
      "description": "The execution constraints for a Job.",
      "properties": {
        "maxWallClockTime": {
          "type": "string",
          "format": "duration",
          "description": "The maximum elapsed time that the Job may run, measured from the time the Job is created. If the Job does not complete within the time limit, the Batch service terminates it and any Tasks that are still running. In this case, the termination reason will be MaxWallClockTimeExpiry. If this property is not specified, there is no time limit on how long the Job may run. The time duration is specified in ISO 8601 format."
        },
        "maxTaskRetryCount": {
          "type": "integer",
          "format": "int32",
          "description": "The maximum number of times each Task may be retried. The Batch service retries a Task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try each Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries a Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry Tasks. If the maximum retry count is -1, the Batch service retries Tasks without limit. The default value is 0 (no retries)."
        }
      }
    },
    "BatchJobManagerTask": {
      "type": "object",
      "description": "Specifies details of a Job Manager Task.\nThe Job Manager Task is automatically started when the Job is created. The\nBatch service tries to schedule the Job Manager Task before any other Tasks in\nthe Job. When shrinking a Pool, the Batch service tries to preserve Nodes where\nJob Manager Tasks are running for as long as possible (that is, Compute Nodes\nrunning 'normal' Tasks are removed before Compute Nodes running Job Manager\nTasks). When a Job Manager Task fails and needs to be restarted, the system\ntries to schedule it at the highest priority. If there are no idle Compute\nNodes available, the system may terminate one of the running Tasks in the Pool\nand return it to the queue in order to make room for the Job Manager Task to\nrestart. Note that a Job Manager Task in one Job does not have priority over\nTasks in other Jobs. Across Jobs, only Job level priorities are observed. For\nexample, if a Job Manager in a priority 0 Job needs to be restarted, it will\nnot displace Tasks of a priority 1 Job. Batch will retry Tasks when a recovery\noperation is triggered on a Node. Examples of recovery operations include (but\nare not limited to) when an unhealthy Node is rebooted or a Compute Node\ndisappeared due to host failure. Retries due to recovery operations are\nindependent of and are not counted against the maxTaskRetryCount. Even if the\nmaxTaskRetryCount is 0, an internal retry due to a recovery operation may\noccur. Because of this, all Tasks should be idempotent. This means Tasks need\nto tolerate being interrupted and restarted without causing any corruption or\nduplicate data. The best practice for long running Tasks is to use some form of\ncheckpointing.",
      "properties": {
        "id": {
          "type": "string",
          "description": "A string that uniquely identifies the Job Manager Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters."
        },
        "displayName": {
          "type": "string",
          "description": "The display name of the Job Manager Task. It need not be unique and can contain any Unicode characters up to a maximum length of 1024."
        },
        "commandLine": {
          "type": "string",
          "description": "The command line of the Job Manager Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables)."
        },
        "containerSettings": {
          "$ref": "#/$defs/BatchTaskContainerSettings",
          "description": "The settings for the container under which the Job Manager Task runs. If the Pool that will run this Task has containerConfiguration set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files."
        },
        "resourceFiles": {
          "type": "array",
          "description": "A list of files that the Batch service will download to the Compute Node before running the command line. Files listed under this element are located in the Task's working directory. There is a maximum size for the list of resource files.  When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.",
          "items": {
            "$ref": "#/$defs/ResourceFile"
          }
        },
        "outputFiles": {
          "type": "array",
          "description": "A list of files that the Batch service will upload from the Compute Node after running the command line. For multi-instance Tasks, the files will only be uploaded from the Compute Node on which the primary Task is executed.",
          "items": {
            "$ref": "#/$defs/OutputFile"
          }
        },
        "environmentSettings": {
          "type": "array",
          "description": "A list of environment variable settings for the Job Manager Task.",
          "items": {
            "$ref": "#/$defs/EnvironmentSetting"
          }
        },
        "constraints": {
          "$ref": "#/$defs/BatchTaskConstraints",
          "description": "Constraints that apply to the Job Manager Task."
        },
        "requiredSlots": {
          "type": "integer",
          "format": "int32",
          "description": "The number of scheduling slots that the Task requires to run. The default is 1. A Task can only be scheduled to run on a compute node if the node has enough free scheduling slots available. For multi-instance Tasks, this property is not supported and must not be specified."
        },
        "killJobOnCompletion": {
          "type": "boolean",
          "description": "Whether completion of the Job Manager Task signifies completion of the entire Job. If true, when the Job Manager Task completes, the Batch service marks the Job as complete. If any Tasks are still running at this time (other than Job Release), those Tasks are terminated. If false, the completion of the Job Manager Task does not affect the Job status. In this case, you should either use the onAllTasksComplete attribute to terminate the Job, or have a client or user terminate the Job explicitly. An example of this is if the Job Manager creates a set of Tasks but then takes no further role in their execution. The default value is true. If you are using the onAllTasksComplete and onTaskFailure attributes to control Job lifetime, and using the Job Manager Task only to create the Tasks for the Job (not to monitor progress), then it is important to set killJobOnCompletion to false."
        },
        "userIdentity": {
          "$ref": "#/$defs/UserIdentity",
          "description": "The user identity under which the Job Manager Task runs. If omitted, the Task runs as a non-administrative user unique to the Task."
        },
        "runExclusive": {
          "type": "boolean",
          "description": "Whether the Job Manager Task requires exclusive use of the Compute Node where it runs. If true, no other Tasks will run on the same Node for as long as the Job Manager is running. If false, other Tasks can run simultaneously with the Job Manager on a Compute Node. The Job Manager Task counts normally against the Compute Node's concurrent Task limit, so this is only relevant if the Compute Node allows multiple concurrent Tasks. The default value is true."
        },
        "applicationPackageReferences": {
          "type": "array",
          "description": "A list of Application Packages that the Batch service will deploy to the\nCompute Node before running the command line.Application Packages are\ndownloaded and deployed to a shared directory, not the Task working\ndirectory. Therefore, if a referenced Application Package is already\non the Compute Node, and is up to date, then it is not re-downloaded;\nthe existing copy on the Compute Node is used. If a referenced Application\nPackage cannot be installed, for example because the package has been deleted\nor because download failed, the Task fails.",
          "items": {
            "$ref": "#/$defs/BatchApplicationPackageReference"
          }
        },
        "allowLowPriorityNode": {
          "type": "boolean",
          "description": "Whether the Job Manager Task may run on a Spot/Low-priority Compute Node. The default value is true."
        }
      },
      "required": [
        "id",
        "commandLine"
      ]
    },
    "BatchJobNetworkConfiguration": {
      "type": "object",
      "description": "(This property is not available by default. Please contact support for more information) The network configuration for the Job.",
      "properties": {
        "subnetId": {
          "type": "string",
          "description": "The ARM resource identifier of the virtual network subnet which Compute Nodes running Tasks from the Job will join for the duration of the Task. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes which will run Tasks from the Job. This can be up to the number of Compute Nodes in the Pool. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet so that Azure Batch service can schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication from the Azure Batch service. For Pools created with a Virtual Machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. Port 443 is also required to be open for outbound connections for communications to Azure Storage. For more details see: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration."
        },
        "skipWithdrawFromVNet": {
          "type": "boolean",
          "description": "Whether to withdraw Compute Nodes from the virtual network to DNC when the job is terminated or deleted.  If true, nodes will remain joined to the virtual network to DNC. If false, nodes will automatically withdraw when the job ends. Defaults to false.",
          "x-ms-client-name": "skipWithdrawFromVnet"
        }
      },
      "required": [
        "subnetId"
      ]
    },
    "BatchJobPreparationTask": {
      "type": "object",
      "description": "A Job Preparation Task to run before any Tasks of the Job on any given Compute Node.\nYou can use Job Preparation to prepare a Node to run Tasks for the Job.\nActivities commonly performed in Job Preparation include: Downloading common\nresource files used by all the Tasks in the Job. The Job Preparation Task can\ndownload these common resource files to the shared location on the Node.\n(AZ_BATCH_NODE_ROOT_DIR\\shared), or starting a local service on the Node so\nthat all Tasks of that Job can communicate with it. If the Job Preparation Task\nfails (that is, exhausts its retry count before exiting with exit code 0),\nBatch will not run Tasks of this Job on the Node. The Compute Node remains\nineligible to run Tasks of this Job until it is reimaged. The Compute Node\nremains active and can be used for other Jobs. The Job Preparation Task can run\nmultiple times on the same Node. Therefore, you should write the Job\nPreparation Task to handle re-execution. If the Node is rebooted, the Job\nPreparation Task is run again on the Compute Node before scheduling any other\nTask of the Job, if rerunOnNodeRebootAfterSuccess is true or if the Job\nPreparation Task did not previously complete. If the Node is reimaged, the Job\nPreparation Task is run again before scheduling any Task of the Job. Batch will\nretry Tasks when a recovery operation is triggered on a Node. Examples of\nrecovery operations include (but are not limited to) when an unhealthy Node is\nrebooted or a Compute Node disappeared due to host failure. Retries due to\nrecovery operations are independent of and are not counted against the\nmaxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to\na recovery operation may occur. Because of this, all Tasks should be\nidempotent. This means Tasks need to tolerate being interrupted and restarted\nwithout causing any corruption or duplicate data. The best practice for long\nrunning Tasks is to use some form of checkpointing.",
      "properties": {
        "id": {
          "type": "string",
          "description": "A string that uniquely identifies the Job Preparation Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobpreparation'. No other Task in the Job can have the same ID as the Job Preparation Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobPreparationTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict)."
        },
        "commandLine": {
          "type": "string",
          "description": "The command line of the Job Preparation Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables)."
        },
        "containerSettings": {
          "$ref": "#/$defs/BatchTaskContainerSettings",
          "description": "The settings for the container under which the Job Preparation Task runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task

# --- truncated at 32 KB (141 KB total) ---
# Full source: https://artifacts.apis.io/microsoft-azure-batch/json-schema/microsoft-azure-batch-batch-job-schedule-create-options-schema.json