你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Pools - Create Pool

服务:: Batch Service

API 版本:: 2025-06-01

为指定的账户创建一个池。
命名池时，请避免包括敏感信息，例如用户名或机密项目名称。此信息可能显示在Microsoft支持工程师可访问的遥测日志中。

POST {endpoint}/pools?api-version=2025-06-01

具有可选参数:

POST {endpoint}/pools?api-version=2025-06-01&timeOut={timeOut}

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string (uri)	Batch 帐户终结点（例如：https://batchaccount.eastus2.batch.azure.com）。
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。
timeOut	query		integer (int32)	服务器处理请求的最长时间（以秒为单位）。默认为 30 秒。如果值大于30，则使用默认值。”

请求头

Media Types: "application/json; odata=minimalmetadata"

名称	类型	说明
client-request-id	string	调用方生成的请求标识，采用不带大括号的 GUID 形式，例如 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0。
return-client-request-id	boolean	服务器是否应在响应中返回 client-request-id。
ocp-date	string (date-time-rfc7231)	发出请求的时间。客户端库通常将此设置为当前的系统时钟时间;如果直接调用 REST API，请显式设置它。

请求正文

Media Types: "application/json; odata=minimalmetadata"

名称	必需	类型	说明
id	True	string	唯一标识帐户中的池的字符串。 ID 可以包含字母数字字符（包括连字符和下划线）的任意组合，并且不能包含超过 64 个字符。 ID 是区分大小写和不区分大小写的（也就是说，帐户中可能没有两个仅大小写不同的池 ID）。
vmSize	True	string	池中虚拟机的大小。池中的所有虚拟机的大小都相同。有关使用虚拟机市场中的映像（使用 virtualMachineConfiguration 创建的池）的池的可用 VM 大小的信息，请参阅 Azure 中虚拟机的大小（）。https://learn.microsoft.com/azure/virtual-machines/sizes/overview Batch 支持除STANDARD_A0和具有高级存储（STANDARD_GS、STANDARD_DS和STANDARD_DSV2系列）之外的所有 Azure VM 大小。
applicationPackageReferences		BatchApplicationPackageReference[]	要安装在池中每个计算节点上的包列表。创建池时，包的应用程序 ID 必须完全限定（/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}）。对包引用的更改会影响所有加入池的新节点，但不会影响池中已存在于池中的计算节点，直到重新启动或重新映像这些节点。任何给定池上最多有 10 个包引用。
autoScaleEvaluationInterval		string (duration)	根据自动缩放公式自动调整池大小的时间间隔。默认值为 15 分钟。最小值和最大值分别为 5 分钟和 168 小时。如果指定的值小于 5 分钟或大于 168 小时，Batch 服务将返回错误;如果直接调用 REST API，则 HTTP 状态代码为 400（请求错误）。
autoScaleFormula		string	池中所需计算节点数的公式。如果 enableAutoScale 设置为 false，则不能指定此属性。如果 enableAutoScale 设置为 true，则需要它。在创建池之前，将检查公式是否有效。如果公式无效，Batch 服务会拒绝请求，并显示详细的错误信息。有关指定此公式的详细信息，请参阅“自动缩放 Azure Batch 池中的计算节点”（https://learn.microsoft.com/azure/batch/batch-automatic-scaling）。
displayName		string	池的显示名称。显示名称不一定是唯一的，可以包含最大长度为 1024 的任何 Unicode 字符。
enableAutoScale		boolean	池大小是否应随时间自动调整。如果为 false，则必须指定至少一个 targetDedicatedNodes 和 targetLowPriorityNodes。如果为 true，则需要 autoScaleFormula 属性，并且池会根据公式自动调整大小。默认值为 false。
enableInterNodeCommunication		boolean	池是否允许在计算节点之间直接通信。由于池的计算节点的部署限制，启用节点间通信会限制池的最大大小。这可能会导致池未达到其所需大小。默认值为 false。
metadata		BatchMetadataItem[]	与池关联的名称/值对列表作为元数据。 Batch 服务不向元数据分配任何含义;它仅用于使用用户代码。
mountConfiguration		MountConfiguration[]	在池的整个生存期内使用指定的文件系统装载存储。使用 Azure 文件共享、NFS、CIFS 或基于 Blobfuse 的文件系统装载存储。
networkConfiguration		NetworkConfiguration	池的网络配置。
resizeTimeout		string (duration)	将计算节点分配给池的超时。此超时仅适用于手动缩放;当 enableAutoScale 设置为 true 时，它不起作用。默认值为 15 分钟。最小值为 5 分钟。如果指定的值小于 5 分钟，Batch 服务将返回错误;如果直接调用 REST API，则 HTTP 状态代码为 400（请求错误）。
startTask		BatchStartTask	指定在联接池时在每个计算节点上运行的任务。当将计算节点添加到池或重启计算节点时，任务将运行。
targetDedicatedNodes		integer (int32)	池中所需的专用计算节点数。如果 enableAutoScale 设置为 true，则不能指定此属性。如果 enableAutoScale 设置为 false，则必须设置 targetDedicatedNodes、targetLowPriorityNodes 或两者。
targetLowPriorityNodes		integer (int32)	池中所需的现成/低优先级计算节点数。如果 enableAutoScale 设置为 true，则不能指定此属性。如果 enableAutoScale 设置为 false，则必须设置 targetDedicatedNodes、targetLowPriorityNodes 或两者。
taskSchedulingPolicy		BatchTaskSchedulingPolicy	任务如何在池中的计算节点之间分布。如果未指定，则默认为分散。
taskSlotsPerNode		integer (int32)	可用于在池中单个计算节点上运行并发任务的任务槽数。默认值为 1。最大值是池的 vmSize 核心数或 256 的 4 倍。
upgradePolicy		UpgradePolicy	池的升级策略。描述升级策略 - 自动、手动或滚动。
userAccounts		UserAccount[]	将在池中的每个计算节点上创建的用户帐户列表。
virtualMachineConfiguration		VirtualMachineConfiguration	池的虚拟机配置。必须指定此属性。

响应

名称	类型	说明
201 Created		请求已成功，因此创建了一个新资源。标头 DataServiceId: string ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	意外错误响应。

名称

类型

说明

201 Created

请求已成功，因此创建了一个新资源。

标头

DataServiceId: string
ETag: string
Last-Modified: string
client-request-id: string
request-id: string

Other Status Codes

BatchError

意外错误响应。

安全性

OAuth2Auth

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

作用域

名称	说明
https://batch.core.windows.net//.default

示例

Creates a pool with accelerated networking

Creates a pool with confidential disk encryption set for user subscription accounts

Creates a pool with disk encryption set for user subscription accounts

Creates a pool with dual stack networking

Creates a pool with mount drive specified

Creates a pool with SecurityProfile

Creates a VirtualMachineConfiguration pool

Creates a VirtualMachineConfiguration pool with containers

Creates a VirtualMachineConfiguration pool with extensions

Creates a VirtualMachineConfiguration pool with OS disk

Creates a VirtualMachineConfiguration pool with ServiceArtifactReference

Creates a pool with accelerated networking

示例请求

HTTP

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "mypool01",
  "vmSize": "Standard_D1_v2",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2025-datacenter-smalldisk",
      "version": "latest"
    },
    "nodeAgentSKUId": "batch.node.windows amd64"
  },
  "targetDedicatedNodes": 2,
  "networkConfiguration": {
    "enableAcceleratedNetworking": true
  }
}

示例响应

状态代码:: 201

Creates a pool with confidential disk encryption set for user subscription accounts

示例请求

HTTP

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "pool",
  "vmSize": "Standard_DC2as_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2019-datacenter-core-g2",
      "version": "latest"
    },
    "osDisk": {
      "managedDisk": {
        "storageAccountType": "standard_lrs",
        "diskEncryptionSet": {
          "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId"
        },
        "securityProfile": {
          "securityEncryptionType": "DiskWithVMGuestState"
        }
      }
    },
    "dataDisks": [
      {
        "lun": 0,
        "diskSizeGB": 1024,
        "managedDisk": {
          "storageAccountType": "standard_lrs",
          "diskEncryptionSet": {
            "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId"
          }
        }
      }
    ],
    "securityProfile": {
      "securityType": "confidentialvm",
      "uefiSettings": {
        "vTpmEnabled": true,
        "secureBootEnabled": true
      }
    },
    "nodeAgentSKUId": "batch.node.windows amd64"
  },
  "targetDedicatedNodes": 1
}

示例响应

状态代码:: 201

Creates a pool with disk encryption set for user subscription accounts

示例请求

HTTP

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "pool",
  "vmSize": "Standard_D2ds_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2019-datacenter-core-g2",
      "version": "latest"
    },
    "osDisk": {
      "managedDisk": {
        "storageAccountType": "standard_lrs",
        "diskEncryptionSet": {
          "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId"
        }
      }
    },
    "dataDisks": [
      {
        "lun": 0,
        "diskSizeGB": 1024,
        "managedDisk": {
          "storageAccountType": "standard_lrs",
          "diskEncryptionSet": {
            "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId"
          }
        }
      }
    ],
    "nodeAgentSKUId": "batch.node.windows amd64"
  },
  "targetDedicatedNodes": 1
}

示例响应

状态代码:: 201

Creates a pool with dual stack networking

示例请求

