Pool - Create

服务:

Batch Management

API 版本:

2024-07-01

在指定的帐户内创建新池。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}?api-version=2024-07-01

URI 参数

名称	在	必需	类型	说明
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[a-zA-Z0-9]+$	批次账户的名称必须在该地区内独一无二。 批量账户名称必须在3到24个字符之间，且只能使用数字和小写字母。 该名称作为访问账户创建区域的批量服务的DNS名称的一部分。 例如： http://accountname.region.batch.azure.com/。
poolName	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9_-]+$	池名称。 这在帐户中必须是唯一的。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 此名称不区分大小写。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。 该值必须是 UUID。
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。

请求头

名称	必需	类型	说明
If-Match		string	要更新的池的实体状态 （ETag） 版本。 仅当池已存在时，才能使用值“*”应用操作。 如果省略，将始终应用此操作。
If-None-Match		string	设置为“*”以允许创建新池，但要防止更新现有池。 将忽略其他值。

请求正文

名称	类型	说明
identity	BatchPoolIdentity	用于 Batch 池的标识类型。
properties.applicationLicenses	string[]	Batch 服务将在池中的每个计算节点上可用的应用程序许可证列表。 应用程序许可证列表必须是可用 Batch 服务应用程序许可证的子集。 如果请求的许可证不受支持，则池创建将失败。
properties.applicationPackages	ApplicationPackageReference[]	要安装在池中每个计算节点上的应用程序包的列表。 对应用程序包引用的更改会影响所有加入池的新计算节点，但在重新启动或重新映像之前，不会影响池中已有的计算节点。 任何给定池上最多有 10 个应用程序包引用。
properties.certificates	CertificateReference[]	要安装在池中每个计算节点上的证书列表。 对于 Windows 计算节点，Batch 服务会将证书安装到指定的证书存储和位置。 对于 Linux 计算节点，证书存储在任务工作目录中的目录中，并向任务提供环境变量AZ_BATCH_CERTIFICATES_DIR以查询此位置。 对于可见性为“remoteUser”的证书，将在用户的主目录中（例如 /home/{user-name}/certs）中创建一个“certs”目录，并将证书置于该目录中。 警告：此属性已弃用，将在 2024 年 2 月之后删除。 请改用 Azure KeyVault 扩展。
properties.deploymentConfiguration	DeploymentConfiguration	此属性描述池节点将部署到的虚拟机。 部署配置属性。
properties.displayName	string	池的显示名称。 显示名称不一定是唯一的，可以包含最大长度为 1024 的任何 Unicode 字符。
properties.interNodeCommunication	InterNodeCommunicationState	池是否允许在节点之间直接通信。 这会对可分配给池的节点施加限制。 启用此值可以减少在池中分配请求的节点数的可能性。 如果未指定，则此值默认为“Disabled”。
properties.metadata	MetadataItem[]	与池关联的名称/值对列表作为元数据。 Batch 服务不向元数据分配任何含义;它仅用于使用用户代码。
properties.mountConfiguration	MountConfiguration[]	要安装在池中每个节点上的文件系统列表。 这支持 Azure 文件存储、NFS、CIFS/SMB 和 Blobfuse。
properties.networkConfiguration	NetworkConfiguration	池的网络配置。 池的网络配置。
properties.resourceTags	object	与池关联的用户指定的标记。 要与 Azure Batch 池关联的用户定义的标记。 指定后，这些标记将传播到与池关联的支持 Azure 资源。 仅当使用 poolAllocationMode 属性设置为“UserSubscription”创建的 Batch 帐户时，才能指定此属性。
properties.scaleSettings	ScaleSettings	配置池中节点数的设置。 定义池的所需大小。 这可以是指定所请求的目标DedicatedNode 的“fixedScale”，也可以是定义定期重新计算的公式的“autoScale”。 如果未指定此属性，则池将具有具有 0 个 targetDedicatedNodes 的固定缩放。
properties.startTask	StartTask	指定在联接池时在每个计算节点上运行的任务。 在 PATCH（更新）操作中，此属性可以设置为空对象，以从池中删除启动任务。
properties.targetNodeCommunicationMode	NodeCommunicationMode	确定池如何与 Batch 服务通信。 如果省略，则默认值为 Default。
properties.taskSchedulingPolicy	TaskSchedulingPolicy	如何跨池中的计算节点分配任务。 如果未指定，则默认为分散。
properties.taskSlotsPerNode	integer (int32)	可用于在池中的单个计算节点上运行并发任务的任务槽数。 默认值为 1。 最大值是池的 vmSize 核心数或 256 的 4 倍。
properties.upgradePolicy	UpgradePolicy	池的升级策略。 描述升级策略 - 自动、手动或滚动。
properties.userAccounts	UserAccount[]	将在池中的每个节点上创建的用户帐户列表。
properties.vmSize	string	池中虚拟机的大小。 池中的所有 VM 大小相同。 有关可用 VM 大小的信息，请参阅 Azure 中虚拟机的大小（https://learn.microsoft.com/azure/virtual-machines/sizes/overview）。 Batch 支持除STANDARD_A0和具有高级存储（STANDARD_GS、STANDARD_DS和STANDARD_DSV2系列）之外的所有 Azure VM 大小。
tags	object	资源的标记。

响应

名称	类型	说明
200 OK	Pool	请求已成功。 标头 ETag: string
Other Status Codes	CloudError	意外错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

CreatePool - accelerated networking

CreatePool - Custom Image

CreatePool - Full VirtualMachineConfiguration

CreatePool - Minimal VirtualMachineConfiguration

CreatePool - No public IP

CreatePool - Public IPs

CreatePool - ResourceTags

CreatePool - SecurityProfile

CreatePool - Tags

CreatePool - UpgradePolicy

CreatePool - UserAssignedIdentities

CreatePool - VirtualMachineConfiguration Extensions

CreatePool - VirtualMachineConfiguration OSDisk

CreatePool - VirtualMachineConfiguration ServiceArtifactReference

CreatePool - accelerated networking

示例请求

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01

{
  "properties": {
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "offer": "WindowsServer",
          "publisher": "MicrosoftWindowsServer",
          "sku": "2016-datacenter-smalldisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64"
      }
    },
    "networkConfiguration": {
      "enableAcceleratedNetworking": true,
      "subnetId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123"
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0
      }
    },
    "vmSize": "STANDARD_D1_V2"
  }
}

示例响应

状态代码:

200

ETag: W/"0x8DB46CB72A227E2"

{
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "properties": {
    "allocationState": "Steady",
    "allocationStateTransitionTime": "2023-04-27T03:00:34.0646502Z",
    "creationTime": "2023-04-27T02:59:41.8592226Z",
    "currentDedicatedNodes": 1,
    "currentLowPriorityNodes": 0,
    "currentNodeCommunicationMode": "Classic",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "offer": "WindowsServer",
          "publisher": "MicrosoftWindowsServer",
          "sku": "2016-datacenter-smalldisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64"
      }
    },
    "interNodeCommunication": "Disabled",
    "lastModified": "2023-04-27T02:59:41.8592226Z",
    "networkConfiguration": {
      "dynamicVnetAssignmentScope": "none",
      "enableAcceleratedNetworking": true,
      "subnetId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123"
    },
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2023-04-27T02:59:41.8592226Z",
    "resizeOperationStatus": {
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M",
      "startTime": "2023-04-27T02:59:41.8592226Z",
      "targetDedicatedNodes": 1
    },
    "scaleSettings": {
      "fixedScale": {
        "resizeTimeout": "PT15M",
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0
      }
    },
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "taskSlotsPerNode": 1,
    "vmSize": "STANDARD_D1_V2"
  }
}

CreatePool - Custom Image

示例请求

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01

{
  "properties": {
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "vmSize": "STANDARD_D4"
  }
}

示例响应

状态代码:

200

ETag: W/"0x8D4EDFEBFADF4AB"

{
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "properties": {
    "allocationState": "Steady",
    "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "creationTime": "2017-08-28T10:22:55.9407275Z",
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0,
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "interNodeCommunication": "Disabled",
    "lastModified": "2017-08-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 0,
        "targetLowPriorityNodes": 0
      }
    },
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "taskSlotsPerNode": 1,
    "vmSize": "STANDARD_D4"
  }
}

CreatePool - Full VirtualMachineConfiguration

示例请求

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01

{
  "properties": {
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "dataDisks": [
          {
            "caching": "ReadWrite",
            "diskSizeGB": 30,
            "lun": 0,
            "storageAccountType": "Premium_LRS"
          },
          {
            "caching": "None",
            "diskSizeGB": 200,
            "lun": 1,
            "storageAccountType": "Standard_LRS"
          }
        ],
        "diskEncryptionConfiguration": {
          "targets": [
            "OsDisk",
            "TemporaryDisk"
          ]
        },
        "imageReference": {
          "offer": "WindowsServer",
          "publisher": "MicrosoftWindowsServer",
          "sku": "2016-Datacenter-SmallDisk",
          "version": "latest"
        },
        "licenseType": "Windows_Server",
        "nodeAgentSkuId": "batch.node.windows amd64",
        "nodePlacementConfiguration": {
          "policy": "Zonal"
        },
        "osDisk": {
          "ephemeralOSDiskSettings": {
            "placement": "CacheDisk"
          }
        },
        "windowsConfiguration": {
          "enableAutomaticUpdates": false
        }
      }
    },
    "networkConfiguration": {
      "endpointConfiguration": {
        "inboundNatPools": [
          {
            "name": "testnat",
            "backendPort": 12001,
            "frontendPortRangeEnd": 15100,
            "frontendPortRangeStart": 15000,
            "networkSecurityGroupRules": [
              {
                "access": "Allow",
                "priority": 150,
                "sourceAddressPrefix": "192.100.12.45",
                "sourcePortRanges": [
                  "1",
                  "2"
                ]
              },
              {
                "access": "Deny",
                "priority": 3500,
                "sourceAddressPrefix": "*",
                "sourcePortRanges": [
                  "*"
                ]
              }
            ],
            "protocol": "TCP"
          }
        ]
      }
    },
    "scaleSettings": {
      "autoScale": {
        "evaluationInterval": "PT5M",
        "formula": "$TargetDedicatedNodes=1"
      }
    },
    "vmSize": "STANDARD_D4"
  }
}

