BatchPoolUpdateOptions

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-batch/json-schema/microsoft-azure-batch-batch-pool-update-options-schema.json",
  "title": "BatchPoolUpdateOptions",
  "description": "Parameters for updating an Azure Batch Pool.",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_superseded/microsoft-azure-batch-pools-api-openapi.yml#/components/schemas/BatchPoolUpdateOptions",
  "type": "object",
  "properties": {
    "displayName": {
      "type": "string",
      "description": "The display name for the Pool. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. This field can be updated only when the pool is empty."
    },
    "vmSize": {
      "type": "string",
      "description": "The size of virtual machines in the Pool. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes).<br /><br />This field can be updated only when the pool is empty."
    },
    "enableInterNodeCommunication": {
      "type": "boolean",
      "description": "Whether the Pool permits direct communication between Compute Nodes. Enabling inter-node communication limits the maximum size of the Pool due to deployment restrictions on the Compute Nodes of the Pool. This may result in the Pool not reaching its desired size. The default value is false.<br /><br />This field can be updated only when the pool is empty."
    },
    "startTask": {
      "$ref": "#/$defs/BatchStartTaskUpdate",
      "description": "A Task to run on each Compute Node as it joins the Pool. The Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted. If this element is present, it overwrites any existing StartTask. If omitted, any existing StartTask is left unchanged."
    },
    "applicationPackageReferences": {
      "type": "array",
      "description": "A list of Packages to be installed on each Compute Node in the Pool. Changes to Package references affect all new Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. If this element is present, it replaces any existing Package references. If you specify an empty collection, then all Package references are removed from the Pool. If omitted, any existing Package references are left unchanged.",
      "items": {
        "$ref": "#/$defs/BatchApplicationPackageReference"
      }
    },
    "metadata": {
      "type": "array",
      "description": "A list of name-value pairs associated with the Pool as metadata. If this element is present, it replaces any existing metadata configured on the Pool. If you specify an empty collection, any metadata is removed from the Pool. If omitted, any existing metadata is left unchanged.",
      "items": {
        "$ref": "#/$defs/BatchMetadataItem"
      }
    },
    "virtualMachineConfiguration": {
      "$ref": "#/$defs/VirtualMachineConfigurationUpdate",
      "description": "The virtual machine configuration for the Pool. This property must be specified.<br /><br />This field can be updated only when the pool is empty."
    },
    "taskSlotsPerNode": {
      "type": "integer",
      "format": "int32",
      "description": "The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256.<br /><br />This field can be updated only when the pool is empty."
    },
    "taskSchedulingPolicy": {
      "$ref": "#/$defs/BatchTaskSchedulingPolicyUpdate",
      "description": "How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread.<br /><br />This field can be updated only when the pool is empty."
    },
    "networkConfiguration": {
      "$ref": "#/$defs/NetworkConfigurationUpdate",
      "description": "The network configuration for the Pool. This field can be updated only when the pool is empty."
    },
    "userAccounts": {
      "type": "array",
      "description": "The list of user Accounts to be created on each Compute Node in the Pool. This field can be updated only when the pool is empty.",
      "items": {
        "$ref": "#/$defs/UserAccount"
      }
    },
    "mountConfiguration": {
      "type": "array",
      "description": "Mount storage using specified file system for the entire lifetime of the pool. Mount the storage using Azure fileshare, NFS, CIFS or Blobfuse based file system.<br /><br />This field can be updated only when the pool is empty.",
      "items": {
        "$ref": "#/$defs/MountConfiguration"
      }
    },
    "upgradePolicy": {
      "$ref": "#/$defs/UpgradePolicyUpdate",
      "description": "The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling.<br /><br />This field can be updated only when the pool is empty."
    }
  },
  "$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"
      ]
    },
    "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"
      ]
    },
    "BatchContainerConfigurationUpdate": {
      "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"
          }
        }
      }
    },
    "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"
      ]
    },
    "BatchMetadataItem": {
      "type": "object",
      "description": "The Batch service does not assign any meaning to this metadata; it is solely\nfor the use of user code.",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the metadata item."
        },
        "value": {
          "type": "string",
          "description": "The value of the metadata item."
        }
      },
      "required": [
        "name",
        "value"
      ]
    },
    "BatchNodeFillType": {
      "type": "string",
      "description": "BatchNodeFillType enums",
      "enum": [
        "spread",
        "pack"
      ],
      "x-ms-enum": {
        "name": "BatchNodeFillType",
        "modelAsString": true,
        "values": [
          {
            "name": "Spread",
            "value": "spread",
            "description": "Tasks should be assigned evenly across all Compute Nodes in the Pool."
          },
          {
            "name": "Pack",
            "value": "pack",
            "description": "As many Tasks as possible (taskSlotsPerNode) should be assigned to each Compute Node in the Pool before any Tasks are assigned to the next Compute Node in the Pool."
          }
        ]
      }
    },
    "BatchNodeIdentityReference": {
      "type": "object",
      "description": "The reference to a user assigned identity associated with the Batch pool which\na compute node will use.",
      "properties": {
        "resourceId": {
          "type": "string",
          "format": "arm-id",
          "description": "The ARM resource id of the user assigned identity."
        }
      }
    },
    "BatchNodePlacementConfiguration": {
      "type": "object",
      "description": "For regional placement, nodes in the pool will be allocated in the same region.\nFor zonal placement, nodes in the pool will be spread across different zones\nwith best effort balancing.",
      "properties": {
        "policy": {
          "$ref": "#/$defs/BatchNodePlacementPolicyType",
          "description": "Node placement Policy type on Batch Pools. Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy."
        }
      }
    },
    "BatchNodePlacementPolicyType": {
      "type": "string",
      "description": "BatchNodePlacementPolicyType enums",
      "enum": [
        "regional",
        "zonal"
      ],
      "x-ms-enum": {
        "name": "BatchNodePlacementPolicyType",
        "modelAsString": true,
        "values": [
          {
            "name": "Regional",
            "value": "regional",
            "description": "All nodes in the pool will be allocated in the same region."
          },
          {
            "name": "Zonal",
            "value": "zonal",
            "description": "Nodes in the pool will be spread across different availability zones with best effort balancing."
          }
        ]
      }
    },
    "BatchOsDisk": {
      "type": "object",
      "description": "Settings for the operating system disk of the compute node (VM).",
      "properties": {
        "ephemeralOSDiskSettings": {
          "$ref": "#/$defs/BatchDiffDiskSettings",
          "description": "Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM)."
        },
        "caching": {
          "$ref": "#/$defs/CachingType",
          "description": "Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage."
        },
        "diskSizeGB": {
          "type": "integer",
          "format": "int32",
          "description": "The initial disk size in GB when creating new OS disk."
        },
        "managedDisk": {
          "$ref": "#/$defs/ManagedDisk",
          "description": "The managed disk parameters."
        },
        "writeAcceleratorEnabled": {
          "type": "boolean",
          "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk."
        }
      }
    },
    "BatchPoolEndpointConfigurationUpdate": {
      "type": "object",
      "description": "The endpoint configuration for a Pool.",
      "properties": {
        "inboundNATPools": {
          "type": "array",
          "description": "A list of inbound NAT Pools that can be used to address specific ports on an individual Compute Node externally. The maximum number of inbound NAT Pools per Batch Pool is 5. If the maximum number of inbound NAT Pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses.",
          "items": {
            "$ref": "#/$defs/BatchInboundNatPool"
          },
          "x-ms-client-name": "inboundNatPools"
        }
      }
    },
    "BatchPoolIdentityReference": {
      "type": "object",
      "description": "The reference of one of the pool identities to encrypt Disk. This identity will be used to access the key vault.",
      "properties": {
        "resourceId": {
          "type": "string",
          "format": "arm-id",
          "description": "The ARM resource id of the user assigned identity. This reference must be included in the pool identities."
        }
      }
    },
    "BatchPublicIpAddressConfiguration": {
      "type": "object",
      "description": "The public IP Address configuration of the networking configuration of a Pool.",
      "properties": {
        "provision": {
          "$ref": "#/$defs/IpAddressProvisioningType",
          "description": "The provisioning type for Public IP Addresses for the Pool. The default value is BatchManaged.",
          "x-ms-client-name": "IpAddressProvisioningType"
        },
        "ipFamilies": {
          "type": "array",
          "description": "The IP families used to specify IP versions available to the pool. IP families are used to determine single-stack or dual-stack pools. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6.",
          "items": {
            "$ref": "#/$defs/IPFamily"
          }
        },
        "ipAddressIds": {
          "type": "array",
          "description": "The list of public IPs which the Batch service will use when provisioning Compute Nodes. The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 Spot/Low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.",
          "items": {
            "type": "string",
            "format": "arm-id",
            "description": "A type definition that refers the id to an Azure Resource Manager resource."
          }
        },
        "ipTags": {
          "type": "array",
          "description": "A list of IP tags associated with the public IP addresses of the Pool. IP tags are used to categorize and filter public IP addresses for billing and management purposes.",
          "items": {
            "$ref": "#/$defs/IPTag"
          }
        }
      }
    },
    "BatchStartTaskUpdate": {
      "type": "object",
      "description": "Batch will retry Tasks when a recovery operation is triggered on a Node.\nExamples of recovery operations include (but are not limited to) when an\nunhealthy Node is rebooted or a Compute Node disappeared due to host failure.\nRetries due to recovery operations are independent of and are not counted\nagainst the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal\nretry due to a recovery operation may occur. Because of this, all Tasks should\nbe idempotent. This means Tasks need to tolerate being interrupted and\nrestarted without causing any corruption or duplicate data. The best practice\nfor long running Tasks is to use some form of checkpointing. In some cases the\nStartTask may be re-run even though the Compute Node was not rebooted. Special\ncare should be taken to avoid StartTasks which create breakaway process or\ninstall/launch services from the StartTask working directory, as this will\nblock Batch from being able to re-run the StartTask.",
      "properties": {
        "commandLine": {
          "type": "string",
          "description": "The command line of the StartTask. 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/BatchTaskContainerSettingsUpdate",
          "description": "The settings for the container under which the StartTask 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 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.  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. Files listed under this element are located in the Task's working directory.",
          "items": {
            "$ref": "#/$defs/ResourceFile"
          }
        },
        "environmentSettings": {
          "type": "array",
          "description": "A list of environment variable settings for the StartTask.",
          "items": {
            "$ref": "#/$defs/EnvironmentSetting"
          }
        },
        "userIdentity": {
          "$ref": "#/$defs/UserIdentity",
          "description": "The user identity under which the StartTask runs. If omitted, the Task runs as a non-administrative user unique to the Task."
        },
        "maxTaskRetryCount": {
          "type": "integer",
          "format": "int32",
          "description": "The maximum number of times the 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 the Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the Task. If the maximum retry count is -1, the Batch service retries the Task without limit, however this is not recommended for a start task or any task. The default value is 0 (no retries)."
        },
        "waitForSuccess": {
          "type": "boolean",
          "description": "Whether the Batch service should wait for the StartTask to complete successfully (that is, to exit with exit code 0) before scheduling any Tasks on the Compute Node. If true and the StartTask fails on a Node, the Batch service retries the StartTask up to its maximum retry count (maxTaskRetryCount). If the Task has still not completed successfully after all retries, then the Batch service marks the Node unusable, and will not schedule Tasks to it. This condition can be detected via the Compute Node state and failure info details. If false, the Batch service will not wait for the StartTask to complete. In this case, other Tasks can start executing on the Compute Node while the StartTask is still running; and even if the StartTask fails, new Tasks will continue to be scheduled on the Compute Node. The default is true."
        }
      }
    },
    "BatchTaskContainerSettingsUpdate": {
      "type": "object",
      "description": "The container settings for a Task.",
      "properties": {
        "containerRunOptions": {
          "type": "string",
          "description": "Additional options to the container create command. These additional options are supplied as arguments to the \"docker create\" command, in addition to those controlled by the Batch Service."
        },
        "imageName": {
          "type": "string",
          "description": "The Image to use to create the container in which the Task will run. This is the full Image reference, as would be specified to \"docker pull\". If no tag is provided as part of the Image name, the tag \":latest\" is used as a default."
        },
        "registry": {
          "$ref": "#/$defs/ContainerRegistryReference",
          "description": "The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation."
        },
        "workingDirectory": {
          "$ref": "#/$defs/ContainerWorkingDirectory",
          "description": "The location of the container Task working directory. The default is 'taskWorkingDirectory'."
        },
        "containerHostBatchBindMounts": {
          "type": "array",
          "description": "The paths you want to mounted to container task. If this array is null or be not present, container task will mount entire temporary disk drive in windows (or AZ_BATCH_NODE_ROOT_DIR in Linux). It won't' mount any data paths into container if this array is set as empty.",
          "items": {
            "$ref": "#/$defs/ContainerHostBatchBindMountEntry"
          }
        }
      }
    },
    "BatchTaskSchedulingPolicyUpdate": {
      "type": "object",
      "description": "Specifies how Tasks should be distributed across Compute Nodes.",
      "properties": {
        "jobDefaultOrder": {
          "type": "string",
          "description": "The order for scheduling tasks from different jobs with the same priority. If not specified, the default is none.",
          "default": "none",
          "enum": [
            "none",
            "creationtime"
          ],
          "x-ms-enum": {
            "name": "BatchJobDefaultOrder",
            "modelAsString": true,
            "values": [
              {
                "name": "None",
                "value": "none",
                "description": "Tasks should be scheduled uniformly from all equal-priority jobs for the pool."
              },
              {
                "name": "CreationTime",
                "value": "creationtime",
                "description": "If jobs have equal priority, tasks from jobs that were created earlier should be scheduled first."
              }
            ]
          }
        },
        "nodeFillType": {
      

# --- truncated at 32 KB (89 KB total) ---
# Full source: https://artifacts.apis.io/microsoft-azure-batch/json-schema/microsoft-azure-batch-batch-pool-update-options-schema.json