HTTP

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "dualstackpool",
  "vmSize": "Standard_D2ds_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "ubuntu-24_04-lts",
      "sku": "server"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04"
  },
  "networkConfiguration": {
    "publicIPAddressConfiguration": {
      "ipFamilies": [
        "IPv4",
        "IPv6"
      ]
    },
    "endpointConfiguration": {
      "inboundNATPools": [
        {
          "backendPort": 22,
          "frontendPortRangeStart": 40000,
          "frontendPortRangeEnd": 40500,
          "name": "sshpool",
          "protocol": "tcp",
          "networkSecurityGroupRules": [
            {
              "access": "allow",
              "priority": 1000,
              "sourceAddressPrefix": "*",
              "sourcePortRanges": [
                "*"
              ]
            }
          ]
        }
      ]
    }
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 1,
  "targetLowPriorityNodes": 0
}

示例响应

状态代码:: 201

Creates a pool with mount drive specified

示例请求

HTTP

POST {endpoint}/pools?api-version=2025-06-01


{
  "id": "pool2",
  "vmSize": "Standard_D4d_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "ubuntu-24_04-lts",
      "sku": "server"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04"
  },
  "mountConfiguration": [
    {
      "azureBlobFileSystemConfiguration": {
        "accountName": "accountName",
        "containerName": "blobContainerName",
        "accountKey": "accountKey",
        "relativeMountPath": "bfusepath"
      }
    },
    {
      "azureFileShareConfiguration": {
        "accountName": "accountName",
        "azureFileUrl": "https://myaccount.file.core.windows.net/fileshare",
        "accountKey": "accountKey",
        "relativeMountPath": "filesharepath",
        "mountOptions": "mount options ver=1.0"
      }
    },
    {
      "nfsMountConfiguration": {
        "source": "somesource nfs url",
        "relativeMountPath": "mountpath",
        "mountOptions": "mount options ver=1.0"
      }
    },
    {
      "cifsMountConfiguration": {
        "username": "accountName",
        "password": "password",
        "source": "//myaccount.file.core.windows.net/file",
        "relativeMountPath": "mountpath",
        "mountOptions": "mount options ver=1.0"
      }
    }
  ],
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false
}

示例响应

状态代码:: 201

Creates a pool with SecurityProfile

示例请求

HTTP

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "mypool001",
  "vmSize": "STANDARD_DC2s_V2",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "ubuntu-24_04-lts",
      "sku": "18_04-lts-gen2",
      "version": "latest"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 18.04",
    "securityProfile": {
      "securityType": "trustedLaunch",
      "encryptionAtHost": true,
      "uefiSettings": {
        "secureBootEnabled": false,
        "vTpmEnabled": null
      }
    }
  },
  "targetDedicatedNodes": 1
}

示例响应

状态代码:: 201

Creates a VirtualMachineConfiguration pool

示例请求

HTTP

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "pool2",
  "vmSize": "Standard_D4d_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "ubuntu-24_04-lts",
      "sku": "server"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04"
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false,
  "enableInterNodeCommunication": true,
  "metadata": [
    {
      "name": "myproperty",
      "value": "myvalue"
    }
  ]
}

示例响应

状态代码:: 201

Creates a VirtualMachineConfiguration pool with containers

示例请求

HTTP

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "pool2",
  "vmSize": "Standard_D4d_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "ubuntu-24_04-lts",
      "sku": "120_04-lts"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04",
    "containerConfiguration": {
      "type": "dockerCompatible",
      "containerImageNames": [
        "busybox"
      ]
    }
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false
}

示例响应

状态代码:: 201

Creates a VirtualMachineConfiguration pool with extensions

示例请求

HTTP

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "pool2",
  "vmSize": "Standard_D4d_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "ubuntu-24_04-lts",
      "sku": "server"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04",
    "extensions": [
      {
        "name": "batchextension1",
        "type": "KeyVaultForLinux",
        "publisher": "Microsoft.Azure.KeyVault",
        "typeHandlerVersion": "2.0",
        "autoUpgradeMinorVersion": true,
        "enableAutomaticUpgrade": true,
        "settings": {
          "secretsManagementSettingsKey": "secretsManagementSettingsValue",
          "authenticationSettingsKey": "authenticationSettingsValue"
        }
      }
    ]
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false,
  "enableInterNodeCommunication": true,
  "metadata": [
    {
      "name": "myproperty",
      "value": "myvalue"
    }
  ]
}

示例响应

状态代码:: 201

Creates a VirtualMachineConfiguration pool with OS disk

示例请求

HTTP

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "mypool001",
  "vmSize": "Standard_D2ds_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "ubuntu-24_04-lts",
      "sku": "server"
    },
    "osDisk": {
      "diskSizeGB": 100,
      "managedDisk": {
        "storageAccountType": "standardssd_lrs"
      },
      "caching": "readwrite",
      "ephemeralOSDiskSettings": {
        "placement": "cachedisk"
      }
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04"
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 1,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 1,
  "enableAutoScale": false
}

示例响应

状态代码:: 201

Creates a VirtualMachineConfiguration pool with ServiceArtifactReference

示例请求

HTTP

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "mypool002",
  "vmSize": "Standard_D4d_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2025-datacenter-smalldisk",
      "version": "latest"
    },
    "windowsConfiguration": {
      "enableAutomaticUpdates": false
    },
    "serviceArtifactReference": {
      "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile"
    },
    "nodeAgentSKUId": "batch.node.windows amd64"
  },
  "targetDedicatedNodes": 2
}

示例响应

状态代码:: 201

定义

名称	说明
AutomaticOsUpgradePolicy	用于执行自动 OS 升级的配置参数。
AutoUserScope	AutoUserScope 枚举
AutoUserSpecification	指定运行 Azure Batch 任务的自动用户的选项。
AzureBlobFileSystemConfiguration	用于使用 Blobfuse 连接到 Azure 存储容器的信息。
AzureFileShareConfiguration	用于连接到 Azure 文件共享的信息。
BatchApplicationPackageReference	对要部署到计算节点的包的引用。
BatchContainerConfiguration	已启用容器的池的配置。
BatchDiffDiskSettings	指定计算节点（VM）使用的操作系统磁盘的临时磁盘设置。
BatchError	从 Azure Batch 服务收到的错误响应。
BatchErrorDetail	Azure Batch 错误响应中包含的附加信息项。
BatchErrorMessage	Azure Batch 错误响应中收到的错误消息。
BatchInboundNatPool	入站 NAT 池，可用于在外部处理 Batch 池中计算节点上的特定端口。
BatchJobDefaultOrder	BatchJobDefaultOrder 枚举
BatchMetadataItem	Batch 服务不为此元数据分配任何含义;它仅用于使用用户代码。
BatchNodeFillType	BatchNodeFillType 枚举
BatchNodeIdentityReference	对与计算节点将使用的 Batch 池关联的用户分配标识的引用。
BatchNodePlacementConfiguration	对于区域放置，池中的节点将在同一区域中分配。对于区域放置，池中的节点将分布在不同区域，并尽最大努力进行平衡。
BatchNodePlacementPolicyType	BatchNodePlacementPolicyType 枚举
BatchOsDisk	计算节点（VM）操作系统磁盘的设置。
BatchPoolCreateOptions	用于创建 Azure Batch 池的参数。
BatchPoolEndpointConfiguration	池的终结点配置。
BatchPoolIdentityReference	用于加密磁盘的池标识之一的引用。此标识将用于访问密钥保管库。
BatchPublicIpAddressConfiguration	池的网络配置的公共 IP 地址配置。
BatchStartTask	当在节点上触发恢复操作时，Batch 将重试任务。恢复操作的示例包括（但不限于）在重新启动运行不正常的节点或计算节点因主机故障而消失时。由于恢复操作而进行的重试与 maxTaskRetryCount 无关，并且不计入 maxTaskRetryCount。即使 maxTaskRetryCount 为 0，也可能发生由于恢复操作而导致的内部重试。因此，所有任务都应是幂等的。这意味着任务需要容忍中断和重启，而不会导致任何损坏或重复数据。长时间运行的任务的最佳做法是使用某种形式的检查点。在某些情况下，即使计算节点未重新启动，StartTask 也可能重新运行。应特别注意避免 StartTaskss 从 StartTask 工作目录创建分离进程或安装/启动服务，因为这会阻止 Batch 重新运行 StartTask。
BatchTaskContainerSettings	任务的容器设置。
BatchTaskSchedulingPolicy	指定应如何跨计算节点分配任务。
BatchUefiSettings	指定在创建虚拟机时使用的安全启动和 vTPM 等安全设置。
BatchVmDiskSecurityProfile	指定托管磁盘的安全配置文件设置。注：它只能为机密虚拟机设置，并且在使用机密虚拟机时需要。
BatchVmImageReference	对 Azure 虚拟机市场映像或 Azure 计算库映像的引用。若要获取 Azure Batch 验证的所有 Azure 市场映像引用的列表，请参阅“列表支持的映像”操作。
CachingType	缓存类型枚举
CifsMountConfiguration	用于连接到 CIFS 文件系统的信息。
ContainerHostBatchBindMountEntry	要装载到任务容器的路径和装载模式的条目。
ContainerHostDataPath	将装载到容器任务的容器的路径。
ContainerRegistryReference	专用容器注册表。
ContainerType	ContainerType 枚举
ContainerWorkingDirectory	ContainerWorkingDirectory 枚举
DataDisk	与池中的计算节点关联的数据磁盘将使用的设置。使用附加的数据磁盘时，需要从 VM 中装载磁盘并设置磁盘格式才能使用这些磁盘。
DiffDiskPlacement	规定了作系统中所有计算节点（虚拟机）磁盘的临时磁盘位置。此属性可由请求中的用户使用，以选择操作系统应位于的位置。例如，用于临时 OS 磁盘预配的缓存磁盘空间。有关临时作系统磁盘大小要求的更多信息，请参阅Windows虚拟机的临时作系统磁盘容量要求，访问https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements
DiskCustomerManagedKey	用于加密磁盘的客户管理的密钥引用。
DiskEncryptionConfiguration	在池中的计算节点上应用的磁盘加密配置。使用 Azure 计算库映像创建的 Linux 池不支持磁盘加密配置。
DiskEncryptionSetParameters	磁盘加密集的 ARM 资源 ID。
DiskEncryptionTarget	DiskEncryptionTarget 枚举
DynamicVNetAssignmentScope	DynamicVNetAssignmentScope enums
ElevationLevel	高程层枚举
EnvironmentSetting	要对任务进程设置的环境变量。
HostEndpointSettings	指定特定的主机终结点设置。
HostEndpointSettingsModeTypes	HostEndpointSettingsModeTypes 枚举
InboundEndpointProtocol	InboundEndpointProtocol 枚举
IpAddressProvisioningType	IPAddressProvisioningType 枚举
IPFamily	用于指定池可用的 IP 版本的 IP 系列。
IPTag	包含与公共 IP 地址关联的 IP 标记。
LinuxUserConfiguration	用于在 Linux 计算节点上创建用户帐户的属性。
LoginMode	登录模式枚举
ManagedDisk	托管磁盘参数。
MountConfiguration	要在每个节点上装载的文件系统。
NetworkConfiguration	池的网络配置。
NetworkSecurityGroupRule	要应用于入站终结点的网络安全组规则。
NetworkSecurityGroupRuleAccess	NetworkSecurityGroupRuleAccess 枚举
NfsMountConfiguration	用于连接到 NFS 文件系统的信息。
ProxyAgentSettings	在创建虚拟机时指定 ProxyAgent 设置。
ResourceFile	要下载到计算节点的单个文件或多个文件。
RollingUpgradePolicy	执行滚动升级时使用的配置参数。
SecurityEncryptionTypes	安全性加密类型枚举
SecurityProfile	指定虚拟机或虚拟机规模集的安全配置文件设置。
SecurityTypes	指定虚拟机的 SecurityType。必须将其设置为任何指定值才能启用 UefiSettings。
ServiceArtifactReference	指定使用“latest”映像版本时，用于为规模集中的所有虚拟机设置相同映像版本的服务项目引用 ID。
StorageAccountType	StorageAccountType 枚举
UpgradeMode	升级模式枚举
UpgradePolicy	描述升级策略 - 自动、手动或滚动。
UserAccount	用于创建用于在 Azure Batch 计算节点上执行任务的用户的属性。
UserIdentity	运行任务的用户标识的定义。指定 userName 或 autoUser 属性，但不能同时指定这两者。
VirtualMachineConfiguration	基于 Azure 虚拟机基础结构的池中计算节点的配置。
VMExtension	虚拟机扩展的配置。
WindowsConfiguration	要应用于虚拟机的 Windows 操作系统设置。
WindowsUserConfiguration	用于在 Windows 计算节点上创建用户帐户的属性。