示例响应

状态代码:

200

ETag: W/"0x8D4EDFEBFADF4AB"

{
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "properties": {
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "creationTime": "2017-08-28T10:22:55.9407275Z",
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0,
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "dataDisks": [
          {
            "caching": "ReadWrite",
            "diskSizeGB": 30,
            "lun": 0,
            "storageAccountType": "Premium_LRS"
          },
          {
            "caching": "None",
            "diskSizeGB": 200,
            "lun": 1,
            "storageAccountType": "Standard_LRS"
          }
        ],
        "diskEncryptionConfiguration": {
          "targets": [
            "OsDisk",
            "TemporaryDisk"
          ]
        },
        "imageReference": {
          "offer": "WindowsServer",
          "publisher": "MicrosoftWindowsServer",
          "sku": "2016-Datacenter-SmallDisk",
          "version": "latest"
        },
        "licenseType": "Windows_Server",
        "nodeAgentSkuId": "batch.node.windows amd64",
        "nodePlacementConfiguration": {
          "policy": "Zonal"
        },
        "windowsConfiguration": {
          "enableAutomaticUpdates": false
        }
      }
    },
    "interNodeCommunication": "Disabled",
    "lastModified": "2017-08-28T10:22:55.9407275Z",
    "networkConfiguration": {
      "endpointConfiguration": {
        "inboundNatPools": [
          {
            "name": "testnat",
            "backendPort": 12001,
            "frontendPortRangeEnd": 15100,
            "frontendPortRangeStart": 15000,
            "networkSecurityGroupRules": [
              {
                "access": "Allow",
                "priority": 150,
                "sourceAddressPrefix": "192.100.12.45",
                "sourcePortRanges": [
                  "1",
                  "2"
                ]
              },
              {
                "access": "Deny",
                "priority": 3500,
                "sourceAddressPrefix": "*",
                "sourcePortRanges": [
                  "*"
                ]
              }
            ],
            "protocol": "TCP"
          }
        ]
      }
    },
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "scaleSettings": {
      "autoScale": {
        "evaluationInterval": "PT5M",
        "formula": "$TargetDedicatedNodes=1"
      }
    },
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "taskSlotsPerNode": 1,
    "vmSize": "STANDARD_D4"
  }
}

CreatePool - Minimal VirtualMachineConfiguration

示例请求

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01

{
  "properties": {
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "offer": "UbuntuServer",
          "publisher": "Canonical",
          "sku": "18.04-LTS",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "scaleSettings": {
      "autoScale": {
        "evaluationInterval": "PT5M",
        "formula": "$TargetDedicatedNodes=1"
      }
    },
    "vmSize": "STANDARD_D4"
  }
}

示例响应

状态代码:

200

ETag: W/"0x8D4EDFEBFADF4AB"

{
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "properties": {
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "creationTime": "2017-08-28T10:22:55.9407275Z",
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0,
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "offer": "UbuntuServer",
          "publisher": "Canonical",
          "sku": "18.04-LTS",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "interNodeCommunication": "Disabled",
    "lastModified": "2017-08-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "scaleSettings": {
      "autoScale": {
        "evaluationInterval": "PT5M",
        "formula": "$TargetDedicatedNodes=1"
      }
    },
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "taskSlotsPerNode": 1,
    "vmSize": "STANDARD_D4"
  }
}

CreatePool - No public IP

示例请求

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01

{
  "properties": {
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "networkConfiguration": {
      "publicIPAddressConfiguration": {
        "provision": "NoPublicIPAddresses"
      },
      "subnetId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123"
    },
    "vmSize": "STANDARD_D4"
  }
}

示例响应

状态代码:

200

ETag: W/"0x8D4EDFEBFADF4AB"

{
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "properties": {
    "allocationState": "Steady",
    "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "creationTime": "2017-08-28T10:22:55.9407275Z",
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0,
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "interNodeCommunication": "Disabled",
    "lastModified": "2017-08-28T10:22:55.9407275Z",
    "networkConfiguration": {
      "publicIPAddressConfiguration": {
        "provision": "NoPublicIPAddresses"
      },
      "subnetId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123"
    },
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 0,
        "targetLowPriorityNodes": 0
      }
    },
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "taskSlotsPerNode": 1,
    "vmSize": "STANDARD_D4"
  }
}

CreatePool - Public IPs

示例请求

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01

{
  "properties": {
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "networkConfiguration": {
      "publicIPAddressConfiguration": {
        "ipAddressIds": [
          "/subscriptions/12345678-1234-1234-1234-1234567890121/resourceGroups/rg13/providers/Microsoft.Network/publicIPAddresses/ip135"
        ],
        "provision": "UserManaged"
      },
      "subnetId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123"
    },
    "vmSize": "STANDARD_D4"
  }
}

示例响应

状态代码:

200

ETag: W/"0x8D4EDFEBFADF4AB"

{
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "properties": {
    "allocationState": "Steady",
    "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "creationTime": "2017-08-28T10:22:55.9407275Z",
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0,
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "interNodeCommunication": "Disabled",
    "lastModified": "2017-08-28T10:22:55.9407275Z",
    "networkConfiguration": {
      "publicIPAddressConfiguration": {
        "ipAddressIds": [
          "/subscriptions/12345678-1234-1234-1234-1234567890121/resourceGroups/rg13/providers/Microsoft.Network/publicIPAddresses/ip135"
        ],
        "provision": "UserManaged"
      },
      "subnetId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123"
    },
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 0,
        "targetLowPriorityNodes": 0
      }
    },
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "taskSlotsPerNode": 1,
    "vmSize": "STANDARD_D4"
  }
}

CreatePool - ResourceTags

示例请求

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01

{
  "properties": {
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "offer": "UbuntuServer",
          "publisher": "Canonical",
          "sku": "18_04-lts-gen2",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "resourceTags": {
      "TagName1": "TagValue1",
      "TagName2": "TagValue2"
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0
      }
    },
    "vmSize": "Standard_d4s_v3"
  }
}

示例响应

状态代码:

200

ETag: W/"0x8DB554F8E08BCF4"

{
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "properties": {
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2023-06-14T07:03:58.3231917Z",
    "creationTime": "2023-06-14T07:03:58.3231917Z",
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0,
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "offer": "UbuntuServer",
          "publisher": "Canonical",
          "sku": "18_04-lts-gen2",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "interNodeCommunication": "Disabled",
    "lastModified": "2023-06-14T07:03:58.3231917Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2023-06-14T07:03:58.3231917Z",
    "resizeOperationStatus": {
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M",
      "startTime": "2023-09-27T07:33:13.0625789Z",
      "targetDedicatedNodes": 1
    },
    "resourceTags": {
      "TagName1": "TagValue1",
      "TagName2": "TagValue2"
    },
    "scaleSettings": {
      "fixedScale": {
        "resizeTimeout": "PT15M",
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0
      }
    },
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "taskSlotsPerNode": 1,
    "vmSize": "STANDARD_D4S_V3"
  }
}

CreatePool - SecurityProfile

示例请求

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01

{
  "properties": {
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "offer": "UbuntuServer",
          "publisher": "Canonical",
          "sku": "18_04-lts-gen2",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04",
        "securityProfile": {
          "encryptionAtHost": true,
          "securityType": "trustedLaunch",
          "uefiSettings": {
            "secureBootEnabled": null,
            "vTpmEnabled": false
          }
        }
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0
      }
    },
    "vmSize": "Standard_d4s_v3"
  }
}

示例响应

状态代码:

200

ETag: W/"0x8DB554F8E08BCF4"

{
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "properties": {
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2023-06-14T07:03:58.3231917Z",
    "creationTime": "2023-06-14T07:03:58.3231917Z",
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0,
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "offer": "UbuntuServer",
          "publisher": "Canonical",
          "sku": "18_04-lts-gen2",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04",
        "securityProfile": {
          "encryptionAtHost": true,
          "securityType": "trustedLaunch",
          "uefiSettings": {
            "vTpmEnabled": false
          }
        }
      }
    },
    "interNodeCommunication": "Disabled",
    "lastModified": "2023-06-14T07:03:58.3231917Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2023-06-14T07:03:58.3231917Z",
    "resizeOperationStatus": {
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M",
      "startTime": "2023-06-14T07:03:58.3231917Z",
      "targetDedicatedNodes": 1
    },
    "scaleSettings": {
      "fixedScale": {
        "resizeTimeout": "PT15M",
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0
      }
    },
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "taskSlotsPerNode": 1,
    "vmSize": "STANDARD_D4S_V3"
  }
}

CreatePool - Tags

示例请求

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01

