{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://artifacts.apis.io/microsoft-azure-batch/json-schema/microsoft-azure-batch-pool-schema.json", "title": "Pool", "description": "Contains information about a pool.", "x-generated": "2026-11-05", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/_superseded/microsoft-azure-batch-pool-api-openapi.yml#/components/schemas/Pool", "type": "object", "properties": { "properties": { "$ref": "#/$defs/PoolProperties", "description": "The properties associated with the pool.", "x-ms-client-flatten": true }, "identity": { "$ref": "#/$defs/BatchPoolIdentity", "description": "The type of identity used for the Batch Pool." }, "etag": { "type": "string", "description": "The ETag of the resource, used for concurrency statements.", "readOnly": true }, "tags": { "type": "object", "description": "The tags of the resource.", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ], "$defs": { "AllocationState": { "type": "string", "description": "Whether the pool is resizing.", "enum": [ "Steady", "Resizing", "Stopping" ], "x-ms-enum": { "name": "AllocationState", "modelAsString": false, "values": [ { "name": "Steady", "value": "Steady", "description": "The pool is not resizing. There are no changes to the number of nodes in the pool in progress. A pool enters this state when it is created and when no operations are being performed on the pool to change the number of nodes." }, { "name": "Resizing", "value": "Resizing", "description": "The pool is resizing; that is, compute nodes are being added to or removed from the pool." }, { "name": "Stopping", "value": "Stopping", "description": "The pool was resizing, but the user has requested that the resize be stopped, but the stop request has not yet been completed." } ] } }, "ApplicationPackageReference": { "type": "object", "title": "Link to an application package inside the batch account", "description": "Link to an application package inside the batch account", "properties": { "id": { "type": "string", "title": "The ID of the application package to install. This must be inside the same Batch account as the pool. This can either be a reference to a specific version or the default version if one exists.", "description": "The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists." }, "version": { "type": "string", "title": "The version of the application to deploy. If omitted, the default version is deployed.", "description": "If this is omitted, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences. If you are calling the REST API directly, the HTTP status code is 409." } }, "required": [ "id" ] }, "AutoScaleRun": { "type": "object", "title": "The results and errors from an execution of a pool autoscale formula.", "description": "The results and errors from an execution of a pool autoscale formula.", "properties": { "evaluationTime": { "type": "string", "format": "date-time", "title": "The time at which the autoscale formula was last evaluated.", "description": "The time at which the autoscale formula was last evaluated." }, "results": { "type": "string", "title": "The final values of all variables used in the evaluation of the autoscale formula.", "description": "Each variable value is returned in the form $variable=value, and variables are separated by semicolons." }, "error": { "$ref": "#/$defs/AutoScaleRunError", "title": "Details of the error encountered evaluating the autoscale formula on the pool, if the evaluation was unsuccessful.", "description": "An error that occurred when autoscaling a pool." } }, "required": [ "evaluationTime" ] }, "AutoScaleRunError": { "type": "object", "title": "An error that occurred when autoscaling a pool.", "description": "An error that occurred when autoscaling a pool.", "properties": { "code": { "type": "string", "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." }, "message": { "type": "string", "description": "A message describing the error, intended to be suitable for display in a user interface." }, "details": { "type": "array", "title": "Additional details about the error.", "description": "Additional details about the error.", "items": { "$ref": "#/$defs/AutoScaleRunError" }, "x-ms-identifiers": [ "code" ] } }, "required": [ "code", "message" ] }, "AutoScaleSettings": { "type": "object", "title": "AutoScale settings for the pool.", "description": "AutoScale settings for the pool.", "properties": { "formula": { "type": "string", "title": "A formula for the desired number of compute nodes in the pool.", "description": "A formula for the desired number of compute nodes in the pool." }, "evaluationInterval": { "type": "string", "format": "duration", "title": "The time interval at which to automatically adjust the pool size according to the autoscale formula.", "description": "If omitted, the default value is 15 minutes (PT15M)." } }, "required": [ "formula" ] }, "AutoUserScope": { "type": "string", "description": "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.", "enum": [ "Task", "Pool" ], "x-ms-enum": { "name": "AutoUserScope", "modelAsString": false, "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 node in a pool." } ] } }, "AutoUserSpecification": { "type": "object", "title": "Specifies the parameters for the auto user that runs a task on the Batch service.", "description": "Specifies the parameters for the auto user that runs a task on the Batch service.", "properties": { "scope": { "$ref": "#/$defs/AutoUserScope", "title": "The scope for the auto user", "description": "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, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks." }, "elevationLevel": { "$ref": "#/$defs/ElevationLevel", "title": "The elevation level of the user.", "description": "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.

If this is set to true for Windows based pools, [WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/rest/api/batchmanagement/pool/create?tabs=HTTP#windowsconfiguration) cannot be set to true." }, "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", "title": "Information used to connect to an Azure Storage Container using Blobfuse.", "description": "Information used to connect to an Azure Storage Container using Blobfuse.", "properties": { "accountName": { "type": "string", "title": "The Azure Storage Account name.", "description": "The Azure Storage Account name." }, "containerName": { "type": "string", "title": "The Azure Blob Storage Container name.", "description": "The Azure Blob Storage Container name." }, "accountKey": { "type": "string", "format": "password", "title": "The Azure Storage Account key.", "description": "This property is mutually exclusive with both sasKey and identity; exactly one must be specified.", "x-ms-secret": true }, "sasKey": { "type": "string", "format": "password", "title": "The Azure Storage SAS token.", "description": "This property is mutually exclusive with both accountKey and identity; exactly one must be specified.", "x-ms-secret": true }, "blobfuseOptions": { "type": "string", "title": "Additional command line options to pass to the mount command.", "description": "These are 'net use' options in Windows and 'mount' options in Linux." }, "relativeMountPath": { "type": "string", "title": "The relative path on the compute node where the file system will be mounted", "description": "All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable." }, "identityReference": { "$ref": "#/$defs/ComputeNodeIdentityReference", "title": "The reference to the user assigned identity to use to access containerName", "description": "This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified." } }, "required": [ "accountName", "containerName", "relativeMountPath" ] }, "AzureFileShareConfiguration": { "type": "object", "title": "Information used to connect to an Azure Fileshare.", "description": "Information used to connect to an Azure Fileshare.", "properties": { "accountName": { "type": "string", "title": "The Azure Storage account name.", "description": "The Azure Storage account name." }, "azureFileUrl": { "type": "string", "title": "The Azure Files URL.", "description": "This is of the form 'https://{account}.file.core.windows.net/'." }, "accountKey": { "type": "string", "format": "password", "title": "The Azure Storage account key.", "description": "The Azure Storage account key.", "x-ms-secret": true }, "relativeMountPath": { "type": "string", "title": "The relative path on the compute node where the file system will be mounted", "description": "All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable." }, "mountOptions": { "type": "string", "title": "Additional command line options to pass to the mount command.", "description": "These are 'net use' options in Windows and 'mount' options in Linux." } }, "required": [ "accountName", "azureFileUrl", "accountKey", "relativeMountPath" ] }, "BatchPoolIdentity": { "type": "object", "description": "The identity of the Batch pool, if configured. If the pool identity is updated during update an existing pool, only the new vms which are created after the pool shrinks to 0 will have the updated identities", "properties": { "type": { "$ref": "#/$defs/PoolIdentityType", "description": "The type of identity used for the Batch Pool." }, "userAssignedIdentities": { "type": "object", "description": "The list of user identities associated with the Batch pool.", "additionalProperties": { "$ref": "#/$defs/UserAssignedIdentities" } } }, "required": [ "type" ] }, "CIFSMountConfiguration": { "type": "object", "title": "Information used to connect to a CIFS file system.", "description": "Information used to connect to a CIFS file system.", "properties": { "userName": { "type": "string", "title": "The user to use for authentication against the CIFS file system.", "description": "The user to use for authentication against the CIFS file system." }, "source": { "type": "string", "title": "The URI of the file system to mount.", "description": "The URI of the file system to mount." }, "relativeMountPath": { "type": "string", "title": "The relative path on the compute node where the file system will be mounted", "description": "All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable." }, "mountOptions": { "type": "string", "title": "Additional command line options to pass to the mount command.", "description": "These are 'net use' options in Windows and 'mount' options in Linux." }, "password": { "type": "string", "format": "password", "title": "The password to use for authentication against the CIFS file system.", "description": "The password to use for authentication against the CIFS file system.", "x-ms-secret": true } }, "required": [ "userName", "source", "relativeMountPath", "password" ] }, "CachingType": { "type": "string", "description": "The type of caching to enable for the disk.", "enum": [ "None", "ReadOnly", "ReadWrite" ], "x-ms-enum": { "name": "CachingType", "modelAsString": false, "values": [ { "name": "None", "value": "None", "description": "The caching mode for the disk is not enabled." }, { "name": "ReadOnly", "value": "ReadOnly", "description": "The caching mode for the disk is read only." }, { "name": "ReadWrite", "value": "ReadWrite", "description": "The caching mode for the disk is read and write." } ] } }, "ComputeNodeDeallocationOption": { "type": "string", "description": "Determines what to do with a node and its running task(s) after it has been selected for deallocation.", "enum": [ "Requeue", "Terminate", "TaskCompletion", "RetainedData" ], "x-ms-enum": { "name": "ComputeNodeDeallocationOption", "modelAsString": false, "values": [ { "name": "Requeue", "value": "Requeue", "description": "Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Remove nodes as soon as tasks have been terminated." }, { "name": "Terminate", "value": "Terminate", "description": "Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Remove nodes as soon as tasks have been terminated." }, { "name": "TaskCompletion", "value": "TaskCompletion", "description": "Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove nodes when all tasks have completed." }, { "name": "RetainedData", "value": "RetainedData", "description": "Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired." } ] } }, "ComputeNodeIdentityReference": { "type": "object", "description": "The reference to a user assigned identity associated with the Batch pool which a compute node will use.", "properties": { "resourceId": { "type": "string", "description": "The ARM resource id of the user assigned identity." } } }, "ContainerConfiguration": { "type": "object", "title": "The configuration for container-enabled pools.", "description": "The configuration for container-enabled pools.", "properties": { "type": { "$ref": "#/$defs/ContainerType", "title": "The container technology to be used.", "description": "The container technology to be used." }, "containerImageNames": { "type": "array", "title": "The collection of container image names.", "description": "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", "title": "Additional private registries from which containers can be pulled.", "description": "If any images must be downloaded from a private registry which requires credentials, then those credentials must be provided here.", "items": { "$ref": "#/$defs/ContainerRegistry" }, "x-ms-identifiers": [ "registryServer" ] } }, "required": [ "type" ] }, "ContainerHostBatchBindMountEntry": { "type": "object", "title": "The entry of path and mount mode you want to mount into task container.", "description": "The entry of path and mount mode you want to mount into task container.", "properties": { "source": { "$ref": "#/$defs/ContainerHostDataPath", "title": "The paths which will be mounted to container task's container.", "description": "The paths which will be mounted to container task's container." }, "isReadOnly": { "type": "boolean", "title": "Mount this source path as read-only mode or not. Default value is false (read/write mode).", "description": "For Linux, if you mount this path as a read/write mode, this does not mean that all users in container have the read/write access for the path, it depends on the access in host VM. If this path is mounted read-only, all users within the container will not be able to modify the path." } } }, "ContainerHostDataPath": { "type": "string", "description": "The paths which will be mounted to container task's container.", "enum": [ "Shared", "Startup", "VfsMounts", "Task", "JobPrep", "Applications" ], "x-ms-enum": { "name": "ContainerHostDataPath", "modelAsString": true, "values": [ { "name": "Shared", "value": "Shared", "description": "The path for multi-instances task to shared their files." }, { "name": "Startup", "value": "Startup", "description": "The path for start task." }, { "name": "VfsMounts", "value": "VfsMounts", "description": "The path contains all virtual file systems are mounted on this node." }, { "name": "Task", "value": "Task", "description": "The task path." }, { "name": "JobPrep", "value": "JobPrep", "description": "The job-prep task path." }, { "name": "Applications", "value": "Applications", "description": "The applications path." } ] } }, "ContainerRegistry": { "type": "object", "title": "A private container registry.", "description": "A private container registry.", "properties": { "username": { "type": "string", "title": "The user name to log into the registry server.", "description": "The user name to log into the registry server.", "x-ms-client-name": "userName" }, "password": { "type": "string", "format": "password", "title": "The password to log into the registry server.", "description": "The password to log into the registry server.", "x-ms-secret": true }, "registryServer": { "type": "string", "title": "The registry URL.", "description": "If omitted, the default is \"docker.io\"." }, "identityReference": { "$ref": "#/$defs/ComputeNodeIdentityReference", "title": "The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password.", "description": "The reference to a user assigned identity associated with the Batch pool which a compute node will use." } } }, "ContainerType": { "type": "string", "description": "The container technology to be used.", "enum": [ "DockerCompatible", "CriCompatible" ], "x-ms-enum": { "name": "ContainerType", "modelAsString": true, "values": [ { "name": "DockerCompatible", "value": "DockerCompatible", "description": "A Docker compatible container technology will be used to launch the containers." }, { "name": "CriCompatible", "value": "CriCompatible", "description": "A CRI based technology will be used to launch the containers." } ] } }, "ContainerWorkingDirectory": { "type": "string", "description": "A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'.", "enum": [ "TaskWorkingDirectory", "ContainerImageDefault" ], "x-ms-enum": { "name": "ContainerWorkingDirectory", "modelAsString": false, "values": [ { "name": "TaskWorkingDirectory", "value": "TaskWorkingDirectory", "description": "Use the standard Batch service task working directory, which will contain the Task resource files populated by Batch." }, { "name": "ContainerImageDefault", "value": "ContainerImageDefault", "description": "Using container image defined working directory. Beware that this directory will not contain the resource files downloaded by Batch." } ] } }, "DataDisk": { "type": "object", "description": "Settings which will be used by the data disks associated to Compute Nodes in the Pool. When using attached data disks, you need to mount and format the disks from within a VM to use them.", "properties": { "lun": { "type": "integer", "format": "int32", "title": "The logical unit number.", "description": "The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. The value must be between 0 and 63, inclusive." }, "caching": { "$ref": "#/$defs/CachingType", "title": "The type of caching to enable for the disk.", "description": "Values are:\n\nnone - The caching mode for the disk is not enabled.\nreadOnly - The caching mode for the disk is read only.\nreadWrite - The caching mode for the disk is read and write.\n\nThe default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/." }, "diskSizeGB": { "type": "integer", "format": "int32", "title": "The initial disk size in GB when creating new data disk.", "description": "The initial disk size in GB when creating new data disk." }, "managedDisk": { "$ref": "#/$defs/ManagedDisk", "title": "The managed disk parameters.", "description": "The managed disk parameters." } }, "required": [ "lun", "diskSizeGB" ] }, "DeploymentConfiguration": { "type": "object", "title": "Deployment configuration properties.", "description": "Deployment configuration properties.", "properties": { "virtualMachineConfiguration": { "$ref": "#/$defs/VirtualMachineConfiguration", "title": "The virtual machine configuration for the pool.", "description": "The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure." } } }, "DiffDiskPlacement": { "type": "string", "description": "The location where the OS disk should be placed.", "enum": [ "CacheDisk" ], "x-ms-enum": { "name": "DiffDiskPlacement", "modelAsString": false, "values": [ { "name": "CacheDisk", "value": "CacheDisk", "description": "The OS disk will be placed on the cache disk of the VM." } ] } }, "DiffDiskSettings": { "type": "object", "title": "Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.", "description": "Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.", "properties": { "placement": { "$ref": "#/$defs/DiffDiskPlacement", "title": "Specifies the ephemeral disk placement for operating system disk for all VMs in the pool.", "description": "This property can be used by user in the request to choose which location the operating system should be in. 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." } } }, "DiskCustomerManagedKey": { "type": "object", "description": "The Customer Managed Key reference to encrypt the Disk.", "properties": { "keyUrl": { "type": "string", "format": "uri", "description": "Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value." }, "rotationToLatestKeyVersionEnabled": { "type": "boolean", "description": "Set this flag to true to enable auto-updating of the Disk Encryption to the latest key version. Default is false." }, "identityReference": { "$ref": "#/$defs/ComputeNodeIdentityReference", "description": "The reference of one of the pool identities to encrypt Disk. This identity will be used to access the KeyVault." } } }, "DiskEncryptionConfiguration": { "type": "object", "description": "The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Virtual Machine Image or Azure Compute Gallery Image.", "properties": { "targets": { "type": "array", "title": "The list of disk targets Batch Service will encrypt on the compute node", "description": "On Linux pool, only \"TemporaryDisk\" is supported; on Windows pool, \"OsDisk\" and \"TemporaryDisk\" must be specified.", "items": { "$ref": "#/$defs/DiskEncryptionTarget" } }, "customerManagedKey": { "$ref": "#/$defs/DiskCustomerManagedKey", "title": "The Customer Managed Key reference to encrypt the OS Disk.", "description": "Customer Managed Key will encrypt OS Disk by EncryptionAtRest, and by default we will encrypt the data disk as well. It can be used only when the pool is configured with an identity and OsDisk is set as one of the targets of DiskEncryption." } } }, "DiskEncryptionSetParameters": { "type": "object", "description": "The ARM resource id of the disk encryption set.", "properties": { "id": { "type": "string", "format": "arm-id", "title": "The resource id of the disk encryption set.", "description": "The ARM resource id of the disk encryption set. The resource should be in the same subscription as the Batch account." } }, "required": [ "id" ] }, "DiskEncryptionTarget": { "type": "string", "description": "If omitted, no disks on the compute nodes in the pool will be encrypted.", "enum": [ "OsDisk", "TemporaryDisk" ], "x-ms-enum": { "name": "DiskEncryptionTarget", "modelAsString": false, "values": [ { "name": "OsDisk", "value": "OsDisk", "description": "The OS Disk on the compute node is encrypted." }, { "name": "TemporaryDisk", "value": "TemporaryDisk", "description": "The temporary disk on the compute node is encrypted. On Linux this encryption applies to other partitions (such as those on mounted data disks) when encryption occurs at boot time." } ] } }, "ElevationLevel": { "type": "string", "description": "The elevation level of the user.", "enum": [ "NonAdmin", "Admin" ], "x-ms-enum": { "name": "ElevationLevel", "modelAsString": false, "values": [ { "name": "NonAdmin", "value": "NonAdmin", "description": "The user is a standard user without elevated access." }, { "name": "Admin", "value": "Admin", "description": "The user is a user with elevated access and operates with full Administrator permissions." } ] } }, "EnvironmentSetting": { "type": "object", "title": "An environment variable to be set on a task process.", "description": "An environment variable to be set on a task process.", "properties": { "name": { "type": "string", "title": "The name of the environment variable.", "description": "The name of the environment variable." }, "value": { "type": "string", "title": "The value of the environment variable.", "description": "The value of the environment variable." } }, "required": [ "name" ] }, "FixedScaleSettings": { "type": "object", "title": "Fixed scale settings for the pool.", "description": "Fixed scale settings for the pool.", "properties": { "resizeTimeout": { "type": "string", "format": "duration", "title": "The timeout for allocation of compute nodes to the pool.", "description": "The default value is 15 minutes. Timeout values use ISO 8601 format. For example, use PT10M for 10 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).", "default": "PT15M" }, "targetDedicatedNodes": { "type": "integer", "format": "int32", "title": "The desired number of dedicated compute nodes in the pool.", "description": "At least one of targetDedicatedNodes, targetLowPriorityNodes must be set." }, "targetLowPriorityNodes": { "type": "integer", "format": "int32", "title": "The desired number of Spot/low-priority compute nodes in the pool.", "description": "At least one of targetDedicatedNodes, targetLowPriorityNodes must be set." }, "nodeDeallocationOption": { "$ref": "#/$defs/ComputeNodeDeallocationOption", "title": "Determines what to do with a node and its running task(s) after it has been selected for deallocation.", "description": "If omitted, the default value is Requeue.", "x-ms-mutability": [ "update", "create" ] } } }, "HostEndpointSettings": { "type": "object", "description": "Specifies particular host endpoint settings.", "properties": { "mode": { "$ref": "#/$defs/HostEndpointSettingsModeTypes", "description": "Specifies the access control policy execution mode." }, "inVMAccessControlProfileReferenceId": { "type": "string", "format": "arm-id", "description": "Specifies the reference to the InVMAccessControlProfileVersion resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version}." } } }, "HostEndpointSettingsModeTypes": { "type": "string", "description": "Specifies the access control policy execution mode.", "enum": [ "Audit", "Enforce" ], "x-ms-enum": { "name": "HostEndpointSettingsModeTypes", "modelAsString": true, "values": [ { "name": "Audit", "value": "Audit", "description": "In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints." }, { "name": "Enforce", "value": "Enforce", "description": "Enforce mode is the recommended mode of operation and system will enforce the access control policy. This property cannot be used together with 'inVMAccessControlProfileReferenceId'." } ] } }, "IPAddressProvisioningType": { "type": "string", "description": "The provisioning type for Public IP Addresses for the Batch Pool.", "enum": [ "BatchManaged", "UserManaged", "NoPublicIPAddresses" ], "x-ms-enum": { "name": "IPAddressProvisioningType", "modelAsString": false, "values": [ { "name": "BatchManaged", "value": "BatchManaged", "description": "A public IP will be created and managed by Batch. There may be multiple public IPs depending on the size of the Pool." }, { "name": "UserManaged", "value": "UserManaged", "description": "Public IPs are provided by the user and will be used to provision the Compute Nodes." }, { "name": "NoPublicIPAddresses", "value": "NoPublicIPAddresses", "description": "No public IP Address will be created for the Compute Nodes in the Pool." } ] } }, "IPFamily": { "type": "string", "description": "The IP families used to specify IP versions available to the pool.", "enum": [ "IPv4", "IPv6" ], "x-ms-enum": { "name": "IPFamily", "modelAsString": true, "values": [ { "name": "IPv4", "value": "IPv4", "description": "IPv4 is available to the pool." }, { "name": "IPv6", "value": "IPv6", "description": "IPv6 is available to the pool." } ] } }, "IPTag": { "type": "object", "title": "Specifies how tasks should be distributed across compute nodes.", "description": "Specifies how tasks should be distributed across compute nodes.", "properties": { "ipTagType": { "type": "string", "title": "The IP Tag type.", "description": "Example: FirstPartyUsage." }, "tag": { "type": "string", "title": "The value of the IP tag associated with the public IP.", "description": "Example: SQL." } } }, "ImageReference": { "type": "object", "title": "A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation.", "description": "A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation.", "properties": { "publisher": { "type": "string", "title": "The publisher of the Azure Virtual Machines Marketplace image.", "description": "For example, Canonical or MicrosoftWindowsServer." }, "offer": { "type": "string", "title": "The offer type of the Azure Virtual Machines Marketplace image.", "description": "For example, UbuntuServer or WindowsServer." }, "sku": { "type": "string", "title": "The SKU of the Azure Virtual Machines Marketplace image.", "description": "For example, 18.04-LTS or 2022-datacenter." }, "version": { "type": "string", "title": "The version of the Azure Virtual Machines Marketplace image.", "description": "A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'." }, "id": { "type": "string", "title": "The ARM resource identifier of the Azure Compute Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{versionId}.", "description": "This property is mutually exclusive with other properties. The Azure Compute Gallery Image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration." }, "sharedGalleryImageId": { "type": "string", "title": "The shared gallery image unique identifier", "description": "This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call." }, "communityGalleryImageId": { "type": "string", "title": "The community gallery image unique identifier", "description": "This property is mutually exclusive with other properties and can be fetched from community gallery image GET call." } } }, "InboundEndpointProtocol": { "type": "string", "description": "The protocol of the endpoint.", "enum": [ "TCP", "UDP" ], "x-ms-enum": { "name": "InboundEndpointProtocol", "modelAsString": false, "values": [ { "name": "TCP", "value": "TCP", "description": "Use TCP for the endpoint." }, { "name": "UDP", "value": "UDP", "description": "Use UDP for the endpoint." } ] } }, "InboundNatPool": { "type": "object", "title": "A inbound NAT pool that can be used to address specific ports on compute nodes in a Batch pool externally.", "description": "A inbound NAT pool that can be used to address specific ports on compute nodes in a Batch pool externally.", "properties": { "name": { "type": "string", "title": "The name of the endpoint.", "description": "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", "title": "The protocol of the endpoint.", "description": "The protocol of the endpoint." }, "backendPort": { "type": "integer", "format": "int32", "title": "The port number on the compute node.", "description": "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", "title": "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.", "description": "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. If any reserved or overlapping values are provided the request fails with HTTP status code 400." }, "frontendPortRangeEnd": { "type": "integer", "format": "int32", "title": "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.", "description": "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. If any reserved or overlapping values are provided the request fails with HTTP status code 400." }, "networkSecurityGroupRules": { "type": "array", "title": "A list of network security group rules that will be applied to the endpoint.", "description": "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" }, "x-ms-identifiers": [] } }, "required": [ "name", "protocol", "backendPort", "frontendPortRangeStart", "frontendPortRangeEnd" ] }, "InterNodeCommunicationState": { "type": "string", "description": "This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'.", "enum": [ "Enabled", "Disabled" ], "x-ms-enum": { "name": "InterNodeCommunicationState", "modelAsString": false, "values": [ { "name": "Enabled", "value": "Enabled", "description": "Enable network communication between virtual machines." }, { "name": "Disabled", "value": "Disabled", "description": "Disable network communication between virtual machines." } ] } }, "JobDefaultOrder": { "type": "string", "description": "The order for scheduling tasks from different jobs with the same priority.", "enum": [ "None", "CreationTime" ], "x-ms-enum": { "name": "JobDefaultOrder", "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." } ] } }, "LinuxUserConfiguration": { "type": "object", "title": "Properties used to create a user account on a Linux node.", "description": "Properties used to create a user account on a Linux node.", "properties": { "uid": { "type": "integer", "format": "int32", "title": "The user ID of the user account.", "description": "The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid." }, "gid": { "type": "integer", "format": "int32", "title": "The group ID for the user account.", "description": "The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid." }, "sshPrivateKey": { "type": "string", "format": "password", "title": "The SSH private key for the user account.", "description": "The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user's .ssh directory is done).", "x-ms-secret": true } } }, "LoginMode": { "type": "string", "description": "Specifies login mode for the user. The default value is Interactive.", "enum": [ "Batch", "Interactive" ], "x-ms-enum": { "name": "LoginMode", "modelAsString": false, "values": [ { "name": "Batch", "value": "Batch", "description": "The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running parallel processes." }, { "name": "Interactive", "value": "Interactive", "description": "The LOGON32_LOGON_INTERACTIVE Win32 login mode. Some applications require having permissions associated with the interactive login mode. If this is the case for an application used in your task, then this option is recommended." } ] } }, "ManagedDisk": { "type": "object", "description": "The managed disk parameters.", "properties": { "storageAccountType": { "$ref": "#/$defs/StorageAccountType", "title": "The storage account type for use in creating data disks or OS disk.", "description": "The storage account type for use in creating data disks or OS disk." }, "securityProfile": { "$ref": "#/$defs/VMDiskSecurityProfile", "title": "Specifies the security profile for the managed disk.", "description": "Specifies the security profile settings for the managed disk. **Note**: It can only be set for Confidential VMs and is required when using Confidential VMs." }, "diskEncryptionSet": { "$ref": "#/$defs/DiskEncryptionSetParameters", "description": "Specifies the customer managed disk encryption set resource id for the managed disk. It can be set only in UserSubscription mode." } } }, "MetadataItem": { "type": "object", "title": "A name-value pair associated with a Batch service resource.", "description": "The Batch service does not assign any meaning to this metadata; it is solely for the use of user code.", "properties": { "name": { "type": "string", "title": "The name of the metadata item.", "description": "The name of the metadata item." }, "value": { "type": "string", "title": "The value of the metadata item.", "description": "The value of the metadata item." } }, "required": [ "name", "value" ] }, "MountConfiguration": { "type": "object", "title": "The file system to mount on each node.", "description": "The file system to mount on each node.", "properties": { "azureBlobFileSystemConfiguration": { "$ref": "#/$defs/AzureBlobFileSystemConfiguration", "title": "The Azure Storage Container to mount using blob FUSE on each node.", "description": "This property is mutually exclusive with all other properties." }, "nfsMountConfiguration": { "$ref": "#/$defs/NFSMountConfiguration", "title": "The NFS file system to mount on each node.", "description": "This property is mutually exclusive with all other properties." }, "cifsMountConfiguration": { "$ref": "#/$defs/CIFSMountConfiguration", "title": "The CIFS/SMB file system to mount on each node.", "description": "This property is mutually exclusive with all other properties." }, "azureFileShareConfiguration": { "$ref": "#/$defs/AzureFileShareConfiguration", "title": "The Azure File Share to mount on each node.", "description": "This property is mutually exclusive with all other properties." } } }, "NFSMountConfiguration": { "type": "object", "title": "Information used to connect to an NFS file system.", "description": "Information used to connect to an NFS file system.", "properties": { "source": { "type": "string", "title": "The URI of the file system to mount.", "description": "The URI of the file system to mount." }, "relativeMountPath": { "type": "string", "title": "The relative path on the compute node where the file system will be mounted", "description": "All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable." }, "mountOptions": { "type": "string", "title": "Additional command line options to pass to the mount command.", "description": "These are 'net use' options in Windows and 'mount' options in Linux." } }, "required": [ "source", "relativeMountPath" ] }, "NetworkConfiguration": { "type": "object", "description": "The network configuration for a pool.", "properties": { "subnetId": { "type": "string", "title": "The ARM resource identifier of the virtual network subnet which the compute nodes of the pool will join. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}.", "description": "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 nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication，including ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration" }, "dynamicVnetAssignmentScope": { "type": "string", "title": "The scope of dynamic vnet assignment.", "description": "The scope of dynamic vnet assignment.", "default": "none", "enum": [ "none", "job" ], "x-ms-enum": { "name": "DynamicVNetAssignmentScope", "modelAsString": false, "values": [ { "name": "none", "value": "none", "description": "No dynamic VNet assignment is enabled." }, { "name": "job", "value": "job", "description": "Dynamic VNet assignment is done per-job. If this value is set, the network configuration subnet ID must also be set. This feature requires approval before use, please contact support" } ] } }, "endpointConfiguration": { "$ref": "#/$defs/PoolEndpointConfiguration", "title": "The configuration for endpoints on compute nodes in the Batch pool.", "description": "The endpoint configuration for a pool." }, "publicIPAddressConfiguration": { "$ref": "#/$defs/PublicIPAddressConfiguration", "title": "The Public IPAddress configuration for Compute Nodes in the Batch Pool.", "description": "The public IP Address configuration of the networking configuration of a Pool." }, "enableAcceleratedNetworking": { "type": "boolean", "title": "Whether this pool should enable accelerated networking.", "description": "Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview." } } }, "NetworkSecurityGroupRule": { "type": "object", "title": "A network security group rule to apply to an inbound endpoint.", "description": "A network security group rule to apply to an inbound endpoint.", "properties": { "priority": { "type": "integer", "format": "int32", "title": "The priority for this rule.", "description": "Priorities within a pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400." }, "access": { "$ref": "#/$defs/NetworkSecurityGroupRuleAccess", "title": "The action that should be taken for a specified IP address, subnet range or tag.", "description": "The action that should be taken for a specified IP address, subnet range or tag." }, "sourceAddressPrefix": { "type": "string", "title": "The source address prefix or tag to match for the rule.", "description": "Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400." }, "sourcePortRanges": { "type": "array", "title": "The source port ranges to match for the rule.", "description": "Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *.", "items": { "type": "string" } } }, "required": [ "priority", "access", "sourceAddressPrefix" ] }, "NetworkSecurityGroupRuleAccess": { "type": "string", "description": "The action that should be taken for a specified IP address, subnet range or tag.", "enum": [ "Allow", "Deny" ], "x-ms-enum": { "name": "NetworkSecurityGroupRuleAccess", "modelAsString": false, "values": [ { "name": "Allow", "value": "Allow", "description": "Allow access." }, { "name": "Deny", "value": "Deny", "description": "Deny access." } ] } }, "NodePlacementConfiguration": { "type": "object", "title": "Node placement configuration for Batch pools.", "description": "Allocation configuration used by Batch Service to provision the nodes.", "properties": { "policy": { "$ref": "#/$defs/NodePlacementPolicyType", "title": "Node placement Policy type on Batch pools.", "description": "Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy." } } }, "NodePlacementPolicyType": { "type": "string", "description": "The default value is regional.", "enum": [ "Regional", "Zonal" ], "x-ms-enum": { "name": "NodePlacementPolicyType", "modelAsString": false, "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 zones with best effort balancing." } ] } }, "OSDisk": { "type": "object", "title": "Settings for the operating system disk of the virtual machine.", "description": "Settings for the operating system disk of the virtual machine.", "properties": { "ephemeralOSDiskSettings": { "$ref": "#/$defs/DiffDiskSettings", "title": "Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.", "description": "Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine." }, "caching": { "$ref": "#/$defs/CachingType", "title": "The type of caching to enable for the disk.", "description": "The type of caching to enable for the disk." }, "managedDisk": { "$ref": "#/$defs/ManagedDisk", "title": "The managed disk parameters.", "description": "The managed disk parameters." }, "diskSizeGB": { "type": "integer", "format": "int32", "title": "The initial disk size in GB when creating new OS disk.", "description": "The initial disk size in GB when creating new OS disk." }, "writeAcceleratorEnabled": { "type": "boolean", "title": "Specifies whether writeAccelerator should be enabled or disabled on the disk.", "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." } } }, "PoolEndpointConfiguration": { "type": "object", "title": "The endpoint configuration for a pool.", "description": "The endpoint configuration for a pool.", "properties": { "inboundNatPools": { "type": "array", "title": "A list of inbound NAT pools that can be used to address specific ports on an individual compute node externally.", "description": "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/InboundNatPool" }, "x-ms-identifiers": [ "name" ] } }, "required": [ "inboundNatPools" ] }, "PoolIdentityType": { "type": "string", "description": "The type of identity used for the Batch Pool.", "enum": [ "UserAssigned", "None" ], "x-ms-enum": { "name": "PoolIdentityType", "modelAsString": false, "values": [ { "name": "UserAssigned", "value": "UserAssigned", "description": "Batch pool has user assigned identities with it." }, { "name": "None", "value": "None", "description": "Batch pool has no identity associated with it. Setting `None` in update pool will remove existing identities." } ] } }, "PoolProperties": { "type": "object", "description": "Pool properties.", "properties": { "displayName": { "type": "string", "title": "The display name for the pool.", "description": "The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024." }, "lastModified": { "type": "string", "format": "date-time", "title": "The last modified time of the pool.", "description": "This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state.", "readOnly": true }, "creationTime": { "type": "string", "format": "date-time", "title": "The creation time of the pool.", "description": "The creation time of the pool.", "readOnly": true }, "provisioningState": { "$ref": "#/$defs/PoolProvisioningState", "title": "The current state of the pool.", "description": "The current state of the pool.", "readOnly": true }, "provisioningStateTransitionTime": { "type": "string", "format": "date-time", "title": "The time at which the pool entered its current state.", "description": "The time at which the pool entered its current state.", "readOnly": true }, "allocationState": { "$ref": "#/$defs/AllocationState", "title": "Whether the pool is resizing.", "description": "Whether the pool is resizing.", "readOnly": true }, "allocationStateTransitionTime": { "type": "string", "format": "date-time", "title": "The time at which the pool entered its current allocation state.", "description": "The time at which the pool entered its current allocation state.", "readOnly": true }, "vmSize": { "type": "string", "title": "The size of virtual machines in the pool. All VMs in a pool are the same size.", "description": "For information about available VM sizes, see Sizes for Virtual Machines in Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series)." }, "deploymentConfiguration": { "$ref": "#/$defs/DeploymentConfiguration", "title": "This property describes the virtual machines that the pool nodes will be deployed on.", "description": "Deployment configuration properties." }, "currentDedicatedNodes": { "type": "integer", "format": "int32", "title": "The number of dedicated compute nodes currently in the pool.", "description": "The number of dedicated compute nodes currently in the pool.", "readOnly": true }, "currentLowPriorityNodes": { "type": "integer", "format": "int32", "title": "The number of Spot/low-priority compute nodes currently in the pool.", "description": "The number of Spot/low-priority compute nodes currently in the pool.", "readOnly": true }, "scaleSettings": { "$ref": "#/$defs/ScaleSettings", "title": "Settings which configure the number of nodes in the pool.", "description": "Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes." }, "autoScaleRun": { "$ref": "#/$defs/AutoScaleRun", "title": "The results and errors from the last execution of the autoscale formula.", "description": "This property is set only if the pool automatically scales, i.e. autoScaleSettings are used.", "readOnly": true }, "interNodeCommunication": { "$ref": "#/$defs/InterNodeCommunicationState", "title": "Whether the pool permits direct communication between nodes.", "description": "This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'." }, "networkConfiguration": { "$ref": "#/$defs/NetworkConfiguration", "title": "The network configuration for the pool.", "description": "The network configuration for a pool." }, "taskSlotsPerNode": { "type": "integer", "format": "int32", "title": "The number of task slots that can be used to run concurrent tasks on a single compute node in the pool.", "description": "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.", "default": 1 }, "taskSchedulingPolicy": { "$ref": "#/$defs/TaskSchedulingPolicy", "title": "How tasks are distributed across compute nodes in a pool.", "description": "If not specified, the default is spread." }, "userAccounts": { "type": "array", "title": "The list of user accounts to be created on each node in the pool.", "description": "The list of user accounts to be created on each node in the pool.", "items": { "$ref": "#/$defs/UserAccount" }, "x-ms-identifiers": [ "name" ] }, "metadata": { "type": "array", "title": "A list of name-value pairs associated with the pool as metadata.", "description": "The Batch service does not assign any meaning to metadata; it is solely for the use of user code.", "items": { "$ref": "#/$defs/MetadataItem" }, "x-ms-identifiers": [ "name" ] }, "startTask": { "$ref": "#/$defs/StartTask", "title": "A task specified to run on each compute node as it joins the pool.", "description": "In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool." }, "applicationPackages": { "type": "array", "title": "The list of application packages to be installed on each compute node in the pool.", "description": "Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. There is a maximum of 10 application package references on any given pool.", "items": { "$ref": "#/$defs/ApplicationPackageReference" } }, "resizeOperationStatus": { "$ref": "#/$defs/ResizeOperationStatus", "title": "Contains details about the current or last completed resize operation.", "description": "Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady).", "readOnly": true }, "mountConfiguration": { "type": "array", "title": "A list of file systems to mount on each node in the pool.", "description": "This supports Azure Files, NFS, CIFS/SMB, and Blobfuse.", "items": { "$ref": "#/$defs/MountConfiguration" }, "x-ms-identifiers": [] }, "upgradePolicy": { "$ref": "#/$defs/UpgradePolicy", "title": "The upgrade policy for the pool.", "description": "Describes an upgrade policy - automatic, manual, or rolling." } } }, "PoolProvisioningState": { "type": "string", "description": "The current state of the pool.", "enum": [ "Succeeded", "Deleting" ], "x-ms-enum": { "name": "PoolProvisioningState", "modelAsString": false, "values": [ { "name": "Succeeded", "value": "Succeeded", "description": "The pool is available to run tasks subject to the availability of compute nodes." }, { "name": "Deleting", "value": "Deleting", "description": "The user has requested that the pool be deleted, but the delete operation has not yet completed." } ] } }, "ProxyAgentSettings": { "type": "object", "description": "Specifies ProxyAgent settings while creating the virtual machine.", "properties": { "enabled": { "type": "boolean", "description": "Specifies whether Metadata Security Protocol feature should be enabled on the virtual machine or virtual machine scale set. Default is False." }, "imds": { "$ref": "#/$defs/HostEndpointSettings", "description": "Settings for the IMDS endpoint." }, "wireServer": { "$ref": "#/$defs/HostEndpointSettings", "description": "Settings for the WireServer endpoint." } } }, "PublicIPAddressConfiguration": { "type": "object", "description": "The public IP Address configuration of the networking configuration of a Pool.", "properties": { "provision": { "$ref": "#/$defs/IPAddressProvisioningType", "title": "The provisioning type for Public IP Addresses for the Batch Pool.", "description": "The default value is BatchManaged" }, "ipAddressIds": { "type": "array", "title": "The list of public IPs which the Batch service will use when provisioning Compute Nodes.", "description": "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" } }, "ipFamilies": { "type": "array", "title": "The IP families used to specify IP versions available to the pool.", "description": "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" } }, "ipTags": { "type": "array", "title": "IP Tags that will applied to new Public IPs that Batch creates.", "description": "IP Tags that will applied to new Public IPs that Batch creates.", "items": { "$ref": "#/$defs/IPTag" }, "x-ms-identifiers": [] } } }, "ResizeError": { "type": "object", "title": "An error that occurred when resizing a pool.", "description": "An error that occurred when resizing a pool.", "properties": { "code": { "type": "string", "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." }, "message": { "type": "string", "description": "A message describing the error, intended to be suitable for display in a user interface." }, "details": { "type": "array", "title": "Additional details about the error.", "description": "Additional details about the error.", "items": { "$ref": "#/$defs/ResizeError" }, "x-ms-identifiers": [ "code" ] } }, "required": [ "code", "message" ] }, "ResizeOperationStatus": { "type": "object", "title": "Details about the current or last completed resize operation.", "description": "Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady).", "properties": { "targetDedicatedNodes": { "type": "integer", "format": "int32", "title": "The desired number of dedicated compute nodes in the pool.", "description": "The desired number of dedicated compute nodes in the pool." }, "targetLowPriorityNodes": { "type": "integer", "format": "int32", "title": "The desired number of Spot/low-priority compute nodes in the pool.", "description": "The desired number of Spot/low-priority compute nodes in the pool." }, "resizeTimeout": { "type": "string", "format": "duration", "title": "The timeout for allocation of compute nodes to the pool or removal of compute nodes from the pool.", "description": "The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." }, "nodeDeallocationOption": { "$ref": "#/$defs/ComputeNodeDeallocationOption", "title": "Determines what to do with a node and its running task(s) after it has been selected for deallocation.", "description": "The default value is requeue." }, "startTime": { "type": "string", "format": "date-time", "title": "The time when this resize operation was started.", "description": "The time when this resize operation was started." }, "errors": { "type": "array", "title": "Details of any errors encountered while performing the last resize on the pool.", "description": "This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady.", "items": { "$ref": "#/$defs/ResizeError" }, "x-ms-identifiers": [ "code" ] } } }, "ResourceFile": { "type": "object", "title": "A single file or multiple files to be downloaded to a compute node.", "description": "A single file or multiple files to be downloaded to a compute node.", "properties": { "autoStorageContainerName": { "type": "string", "title": "The storage container name in the auto storage account.", "description": "The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified." }, "storageContainerUrl": { "type": "string", "title": "The URL of the blob container within Azure Blob Storage.", "description": "The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the container to allow public access." }, "httpUrl": { "type": "string", "title": "The URL of the file to download.", "description": "The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access." }, "blobPrefix": { "type": "string", "title": "The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs whose names begin with the specified prefix will be downloaded.", "description": "The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded." }, "filePath": { "type": "string", "title": "The location on the compute node to which to download the file, relative to the task's working directory.", "description": "If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..')." }, "fileMode": { "type": "string", "title": "The file permission mode attribute in octal format.", "description": "This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file." }, "identityReference": { "$ref": "#/$defs/ComputeNodeIdentityReference", "title": "The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl", "description": "The reference to a user assigned identity associated with the Batch pool which a compute node will use." } } }, "RollingUpgradePolicy": { "type": "object", "description": "The configuration parameters used while performing a rolling upgrade.", "properties": { "enableCrossZoneUpgrade": { "type": "boolean", "description": "Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. If this field is not set, Azure Azure Batch will not set its default value. The value of enableCrossZoneUpgrade on the created VirtualMachineScaleSet will be decided by the default configurations on VirtualMachineScaleSet. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal." }, "maxBatchInstancePercent": { "type": "integer", "format": "int32", "description": "The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent.", "minimum": 5, "maximum": 100 }, "maxUnhealthyInstancePercent": { "type": "integer", "format": "int32", "description": "The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent.", "minimum": 5, "maximum": 100 }, "maxUnhealthyUpgradedInstancePercent": { "type": "integer", "format": "int32", "description": "The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of this field should be between 0 and 100, inclusive.", "minimum": 0, "maximum": 100 }, "pauseTimeBetweenBatches": { "type": "string", "description": "The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format." }, "prioritizeUnhealthyInstances": { "type": "boolean", "description": "Upgrade all unhealthy instances in a scale set before any healthy instances." }, "rollbackFailedInstancesOnPolicyBreach": { "type": "boolean", "description": "Rollback failed instances to previous model if the Rolling Upgrade policy is violated." } } }, "ScaleSettings": { "type": "object", "title": "Scale settings for the pool", "description": "Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes.", "properties": { "fixedScale": { "$ref": "#/$defs/FixedScaleSettings", "title": "Fixed scale settings for the pool.", "description": "This property and autoScale are mutually exclusive and one of the properties must be specified." }, "autoScale": { "$ref": "#/$defs/AutoScaleSettings", "title": "AutoScale settings for the pool.", "description": "This property and fixedScale are mutually exclusive and one of the properties must be specified." } } }, "SecurityEncryptionTypes": { "type": "string", "description": "Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. **Note**: It can be set for only Confidential VMs and required when using Confidential VMs.", "enum": [ "NonPersistedTPM", "VMGuestStateOnly", "DiskWithVMGuestState" ], "x-ms-enum": { "name": "SecurityEncryptionTypes", "modelAsString": true, "values": [ { "name": "NonPersistedTPM", "value": "NonPersistedTPM", "description": "EncryptionType of the managed disk is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob." }, { "name": "VMGuestStateOnly", "value": "VMGuestStateOnly", "description": "EncryptionType of the managed disk is set to VMGuestStateOnly for encryption of just the VMGuestState blob." }, { "name": "DiskWithVMGuestState", "value": "DiskWithVMGuestState", "description": "EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob. It is not supported in data disks." } ] } }, "SecurityProfile": { "type": "object", "description": "Specifies the security profile settings for the virtual machine or virtual machine scale set.", "properties": { "securityType": { "$ref": "#/$defs/SecurityTypes", "title": "Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.", "description": "Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings." }, "encryptionAtHost": { "type": "boolean", "description": "This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself." }, "uefiSettings": { "$ref": "#/$defs/UefiSettings", "title": "Specifies the security settings like secure boot and vTPM used while creating the virtual machine.", "description": "Specifies the security settings like secure boot and vTPM used while creating the virtual machine." }, "proxyAgentSettings": { "$ref": "#/$defs/ProxyAgentSettings", "description": "Specifies ProxyAgent settings while creating the virtual machine." } } }, "SecurityTypes": { "type": "string", "description": "Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.", "enum": [ "trustedLaunch", "confidentialVM" ], "x-ms-enum": { "name": "SecurityTypes", "modelAsString": false, "values": [ { "name": "trustedLaunch", "value": "trustedLaunch", "description": "Trusted launch protects against advanced and persistent attack techniques." }, { "name": "confidentialVM", "value": "confidentialVM", "description": "Azure confidential computing offers confidential VMs are for tenants with high security and confidentiality requirements. These VMs provide a strong, hardware-enforced boundary to help meet your security needs. You can use confidential VMs for migrations without making changes to your code, with the platform protecting your VM's state from being read or modified." } ] } }, "ServiceArtifactReference": { "type": "object", "description": "Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version.", "properties": { "id": { "type": "string", "title": "The service artifact reference id of ServiceArtifactReference", "description": "The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}" } }, "required": [ "id" ] }, "StartTask": { "type": "object", "title": "A task which is run when a compute node joins a pool in the Azure Batch service, or when the compute node is rebooted or reimaged.", "description": "In some cases the start task may be re-run even though the node was not rebooted. Due to this, start tasks should be idempotent and exit gracefully if the setup they're performing has already been done. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task.", "properties": { "commandLine": { "type": "string", "title": "The command line of the start task.", "description": "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. Required if any other properties of the startTask are specified." }, "resourceFiles": { "type": "array", "title": "A list of files that the Batch service will download to the compute node before running the command line.", "description": "A list of files that the Batch service will download to the compute node before running the command line.", "items": { "$ref": "#/$defs/ResourceFile" }, "x-ms-identifiers": [ "httpUrl" ] }, "environmentSettings": { "type": "array", "title": "A list of environment variable settings for the start task.", "description": "A list of environment variable settings for the start task.", "items": { "$ref": "#/$defs/EnvironmentSetting" }, "x-ms-identifiers": [ "name" ] }, "userIdentity": { "$ref": "#/$defs/UserIdentity", "title": "The user identity under which the start task runs.", "description": "If omitted, the task runs as a non-administrative user unique to the task." }, "maxTaskRetryCount": { "type": "integer", "format": "int32", "title": "The maximum number of times the task may be retried.", "description": "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. Default is 0", "default": 0 }, "waitForSuccess": { "type": "boolean", "title": "Whether the Batch service should wait for the start task to complete successfully (that is, to exit with exit code 0) before scheduling any tasks on the compute node.", "description": "If true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is true." }, "containerSettings": { "$ref": "#/$defs/TaskContainerSettings", "title": "The settings for the container under which the start task runs.", "description": "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." } } }, "StorageAccountType": { "type": "string", "description": "The storage account type for use in creating data disks or OS disk.", "enum": [ "Standard_LRS", "Premium_LRS", "StandardSSD_LRS" ], "x-ms-enum": { "name": "StorageAccountType", "modelAsString": false, "values": [ { "name": "Standard_LRS", "value": "Standard_LRS", "description": "The data disk / OS disk should use standard locally redundant storage." }, { "name": "Premium_LRS", "value": "Premium_LRS", "description": "The data disk / OS disk should use premium locally redundant storage." }, { "name": "StandardSSD_LRS", "value": "StandardSSD_LRS", "description": "The data disk / OS disk should use standard SSD locally redundant storage." } ] } }, "TaskContainerSettings": { "type": "object", "title": "The container settings for a task.", "description": "The container settings for a task.", "properties": { "containerRunOptions": { "type": "string", "title": "Additional options to the container create command.", "description": "These additional options are supplied as arguments to the \"docker create\" command, in addition to those controlled by the Batch Service." }, "imageName": { "type": "string", "title": "The image to use to create the container in which the task will run.", "description": "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/ContainerRegistry", "title": "The private registry which contains the container image.", "description": "This setting can be omitted if was already provided at pool creation." }, "workingDirectory": { "$ref": "#/$defs/ContainerWorkingDirectory", "title": "A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'.", "description": "A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'." }, "containerHostBatchBindMounts": { "type": "array", "title": "The paths you want to mounted to container task.", "description": "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" }, "x-ms-identifiers": [] } }, "required": [ "imageName" ] }, "TaskSchedulingPolicy": { "type": "object", "title": "Specifies how tasks should be distributed across compute nodes.", "description": "Specifies how tasks should be distributed across compute nodes.", "properties": { "jobDefaultOrder": { "$ref": "#/$defs/JobDefaultOrder", "title": "If not specified, the default is none.", "description": "The order for scheduling tasks from different jobs with the same priority." }, "nodeFillType": { "type": "string", "title": "How tasks should be distributed across compute nodes.", "description": "How tasks should be distributed across compute nodes.", "default": "Spread", "enum": [ "Spread", "Pack" ], "x-ms-enum": { "name": "ComputeNodeFillType", "modelAsString": false, "values": [ { "name": "Spread", "value": "Spread", "description": "Tasks should be assigned evenly across all nodes in the pool." }, { "name": "Pack", "value": "Pack", "description": "As many tasks as possible (taskSlotsPerNode) should be assigned to each node in the pool before any tasks are assigned to the next node in the pool." } ] } } }, "required": [ "nodeFillType" ] }, "UefiSettings": { "type": "object", "description": "Specifies the security settings like secure boot and vTPM used while creating the virtual machine.", "properties": { "secureBootEnabled": { "type": "boolean", "description": "Specifies whether secure boot should be enabled on the virtual machine." }, "vTpmEnabled": { "type": "boolean", "description": "Specifies whether vTPM should be enabled on the virtual machine." } } }, "UpgradeMode": { "type": "string", "description": "Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time.

**Rolling** - Scale set performs updates in batches with an optional pause time in between.", "enum": [ "automatic", "manual", "rolling" ], "x-ms-enum": { "name": "UpgradeMode", "modelAsString": false, "values": [ { "name": "automatic", "value": "automatic", "description": "All virtual machines in the scale set are automatically updated at the same time." }, { "name": "manual", "value": "manual", "description": "You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action." }, { "name": "rolling", "value": "rolling", "description": "The existing instances in a scale set are brought down in batches to be upgraded. Once the upgraded batch is complete, the instances will begin taking traffic again and the next batch will begin. This continues until all instances brought up-to-date." } ] } }, "UpgradePolicy": { "type": "object", "description": "Describes an upgrade policy - automatic, manual, or rolling.", "properties": { "mode": { "$ref": "#/$defs/UpgradeMode", "title": "Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time.

**Rolling** - Scale set performs updates in batches with an optional pause time in between.", "description": "Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time.

**Rolling** - Scale set performs updates in batches with an optional pause time in between." }, "automaticOSUpgradePolicy": { "$ref": "#/$defs/AutomaticOSUpgradePolicy", "title": "Configuration parameters used for performing automatic OS Upgrade.", "description": "The configuration parameters used for performing automatic OS upgrade." }, "rollingUpgradePolicy": { "$ref": "#/$defs/RollingUpgradePolicy", "title": "The configuration parameters used while performing a rolling upgrade.", "description": "The configuration parameters used while performing a rolling upgrade." } }, "required": [ "mode" ] }, "UserAccount": { "type": "object", "title": "Properties used to create a user on an Azure Batch node.", "description": "Properties used to create a user on an Azure Batch node.", "properties": { "name": { "type": "string", "title": "The name of the user account. Names can contain any Unicode characters up to a maximum length of 20.", "description": "The name of the user account. Names can contain any Unicode characters up to a maximum length of 20." }, "password": { "type": "string", "format": "password", "title": "The password for the user account.", "description": "The password for the user account.", "x-ms-secret": true }, "elevationLevel": { "$ref": "#/$defs/ElevationLevel", "title": "The elevation level of the user.", "description": "nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin." }, "linuxUserConfiguration": { "$ref": "#/$defs/LinuxUserConfiguration", "title": "The Linux-specific user configuration for the user account.", "description": "This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options." }, "windowsUserConfiguration": { "$ref": "#/$defs/WindowsUserConfiguration", "title": "The Windows-specific user configuration for the user account.", "description": "This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options." } }, "required": [ "name", "password" ] }, "UserAssignedIdentities": { "type": "object", "description": "The list of associated user identities.", "properties": { "principalId": { "type": "string", "description": "The principal id of user assigned identity.", "readOnly": true }, "clientId": { "type": "string", "description": "The client id of user assigned identity.", "readOnly": true } } }, "UserIdentity": { "type": "object", "title": "The definition of the user identity under which the task is run.", "description": "Specify either the userName or autoUser property, but not both.", "properties": { "userName": { "type": "string", "title": "The name of the user identity under which the task is run.", "description": "The userName and autoUser properties are mutually exclusive; you must specify one but not both." }, "autoUser": { "$ref": "#/$defs/AutoUserSpecification", "title": "The auto user under which the task is run.", "description": "The userName and autoUser properties are mutually exclusive; you must specify one but not both." } } }, "VMDiskSecurityProfile": { "type": "object", "description": "Specifies the security profile settings for the managed disk. **Note**: It can only be set for Confidential VMs and is required when using Confidential VMs.", "properties": { "securityEncryptionType": { "$ref": "#/$defs/SecurityEncryptionTypes", "title": "Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. **Note**: It can be set for only Confidential VMs and required when using Confidential VMs.", "description": "Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. **Note**: It can be set for only Confidential VMs and required when using Confidential VMs." }, "diskEncryptionSet": { "$ref": "#/$defs/DiskEncryptionSetParameters", "description": "Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. It can be set only in UserSubscription mode." } } }, "VMExtension": { "type": "object", "title": "The configuration for virtual machine extensions.", "description": "The configuration for virtual machine extensions.", "properties": { "name": { "type": "string", "title": "The name of the virtual machine extension.", "description": "The name of the virtual machine extension." }, "publisher": { "type": "string", "title": "The name of the extension handler publisher.", "description": "The name of the extension handler publisher." }, "type": { "type": "string", "title": "The type of the extensions.", "description": "The type of the extensions." }, "typeHandlerVersion": { "type": "string", "title": "The version of script handler.", "description": "The version of script handler." }, "autoUpgradeMinorVersion": { "type": "boolean", "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." }, "enableAutomaticUpgrade": { "type": "boolean", "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available." }, "settings": { "title": "JSON formatted public settings for the extension.", "description": "JSON formatted public settings for the extension." }, "protectedSettings": { "format": "password", "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.", "x-ms-secret": true }, "provisionAfterExtensions": { "type": "array", "title": "The collection of extension names.", "description": "Collection of extension names after which this extension needs to be provisioned.", "items": { "type": "string" } } }, "required": [ "name", "publisher", "type" ] }, "VirtualMachineConfiguration": { "type": "object", "title": "The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure.", "description": "The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure.", "properties": { "imageReference": { "$ref": "#/$defs/ImageReference", "title": "A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use.", "description": "A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation." }, "nodeAgentSkuId": { "type": "string", "title": "The SKU of the Batch node agent to be provisioned on compute nodes in the pool.", "description": "The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems. You must specify a node agent SKU which matches the selected image reference. To get the list of supported node agent SKUs along with their list of verified image references, see the 'List supported node agent SKUs' operation." }, "windowsConfiguration": { "$ref": "#/$defs/WindowsConfiguration", "title": "Windows operating system settings on the virtual machine.", "description": "This property must not be specified if the imageReference specifies a Linux OS image." }, "dataDisks": { "type": "array", "title": "The configuration for data disks attached to the compute nodes in the pool.", "description": "This property must be specified if the compute nodes in the pool need to have empty data disks attached to them.", "items": { "$ref": "#/$defs/DataDisk" }, "x-ms-identifiers": [ "lun" ] }, "licenseType": { "type": "string", "title": "The type of on-premises license to be used when deploying the operating system.", "description": "This only applies to images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are:\n\nWindows_Server - The on-premises license is for Windows Server.\nWindows_Client - The on-premises license is for Windows Client." }, "containerConfiguration": { "$ref": "#/$defs/ContainerConfiguration", "title": "The container configuration for the pool.", "description": "If specified, setup is performed on each node in the pool to allow tasks to run in containers. All regular tasks and job manager tasks run on this pool must specify the containerSettings property, and all other tasks may specify it." }, "diskEncryptionConfiguration": { "$ref": "#/$defs/DiskEncryptionConfiguration", "title": "The disk encryption configuration for the pool.", "description": "If specified, encryption is performed on each node in the pool during node provisioning." }, "nodePlacementConfiguration": { "$ref": "#/$defs/NodePlacementConfiguration", "title": "The node placement configuration for the pool.", "description": "This configuration will specify rules on how nodes in the pool will be physically allocated." }, "extensions": { "type": "array", "title": "The virtual machine extension for the pool.", "description": "If specified, the extensions mentioned in this configuration will be installed on each node.", "items": { "$ref": "#/$defs/VMExtension" }, "x-ms-identifiers": [ "name", "type" ] }, "osDisk": { "$ref": "#/$defs/OSDisk", "title": "Settings for the operating system disk of the Virtual Machine.", "description": "Contains configuration for ephemeral OSDisk settings." }, "securityProfile": { "$ref": "#/$defs/SecurityProfile", "title": "Specifies the security profile settings for the virtual machine or virtual machine scale set.", "description": "Specifies the security profile settings for the virtual machine or virtual machine scale set." }, "serviceArtifactReference": { "$ref": "#/$defs/ServiceArtifactReference", "title": "Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version.", "description": "The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}" } }, "required": [ "imageReference", "nodeAgentSkuId" ] }, "WindowsConfiguration": { "type": "object", "title": "Windows operating system settings to apply to the virtual machine.", "description": "Windows operating system settings to apply to the virtual machine.", "properties": { "enableAutomaticUpdates": { "type": "boolean", "title": "Whether automatic updates are enabled on the virtual machine.", "description": "If omitted, the default value is true." } } }, "WindowsUserConfiguration": { "type": "object", "title": "Properties used to create a user account on a Windows node.", "description": "Properties used to create a user account on a Windows node.", "properties": { "loginMode": { "$ref": "#/$defs/LoginMode", "title": "Login mode for user", "description": "Specifies login mode for the user. The default value is Interactive." } } } } }