AutomaticOsUpgradePolicy

对象

用于执行自动 OS 升级的配置参数。

名称	类型	说明
disableAutomaticRollback	boolean	是否应禁用 OS 映像回滚功能。
enableAutomaticOSUpgrade	boolean	指示当较新版本的 OS 映像可用时，是否应以滚动方式自动将 OS 升级应用于规模集实例。如果对于基于 Windows 的池，WindowsConfiguration.enableAutomaticUpdates 不能设置为 true。
osRollingUpgradeDeferral	boolean	如果 OS 升级正在运行任务，请延迟 TVM 上的 OS 升级。
useRollingUpgradePolicy	boolean	指示是否应在自动 OS 升级期间使用滚动升级策略。如果未在 VMSS 上定义任何策略，则自动 OS 升级将回退到默认策略。

AutoUserScope

枚举

AutoUserScope 枚举

值	说明
task	指定服务应为该任务创建新用户。
pool	指定任务作为公共自动用户账户运行，该账户在池中的每个计算节点创建。

AutoUserSpecification

对象

指定运行 Azure Batch 任务的自动用户的选项。

名称	类型	说明
elevationLevel	ElevationLevel	自动用户的提升级别。默认值为 nonAdmin。
scope	AutoUserScope	自动用户的范围。默认值为池。如果池正在运行 Windows，则应指定任务值（如果需要在任务之间进行更严格的隔离）。例如，如果任务以可能影响其他任务的方式更改注册表。

AzureBlobFileSystemConfiguration

对象

用于使用 Blobfuse 连接到 Azure 存储容器的信息。

名称	类型	说明
accountKey	string (password)	Azure 存储帐户密钥。此属性与 sasKey 和标识互斥;必须指定一个。
accountName	string	Azure 存储帐户名称。
blobfuseOptions	string	要传递给装载命令的其他命令行选项。这些是 Windows 中的“net use”选项，Linux 中的“装载”选项。
containerName	string	Azure Blob 存储容器名称。
identityReference	BatchNodeIdentityReference	指的是用户分配的身份，用于访问containerName。此属性与 accountKey 和 sasKey 互斥;必须指定一个。
relativeMountPath	string	计算节点上的相对路径，文件系统将被挂载。所有文件系统都相对于 Batch 装载目录进行装载，可通过AZ_BATCH_NODE_MOUNTS_DIR环境变量进行访问。
sasKey	string (password)	Azure 存储 SAS 令牌。此属性与 accountKey 和 identity 互斥;必须指定一个。

AzureFileShareConfiguration

对象

用于连接到 Azure 文件共享的信息。

名称	类型	说明
accountKey	string (password)	Azure 存储帐户密钥。
accountName	string	Azure 存储帐户名称。
azureFileUrl	string (uri)	Azure 文件 URL。此格式为“https://{account}.file.core.windows.net/”。
mountOptions	string	要传递给装载命令的其他命令行选项。这些是 Windows 中的“net use”选项，Linux 中的“装载”选项。
relativeMountPath	string	计算节点上的相对路径，文件系统将被挂载。所有文件系统都相对于 Batch 装载目录进行装载，可通过AZ_BATCH_NODE_MOUNTS_DIR环境变量进行访问。

BatchApplicationPackageReference

对象

对要部署到计算节点的包的引用。

名称	类型	说明
applicationId	string	部署应用的ID。创建池时，包的应用程序 ID 必须完全限定（/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}）。
version	string	要部署的应用程序的版本。如果省略，则部署默认版本。如果池中省略了这一点，且该应用未指定默认版本，请求将失败，错误代码为 InvalidApplicationPackageReferences 和 HTTP 状态代码 409。如果任务中省略了这一点，且该应用未指定默认版本，任务将因预处理错误而失败。

BatchContainerConfiguration

对象

已启用容器的池的配置。

名称	类型	说明
containerImageNames	string[]	集装箱图片名称集合。这是完整的映像引用，正如“docker pull”中指定的那样。除非镜像已完全经过替代注册表的限定，否则镜像将从默认的 Docker 注册表中获取源。
containerRegistries	ContainerRegistryReference[]	可从中提取容器的其他专用注册表。如果任何镜像必须从需要凭证的私有注册表下载，那么这些凭证必须在这里提供。
type	ContainerType	要使用的容器技术。

BatchDiffDiskSettings

对象

指定计算节点（VM）使用的操作系统磁盘的临时磁盘设置。

名称	类型	说明
placement	DiffDiskPlacement	指定池中所有 VM 的操作系统磁盘的临时磁盘放置。用户可以在请求中使用此属性来选择用于临时 OS 磁盘预配的位置，例如缓存磁盘空间。有关临时 OS 磁盘大小要求的详细信息，请参阅 https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements 和 Linux VM 的 Windows VM 的临时 OS 磁盘大小要求。

BatchError

对象

从 Azure Batch 服务收到的错误响应。

名称	类型	说明
code	string	错误的标识符。代码是固定的，旨在以编程方式使用。
message	BatchErrorMessage	描述错误的消息，旨在适合在用户界面中显示。
values	BatchErrorDetail[]	包含有关错误的更多详细信息的键值对的集合。

BatchErrorDetail

对象

Azure Batch 错误响应中包含的附加信息项。

名称	类型	说明
key	string	指定 Value 属性含义的标识符。
value	string	错误响应附带的其他信息。

BatchErrorMessage

对象

Azure Batch 错误响应中收到的错误消息。

名称	类型	说明
lang	string	错误消息的语言代码。
value	string	消息的文本。

BatchInboundNatPool

对象

入站 NAT 池，可用于在外部处理 Batch 池中计算节点上的特定端口。