{
  "properties": {
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "offer": "0001-com-ubuntu-server-jammy",
          "publisher": "Canonical",
          "sku": "22_04-lts",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 22.04"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0
      }
    },
    "vmSize": "Standard_d4s_v3"
  }
}

示例响应

状态代码:

200

ETag: W/"0x8DB554F8E08BCF4"

{
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "properties": {
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2023-06-14T07:03:58.3231917Z",
    "creationTime": "2023-06-14T07:03:58.3231917Z",
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0,
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "offer": "0001-com-ubuntu-server-jammy",
          "publisher": "Canonical",
          "sku": "22_04-lts",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 22.04"
      }
    },
    "interNodeCommunication": "Disabled",
    "lastModified": "2023-06-14T07:03:58.3231917Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2023-06-14T07:03:58.3231917Z",
    "resizeOperationStatus": {
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M",
      "startTime": "2023-09-27T07:33:13.0625789Z",
      "targetDedicatedNodes": 1
    },
    "scaleSettings": {
      "fixedScale": {
        "resizeTimeout": "PT15M",
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0
      }
    },
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "taskSlotsPerNode": 1,
    "vmSize": "STANDARD_D4S_V3"
  }
}

CreatePool - UpgradePolicy

示例请求

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01

{
  "properties": {
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "offer": "WindowsServer",
          "publisher": "MicrosoftWindowsServer",
          "sku": "2019-datacenter-smalldisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64",
        "nodePlacementConfiguration": {
          "policy": "Zonal"
        },
        "windowsConfiguration": {
          "enableAutomaticUpdates": false
        }
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 2,
        "targetLowPriorityNodes": 0
      }
    },
    "upgradePolicy": {
      "automaticOSUpgradePolicy": {
        "disableAutomaticRollback": true,
        "enableAutomaticOSUpgrade": true,
        "osRollingUpgradeDeferral": true,
        "useRollingUpgradePolicy": true
      },
      "mode": "automatic",
      "rollingUpgradePolicy": {
        "enableCrossZoneUpgrade": true,
        "maxBatchInstancePercent": 20,
        "maxUnhealthyInstancePercent": 20,
        "maxUnhealthyUpgradedInstancePercent": 20,
        "pauseTimeBetweenBatches": "PT0S",
        "prioritizeUnhealthyInstances": false,
        "rollbackFailedInstancesOnPolicyBreach": false
      }
    },
    "vmSize": "Standard_d4s_v3"
  }
}

示例响应

状态代码:

200

ETag: W/"0x8DB51E64D3C3B69"

{
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "properties": {
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2023-05-11T06:16:44.2372184Z",
    "creationTime": "2023-05-11T06:16:44.2372184Z",
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0,
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "offer": "WindowsServer",
          "publisher": "MicrosoftWindowsServer",
          "sku": "2019-datacenter-smalldisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64",
        "nodePlacementConfiguration": {
          "policy": "Zonal"
        },
        "windowsConfiguration": {
          "enableAutomaticUpdates": false
        }
      }
    },
    "interNodeCommunication": "Disabled",
    "lastModified": "2023-05-11T06:16:44.2372184Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2023-05-11T06:16:44.2372184Z",
    "resizeOperationStatus": {
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M",
      "startTime": "2023-05-11T06:16:44.2372184Z",
      "targetDedicatedNodes": 2
    },
    "scaleSettings": {
      "fixedScale": {
        "resizeTimeout": "PT15M",
        "targetDedicatedNodes": 2,
        "targetLowPriorityNodes": 0
      }
    },
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "taskSlotsPerNode": 1,
    "upgradePolicy": {
      "automaticOSUpgradePolicy": {
        "disableAutomaticRollback": true,
        "enableAutomaticOSUpgrade": true,
        "osRollingUpgradeDeferral": true,
        "useRollingUpgradePolicy": true
      },
      "mode": "automatic",
      "rollingUpgradePolicy": {
        "enableCrossZoneUpgrade": true,
        "maxBatchInstancePercent": 20,
        "maxUnhealthyInstancePercent": 20,
        "maxUnhealthyUpgradedInstancePercent": 20,
        "pauseTimeBetweenBatches": "PT0S",
        "prioritizeUnhealthyInstances": false,
        "rollbackFailedInstancesOnPolicyBreach": false
      }
    },
    "vmSize": "STANDARD_D4S_V3"
  }
}

CreatePool - UserAssignedIdentities

示例请求

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01

{
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {},
      "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {}
    }
  },
  "properties": {
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "offer": "UbuntuServer",
          "publisher": "Canonical",
          "sku": "18.04-LTS",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "scaleSettings": {
      "autoScale": {
        "evaluationInterval": "PT5M",
        "formula": "$TargetDedicatedNodes=1"
      }
    },
    "vmSize": "STANDARD_D4"
  }
}

示例响应

状态代码:

200

ETag: W/"0x8D4EDFEBFADF4AB"

{
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "clientId": "clientId1",
        "principalId": "principalId1"
      },
      "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {
        "clientId": "clientId2",
        "principalId": "principalId2"
      }
    }
  },
  "properties": {
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2020-10-01T10:22:55.9407275Z",
    "creationTime": "2020-10-01T10:22:55.9407275Z",
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0,
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "offer": "UbuntuServer",
          "publisher": "Canonical",
          "sku": "18.04-LTS",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "interNodeCommunication": "Disabled",
    "lastModified": "2020-10-01T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2020-10-01T10:22:55.9407275Z",
    "scaleSettings": {
      "autoScale": {
        "evaluationInterval": "PT5M",
        "formula": "$TargetDedicatedNodes=1"
      }
    },
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "taskSlotsPerNode": 1,
    "vmSize": "STANDARD_D4"
  }
}

CreatePool - VirtualMachineConfiguration Extensions

示例请求

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01

{
  "properties": {
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "offer": "0001-com-ubuntu-server-focal",
          "publisher": "Canonical",
          "sku": "20_04-lts"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 20.04",
        "extensions": [
          {
            "name": "batchextension1",
            "type": "KeyVaultForLinux",
            "autoUpgradeMinorVersion": true,
            "enableAutomaticUpgrade": true,
            "publisher": "Microsoft.Azure.KeyVault",
            "settings": {
              "authenticationSettingsKey": "authenticationSettingsValue",
              "secretsManagementSettingsKey": "secretsManagementSettingsValue"
            },
            "typeHandlerVersion": "2.0"
          }
        ]
      }
    },
    "scaleSettings": {
      "autoScale": {
        "evaluationInterval": "PT5M",
        "formula": "$TargetDedicatedNodes=1"
      }
    },
    "targetNodeCommunicationMode": "Default",
    "vmSize": "STANDARD_D4"
  }
}

示例响应

状态代码:

200

ETag: W/"0x8D4EDFEBFADF4AB"

{
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "properties": {
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "creationTime": "2017-08-28T10:22:55.9407275Z",
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0,
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "offer": "0001-com-ubuntu-server-focal",
          "publisher": "Canonical",
          "sku": "20_04-lts"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 20.04",
        "extensions": [
          {
            "name": "batchextension1",
            "type": "KeyVaultForLinux",
            "autoUpgradeMinorVersion": true,
            "enableAutomaticUpgrade": true,
            "publisher": "Microsoft.Azure.KeyVault",
            "settings": {
              "authenticationSettingsKey": "authenticationSettingsValue",
              "secretsManagementSettingsKey": "secretsManagementSettingsValue"
            },
            "typeHandlerVersion": "2.0"
          }
        ]
      }
    },
    "interNodeCommunication": "Disabled",
    "lastModified": "2017-08-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "scaleSettings": {
      "autoScale": {
        "evaluationInterval": "PT5M",
        "formula": "$TargetDedicatedNodes=1"
      }
    },
    "targetNodeCommunicationMode": "Default",
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "taskSlotsPerNode": 1,
    "vmSize": "STANDARD_D4"
  }
}

CreatePool - VirtualMachineConfiguration OSDisk

示例请求

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01

{
  "properties": {
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "offer": "windowsserver",
          "publisher": "microsoftwindowsserver",
          "sku": "2022-datacenter-smalldisk"
        },
        "nodeAgentSkuId": "batch.node.windows amd64",
        "osDisk": {
          "caching": "ReadWrite",
          "diskSizeGB": 100,
          "managedDisk": {
            "storageAccountType": "StandardSSD_LRS"
          },
          "writeAcceleratorEnabled": false
        }
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0
      }
    },
    "vmSize": "Standard_d2s_v3"
  }
}

示例响应

状态代码:

200

ETag: W/"0x8DB51F14DC1A8AD"

{
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "properties": {
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2023-08-24T02:12:27.7527697Z",
    "creationTime": "2023-08-24T02:12:27.7527697Z",
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0,
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "offer": "windowsserver",
          "publisher": "microsoftwindowsserver",
          "sku": "2022-datacenter-smalldisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64",
        "osDisk": {
          "caching": "ReadWrite",
          "diskSizeGB": 100,
          "managedDisk": {
            "storageAccountType": "StandardSSD_LRS"
          },
          "writeAcceleratorEnabled": false
        }
      }
    },
    "interNodeCommunication": "Disabled",
    "lastModified": "2023-08-24T02:12:27.7527697Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2023-08-24T02:12:27.7527697Z",
    "resizeOperationStatus": {
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M",
      "startTime": "2023-08-24T02:12:27.7527697Z",
      "targetDedicatedNodes": 1
    },
    "scaleSettings": {
      "fixedScale": {
        "resizeTimeout": "PT15M",
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0
      }
    },
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "taskSlotsPerNode": 1,
    "vmSize": "STANDARD_D2_V3"
  }
}