名称	类型	说明
backendPort	integer (int32)	计算节点上的端口号。这必须在批处理池中唯一。可接受的值介于 1 和 65535 之间，但 29876 和 29877 除外，因为这些值是保留的。如果提供任何保留值，则请求失败并显示 HTTP 状态代码 400。
frontendPortRangeEnd	integer (int32)	将用于在各个计算节点上提供后端端口入站访问的外部端口范围内的最后一个端口号。可接受的值介于 1 到 65534 之间，但 Batch 服务保留的端口范围为 50000 到 55000。池内的所有范围必须独立且不能重叠。每个射程至少包含40个端口。如果提供任何保留值或重叠值，则请求失败并显示 HTTP 状态代码 400。
frontendPortRangeStart	integer (int32)	这是用于在各个计算节点上提供后端端口入站访问的外部端口范围内的第一个端口号。可接受的值介于 1 到 65534 之间，但保留的端口范围为 50000 到 55000。池内的所有范围必须独立且不能重叠。每个射程至少包含40个端口。如果提供任何保留值或重叠值，则请求失败并显示 HTTP 状态代码 400。
name	string	终结点的名称。名称必须在批处理池中唯一，包含字母、数字、下划线、句号和连字符。名称必须以字母或数字开头，必须以字母、数字或下划线结尾，并且不能超过 77 个字符。如果提供任何无效值，则请求失败并显示 HTTP 状态代码 400。
networkSecurityGroupRules	NetworkSecurityGroupRule[]	将应用于终结点的网络安全组规则列表。批处理池中所有端点最多可指定25条规则。如果未指定网络安全组规则，则会创建默认规则以允许对指定的 backendPort 进行入站访问。如果超过网络安全组规则的最大数目，则请求失败并显示 HTTP 状态代码 400。
protocol	InboundEndpointProtocol	终结点的协议。

BatchJobDefaultOrder

枚举

BatchJobDefaultOrder 枚举

值	说明
none	任务应从池中所有同等优先级的作业统一调度。
creationtime	如果作业优先级相等，则应优先调度之前创建的作业中的任务。

BatchMetadataItem

对象

Batch 服务不为此元数据分配任何含义;它仅用于使用用户代码。

名称	类型	说明
name	string	元数据项的名称。
value	string	元数据项的值。

BatchNodeFillType

枚举

BatchNodeFillType 枚举

值	说明
spread	任务应在池中所有计算节点间均匀分配。
pack	在分配到池中下一个计算节点之前，应尽可能多地分配任务（taskSlotsPerNode）。

BatchNodeIdentityReference

对象

对与计算节点将使用的 Batch 池关联的用户分配标识的引用。

名称	类型	说明
resourceId	string (arm-id)	用户分配标识的 ARM 资源 ID。

BatchNodePlacementConfiguration

对象

对于区域放置，池中的节点将在同一区域中分配。对于区域放置，池中的节点将分布在不同区域，并尽最大努力进行平衡。

名称	类型	说明
policy	BatchNodePlacementPolicyType	Batch 池上的节点放置策略类型。 Batch 服务用于预配节点的分配策略。如果未指定，Batch 将使用区域策略。

BatchNodePlacementPolicyType

枚举

BatchNodePlacementPolicyType 枚举

值	说明
regional	池中的所有节点都将在同一区域中分配。
zonal	池中的节点将分布在不同的可用区间，采用尽力平衡。

BatchOsDisk

对象

计算节点（VM）操作系统磁盘的设置。

名称	类型	说明
caching	CachingType	指定缓存要求。可能的值包括：None、ReadOnly、ReadWrite。默认值为：标准存储无。高级存储的 ReadOnly。
diskSizeGB	integer (int32)	创建新 OS 磁盘时的初始磁盘大小（以 GB 为单位）。
ephemeralOSDiskSettings	BatchDiffDiskSettings	指定计算节点（VM）使用的操作系统磁盘的临时磁盘设置。
managedDisk	ManagedDisk	托管磁盘参数。
writeAcceleratorEnabled	boolean	指定是应在磁盘上启用或禁用 writeAccelerator。

BatchPoolCreateOptions

对象

用于创建 Azure Batch 池的参数。

名称	类型	说明
applicationPackageReferences	BatchApplicationPackageReference[]	要安装在池中每个计算节点上的包列表。创建池时，包的应用程序 ID 必须完全限定（/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}）。对包引用的更改会影响所有加入池的新节点，但不会影响池中已存在于池中的计算节点，直到重新启动或重新映像这些节点。任何给定池上最多有 10 个包引用。
autoScaleEvaluationInterval	string (duration)	根据自动缩放公式自动调整池大小的时间间隔。默认值为 15 分钟。最小值和最大值分别为 5 分钟和 168 小时。如果指定的值小于 5 分钟或大于 168 小时，Batch 服务将返回错误;如果直接调用 REST API，则 HTTP 状态代码为 400（请求错误）。
autoScaleFormula	string	池中所需计算节点数的公式。如果 enableAutoScale 设置为 false，则不能指定此属性。如果 enableAutoScale 设置为 true，则需要它。在创建池之前，将检查公式是否有效。如果公式无效，Batch 服务会拒绝请求，并显示详细的错误信息。有关指定此公式的详细信息，请参阅“自动缩放 Azure Batch 池中的计算节点”（https://learn.microsoft.com/azure/batch/batch-automatic-scaling）。
displayName	string	池的显示名称。显示名称不一定是唯一的，可以包含最大长度为 1024 的任何 Unicode 字符。
enableAutoScale	boolean	池大小是否应随时间自动调整。如果为 false，则必须指定至少一个 targetDedicatedNodes 和 targetLowPriorityNodes。如果为 true，则需要 autoScaleFormula 属性，并且池会根据公式自动调整大小。默认值为 false。
enableInterNodeCommunication	boolean	池是否允许在计算节点之间直接通信。由于池的计算节点的部署限制，启用节点间通信会限制池的最大大小。这可能会导致池未达到其所需大小。默认值为 false。
id	string	唯一标识帐户中的池的字符串。 ID 可以包含字母数字字符（包括连字符和下划线）的任意组合，并且不能包含超过 64 个字符。 ID 是区分大小写和不区分大小写的（也就是说，帐户中可能没有两个仅大小写不同的池 ID）。
metadata	BatchMetadataItem[]	与池关联的名称/值对列表作为元数据。 Batch 服务不向元数据分配任何含义;它仅用于使用用户代码。
mountConfiguration	MountConfiguration[]	在池的整个生存期内使用指定的文件系统装载存储。使用 Azure 文件共享、NFS、CIFS 或基于 Blobfuse 的文件系统装载存储。
networkConfiguration	NetworkConfiguration	池的网络配置。
resizeTimeout	string (duration)	将计算节点分配给池的超时。此超时仅适用于手动缩放;当 enableAutoScale 设置为 true 时，它不起作用。默认值为 15 分钟。最小值为 5 分钟。如果指定的值小于 5 分钟，Batch 服务将返回错误;如果直接调用 REST API，则 HTTP 状态代码为 400（请求错误）。
startTask	BatchStartTask	指定在联接池时在每个计算节点上运行的任务。当将计算节点添加到池或重启计算节点时，任务将运行。
targetDedicatedNodes	integer (int32)	池中所需的专用计算节点数。如果 enableAutoScale 设置为 true，则不能指定此属性。如果 enableAutoScale 设置为 false，则必须设置 targetDedicatedNodes、targetLowPriorityNodes 或两者。
targetLowPriorityNodes	integer (int32)	池中所需的现成/低优先级计算节点数。如果 enableAutoScale 设置为 true，则不能指定此属性。如果 enableAutoScale 设置为 false，则必须设置 targetDedicatedNodes、targetLowPriorityNodes 或两者。
taskSchedulingPolicy	BatchTaskSchedulingPolicy	任务如何在池中的计算节点之间分布。如果未指定，则默认为分散。
taskSlotsPerNode	integer (int32)	可用于在池中单个计算节点上运行并发任务的任务槽数。默认值为 1。最大值是池的 vmSize 核心数或 256 的 4 倍。
upgradePolicy	UpgradePolicy	池的升级策略。描述升级策略 - 自动、手动或滚动。
userAccounts	UserAccount[]	将在池中的每个计算节点上创建的用户帐户列表。
virtualMachineConfiguration	VirtualMachineConfiguration	池的虚拟机配置。必须指定此属性。
vmSize	string	池中虚拟机的大小。池中的所有虚拟机的大小都相同。有关使用虚拟机市场中的映像（使用 virtualMachineConfiguration 创建的池）的池的可用 VM 大小的信息，请参阅 Azure 中虚拟机的大小（）。https://learn.microsoft.com/azure/virtual-machines/sizes/overview Batch 支持除STANDARD_A0和具有高级存储（STANDARD_GS、STANDARD_DS和STANDARD_DSV2系列）之外的所有 Azure VM 大小。

BatchPoolEndpointConfiguration

对象

池的终结点配置。

名称	类型	说明
inboundNATPools	BatchInboundNatPool[]	一份可用于外部特定计算节点端口寻址的入站NAT池列表。每个批处理池的最大入站NAT池数为5个。如果入站NAT池的最大数量超过，请求将失败，HTTP状态代码为400。如果 IPAddressProvisioningType 为 NoPublicIPAddresses，则无法指定此项。

BatchPoolIdentityReference

对象

用于加密磁盘的池标识之一的引用。此标识将用于访问密钥保管库。

名称	类型	说明
resourceId	string (arm-id)	用户分配标识的 ARM 资源 ID。此引用必须包含在池标识中。

BatchPublicIpAddressConfiguration

对象

池的网络配置的公共 IP 地址配置。

名称	类型	说明
ipAddressIds	string[] (arm-id)	预配计算节点时 Batch 服务将使用的公共 IP 列表。此处指定的 IP 数限制池的最大大小 - 可以为每个公共 IP 分配 100 个专用节点或 100 个现成/低优先级节点。例如，需要 250 个专用 VM 的池至少需要指定 3 个公共 IP。此集合的每个元素都采用以下形式：/subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}。
ipFamilies	IPFamily[]	用于指定池可用的 IP 版本的 IP 系列。 IP 系列用于确定单堆栈池或双堆栈池。对于单堆栈，预期值为 IPv4。对于双堆栈，预期值为 IPv4 和 IPv6。
ipTags	IPTag[]	与池的公共 IP 地址关联的 IP 标记列表。 IP 标签用于对公共 IP 地址进行分类和过滤，以用于计费和管理目的。
provision	IpAddressProvisioningType	池的公共 IP 地址的预配类型。默认值为 BatchManaged。

BatchStartTask

对象

当在节点上触发恢复操作时，Batch 将重试任务。恢复操作的示例包括（但不限于）在重新启动运行不正常的节点或计算节点因主机故障而消失时。由于恢复操作而进行的重试与 maxTaskRetryCount 无关，并且不计入 maxTaskRetryCount。即使 maxTaskRetryCount 为 0，也可能发生由于恢复操作而导致的内部重试。因此，所有任务都应是幂等的。这意味着任务需要容忍中断和重启，而不会导致任何损坏或重复数据。长时间运行的任务的最佳做法是使用某种形式的检查点。在某些情况下，即使计算节点未重新启动，StartTask 也可能重新运行。应特别注意避免 StartTaskss 从 StartTask 工作目录创建分离进程或安装/启动服务，因为这会阻止 Batch 重新运行 StartTask。

名称	类型	说明
commandLine	string	StartTask 的命令行。命令行未在 shell 下运行，因此不能利用 shell 功能（如环境变量扩展）。如果要利用这些功能，则应在命令行中调用 shell，例如在 Windows 中使用“cmd /c MyCommand”或在 Linux 中使用“/bin/sh -c MyCommand”。如果命令行引用文件路径，则应使用相对路径（相对于任务工作目录），或使用 Batch 提供的环境变量（https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables）。
containerSettings	BatchTaskContainerSettings	启动任务运行容器的设置。当指定时，AZ_BATCH_NODE_ROOT_DIR（节点上 Azure Batch 目录的根节点）下方的所有目录递归映射到容器中，所有任务环境变量映射到容器中，任务命令行在容器中执行。容器中AZ_BATCH_NODE_ROOT_DIR外生成的文件可能不会反映到主机磁盘，这意味着批处理文件API无法访问这些文件。
environmentSettings	EnvironmentSetting[]	StartTask 的环境变量设置列表。
maxTaskRetryCount	integer (int32)	可以重试任务的最大次数。如果 Batch 服务退出代码为非零，则重试任务。请注意，此值专门控制重试次数。 Batch 服务将尝试一次任务，然后可能会重试到此限制。例如，如果最大重试计数为 3，Batch 将尝试任务最多 4 次（一次初始尝试和 3 次重试）。如果最大重试计数为 0，Batch 服务不会重试任务。如果最大重试计数为 -1，Batch 服务将重试任务，但不建议用于启动任务或任何任务。默认值为 0（无重试）。
resourceFiles	ResourceFile[]	Batch 服务在运行命令行之前将下载到计算节点的文件列表。资源文件列表的最大大小。超过最大大小时，请求将失败，响应错误代码将为 RequestEntityTooLarge。如果发生这种情况，则必须减小 ResourceFiles 的集合大小。这可以使用 .zip 文件、应用程序包或 Docker 容器来实现。此元素下列出的文件位于任务的工作目录中。
userIdentity	UserIdentity	启动任务运行的用户身份。如果省略，任务将作为任务独一无二的非管理员用户运行。
waitForSuccess	boolean	在计划计算节点上的任何任务之前，Batch 服务是否应等待 StartTask 成功完成（即退出代码 0）。如果 True 且 StartTask 在节点上失败，Batch 服务将重试 StartTask，最大重试计数（maxTaskRetryCount）。如果任务在所有重试后仍未成功完成，则 Batch 服务会标记节点不可用，并且不会为其计划任务。可以通过计算节点状态和故障信息详细信息来检测此条件。如果为 false，Batch 服务不会等待 StartTask 完成。在这种情况下，在 StartTask 仍在运行时，其他任务可以开始在计算节点上执行;即使 StartTask 失败，新任务将继续在计算节点上计划。默认值为 true。

BatchTaskContainerSettings

对象

任务的容器设置。

名称	类型	说明
containerHostBatchBindMounts	ContainerHostBatchBindMountEntry[]	要装载到容器任务的路径。如果此数组为 null 或不存在，容器任务将在 Windows 中装载整个临时磁盘驱动器（或 Linux 中的AZ_BATCH_NODE_ROOT_DIR）。如果此数组设置为空，则不会将任何数据路径装载到容器中。
containerRunOptions	string	容器创建命令的其他选项。除了 Batch 服务控制的选项外，这些附加选项还作为“docker create”命令的参数提供。
imageName	string	用于创建任务运行容器的图片。这是完整的映像引用，正如“docker pull”中指定的那样。如果图片名称中没有提供标签，默认使用标签“：latest”。
registry	ContainerRegistryReference	包含容器镜像的私有注册表。如果在创建池时已经提供了该设置，可以省略。
workingDirectory	ContainerWorkingDirectory	容器任务工作目录的位置。默认值为“taskWorkingDirectory”。

BatchTaskSchedulingPolicy

对象

指定应如何跨计算节点分配任务。

名称	类型	默认值	说明
jobDefaultOrder	BatchJobDefaultOrder	none	从具有相同优先级的不同作业中调度任务的顺序。如果未指定，则默认值为 none。
nodeFillType	BatchNodeFillType		任务如何在池中的计算节点之间分布。如果未指定，则默认为分散。

BatchUefiSettings

对象

指定在创建虚拟机时使用的安全启动和 vTPM 等安全设置。

名称	类型	说明
secureBootEnabled	boolean	指定是否应在虚拟机上启用安全启动。
vTpmEnabled	boolean	指定是否应在虚拟机上启用 vTPM。

BatchVmDiskSecurityProfile

对象

指定托管磁盘的安全配置文件设置。注：它只能为机密虚拟机设置，并且在使用机密虚拟机时需要。

名称	类型	说明
securityEncryptionType	SecurityEncryptionTypes	指定托管磁盘的 EncryptionType。它设置为 VMGuestStateOnly 以仅加密 VMGuestState blob，而 NonPersistedTPM 用于不保留 VMGuestState blob 中的固件状态。注：只能为机密虚拟机设置，并且在使用机密虚拟机时是必需的。

BatchVmImageReference

对象

对 Azure 虚拟机市场映像或 Azure 计算库映像的引用。若要获取 Azure Batch 验证的所有 Azure 市场映像引用的列表，请参阅“列表支持的映像”操作。

名称	类型	说明
communityGalleryImageId	string	社区画廊图片唯一标识符。此属性与其他属性互斥，可以从社区库映像 GET 调用中提取。
exactVersion	string	用于创建节点的平台镜像或市场镜像的特定版本。该只读字段仅在创建池时指定的“版本”值为“最新”时才与“版本”不同。
offer	string	Azure 虚拟机市场镜像的 offer 类型。例如，UbuntuServer 或 WindowsServer。
publisher	string	Azure虚拟机市场镜像的发布者。例如，Canonical 或 MicrosoftWindowsServer。
sharedGalleryImageId	string	共享图库图像的唯一标识符。此属性与其他属性互斥，可以从共享库映像 GET 调用中提取。
sku	string	Azure 虚拟机市场镜像的 SKU。例如，18.04-LTS 或 2019-Datacenter。
version	string	Azure 虚拟机市场镜像的版本。可以指定“最新”值以选择图像的最新版本。如果省略，则默认值为“latest”。
virtualMachineImageId	string (arm-id)	Azure 计算库映像的 ARM 资源标识符。池中的计算节点将使用该图像ID创建。这类格式为 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} 或 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}，始终默认使用最新的图像版本。该属性与其他 ImageReference 属性互斥。 Azure 计算库镜像必须在与 Azure 批处理账户相同区域内有副本，并且订阅也必须与 Azure Batch 账户相同。如果imageId中未指定镜像版本，则使用最新版本。有关批处理计算节点代理与批处理服务通信的防火墙设置，请参见 https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration。

CachingType

枚举

缓存类型枚举

值	说明
none	未启用磁盘的缓存模式。
readonly	磁盘的缓存模式是只读的。
readwrite	磁盘的缓存模式是读取和写入的。

CifsMountConfiguration

对象

用于连接到 CIFS 文件系统的信息。

名称	类型	说明
mountOptions	string	要传递给装载命令的其他命令行选项。这些是 Windows 中的“net use”选项，Linux 中的“装载”选项。
password	string (password)	用于针对 CIFS 文件系统进行身份验证的密码。
relativeMountPath	string	计算节点上的相对路径，文件系统将被挂载。所有文件系统都相对于 Batch 装载目录进行装载，可通过AZ_BATCH_NODE_MOUNTS_DIR环境变量进行访问。
source	string	要装载的文件系统的 URI。
username	string	用于对 CIFS 文件系统进行身份验证的用户。

ContainerHostBatchBindMountEntry

对象

要装载到任务容器的路径和装载模式的条目。

名称	类型	说明
isReadOnly	boolean	将此源路径装载为只读模式或不装载。默认值为 false（读/写模式）。对于 Linux，如果将此路径装载为读/写模式，这并不意味着容器中的所有用户都具有路径的读/写访问权限，这取决于主机 VM 中的访问。如果此路径装载为只读，则容器中的所有用户将无法修改路径。
source	ContainerHostDataPath	装载到容器客户的路径可以选择。

ContainerHostDataPath

枚举

将装载到容器任务的容器的路径。

值	说明
Shared	用于共享其文件的多实例任务的路径。
Startup	启动任务的路径。
VfsMounts	该路径包含此节点上装载的所有虚拟文件系统。
Task	任务路径。
JobPrep	作业准备任务路径。
Applications	应用程序路径。