CreatePool - VirtualMachineConfiguration ServiceArtifactReference

示例请求

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-01

{
  "properties": {
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "offer": "WindowsServer",
          "publisher": "MicrosoftWindowsServer",
          "sku": "2019-datacenter-smalldisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64",
        "serviceArtifactReference": {
          "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile"
        },
        "windowsConfiguration": {
          "enableAutomaticUpdates": false
        }
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 2,
        "targetLowPriorityNodes": 0
      }
    },
    "upgradePolicy": {
      "automaticOSUpgradePolicy": {
        "enableAutomaticOSUpgrade": true
      },
      "mode": "automatic"
    },
    "vmSize": "Standard_d4s_v3"
  }
}

示例响应

状态代码:

200

ETag: W/"0x8DB51F14DC1A8AD"

{
  "name": "mypool41",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "properties": {
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2023-05-11T07:44:44.8580493Z",
    "creationTime": "2023-05-11T07:44:44.8580493Z",
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0,
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "offer": "WindowsServer",
          "publisher": "MicrosoftWindowsServer",
          "sku": "2019-datacenter-smalldisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64",
        "serviceArtifactReference": {
          "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile"
        },
        "windowsConfiguration": {
          "enableAutomaticUpdates": false
        }
      }
    },
    "interNodeCommunication": "Disabled",
    "lastModified": "2023-05-11T07:44:44.8580493Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2023-05-11T07:44:44.8580493Z",
    "resizeOperationStatus": {
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M",
      "startTime": "2023-05-11T07:44:44.8580493Z",
      "targetDedicatedNodes": 2
    },
    "scaleSettings": {
      "fixedScale": {
        "resizeTimeout": "PT15M",
        "targetDedicatedNodes": 2,
        "targetLowPriorityNodes": 0
      }
    },
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "taskSlotsPerNode": 1,
    "upgradePolicy": {
      "automaticOSUpgradePolicy": {
        "enableAutomaticOSUpgrade": true
      },
      "mode": "automatic"
    },
    "vmSize": "STANDARD_D4S_V3"
  }
}

定义

名称	说明
AllocationState	池是否调整大小。
ApplicationPackageReference	链接到批处理帐户中的应用程序包
AutomaticOSUpgradePolicy	用于执行自动 OS 升级的配置参数。
AutoScaleRun	池自动缩放公式执行的结果和错误。
AutoScaleRunError	自动缩放池时发生的错误。
AutoScaleSettings	池的自动缩放设置。
AutoUserScope	默认值为 Pool。 如果池正在运行 Windows，则应指定任务值（如果需要在任务之间进行更严格的隔离）。 例如，如果任务以可能影响其他任务的方式改变注册表，或者已在池中指定了证书，而正常任务不应可访问，但应可通过启动任务访问。
AutoUserSpecification	指定在 Batch 服务上运行任务的自动用户的参数。
AzureBlobFileSystemConfiguration	用于使用 Blobfuse 连接到 Azure 存储容器的信息。
AzureFileShareConfiguration	用于连接到 Azure 文件共享的信息。
BatchPoolIdentity	Batch 池的标识（如果已配置）。 如果在更新现有池期间更新池标识，则只有池收缩到 0 后创建的新 VM 才会有更新的标识
CachingType	要为磁盘启用的缓存类型。
CertificateReference	对要安装在池中的计算节点上的证书的引用。 这必须与池位于同一帐户内。
CertificateStoreLocation	默认值为 currentUser。 此属性仅适用于使用 Windows 计算节点配置的池。 对于 Linux 计算节点，证书存储在任务工作目录中的目录中，并向任务提供环境变量AZ_BATCH_CERTIFICATES_DIR以查询此位置。 对于可见性为“remoteUser”的证书，将在用户的主目录中（例如 /home/{user-name}/certs）中创建一个“certs”目录，并将证书置于该目录中。
CertificateVisibility
CIFSMountConfiguration	用于连接到 CIFS 文件系统的信息。
CloudError	Batch 服务的错误响应。
CloudErrorBody	Batch 服务的错误响应。
ComputeNodeDeallocationOption	确定在为解除分配选择节点后如何处理节点及其正在运行的任务。
ComputeNodeFillType	如何跨计算节点分配任务。
ComputeNodeIdentityReference	对与计算节点将使用的 Batch 池关联的用户分配标识的引用。
ContainerConfiguration	已启用容器的池的配置。
ContainerHostBatchBindMountEntry	要装载到任务容器的路径和装载模式的条目。
ContainerHostDataPath	将装载到容器任务的容器的路径。
ContainerRegistry	专用容器注册表。
ContainerType	要使用的容器技术。
ContainerWorkingDirectory	用于指示容器任务工作目录所在的位置的标志。 默认值为“taskWorkingDirectory”。
createdByType	创建资源的标识的类型。
DataDisk	与池中的计算节点关联的数据磁盘将使用的设置。 使用附加的数据磁盘时，需要从 VM 中装载磁盘并设置磁盘格式才能使用这些磁盘。
DeploymentConfiguration	部署配置属性。
DiffDiskPlacement	作系统磁盘应该放置的位置。
DiffDiskSettings	指定虚拟机使用的操作系统磁盘的临时磁盘设置。
DiskEncryptionConfiguration	在池中的计算节点上应用的磁盘加密配置。 使用虚拟机映像或 Azure 计算库映像创建的 Linux 池不支持磁盘加密配置。
DiskEncryptionTarget	如果省略，池中的计算节点上没有磁盘将被加密。
DynamicVNetAssignmentScope	动态 vnet 分配的范围。
ElevationLevel	用户的提升级别。
EnvironmentSetting	要对任务进程设置的环境变量。
FixedScaleSettings	修复了池的缩放设置。
ImageReference	对 Azure 虚拟机市场映像或自定义虚拟机的 Azure 映像资源的引用。 若要获取 Azure Batch 验证的所有 imageReference 的列表，请参阅“列出支持的节点代理 SKU”操作。
InboundEndpointProtocol	终结点的协议。
InboundNatPool	入站 NAT 池，可用于在外部处理 Batch 池中计算节点上的特定端口。
InterNodeCommunicationState	这会对可分配给池的节点施加限制。 启用此值可以减少在池中分配请求的节点数的可能性。 如果未指定，则此值默认为“Disabled”。
IPAddressProvisioningType	Batch 池的公共 IP 地址的预配类型。
LinuxUserConfiguration	用于在 Linux 节点上创建用户帐户的属性。
LoginMode	指定用户的登录模式。 默认值为 Interactive。
ManagedDisk
MetadataItem	与 Batch 服务资源关联的名称/值对。
MountConfiguration	要在每个节点上装载的文件系统。
NetworkConfiguration	池的网络配置。
NetworkSecurityGroupRule	要应用于入站终结点的网络安全组规则。
NetworkSecurityGroupRuleAccess	应对指定 IP 地址、子网范围或标记执行的操作。
NFSMountConfiguration	用于连接到 NFS 文件系统的信息。
NodeCommunicationMode	确定池如何与 Batch 服务通信。
NodePlacementConfiguration	批处理池的节点放置配置。
NodePlacementPolicyType	默认值是区域性的。
OSDisk	虚拟机操作系统磁盘的设置。
Pool	包含有关池的信息。
PoolEndpointConfiguration	池的终结点配置。
PoolIdentityType	用于 Batch 池的标识类型。
PoolProvisioningState	池的当前状态。
PublicIPAddressConfiguration	池的网络配置的公共 IP 地址配置。
ResizeError	调整池大小时发生的错误。
ResizeOperationStatus	有关当前或上次完成的大小调整操作的详细信息。
ResourceFile	要下载到计算节点的单个文件或多个文件。
RollingUpgradePolicy	执行滚动升级时使用的配置参数。
ScaleSettings	池的缩放设置
SecurityEncryptionTypes	指定托管磁盘的 EncryptionType。 它设置为 VMGuestStateOnly 以仅加密 VMGuestState blob，而 NonPersistedTPM 用于不保留 VMGuestState blob 中的固件状态。 注意：只能为机密 VM 设置它，在使用机密 VM 时是必需的。
SecurityProfile	指定虚拟机或虚拟机规模集的安全配置文件设置。
SecurityTypes	指定虚拟机的 SecurityType。 必须将其设置为任何指定值才能启用 UefiSettings。
ServiceArtifactReference	指定使用“latest”映像版本时，用于为规模集中的所有虚拟机设置相同映像版本的服务项目引用 ID。
StartTask	当计算节点加入 Azure Batch 服务中的池时或计算节点重新启动或重新映像时运行的任务。
StorageAccountType	用于创建数据磁盘或 OS 磁盘的存储帐户类型。
systemData	与创建和上次修改资源相关的元数据。
TaskContainerSettings	任务的容器设置。
TaskSchedulingPolicy	指定应如何跨计算节点分配任务。
UefiSettings	指定在创建虚拟机时使用的安全启动和 vTPM 等安全设置。
UpgradeMode	指定升级到规模集中虚拟机的模式。 可能的值包括： 手动 - 控制对规模集中虚拟机的更新的应用程序。 使用 manualUpgrade 操作执行此操作。 自动 - 规模集中的所有虚拟机同时自动更新。 滚动 - 规模集按批执行更新，并在两者之间有可选的暂停时间。
UpgradePolicy	描述升级策略 - 自动、手动或滚动。
UserAccount	用于在 Azure Batch 节点上创建用户的属性。
UserAssignedIdentities	关联的用户标识列表。
UserIdentity	运行任务的用户标识的定义。
VirtualMachineConfiguration	基于 Azure 虚拟机基础结构的池中计算节点的配置。
VMDiskSecurityProfile	指定托管磁盘的安全配置文件设置。 注意：只能为机密 VM 设置它，在使用机密 VM 时是必需的。
VMExtension	虚拟机扩展的配置。
WindowsConfiguration	要应用于虚拟机的 Windows 操作系统设置。
WindowsUserConfiguration	用于在 Windows 节点上创建用户帐户的属性。