ContainerRegistryReference

对象

专用容器注册表。

名称	类型	说明
identityReference	BatchNodeIdentityReference	对用于访问 Azure 容器注册表（而不是用户名和密码）的用户分配标识的引用。
password	string (password)	登录到注册表服务器的密码。
registryServer	string (uri)	注册表 URL。如果省略，则默认值为“docker.io”。
username	string	要登录到注册表服务器的用户名。

ContainerType

枚举

ContainerType 枚举

值	说明
dockerCompatible	Docker 兼容的容器技术将用于启动容器。
criCompatible	基于 CRI 的技术将用于启动容器。

ContainerWorkingDirectory

枚举

ContainerWorkingDirectory 枚举

值	说明
taskWorkingDirectory	使用标准的批处理服务任务工作目录，该目录将包含由批处理填充的任务资源文件。
containerImageDefault	使用容器 Image 中定义的工作目录。注意该目录不会包含批处理下载的资源文件。

DataDisk

对象

与池中的计算节点关联的数据磁盘将使用的设置。使用附加的数据磁盘时，需要从 VM 中装载磁盘并设置磁盘格式才能使用这些磁盘。

名称	类型	说明
caching	CachingType	要为数据磁盘启用的缓存类型。缓存的默认值为 readwrite。有关缓存选项的信息，请参阅：https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/。
diskSizeGB	integer (int32)	初始磁盘大小（以 GB 为单位）。
lun	integer (int32)	逻辑单元号。 logicalUnitNumber 用于唯一标识每个数据磁盘。如果附加多个磁盘，每个磁盘应具有不同的 logicalUnitNumber。该值必须介于 0 和 63 之间（含）。
managedDisk	ManagedDisk	托管磁盘参数。
storageAccountType	StorageAccountType	要用于数据磁盘的存储帐户类型。如果省略，则默认值为“standard_lrs”。

DiffDiskPlacement

枚举

规定了作系统中所有计算节点（虚拟机）磁盘的临时磁盘位置。此属性可由请求中的用户使用，以选择操作系统应位于的位置。例如，用于临时 OS 磁盘预配的缓存磁盘空间。有关临时作系统磁盘大小要求的更多信息，请参阅Windows虚拟机的临时作系统磁盘容量要求，访问https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements

值	说明
cachedisk	临时 OS 磁盘存储在 VM 缓存中。

DiskCustomerManagedKey

对象

用于加密磁盘的客户管理的密钥引用。

名称	类型	说明
identityReference	BatchPoolIdentityReference	用于加密磁盘的池标识之一的引用。此标识将用于访问 KeyVault。
keyUrl	string	指向 KeyVault 中的密钥的完全版本控制密钥 URL。无论 rotationToLatestKeyVersionEnabled 值如何，都需要 URL 的版本段。
rotationToLatestKeyVersionEnabled	boolean	将此标志设置为 true 以启用磁盘加密自动更新到最新的密钥版本。默认值为 false。

DiskEncryptionConfiguration

对象

在池中的计算节点上应用的磁盘加密配置。使用 Azure 计算库映像创建的 Linux 池不支持磁盘加密配置。

名称	类型	说明
customerManagedKey	DiskCustomerManagedKey	用于加密 OS 磁盘的客户管理密钥引用。客户管理的密钥将通过 EncryptionAtRest 加密 OS 磁盘，默认情况下，我们还将加密数据磁盘。仅当池配置了标识并且 OsDisk 设置为 DiskEncryption 的目标之一时，才能使用它。
targets	DiskEncryptionTarget[]	磁盘目标 Batch 服务将在计算节点上加密。磁盘目标 Batch 服务将在计算节点上加密。

DiskEncryptionSetParameters

对象

磁盘加密集的 ARM 资源 ID。

名称	类型	说明
id	string (arm-id)	磁盘加密集的 ARM 资源 ID。资源必须与 Batch 帐户位于同一订阅中。

DiskEncryptionTarget

枚举

DiskEncryptionTarget 枚举

值	说明
osdisk	计算节点上的 OS 磁盘已加密。
temporarydisk	计算节点上的临时磁盘已加密。在 Linux 上，此加密适用于在启动时进行加密时的其他分区（例如装载的数据磁盘上的分区）。

DynamicVNetAssignmentScope

枚举

DynamicVNetAssignmentScope enums

值	说明
none	未启用动态 VNet 分配。
job	动态 VNet 分配按作业完成。

ElevationLevel

枚举

高程层枚举

值	说明
nonadmin	用户是没有提升访问权限的标准用户。
admin	用户是具有提升访问权限并具有完全管理员权限的用户。

EnvironmentSetting

对象

要对任务进程设置的环境变量。

名称	类型	说明
name	string	环境变量的名称。
value	string	环境变量的值。

HostEndpointSettings

对象

指定特定的主机终结点设置。

名称	类型	说明
inVMAccessControlProfileReferenceId	string	以 /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} 的形式指定对 InVMAccessControlProfileVersion 资源 ID 的引用。
mode	HostEndpointSettingsModeTypes	指定访问控制策略执行模式。

HostEndpointSettingsModeTypes

枚举

HostEndpointSettingsModeTypes 枚举

值	说明
Audit	在审核模式下，系统就像强制实施访问控制策略一样，包括在日志中发出访问拒绝条目，但它实际上不会拒绝对主机终结点的任何请求。
Enforce	强制模式是推荐的作模式，系统将执行访问控制策略。该属性不能与“inVMAccessControlProfileReferenceId”一起使用。

InboundEndpointProtocol

枚举

InboundEndpointProtocol 枚举

值	说明
tcp	对终结点使用 TCP。
udp	对终结点使用 UDP。

IpAddressProvisioningType

枚举

IPAddressProvisioningType 枚举

值	说明
batchmanaged	公共 IP 将由 Batch 创建和管理。可能有多个公共 IP，具体取决于池的大小。
usermanaged	公共 IP 由用户提供，用于预配计算节点。
nopublicipaddresses	不会创建公共IP地址。

IPFamily

枚举

用于指定池可用的 IP 版本的 IP 系列。

值	说明
IPv4	IPv4 是池的。
IPv6	IPv6 是池可用的。

IPTag

对象

包含与公共 IP 地址关联的 IP 标记。

名称	类型	说明
ipTagType	string	IP 标记类型。示例：FirstPartyUsage。
tag	string	与公共 IP 关联的 IP 标记的值。示例：SQL。

LinuxUserConfiguration

对象

用于在 Linux 计算节点上创建用户帐户的属性。

名称	类型	说明
gid	integer (int32)	用户账户的群组ID。 uid 和 gid 属性必须同时指定或根本不指定。如果未指定基础操作系统，则选取 gid。
sshPrivateKey	string (password)	用户账户的SSH私钥。私钥不得受密码保护。当 Linux 池的 enableInterNodeCommunication 属性为真时，私钥用于自动配置基于非对称密钥的 SSH 认证（如果 enableInterNodeCommunication 为假则忽略）。它通过将密钥对放入用户的 .ssh 目录来执行此操作。如果未指定，计算节点之间不会配置无密码SSH（用户的.ssh目录不进行修改）。
uid	integer (int32)	用户账户的用户ID。 uid 和 gid 属性必须同时指定或根本不指定。如果未指定基础操作系统，则选取 uid。

LoginMode

枚举

登录模式枚举

值	说明
batch	LOGON32_LOGON_BATCH Win32 登录模式。对于长时间运行的并行进程，建议使用批处理登录模式。
interactive	LOGON32_LOGON_INTERACTIVE Win32 登录模式。 Windows 虚拟机配置池启用了 UAC。如果在 Windows 虚拟机配置池中以提升用户身份使用该选项，用户会话不会被提升，除非任务命令行执行的应用程序配置为始终需要管理员权限或始终要求最大权限。

ManagedDisk

对象

托管磁盘参数。

名称	类型	说明
diskEncryptionSet	DiskEncryptionSetParameters	指定托管磁盘的客户托管磁盘加密集资源 ID。它只能在 UserSubscription 模式下设置。
securityProfile	BatchVmDiskSecurityProfile	指定托管磁盘的安全配置文件设置。
storageAccountType	StorageAccountType	托管磁盘的存储帐户类型。

MountConfiguration

对象

要在每个节点上装载的文件系统。

名称	类型	说明
azureBlobFileSystemConfiguration	AzureBlobFileSystemConfiguration	在每个节点上使用 blob FUSE 装载的 Azure 存储容器。此属性与其他所有属性互斥。
azureFileShareConfiguration	AzureFileShareConfiguration	要在每个节点上装载的 Azure 文件共享。此属性与其他所有属性互斥。
cifsMountConfiguration	CifsMountConfiguration	要在每个节点上装载的 CIFS/SMB 文件系统。此属性与其他所有属性互斥。
nfsMountConfiguration	NfsMountConfiguration	要在每个节点上装载的 NFS 文件系统。此属性与其他所有属性互斥。

NetworkConfiguration

对象

池的网络配置。

名称	类型	说明
dynamicVNetAssignmentScope	DynamicVNetAssignmentScope	动态 vnet 分配的范围。
enableAcceleratedNetworking	boolean	此池是否应启用加速网络。加速网络使单个根 I/O 虚拟化（SR-IOV）能够连接到 VM，这可能会导致网络性能得到改善。有关详细信息，请参阅：https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview。
endpointConfiguration	BatchPoolEndpointConfiguration	批处理池中计算节点端点的配置。
publicIPAddressConfiguration	BatchPublicIpAddressConfiguration	Batch 池中计算节点的公共 IPAddress 配置。
subnetId	string	虚拟网络子网的ARM资源标识符，池中的计算节点将加入该子网。此格式为 /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}。虚拟网络必须与 Azure Batch 帐户位于同一区域和订阅中。指定的子网应有足够的空闲IP地址以容纳池中计算节点数量。如果子网没有足够的空闲IP地址，池会部分分配节点，导致重新大小错误。 “MicrosoftAzureBatch”服务主体必须具有指定 VNet 的“经典虚拟机参与者”Role-Based 访问控制（RBAC）角色。指定的子网必须允许Azure批处理服务的通信，才能在节点上调度任务。可以通过检查指定的 VNet 是否具有任何关联的网络安全组（NSG）来验证这一点。如果 NSG 拒绝与指定子网中的节点的通信，Batch 服务会将计算节点的状态设置为不可用。仅支持 ARM 虚拟网络（“Microsoft.Network/virtualNetworks”）。如果指定的VNet存在任何关联的网络安全组（NSG），则必须启用几个预留的系统端口用于入站通信，包括端口29876和29877。此外，在端口 443 上启用到 Azure 存储的出站连接。有关详细信息，请参阅：https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

对象

要应用于入站终结点的网络安全组规则。

名称	类型	说明
access	NetworkSecurityGroupRuleAccess	应对指定 IP 地址、子网范围或标记执行的操作。
priority	integer (int32)	此规则的优先级。池内的优先级必须是唯一的，并按优先级顺序进行评估。优先级越高的数字越低。例如，可以使用订单号 150、250 和 350 指定规则。顺序编号为 150 的规则优先于顺序为 250 的规则。允许的优先级为 150 到 4096。如果提供了任何保留值或重复值，则请求失败并显示 HTTP 状态代码 400。
sourceAddressPrefix	string	要匹配规则的源地址前缀或标记。有效值为单个 IP 地址（即 10.10.10.10）、IP 子网（即 192.168.1.0/24）、默认标记或 * （适用于所有地址）。如果提供了任何其他值，请求将失败并显示 HTTP 状态代码 400。
sourcePortRanges	string[]	要匹配规则的源端口范围。有效的数值包括“'（适用于所有端口0-65535）、特定端口（即22）或端口范围（如100-200）。端口必须在0到65535之间。本集合中的每个条目不得与其他条目重叠（无论是某个范围还是单个端口）。如果提供其他值，请求将以HTTP状态代码400失败。默认值为“'。

NetworkSecurityGroupRuleAccess

枚举

NetworkSecurityGroupRuleAccess 枚举

值	说明
allow	允许访问。
deny	拒绝访问。

NfsMountConfiguration

对象

用于连接到 NFS 文件系统的信息。

名称	类型	说明
mountOptions	string	要传递给装载命令的其他命令行选项。这些是 Windows 中的“net use”选项，Linux 中的“装载”选项。
relativeMountPath	string	计算节点上的相对路径，文件系统将被挂载。所有文件系统都相对于 Batch 装载目录进行装载，可通过AZ_BATCH_NODE_MOUNTS_DIR环境变量进行访问。
source	string	要装载的文件系统的 URI。

ProxyAgentSettings

对象

在创建虚拟机时指定 ProxyAgent 设置。

名称	类型	说明
enabled	boolean	指定是否应在虚拟机或虚拟机规模集上启用元数据安全协议功能。默认值为 False。
imds	HostEndpointSettings	IMDS 端点的设置。
wireServer	HostEndpointSettings	WireServer 终结点的设置。

ResourceFile

对象

要下载到计算节点的单个文件或多个文件。

名称	类型	说明
autoStorageContainerName	string	自动存储账户中的存储容器名称。 autoStorageContainerName、storageContainerUrl 和 httpUrl 属性互斥，必须指定其中一个属性。
blobPrefix	string	从 Azure 存储容器下载 Blob 时要使用的 Blob 前缀。仅下载名称以指定前缀开头的 blob。仅当使用 autoStorageContainerName 或 storageContainerUrl 时，该属性才有效。此前缀可以是部分文件名或子目录。如果未指定前缀，则会下载容器中的所有文件。
fileMode	string	以八进制格式的文件权限模式属性。该特性仅适用于下载到 Linux 计算节点的文件。如果为将下载到 Windows 计算节点的资源文件指定了该文件，则该文件将被忽略。如果Linux计算节点未指定该属性，则默认值为0770。
filePath	string	计算节点上相对于任务工作目录下载文件的位置。如果指定了 httpUrl 属性，则需要 filePath，并描述文件将下载到的路径，包括文件名。否则，如果指定 autoStorageContainerName 或 storageContainerUrl 属性，则 filePath 是可选的，并且是将文件下载到的目录。如果 filePath 用作目录，则与输入数据关联的任何目录结构都将完整保留并追加到指定的 filePath 目录。指定的相对路径不能从任务的工作目录中跳出（例如使用“..”）。
httpUrl	string (uri)	要下载的文件的 URL。 autoStorageContainerName、storageContainerUrl 和 httpUrl 属性互斥，必须指定其中一个属性。如果 URL 指向 Azure Blob 存储，则必须从计算节点读取该 URL。可通过三种方法获取 Azure 存储中 Blob 的此类 URL：包括授予对 Blob 的读取权限的共享访问签名（SAS），使用具有读取权限的托管标识，或为 Blob 或其容器设置 ACL 以允许公共访问。
identityReference	BatchNodeIdentityReference	指的是用来访问 Azure Blob 存储的用户指定身份，由 storageContainerUrl 或 httpURL 指定。
storageContainerUrl	string (uri)	Azure Blob 存储中 Blob 容器的 URL。 autoStorageContainerName、storageContainerUrl 和 httpUrl 属性互斥，必须指定其中一个属性。此 URL 必须可从计算节点读取和列出。可通过三种方法获取 Azure 存储中容器的此类 URL：包括授予对容器的读取和列表权限的共享访问签名（SAS），使用具有读取和列表权限的托管标识，或为容器设置 ACL 以允许公共访问。

RollingUpgradePolicy

对象

执行滚动升级时使用的配置参数。

名称	类型	说明
enableCrossZoneUpgrade	boolean	允许 VMSS 在构造升级批处理时忽略 AZ 边界。考虑 Update 域和 maxBatchInstancePercent 以确定批大小。仅当将 NodePlacementConfiguration 用作 Zonal 时，此字段才可设置为 true 或 false。
maxBatchInstancePercent	integer (int32)	一批滚动升级同时升级的总虚拟机实例的最大百分比。由于这是一个最大值，因此以前的或将来的批中的不正常实例可能会导致批处理中的实例百分比降低，以确保更高的可靠性。此字段的值应介于 5 和 100 之间（含）。如果 maxBatchInstancePercent 和 maxUnhealthyInstancePercent 都赋值，则 maxBatchInstancePercent 的值不应大于 maxUnhealthyInstancePercent。
maxUnhealthyInstancePercent	integer (int32)	规模集中可能同时运行不正常的虚拟机实例的最大百分比，无论是由于升级，还是虚拟机运行状况检查在滚动升级中止之前处于不正常状态。在启动任何批处理之前，将检查此约束。此字段的值应介于 5 和 100 之间（含）。如果 maxBatchInstancePercent 和 maxUnhealthyInstancePercent 都赋值，则 maxBatchInstancePercent 的值不应大于 maxUnhealthyInstancePercent。
maxUnhealthyUpgradedInstancePercent	integer (int32)	可发现处于不正常状态的已升级虚拟机实例的最大百分比。升级每个批处理后，将进行此检查。如果超过此百分比，滚动更新将中止。此字段的值应介于 0 和 100 之间（含）。
pauseTimeBetweenBatches	string (duration)	完成一批中所有虚拟机的更新和开始下一批之间的等待时间。持续时间应采用 ISO 8601 格式指定。
prioritizeUnhealthyInstances	boolean	在任何正常运行的实例之前，升级规模集中的所有不正常实例。
rollbackFailedInstancesOnPolicyBreach	boolean	如果违反滚动升级策略，回滚失败实例到以前的模型。

SecurityEncryptionTypes

枚举

安全性加密类型枚举

值	说明
DiskWithVMGuestState	托管磁盘的 EncryptionType 设置为 DiskWithVMGuestState，以便对托管磁盘和 VMGuestState blob 进行加密。数据磁盘不支持此功能。
NonPersistedTPM	托管磁盘的 EncryptionType 设置为 NonPersistedTPM，以便不在 VMGuestState blob 中保留固件状态。
VMGuestStateOnly	托管磁盘的 EncryptionType 设置为 VMGuestStateOnly，以便仅对 VMGuestState blob 进行加密。

SecurityProfile

对象

指定虚拟机或虚拟机规模集的安全配置文件设置。

名称	类型	说明
encryptionAtHost	boolean	用户可以在请求中使用此属性来启用或禁用虚拟机或虚拟机规模集的主机加密。这将为所有磁盘启用加密，包括主机本身的资源/临时磁盘。有关主机要求加密的详细信息，请参阅 https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizes。
proxyAgentSettings	ProxyAgentSettings	在创建虚拟机时指定 ProxyAgent 设置。
securityType	SecurityTypes	指定虚拟机的 SecurityType。必须将其设置为任何指定值才能启用 UefiSettings。
uefiSettings	BatchUefiSettings	指定在创建虚拟机时使用的安全启动和 vTPM 等安全设置。指定在创建虚拟机时使用的安全启动和 vTPM 等安全设置。

SecurityTypes

枚举