AllocationState

枚举

池是否调整大小。

值	说明
Steady	池未调整大小。 不会更改池中正在进行的节点数。 池在创建时以及池上未执行任何操作以更改节点数时进入此状态。
Resizing	池正在调整大小;也就是说，正在向池中添加或删除计算节点。
Stopping	池正在调整大小，但用户已请求停止调整大小，但尚未完成停止请求。

ApplicationPackageReference

对象

链接到批处理帐户中的应用程序包

名称	类型	说明
id	string	要安装的应用程序包的 ID。 这必须与池位于同一批处理帐户内。 这可以是对特定版本的引用，也可以是默认版本（如果存在）。
version	string	要部署的应用程序的版本。 如果省略，则部署默认版本。 如果省略此项，并且没有为此应用程序指定默认版本，则请求将失败，错误代码 InvalidApplicationPackageReferences。 如果直接调用 REST API，则 HTTP 状态代码为 409。

AutomaticOSUpgradePolicy

对象

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

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

AutoScaleRun

对象

池自动缩放公式执行的结果和错误。

名称	类型	说明
error	AutoScaleRunError	如果评估失败，在池中评估自动缩放公式时遇到错误的详细信息。 自动缩放池时发生的错误。
evaluationTime	string (date-time)	上次计算自动缩放公式的时间。
results	string	自动缩放公式计算中使用的所有变量的最终值。 每个变量值以 $variable=value 的形式返回，变量由分号分隔。

AutoScaleRunError

对象

自动缩放池时发生的错误。

名称	类型	说明
code	string	错误的标识符。 代码是固定的，旨在以编程方式使用。
details	AutoScaleRunError[]	有关错误的其他详细信息。
message	string	描述错误的消息，旨在适合在用户界面中显示。

AutoScaleSettings

对象

池的自动缩放设置。

名称	类型	说明
evaluationInterval	string (duration)	根据自动缩放公式自动调整池大小的时间间隔。 如果省略，则默认值为 15 分钟（PT15M）。
formula	string	池中所需计算节点数的公式。

AutoUserScope

枚举

默认值为 Pool。 如果池正在运行 Windows，则应指定任务值（如果需要在任务之间进行更严格的隔离）。 例如，如果任务以可能影响其他任务的方式改变注册表，或者已在池中指定了证书，而正常任务不应可访问，但应可通过启动任务访问。

值	说明
Task	指定服务应为任务创建新用户。
Pool	指定任务作为在池中的每个节点上创建的通用自动用户帐户运行。

AutoUserSpecification

对象

指定在 Batch 服务上运行任务的自动用户的参数。

名称	类型	说明
elevationLevel	ElevationLevel	用户的提升级别。 默认值为 nonAdmin。
scope	AutoUserScope	自动用户的范围 默认值为 Pool。 如果池正在运行 Windows，则应指定任务值（如果需要在任务之间进行更严格的隔离）。 例如，如果任务以可能影响其他任务的方式改变注册表，或者已在池中指定了证书，而正常任务不应可访问，但应可通过启动任务访问。

AzureBlobFileSystemConfiguration

对象

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

名称	类型	说明
accountKey	string (password)	Azure 存储帐户密钥。 此属性与 sasKey 和标识互斥;必须指定一个。
accountName	string	Azure 存储帐户名称。
blobfuseOptions	string	要传递给装载命令的其他命令行选项。 这些是 Windows 中的“net use”选项，Linux 中的“装载”选项。
containerName	string	Azure Blob 存储容器名称。
identityReference	ComputeNodeIdentityReference	对用于访问 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	Azure 文件 URL。 此格式为“https://{account}.file.core.windows.net/”。
mountOptions	string	要传递给装载命令的其他命令行选项。 这些是 Windows 中的“net use”选项，Linux 中的“装载”选项。
relativeMountPath	string	将装载文件系统的计算节点上的相对路径 所有文件系统都相对于 Batch 装载目录进行装载，可通过AZ_BATCH_NODE_MOUNTS_DIR环境变量进行访问。

BatchPoolIdentity

对象

Batch 池的标识（如果已配置）。 如果在更新现有池期间更新池标识，则只有池收缩到 0 后创建的新 VM 才会有更新的标识

名称	类型	说明
type	PoolIdentityType	用于 Batch 池的标识类型。
userAssignedIdentities	<string,  UserAssignedIdentities>	与 Batch 池关联的用户标识列表。

CachingType

枚举

要为磁盘启用的缓存类型。

值	说明
None	未启用磁盘的缓存模式。
ReadOnly	磁盘的缓存模式是只读的。
ReadWrite	磁盘的缓存模式是读取和写入的。

CertificateReference

对象

对要安装在池中的计算节点上的证书的引用。 这必须与池位于同一帐户内。

名称	类型	说明
id	string	要安装在池中的证书的完全限定 ID。 这必须与池位于同一批处理帐户内。
storeLocation	CertificateStoreLocation	要在其中安装证书的计算节点上的证书存储位置。 默认值为 currentUser。 此属性仅适用于使用 Windows 计算节点配置的池。 对于 Linux 计算节点，证书存储在任务工作目录中的目录中，并向任务提供环境变量AZ_BATCH_CERTIFICATES_DIR以查询此位置。 对于可见性为“remoteUser”的证书，将在用户的主目录中（例如 /home/{user-name}/certs）中创建一个“certs”目录，并将证书置于该目录中。
storeName	string	要在其中安装证书的计算节点上的证书存储的名称。 此属性仅适用于使用 Windows 计算节点配置的池。 常见的存储名称包括：My、Root、CA、Trust、Trustallowed、TrustedPeople、TrustedPublisher、AuthRoot、AddressBook，但也可以使用任何自定义存储名称。 默认值为“我的”。
visibility	CertificateVisibility[]	计算节点上的哪些用户帐户应有权访问证书的专用数据。

CertificateStoreLocation

枚举

默认值为 currentUser。 此属性仅适用于使用 Windows 计算节点配置的池。 对于 Linux 计算节点，证书存储在任务工作目录中的目录中，并向任务提供环境变量AZ_BATCH_CERTIFICATES_DIR以查询此位置。 对于可见性为“remoteUser”的证书，将在用户的主目录中（例如 /home/{user-name}/certs）中创建一个“certs”目录，并将证书置于该目录中。

值	说明
CurrentUser	证书应安装到 CurrentUser 证书存储。
LocalMachine	证书应安装到 LocalMachine 证书存储。

CertificateVisibility

枚举

值	说明
StartTask	证书应该对运行启动任务的用户帐户可见。 请注意，如果 AutoUser 作用域是 StartTask 和 Task 的池，则此证书也将对任务可见。
Task	证书应该对运行作业任务的用户帐户可见。
RemoteUser	证书应该对用户远程访问节点的用户帐户可见。

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 文件系统进行身份验证的用户。

CloudError

对象

Batch 服务的错误响应。

名称	类型	说明
error	CloudErrorBody	错误响应的正文。

CloudErrorBody

对象

Batch 服务的错误响应。

名称	类型	说明
code	string	错误的标识符。 代码是固定的，旨在以编程方式使用。
details	CloudErrorBody[]	有关错误的其他详细信息的列表。
message	string	描述错误的消息，旨在适合在用户界面中显示。
target	string	特定错误的目标。 例如，错误属性的名称。

ComputeNodeDeallocationOption

枚举

确定在为解除分配选择节点后如何处理节点及其正在运行的任务。

值	说明
Requeue	终止正在运行的任务进程并重新排队任务。 当节点可用时，任务将再次运行。 在任务终止后立即删除节点。
Terminate	终止正在运行的任务。 任务将在 failureInfo 中完成，指示它们已终止，并且不会再次运行。 在任务终止后立即删除节点。
TaskCompletion	允许当前运行的任务完成。 等待时不安排新任务。 完成所有任务后，删除节点。
RetainedData	已弃用，建议将任务数据上传到任务中的 Azure 存储，并改用 TaskCompletion 。 允许当前运行的任务完成，然后等待所有任务数据保留期到期。 等待时不安排新任务。 删除所有任务保留期已过期的节点。

ComputeNodeFillType

枚举

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

值	说明
Spread	应跨池中的所有节点均匀分配任务。
Pack	在将任何任务分配到池中的下一个节点之前，应向池中的每个节点分配尽可能多的任务（taskSlotsPerNode）。

ComputeNodeIdentityReference

对象

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

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

ContainerConfiguration

对象

已启用容器的池的配置。

名称	类型	说明
containerImageNames	string[]	容器映像名称的集合。 这是完整的映像引用，如指定为“docker pull”。 除非映像使用备用注册表完全限定映像，否则映像将源自默认 Docker 注册表。
containerRegistries	ContainerRegistry[]	可从中提取容器的其他专用注册表。 如果必须从需要凭据的专用注册表下载任何映像，则必须在此处提供这些凭据。
type	ContainerType	要使用的容器技术。