指定虚拟机的 SecurityType。必须将其设置为任何指定值才能启用 UefiSettings。

值	说明
trustedLaunch	受信任启动能够防范具有持续性的高级攻击手法。
confidentialvm	Azure 机密计算为具有高安全性和机密性要求的租户提供机密 VM。这些虚拟机提供了强大的硬件强制边界，可帮助满足你的安全需求。可以使用机密 VM 进行迁移，而无需更改代码，而平台可保护 VM 的状态不被读取或修改。

ServiceArtifactReference

对象

指定使用“latest”映像版本时，用于为规模集中的所有虚拟机设置相同映像版本的服务项目引用 ID。

名称	类型	说明
id	string	ServiceArtifactReference 的服务工件引用 ID。以 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} 的形式的服务项目引用 ID

StorageAccountType

枚举

StorageAccountType 枚举

值	说明
standard_lrs	数据磁盘应使用标准的本地冗余存储。
premium_lrs	数据磁盘应使用高级本地冗余存储。
standardssd_lrs	数据磁盘/OS 磁盘应使用标准 SSD 本地冗余存储。

UpgradeMode

枚举

升级模式枚举

值	说明
automatic	规模集中的所有虚拟机都会同时自动更新。
manual	可以控制对规模集中虚拟机的更新的应用程序。使用 manualUpgrade 操作执行此操作。
rolling	规模集中的现有实例将分批关闭以升级。升级后的批处理完成后，实例将再次开始获取流量，下一批将开始。这一直持续到所有实例 up-to-date。

UpgradePolicy

对象

描述升级策略 - 自动、手动或滚动。

名称	类型	说明
automaticOSUpgradePolicy	AutomaticOsUpgradePolicy	用于执行自动 OS 升级的配置参数。用于执行自动 OS 升级的配置参数。
mode	UpgradeMode	指定升级到规模集中虚拟机的模式。可能的值为：手动 - 控制对规模集中虚拟机的更新的应用程序。使用 manualUpgrade 操作执行此操作。自动 - 规模集中的所有虚拟机同时自动更新。滚动 - 规模集按批执行更新，并在两者之间有可选的暂停时间。
rollingUpgradePolicy	RollingUpgradePolicy	执行滚动升级时使用的配置参数。

UserAccount

对象

用于创建用于在 Azure Batch 计算节点上执行任务的用户的属性。

名称	类型	说明
elevationLevel	ElevationLevel	用户账户的海拔等级。默认值为 nonAdmin。
linuxUserConfiguration	LinuxUserConfiguration	Linux专用的用户配置。如果在 Windows 池中指定了该属性，则会被忽略。如果未指定，则使用默认选项创建用户。
name	string	用户账户名称。名称可以包含最大长度为 20 的任何 Unicode 字符。
password	string (password)	用户账户的密码。
windowsUserConfiguration	WindowsUserConfiguration	Windows专用用户账户配置。该属性只有在用户处于 Windows 池中时才能指定。如果未指定且在 Windows 池中，用户会被创建为默认选项。

UserIdentity

对象

运行任务的用户标识的定义。指定 userName 或 autoUser 属性，但不能同时指定这两者。

名称	类型	说明
autoUser	AutoUserSpecification	任务运行的自动用户。 userName 和 autoUser 属性互斥;必须指定一个，但不能同时指定两者。
username	string	任务运行时所用的用户身份名称。 userName 和 autoUser 属性互斥;必须指定一个，但不能同时指定两者。

VirtualMachineConfiguration

对象

基于 Azure 虚拟机基础结构的池中计算节点的配置。

名称	类型	说明
containerConfiguration	BatchContainerConfiguration	泳池的容器配置。如有指定，会在池中的每个计算节点上进行设置，以允许任务在容器中运行。所有在该池上运行的常规任务和作业管理器任务都必须指定 containerSettings 属性，其他所有任务也可以指定该属性。
dataDisks	DataDisk[]	连接在计算节点池中的数据磁盘配置。如果池中的计算节点需要连接空数据盘，必须指定该属性。这无法更新。每个计算节点都有自己的磁盘（磁盘不是文件共享）。现有的磁盘无法连接，每个连接的磁盘都是空的。当计算节点从池中移除时，磁盘及其所有关联的数据也会被删除。磁盘安装后不进行格式化，必须在使用前格式化——更多信息请参见 https://learn.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux 和 https://learn.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine。
diskEncryptionConfiguration	DiskEncryptionConfiguration	池的磁盘加密配置。如果指定了加密，则会在节点预配期间对池中的每个节点执行加密。
extensions	VMExtension[]	池的虚拟机扩展。如果指定，此配置中提到的扩展将安装在每个节点上。
imageReference	BatchVmImageReference	对 Azure 虚拟机市场映像或要使用的自定义虚拟机映像的引用。
licenseType	string	这仅适用于包含Windows作系统的镜像，且仅在你持有将部署计算节点的有效本地许可时使用。如果省略，则不会应用本地许可折扣。值为： Windows_Server - 本地许可证适用于 Windows Server。 Windows_Client - 本地许可证适用于 Windows 客户端。
nodeAgentSKUId	string	要在池中的计算节点上预配的 Batch 计算节点代理的 SKU。 Batch 计算节点代理是在池中的每个计算节点上运行的程序，并在计算节点和 Batch 服务之间提供命令和控制接口。对于不同的操作系统，计算节点代理有不同的实现（称为 SKU）。必须指定与所选映像引用匹配的计算节点代理 SKU。若要获取支持的计算节点代理 SKU 及其已验证映像引用列表，请参阅“列出支持的计算节点代理 SKU”操作。
nodePlacementConfiguration	BatchNodePlacementConfiguration	池的节点放置配置。此配置将指定池中节点的物理分配方式的规则。
osDisk	BatchOsDisk	虚拟机操作系统磁盘的设置。
securityProfile	SecurityProfile	指定虚拟机或虚拟机规模集的安全配置文件设置。
serviceArtifactReference	ServiceArtifactReference	指定使用“latest”映像版本时，用于为规模集中的所有虚拟机设置相同映像版本的服务项目引用 ID。以 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} 的形式的服务项目引用 ID
windowsConfiguration	WindowsConfiguration	虚拟机上的 Windows 操作系统设置。如果imageReference属性指定了Linux作系统镜像，则该属性不应被指定。

VMExtension

对象

虚拟机扩展的配置。

名称	类型	说明
autoUpgradeMinorVersion	boolean	指示扩展是否应在部署时使用较新的次要版本。但是，部署后，除非重新部署，否则扩展不会升级次要版本，即使此属性设置为 true 也是如此。
enableAutomaticUpgrade	boolean	指示如果有较新版本的扩展可用，平台是否应自动升级扩展。
name	string	虚拟机扩展的名称。
protectedSettings	object	该扩展可以包含 protectedSettings 或 protectedSettingsFromKeyVault，或者根本不包含受保护的设置。
provisionAfterExtensions	string[]	扩展名称的集合。需要预配此扩展的扩展名称的集合。
publisher	string	扩展处理程序发布者的名称。
settings	object	扩展的 JSON 格式公共设置。
type	string	分机的类型。
typeHandlerVersion	string	脚本处理程序的版本。

WindowsConfiguration

对象

要应用于虚拟机的 Windows 操作系统设置。

名称	类型	说明
enableAutomaticUpdates	boolean	是否在虚拟机上启用自动更新。如果省略，则默认值为 true。

WindowsUserConfiguration

对象

用于在 Windows 计算节点上创建用户帐户的属性。

名称	类型	说明
loginMode	LoginMode	用户的登录模式。默认是“批处理”。

通过

Pools - Create Pool

URI 参数

请求头

请求正文

响应

安全性

OAuth2Auth

作用域

示例

Creates a pool with accelerated networking

示例请求

示例响应

Creates a pool with confidential disk encryption set for user subscription accounts

示例请求

示例响应

Creates a pool with disk encryption set for user subscription accounts

示例请求

示例响应

Creates a pool with dual stack networking

示例请求

示例响应

Creates a pool with mount drive specified

示例请求

示例响应

Creates a pool with SecurityProfile

示例请求

示例响应

Creates a VirtualMachineConfiguration pool

示例请求

示例响应

Creates a VirtualMachineConfiguration pool with containers

示例请求

示例响应

Creates a VirtualMachineConfiguration pool with extensions

示例请求

示例响应

Creates a VirtualMachineConfiguration pool with OS disk

示例请求

示例响应

Creates a VirtualMachineConfiguration pool with ServiceArtifactReference

示例请求

示例响应

定义

AutomaticOsUpgradePolicy

AutoUserScope

AutoUserSpecification

AzureBlobFileSystemConfiguration

AzureFileShareConfiguration

BatchApplicationPackageReference

BatchContainerConfiguration

BatchDiffDiskSettings

BatchError

BatchErrorDetail

BatchErrorMessage

BatchInboundNatPool

BatchJobDefaultOrder

BatchMetadataItem

BatchNodeFillType

BatchNodeIdentityReference

BatchNodePlacementConfiguration

BatchNodePlacementPolicyType

BatchOsDisk

BatchPoolCreateOptions

BatchPoolEndpointConfiguration

BatchPoolIdentityReference

BatchPublicIpAddressConfiguration

BatchStartTask

BatchTaskContainerSettings

BatchTaskSchedulingPolicy

BatchUefiSettings

BatchVmDiskSecurityProfile

BatchVmImageReference

CachingType

CifsMountConfiguration

ContainerHostBatchBindMountEntry

ContainerHostDataPath

ContainerRegistryReference

ContainerType

ContainerWorkingDirectory