ContainerHostBatchBindMountEntry

对象

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

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

ContainerHostDataPath

枚举

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

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

ContainerRegistry

对象

专用容器注册表。

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

ContainerType

枚举

要使用的容器技术。

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

ContainerWorkingDirectory

枚举

用于指示容器任务工作目录所在的位置的标志。 默认值为“taskWorkingDirectory”。

值	说明
TaskWorkingDirectory	使用标准 Batch 服务任务工作目录，其中包含 Batch 填充的任务资源文件。
ContainerImageDefault	使用容器映像定义的工作目录。 请注意，此目录将不包含 Batch 下载的资源文件。

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

DataDisk

对象

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

名称	类型	说明
caching	CachingType	要为磁盘启用的缓存类型。 值为： none - 未启用磁盘的缓存模式。 readOnly - 磁盘的缓存模式是只读的。 readWrite - 磁盘的缓存模式是读取和写入。 缓存的默认值为 none。 有关缓存选项的信息，请参阅：https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/。
diskSizeGB	integer (int32)	创建新数据磁盘时的初始磁盘大小（以 GB 为单位）。
lun	integer (int32)	逻辑单元号。 lun 用于唯一标识每个数据磁盘。 如果附加多个磁盘，每个磁盘应具有不同的 lun。 该值必须介于 0 和 63 之间（含）。
storageAccountType	StorageAccountType	用于创建数据磁盘或 OS 磁盘的存储帐户类型。 如果省略，则默认值为“Standard_LRS”。 值为： Standard_LRS - 数据磁盘应使用标准本地冗余存储。 Premium_LRS - 数据磁盘应使用高级本地冗余存储。

DeploymentConfiguration

对象

部署配置属性。

名称	类型	说明
virtualMachineConfiguration	VirtualMachineConfiguration	池的虚拟机配置。 基于 Azure 虚拟机基础结构的池中计算节点的配置。

DiffDiskPlacement

枚举

作系统磁盘应该放置的位置。

值	说明
CacheDisk	作系统磁盘会被放置在虚拟机的缓存磁盘上。

DiffDiskSettings

对象

指定虚拟机使用的操作系统磁盘的临时磁盘设置。

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

DiskEncryptionConfiguration

对象

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

名称	类型	说明
targets	DiskEncryptionTarget[]	Batch 服务将在计算节点上加密的磁盘目标列表 在 Linux 池中，仅支持“TemporaryDisk”;在 Windows 池中，必须指定“OsDisk”和“TemporaryDisk”。

DiskEncryptionTarget

枚举

如果省略，池中的计算节点上没有磁盘将被加密。

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

DynamicVNetAssignmentScope

枚举

动态 vnet 分配的范围。

值	说明
none	未启用动态 VNet 分配。
job	动态 VNet 分配按作业完成。 如果设置了此值，还必须设置网络配置子网 ID。 此功能需要在使用前获得批准，请联系支持人员

ElevationLevel

枚举

用户的提升级别。

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

EnvironmentSetting

对象

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

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

FixedScaleSettings

对象

修复了池的缩放设置。

名称	类型	默认值	说明
nodeDeallocationOption	ComputeNodeDeallocationOption		确定节点及其正在运行的任务（如果池大小正在减少）执行的操作。 如果省略，则默认值为“重新排队”。
resizeTimeout	string (duration)	PT15M	将计算节点分配给池的超时。 默认值为 15 分钟。 超时值使用 ISO 8601 格式。 例如，使用 PT10M 10 分钟。 最小值为 5 分钟。 如果指定的值小于 5 分钟，Batch 服务将拒绝请求并显示错误;如果直接调用 REST API，则 HTTP 状态代码为 400（请求错误）。
targetDedicatedNodes	integer (int32)		池中所需的专用计算节点数。 必须设置至少一个 targetDedicatedNodes，targetLowPriorityNodes。
targetLowPriorityNodes	integer (int32)		池中所需的现成/低优先级计算节点数。 必须设置至少一个 targetDedicatedNodes，targetLowPriorityNodes。

ImageReference

对象

对 Azure 虚拟机市场映像或自定义虚拟机的 Azure 映像资源的引用。 若要获取 Azure Batch 验证的所有 imageReference 的列表，请参阅“列出支持的节点代理 SKU”操作。

名称	类型	说明
communityGalleryImageId	string	社区库映像唯一标识符 此属性与其他属性互斥，可以从社区库映像 GET 调用中提取。
id	string	Azure 计算库映像的 ARM 资源标识符。 池中的计算节点将使用此映像 ID 创建。此格式为 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName}/versions/{versionId}。 此属性与其他属性互斥。 Azure 计算库映像必须与 Azure Batch 帐户位于同一区域中的副本。 有关 Batch 节点代理与 Batch 服务通信的防火墙设置的信息，请参阅 https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration。
offer	string	Azure 虚拟机市场映像的产品/服务类型。 例如，UbuntuServer 或 WindowsServer。
publisher	string	Azure 虚拟机市场映像的发布者。 例如，Canonical 或 MicrosoftWindowsServer。
sharedGalleryImageId	string	共享库映像唯一标识符 此属性与其他属性互斥，可以从共享库映像 GET 调用中提取。
sku	string	Azure 虚拟机市场映像的 SKU。 例如，18.04-LTS 或 2022 数据中心。
version	string	Azure 虚拟机市场映像的版本。 可以指定值“latest”以选择映像的最新版本。 如果省略，则默认值为“latest”。

InboundEndpointProtocol

枚举

终结点的协议。

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

InboundNatPool

对象

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

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

InterNodeCommunicationState

枚举

这会对可分配给池的节点施加限制。 启用此值可以减少在池中分配请求的节点数的可能性。 如果未指定，则此值默认为“Disabled”。

值	说明
Enabled	启用虚拟机之间的网络通信。
Disabled	禁用虚拟机之间的网络通信。

IPAddressProvisioningType

枚举

Batch 池的公共 IP 地址的预配类型。

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

LinuxUserConfiguration

对象

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

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

LoginMode

枚举

指定用户的登录模式。 默认值为 Interactive。

值	说明
Batch	LOGON32_LOGON_BATCH Win32 登录模式。 对于长时间运行的并行进程，建议使用批处理登录模式。
Interactive	LOGON32_LOGON_INTERACTIVE Win32 登录模式。 某些应用程序需要具有与交互式登录模式关联的权限。 如果这是任务中使用的应用程序的情况，则建议使用此选项。

ManagedDisk

对象

名称	类型	说明
securityProfile	VMDiskSecurityProfile	指定托管磁盘的安全配置文件。 指定托管磁盘的安全配置文件设置。 注意：只能为机密 VM 设置它，在使用机密 VM 时是必需的。
storageAccountType	StorageAccountType	用于创建数据磁盘或 OS 磁盘的存储帐户类型。

MetadataItem

对象

与 Batch 服务资源关联的名称/值对。

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

MountConfiguration

对象

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

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

NetworkConfiguration

对象

池的网络配置。

名称	类型	默认值	说明
dynamicVnetAssignmentScope	DynamicVNetAssignmentScope	none	动态 vnet 分配的范围。
enableAcceleratedNetworking	boolean		此池是否应启用加速网络。 加速网络使单个根 I/O 虚拟化（SR-IOV）能够连接到 VM，这可能会导致网络性能得到改善。 有关详细信息，请参阅：https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview。
endpointConfiguration	PoolEndpointConfiguration		Batch 池中计算节点上终结点的配置。 池的终结点配置。
publicIPAddressConfiguration	PublicIPAddressConfiguration		Batch 池中计算节点的公共 IPAddress 配置。 池的网络配置的公共 IP 地址配置。
subnetId	string		池计算节点将加入的虚拟网络子网的 ARM 资源标识符。 此格式为 /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}。 虚拟网络必须与 Azure Batch 帐户位于同一区域和订阅中。 指定的子网应有足够的可用 IP 地址来容纳池中的节点数。 如果子网没有足够的可用 IP 地址，池将部分分配计算节点，并发生调整大小错误。 “MicrosoftAzureBatch”服务主体必须具有指定 VNet 的“经典虚拟机参与者”Role-Based 访问控制（RBAC）角色。 指定的子网必须允许来自 Azure Batch 服务的通信，以便能够在计算节点上计划任务。 可以通过检查指定的 VNet 是否具有任何关联的网络安全组（NSG）来验证这一点。 如果 NSG 拒绝与指定子网中的计算节点的通信，Batch 服务会将计算节点的状态设置为不可用。 如果指定的 VNet 具有任何关联的网络安全组（NSG），则必须为入站通信（包括端口 29876 和 29877）启用一些保留的系统端口。 此外，在端口 443 上启用到 Azure 存储的出站连接。 有关详细信息，请参阅：https://learn.microsoft.com/azure/batch/batch-api-basics#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）或端口或端口范围的数组（即 100-200）。 端口应介于 0 到 65535 的范围内，端口范围或端口不能重叠。 如果提供了任何其他值，请求将失败并显示 HTTP 状态代码 400。 默认值为 *。

NetworkSecurityGroupRuleAccess

枚举

应对指定 IP 地址、子网范围或标记执行的操作。

值	说明
Allow	允许访问。
Deny	拒绝访问。

NFSMountConfiguration

对象

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

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

NodeCommunicationMode

枚举

确定池如何与 Batch 服务通信。

值	说明
Default	节点通信模式由 Batch 服务自动设置。
Classic	使用经典通信模式的节点需要在端口 29876 和 29877 上通过“BatchNodeManagement”进行入站 TCP 通信。{region}“ 服务标记和端口 443 上的出站 TCP 通信到”Storage.region“和”BatchNodeManagement”。{region}“ 服务标记。
Simplified	使用简化通信模式的节点需要在端口 443 上与“BatchNodeManagement”进行出站 TCP 通信。{region}“ 服务标记。 不需要打开的入站端口。

NodePlacementConfiguration

对象

批处理池的节点放置配置。

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

NodePlacementPolicyType

枚举

默认值是区域性的。

值	说明
Regional	池中的所有节点都将在同一区域中分配。
Zonal	池中的节点将分布在不同区域，并尽最大努力进行平衡。

OSDisk

对象

虚拟机操作系统磁盘的设置。

名称	类型	说明
caching	CachingType	要为磁盘启用的缓存类型。
diskSizeGB	integer (int32)	创建新 OS 磁盘时的初始磁盘大小（以 GB 为单位）。
ephemeralOSDiskSettings	DiffDiskSettings	指定虚拟机使用的操作系统磁盘的临时磁盘设置。
managedDisk	ManagedDisk	托管磁盘参数。
writeAcceleratorEnabled	boolean	指定是应在磁盘上启用或禁用 writeAccelerator。

Pool

对象

包含有关池的信息。

名称	类型	默认值	说明
etag	string		资源的 ETag，用于并发语句。
id	string (arm-id)		资源的完全限定资源 ID。 例如，“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
identity	BatchPoolIdentity		用于 Batch 池的标识类型。
name	string		资源的名称
properties.allocationState	AllocationState		池是否调整大小。
properties.allocationStateTransitionTime	string (date-time)		池进入其当前分配状态的时间。
properties.applicationLicenses	string[]		Batch 服务将在池中的每个计算节点上可用的应用程序许可证列表。 应用程序许可证列表必须是可用 Batch 服务应用程序许可证的子集。 如果请求的许可证不受支持，则池创建将失败。
properties.applicationPackages	ApplicationPackageReference[]		要安装在池中每个计算节点上的应用程序包的列表。 对应用程序包引用的更改会影响所有加入池的新计算节点，但在重新启动或重新映像之前，不会影响池中已有的计算节点。 任何给定池上最多有 10 个应用程序包引用。
properties.autoScaleRun	AutoScaleRun		自动缩放公式上次执行的结果和错误。 仅当池自动缩放（即使用 autoScaleSettings）时，才会设置此属性。
properties.certificates	CertificateReference[]		要安装在池中每个计算节点上的证书列表。 对于 Windows 计算节点，Batch 服务会将证书安装到指定的证书存储和位置。 对于 Linux 计算节点，证书存储在任务工作目录中的目录中，并向任务提供环境变量AZ_BATCH_CERTIFICATES_DIR以查询此位置。 对于可见性为“remoteUser”的证书，将在用户的主目录中（例如 /home/{user-name}/certs）中创建一个“certs”目录，并将证书置于该目录中。 警告：此属性已弃用，将在 2024 年 2 月之后删除。 请改用 Azure KeyVault 扩展。
properties.creationTime	string (date-time)		池的创建时间。
properties.currentDedicatedNodes	integer (int32)		池中当前专用计算节点的数目。
properties.currentLowPriorityNodes	integer (int32)		池中当前存在的现成/低优先级计算节点数。
properties.currentNodeCommunicationMode	NodeCommunicationMode		确定池如何与 Batch 服务通信。
properties.deploymentConfiguration	DeploymentConfiguration		此属性描述池节点将部署到的虚拟机。 部署配置属性。
properties.displayName	string		池的显示名称。 显示名称不一定是唯一的，可以包含最大长度为 1024 的任何 Unicode 字符。
properties.interNodeCommunication	InterNodeCommunicationState		池是否允许在节点之间直接通信。 这会对可分配给池的节点施加限制。 启用此值可以减少在池中分配请求的节点数的可能性。 如果未指定，则此值默认为“Disabled”。
properties.lastModified	string (date-time)		池的上次修改时间。 这是池级别数据（如 targetDedicatedNodes 或 autoScaleSettings）上次更改的时间。 它不考虑节点级更改，例如计算节点更改状态。
properties.metadata	MetadataItem[]		与池关联的名称/值对列表作为元数据。 Batch 服务不向元数据分配任何含义;它仅用于使用用户代码。
properties.mountConfiguration	MountConfiguration[]		要安装在池中每个节点上的文件系统列表。 这支持 Azure 文件存储、NFS、CIFS/SMB 和 Blobfuse。
properties.networkConfiguration	NetworkConfiguration		池的网络配置。 池的网络配置。
properties.provisioningState	PoolProvisioningState		池的当前状态。
properties.provisioningStateTransitionTime	string (date-time)		池进入其当前状态的时间。
properties.resizeOperationStatus	ResizeOperationStatus		包含有关当前或上次完成的大小调整操作的详细信息。 描述当前操作（如果池 AllocationState 调整大小）或之前完成的操作（如果 AllocationState 为稳定）。
properties.resourceTags	object		与池关联的用户指定的标记。 要与 Azure Batch 池关联的用户定义的标记。 指定后，这些标记将传播到与池关联的支持 Azure 资源。 仅当使用 poolAllocationMode 属性设置为“UserSubscription”创建的 Batch 帐户时，才能指定此属性。
properties.scaleSettings	ScaleSettings		配置池中节点数的设置。 定义池的所需大小。 这可以是指定所请求的目标DedicatedNode 的“fixedScale”，也可以是定义定期重新计算的公式的“autoScale”。 如果未指定此属性，则池将具有具有 0 个 targetDedicatedNodes 的固定缩放。
properties.startTask	StartTask		指定在联接池时在每个计算节点上运行的任务。 在 PATCH（更新）操作中，此属性可以设置为空对象，以从池中删除启动任务。
properties.targetNodeCommunicationMode	NodeCommunicationMode		确定池如何与 Batch 服务通信。 如果省略，则默认值为 Default。
properties.taskSchedulingPolicy	TaskSchedulingPolicy		如何跨池中的计算节点分配任务。 如果未指定，则默认为分散。
properties.taskSlotsPerNode	integer (int32)	1	可用于在池中的单个计算节点上运行并发任务的任务槽数。 默认值为 1。 最大值是池的 vmSize 核心数或 256 的 4 倍。
properties.upgradePolicy	UpgradePolicy		池的升级策略。 描述升级策略 - 自动、手动或滚动。
properties.userAccounts	UserAccount[]		将在池中的每个节点上创建的用户帐户列表。
properties.vmSize	string		池中虚拟机的大小。 池中的所有 VM 大小相同。 有关可用 VM 大小的信息，请参阅 Azure 中虚拟机的大小（https://learn.microsoft.com/azure/virtual-machines/sizes/overview）。 Batch 支持除STANDARD_A0和具有高级存储（STANDARD_GS、STANDARD_DS和STANDARD_DSV2系列）之外的所有 Azure VM 大小。
systemData	systemData		包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object		资源的标记。
type	string		资源的类型。 例如，“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

PoolEndpointConfiguration

对象

池的终结点配置。

名称	类型	说明
inboundNatPools	InboundNatPool[]	入站 NAT 池列表，可用于在外部解决单个计算节点上的特定端口。 每个 Batch 池的最大入站 NAT 池数为 5。 如果超出最大入站 NAT 池数，则请求失败并显示 HTTP 状态代码 400。 如果 IPAddressProvisioningType 为 NoPublicIPAddresses，则无法指定此项。

PoolIdentityType

枚举

用于 Batch 池的标识类型。

值	说明
UserAssigned	Batch 池具有用户分配的标识。
None	Batch 池没有与之关联的标识。 在更新池中设置 None 将删除现有标识。

PoolProvisioningState

枚举

池的当前状态。

值	说明
Succeeded	池可用于运行受计算节点可用性约束的任务。
Deleting	用户已请求删除池，但删除操作尚未完成。

PublicIPAddressConfiguration

对象

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

名称	类型	说明
ipAddressIds	string[]	预配计算节点时 Batch 服务将使用的公共 IP 列表。 此处指定的 IP 数限制池的最大大小 - 可以为每个公共 IP 分配 100 个专用节点或 100 个现成/低优先级节点。 例如，需要 250 个专用 VM 的池至少需要指定 3 个公共 IP。 此集合的每个元素都采用以下形式：/subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}。
provision	IPAddressProvisioningType	Batch 池的公共 IP 地址的预配类型。 默认值为 BatchManaged

ResizeError

对象

调整池大小时发生的错误。

名称	类型	说明
code	string	错误的标识符。 代码是固定的，旨在以编程方式使用。
details	ResizeError[]	有关错误的其他详细信息。
message	string	描述错误的消息，旨在适合在用户界面中显示。

ResizeOperationStatus

对象

有关当前或上次完成的大小调整操作的详细信息。

名称	类型	说明
errors	ResizeError[]	在池上执行上一次重设大小时遇到的任何错误的详细信息。 仅当上一个池调整大小期间发生错误，并且仅当池 allocationState 为稳定时，才会设置此属性。
nodeDeallocationOption	ComputeNodeDeallocationOption	确定在为解除分配选择节点后如何处理节点及其正在运行的任务。 默认值为重新排队。
resizeTimeout	string (duration)	将计算节点分配给池或从池中删除计算节点的超时。 默认值为 15 分钟。 最小值为 5 分钟。 如果指定的值小于 5 分钟，Batch 服务将返回错误;如果直接调用 REST API，则 HTTP 状态代码为 400（请求错误）。
startTime	string (date-time)	启动此调整大小操作的时间。
targetDedicatedNodes	integer (int32)	池中所需的专用计算节点数。
targetLowPriorityNodes	integer (int32)	池中所需的现成/低优先级计算节点数。

ResourceFile

对象

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

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

RollingUpgradePolicy

对象

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

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

ScaleSettings

对象

池的缩放设置

名称	类型	说明
autoScale	AutoScaleSettings	池的自动缩放设置。 此属性和 fixedScale 是互斥的，必须指定其中一个属性。
fixedScale	FixedScaleSettings	修复了池的缩放设置。 此属性和 autoScale 互斥，必须指定其中一个属性。

SecurityEncryptionTypes

枚举

指定托管磁盘的 EncryptionType。 它设置为 VMGuestStateOnly 以仅加密 VMGuestState blob，而 NonPersistedTPM 用于不保留 VMGuestState blob 中的固件状态。 注意：只能为机密 VM 设置它，在使用机密 VM 时是必需的。

值	说明
NonPersistedTPM
VMGuestStateOnly

SecurityProfile

对象

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

名称	类型	说明
encryptionAtHost	boolean	用户可以在请求中使用此属性来启用或禁用虚拟机或虚拟机规模集的主机加密。 这将为所有磁盘启用加密，包括主机本身的资源/临时磁盘。
securityType	SecurityTypes	指定虚拟机的 SecurityType。 必须将其设置为任何指定值才能启用 UefiSettings。
uefiSettings	UefiSettings	指定在创建虚拟机时使用的安全启动和 vTPM 等安全设置。

SecurityTypes

枚举

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

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

ServiceArtifactReference

对象

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

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

StartTask

对象

当计算节点加入 Azure Batch 服务中的池时或计算节点重新启动或重新映像时运行的任务。

名称	类型	默认值	说明
commandLine	string		启动任务的命令行。 命令行未在 shell 下运行，因此不能利用 shell 功能（如环境变量扩展）。 如果要利用这些功能，则应在命令行中调用 shell，例如在 Windows 中使用“cmd /c MyCommand”或在 Linux 中使用“/bin/sh -c MyCommand”。 如果指定了 startTask 的任何其他属性，则为必需。
containerSettings	TaskContainerSettings		启动任务所依据的容器的设置。 指定此项后，AZ_BATCH_NODE_ROOT_DIR（节点上的 Azure Batch 目录的根目录）以递归方式映射到容器中，所有任务环境变量都映射到容器中，任务命令行在容器中执行。
environmentSettings	EnvironmentSetting[]		启动任务的环境变量设置列表。
maxTaskRetryCount	integer (int32)	0	可以重试任务的最大次数。 如果 Batch 服务退出代码为非零，则重试任务。 请注意，此值专门控制重试次数。 Batch 服务将尝试一次任务，然后最多可以重试此限制。 例如，如果最大重试计数为 3，Batch 将尝试任务最多 4 次（一次初始尝试和 3 次重试）。 如果最大重试计数为 0，Batch 服务不会重试该任务。 如果最大重试计数为 -1，Batch 服务将重试任务，且没有限制。 默认值为 0
resourceFiles	ResourceFile[]		Batch 服务在运行命令行之前将下载到计算节点的文件列表。
userIdentity	UserIdentity		运行启动任务的用户标识。 如果省略，任务将作为任务唯一的非管理用户运行。
waitForSuccess	boolean		在计划计算节点上的任何任务之前，Batch 服务是否应等待启动任务成功完成（即退出代码 0）。 如果 true 并且启动任务在计算节点上失败，Batch 服务将启动任务重试到其最大重试计数（maxTaskRetryCount）。 如果任务在所有重试后仍未成功完成，Batch 服务会将计算节点标记为不可用，并且不会为其计划任务。 可以通过节点状态和计划错误详细信息来检测此条件。 如果为 false，Batch 服务不会等待启动任务完成。 在这种情况下，当启动任务仍在运行时，其他任务可以开始在计算节点上执行;即使启动任务失败，新任务也会继续在节点上计划。 默认值为 true。

StorageAccountType

枚举

用于创建数据磁盘或 OS 磁盘的存储帐户类型。

值	说明
Standard_LRS	数据磁盘/OS 磁盘应使用标准本地冗余存储。
Premium_LRS	数据磁盘/OS 磁盘应使用高级本地冗余存储。
StandardSSD_LRS	数据磁盘/OS 磁盘应使用标准 SSD 本地冗余存储。

systemData

对象

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

TaskContainerSettings

对象

任务的容器设置。

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

TaskSchedulingPolicy

对象

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

名称	类型	默认值	说明
nodeFillType	ComputeNodeFillType	Spread	如何跨计算节点分配任务。

UefiSettings

对象

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

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

UpgradeMode

枚举

指定升级到规模集中虚拟机的模式。

可能的值包括：

手动 - 控制对规模集中虚拟机的更新的应用程序。 使用 manualUpgrade 操作执行此操作。

自动 - 规模集中的所有虚拟机同时自动更新。

滚动 - 规模集按批执行更新，并在两者之间有可选的暂停时间。

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

UpgradePolicy

对象

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

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

UserAccount

对象

用于在 Azure Batch 节点上创建用户的属性。

名称	类型	说明
elevationLevel	ElevationLevel	用户的提升级别。 nonAdmin - 自动用户是没有提升访问权限的标准用户。 管理员 - 自动用户是具有提升访问权限并具有完全管理员权限的用户。 默认值为 nonAdmin。
linuxUserConfiguration	LinuxUserConfiguration	用户帐户的特定于 Linux 的用户配置。 如果在 Windows 池上指定此属性，则忽略此属性。 如果未指定，则使用默认选项创建用户。
name	string	用户帐户的名称。 名称可以包含最大长度为 20 的任何 Unicode 字符。
password	string (password)	用户帐户的密码。
windowsUserConfiguration	WindowsUserConfiguration	用户帐户的特定于 Windows 的用户配置。 只有在用户位于 Windows 池中时，才能指定此属性。 如果未指定且在 Windows 池上，则会使用默认选项创建用户。

UserAssignedIdentities

对象

关联的用户标识列表。

名称	类型	说明
clientId	string	用户分配标识的客户端 ID。
principalId	string	用户分配标识的主体 ID。

UserIdentity

对象

运行任务的用户标识的定义。

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

VirtualMachineConfiguration

对象

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

名称	类型	说明
containerConfiguration	ContainerConfiguration	池的容器配置。 如果指定，则会在池中的每个节点上执行安装程序，以允许任务在容器中运行。 在此池上运行的所有常规任务和作业管理器任务都必须指定 containerSettings 属性，所有其他任务都可以指定它。
dataDisks	DataDisk[]	附加到池中计算节点的数据磁盘的配置。 如果池中的计算节点需要附加空数据磁盘，则必须指定此属性。
diskEncryptionConfiguration	DiskEncryptionConfiguration	池的磁盘加密配置。 如果指定了加密，则会在节点预配期间对池中的每个节点执行加密。
extensions	VMExtension[]	池的虚拟机扩展。 如果指定，此配置中提到的扩展将安装在每个节点上。
imageReference	ImageReference	对 Azure 虚拟机市场映像或要使用的自定义虚拟机映像的引用。 对 Azure 虚拟机市场映像或自定义虚拟机的 Azure 映像资源的引用。 若要获取 Azure Batch 验证的所有 imageReference 的列表，请参阅“列出支持的节点代理 SKU”操作。
licenseType	string	部署操作系统时要使用的本地许可证的类型。 这仅适用于包含 Windows 操作系统的映像，并且仅在为将要部署的节点保留有效的本地许可证时使用。 如果省略，则不会应用本地许可折扣。 值为： Windows_Server - 本地许可证适用于 Windows Server。 Windows_Client - 本地许可证适用于 Windows 客户端。
nodeAgentSkuId	string	要在池中的计算节点上预配的 Batch 节点代理的 SKU。 Batch 节点代理是在池中的每个节点上运行的程序，并在节点与 Batch 服务之间提供命令和控制接口。 对于不同的操作系统，节点代理（称为 SKU）有不同的实现。 必须指定与所选映像引用匹配的节点代理 SKU。 若要获取支持的节点代理 SKU 及其已验证映像引用列表，请参阅“列出支持的节点代理 SKU”操作。
nodePlacementConfiguration	NodePlacementConfiguration	池的节点放置配置。 此配置将指定池中节点的物理分配方式的规则。
osDisk	OSDisk	虚拟机操作系统磁盘的设置。 包含临时 OSDisk 设置的配置。
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 OS 映像，则不能指定此属性。

VMDiskSecurityProfile

对象

指定托管磁盘的安全配置文件设置。 注意：只能为机密 VM 设置它，在使用机密 VM 时是必需的。

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

VMExtension

对象

虚拟机扩展的配置。

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

WindowsConfiguration

对象

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

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

WindowsUserConfiguration

对象

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

名称	类型	说明
loginMode	LoginMode	用户的登录模式 指定用户的登录模式。 默认值为 Interactive。