Pools - Create Pool

Служба:

Batch Service

Версия API:

2025-06-01

Создаёт пул для указанного аккаунта.
При именовании пулов не следует включать конфиденциальную информацию, например имена пользователей или имена секретных проектов. Эта информация может отображаться в телеметрических журналах, доступных инженерам служба поддержки Майкрософт.

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)	Конечная точка учетной записи пакетной службы (например, 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	Строка, которая однозначно идентифицирует пул в учетной записи. Идентификатор может содержать любое сочетание буквенно-цифровых символов, включая дефисы и символы подчеркивания, и не может содержать более 64 символов. Идентификатор сохраняет регистр и не учитывает регистр (т. е. у вас могут не быть двух идентификаторов пула в учетной записи, которые отличаются только по регистру).
vmSize	True	string	Размер виртуальных машин в пуле. Все виртуальные машины в пуле имеют одинаковый размер. Для информации о доступных размерах виртуальных машин для пулов, использующих изображения с Виртуальные машины Marketplace (пулы, созданные с помощью virtualMachineConfiguration), см. раздел Размеры для Виртуальные машины в Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). Пакетный режим поддерживает все Azure размеры виртуальных машин, кроме STANDARD_A0 и тех, что имеют премиальный накопитель (серии STANDARD_GS, STANDARD_DS и STANDARD_DSV2).
applicationPackageReferences		BatchApplicationPackageReference[]	Список пакетов, установленных на каждом вычислительном узле в пуле. При создании пула идентификатор приложения пакета должен быть полностью квалифицирован (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Майкрософт. Batch/batchAccounts/{accountName}/applications/{applicationName}). Изменения ссылок на пакеты влияют на все новые узлы, присоединенные к пулу, но не влияют на вычислительные узлы, которые уже находятся в пуле, пока они не перезагрузятся или переимыслятся. В любом пуле имеется не более 10 ссылок на пакеты.
autoScaleEvaluationInterval		string (duration)	Интервал времени, с помощью которого автоматически настраивается размер пула в соответствии с формулой автомасштабирования. Значение по умолчанию — 15 минут. Минимальное и максимальное значение — 5 минут и 168 часов соответственно. Если указать значение менее 5 минут или больше 168 часов, служба пакетной службы возвращает ошибку; Если вы вызываете REST API напрямую, код состояния HTTP равен 400 (недопустимый запрос). Длительность времени указана в формате ISO 8601.
autoScaleFormula		string	Формула для требуемого количества вычислительных узлов в пуле. Это свойство не должно быть указано, если параметр enableAutoScale имеет значение false. Требуется, если параметр enableAutoScale имеет значение true. Формула проверяется на допустимость перед созданием пула. Если формула недопустима, служба пакетной службы отклоняет запрос с подробными сведениями об ошибке. Для получения дополнительной информации о задании этой формулы см. «Автоматическое масштабирование вычислительных узлов в пакетная служба Azure пуле» (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).
displayName		string	Отображаемое имя пула. Отображаемое имя не должно быть уникальным и может содержать любые символы Юникода до максимальной длины 1024.
enableAutoScale		boolean	Следует ли автоматически настраивать размер пула с течением времени. Если значение false, необходимо указать по крайней мере один из targetDedicatedNodes и targetLowPriorityNodes. Если значение true, требуется свойство autoScaleFormula, а пул автоматически изменяет размер в соответствии с формулой. По умолчанию используется значение false.
enableInterNodeCommunication		boolean	Разрешает ли пул прямой обмен данными между вычислительными узлами. Включение обмена данными между узлами ограничивает максимальный размер пула из-за ограничений развертывания на вычислительных узлах пула. Это может привести к тому, что пул не достигает требуемого размера. По умолчанию используется значение false.
metadata		BatchMetadataItem[]	Список пар "имя-значение", связанных с пулом в качестве метаданных. Пакетная служба не назначает никакое значение метаданным; он предназначен исключительно для использования пользовательского кода.
mountConfiguration		MountConfiguration[]	Монтирование хранилища с использованием указанной файловой системы на весь срок жизни пула. Монтировать хранилище с помощью файловой системы Azure, NFS, CIFS или файловой системы на базе Blobfuse.
networkConfiguration		NetworkConfiguration	Конфигурация сети для пула.
resizeTimeout		string (duration)	Время ожидания выделения вычислительных узлов в пул. Это время ожидания применяется только к масштабированию вручную; Он не действует, если параметр enableAutoScale имеет значение true. Значение по умолчанию — 15 минут. Минимальное значение — 5 минут. Если указать значение менее 5 минут, пакетная служба возвращает ошибку; Если вы вызываете REST API напрямую, код состояния HTTP равен 400 (недопустимый запрос). Длительность времени указана в формате ISO 8601.
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. Максимальное значение меньше 4 раза меньше числа ядер vmSize пула или 256.
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	Непредвиденное сообщение об ошибке.

Безопасность

OAuth2Auth

Тип: oauth2
Flow: 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	Параметры конфигурации, используемые для автоматического обновления ОС.
AutoUserScope	AutoUserScope enums
AutoUserSpecification	Задаёт параметры для автопользователя, который выполняет задачу пакетная служба Azure.
AzureBlobFileSystemConfiguration	Информация, используемая для подключения к контейнеру служба хранилища Azure с помощью Blobfuse.
AzureFileShareConfiguration	Информация, используемая для подключения к файловому ресурсу Azure.
BatchApplicationPackageReference	Ссылка на пакет для развертывания на вычислительных узлах.
BatchContainerConfiguration	Конфигурация пулов с поддержкой контейнера.
BatchDiffDiskSettings	Указывает временные параметры диска для диска операционной системы, используемого вычислительным узлом (vm).
BatchError	Получена ошибка от сервиса пакетная служба Azure.
BatchErrorDetail	Дополнительная информация, включённая в ответ на ошибку пакетная служба Azure.
BatchErrorMessage	Сообщение об ошибке, полученное в ответе на ошибку пакетная служба Azure.
BatchInboundNatPool	Входящий пул NAT, который можно использовать для решения конкретных портов на вычислительных узлах во внешнем пуле пакетной службы.
BatchJobDefaultOrder	Enums BatchJobDefaultOrder
BatchMetadataItem	Пакетная служба не назначает никакое значение этим метаданным; он предназначен исключительно для использования пользовательского кода.
BatchNodeFillType	BatchNodeFillType enums
BatchNodeIdentityReference	Ссылка на назначенное пользователем удостоверение, связанное с пулом пакетной службы, который будет использовать вычислительный узел.
BatchNodePlacementConfiguration	Для регионального размещения узлы в пуле будут выделены в одном регионе. Для зонального размещения узлы в пуле будут распространяться по разным зонам с оптимальной балансировкой усилий.
BatchNodePlacementPolicyType	BatchNodePlacementPolicyType enums
BatchOsDisk	Параметры диска операционной системы вычислительного узла (VM).
BatchPoolCreateOptions	Parameters for creating a пакетная служба Azure Pool.
BatchPoolEndpointConfiguration	Конфигурация конечной точки для пула.
BatchPoolIdentityReference	Ссылка на один из идентификаторов пула для шифрования диска. Это удостоверение будет использоваться для доступа к хранилищу ключей.
BatchPublicIpAddressConfiguration	Конфигурация общедоступного IP-адреса конфигурации сети пула.
BatchStartTask	Пакетная служба будет повторять задачи при активации операции восстановления на узле. Примеры операций восстановления включают (но не ограничиваются) при перезагрузке неработоспособного узла или вычислительном узле исчезли из-за сбоя узла. Повторные попытки из-за операций восстановления не учитываются и не учитываются для maxTaskRetryCount. Даже если значение maxTaskRetryCount равно 0, может произойти внутренняя повторная попытка из-за операции восстановления. Из-за этого все задачи должны быть идемпотентными. Это означает, что задачи должны терпеть прерывание и перезапуск без повреждения или дублирования данных. Рекомендуется использовать определенную форму контрольных точек для длительных задач. В некоторых случаях запуск StartTask может выполняться повторно, даже если вычислительный узел не был перезагружен. Следует учесть, чтобы избежать запуска StartTasks, создающих отсортовый процесс или установку или запуск служб из рабочего каталога StartTask, так как это приведет к тому, что пакетная служба сможет повторно запустить StartTask.
BatchTaskContainerSettings	Параметры контейнера для задачи.
BatchTaskSchedulingPolicy	Указывает, как задачи должны распределяться по вычислительным узлам.
BatchUefiSettings	Указывает параметры безопасности, такие как безопасная загрузка и vTPM, используемые при создании виртуальной машины.
BatchVmDiskSecurityProfile	Задает параметры профиля безопасности для управляемого диска. Примечание: Он может быть установлен только для конфиденциальных виртуальных машин и необходим при использовании конфиденциальных виртуальных машин.
BatchVmImageReference	Ссылка на Виртуальные машины Azure Marketplace Image или Azure Compute Gallery Image. Чтобы получить список всех ссылок на изображения Azure Marketplace, проверенных пакетная служба Azure, смотрите операцию 'List Supported Images'.
CachingType	Энумы CachingType
CifsMountConfiguration	Сведения, используемые для подключения к файловой системе CIFS.
ContainerHostBatchBindMountEntry	Вход пути и режима подключения, который требуется подключить к контейнеру задач.
ContainerHostDataPath	Пути, которые будут подключены к контейнеру задачи контейнера.
ContainerRegistryReference	Частный реестр контейнеров.
ContainerType	ContainerType enums
ContainerWorkingDirectory	ContainerWorkingDirectory enums
DataDisk	Параметры, которые будут использоваться дисками данных, связанными с вычислительными узлами в пуле. При использовании подключенных дисков данных необходимо подключить и отформатировать диски из виртуальной машины, чтобы использовать их.
DiffDiskPlacement	Задаёт эфемерное расположение диска для диска операционной системы для всех вычислительных узлов (VM) пула. Это свойство можно использовать пользователем в запросе, чтобы выбрать расположение операционной системы. Например, кэшировать место на диске для подготовки диска Эфемеральной ОС. Для получения дополнительной информации о требованиях к размеру диска Ephemeral OS, пожалуйста, обратитесь к требованиям к размеру диска для Windows виртуальных машин на https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements и Linux VM на https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements
DiskCustomerManagedKey	Ссылка на ключ, управляемый клиентом, для шифрования диска.
DiskEncryptionConfiguration	Конфигурация шифрования дисков, примененная к вычислительным узлам в пуле. Конфигурация шифрования диска не поддерживается в пуле Linux, созданном с помощью образа Azure Compute Gallery.
DiskEncryptionSetParameters	Идентификатор ресурса ARM набора шифрования диска.
DiskEncryptionTarget	Enums DiskEncryptionTarget
DynamicVNetAssignmentScope	DynamicVNetAssignmentScope enums
ElevationLevel	Enums ElevationLevel
EnvironmentSetting	Переменная среды, устанавливаемая в процессе задачи.
HostEndpointSettings	Указывает определенные параметры конечной точки узла.
HostEndpointSettingsModeTypes	HostEndpointSettingsModeTypes enums
InboundEndpointProtocol	Enums InboundEndpointProtocol
IpAddressProvisioningType	IPAddressProvisioningType enums
IPFamily	Семейства IP-адресов, используемые для указания версий IP-адресов, доступных для пула.
IPTag	Содержит тег IP, связанный с общедоступным IP-адресом.
LinuxUserConfiguration	Свойства, используемые для создания учетной записи пользователя на вычислительном узле Linux.
LoginMode	Enums LoginMode
ManagedDisk	Параметры управляемого диска.
MountConfiguration	Файловая система для подключения на каждом узле.
NetworkConfiguration	Конфигурация сети для пула.
NetworkSecurityGroupRule	Правило группы безопасности сети для применения к входящей конечной точке.
NetworkSecurityGroupRuleAccess	NetworkSecurityGroupRuleAccess enums
NfsMountConfiguration	Сведения, используемые для подключения к файловой системе NFS.
ProxyAgentSettings	Задает параметры ProxyAgent при создании виртуальной машины.
ResourceFile	Один файл или несколько файлов, которые нужно скачать на вычислительный узел.
RollingUpgradePolicy	Параметры конфигурации, используемые при выполнении последовательного обновления.
SecurityEncryptionTypes	Enums SecurityEncryptionTypes
SecurityProfile	Задает параметры профиля безопасности для масштабируемого набора виртуальных машин или виртуальной машины.
SecurityTypes	Указывает тип безопасности виртуальной машины. Для включения UefiSettings необходимо задать любое указанное значение.
ServiceArtifactReference	Указывает идентификатор ссылки на артефакт службы, используемый для задания одной версии образа для всех виртуальных машин в масштабируемом наборе при использовании последней версии образа.
StorageAccountType	Перечисления StorageAccountType
UpgradeMode	Enums UpgradeMode
UpgradePolicy	Описывает политику обновления — автоматическую, ручную или перекатную.
UserAccount	Свойства, используемые для создания пользователя, используемого для выполнения задач на вычислительном узле пакетная служба Azure.
UserIdentity	Определение удостоверения пользователя, в котором выполняется задача. Укажите свойство userName или autoUser, но не оба.
VirtualMachineConfiguration	Конфигурация вычислительных узлов в пуле на базе инфраструктуры Виртуальные машины Azure.
VMExtension	Конфигурация расширений виртуальных машин.
WindowsConfiguration	Настройки операционной системы Windows для применения к виртуальной машине.
WindowsUserConfiguration	Свойства, используемые для создания учетной записи пользователя на вычислительном узле Windows.

AutomaticOsUpgradePolicy

Объект

Параметры конфигурации, используемые для автоматического обновления ОС.

Имя	Тип	Описание
disableAutomaticRollback	boolean	Следует ли отключить функцию отката образа ОС.
enableAutomaticOSUpgrade	boolean	Указывает, следует ли автоматически применять обновления ОС к экземплярам масштабируемого набора в последовательном режиме, когда становится доступной более новая версия образа ОС. Если это установлено в true для пулов на базе Windows, то WindowsConfiguration.enableAutomaticUpdates нельзя установить true.
osRollingUpgradeDeferral	boolean	Отложить обновление ОС на телевизорах, если они выполняют задачи.
useRollingUpgradePolicy	boolean	Указывает, следует ли использовать политику последовательного обновления во время автоматического обновления ОС. Автоматическое обновление ОС откатится к политике по умолчанию, если политика не определена в VMSS.

AutoUserScope

Перечисление

AutoUserScope enums

Значение	Описание
task	Указывает, что сервис должен создать нового пользователя для задачи.
pool	Указывает, что задача выполняется как общий автопользовательский аккаунт, который создаётся на каждом вычислительном узле пула.

AutoUserSpecification

Объект

Задаёт параметры для автопользователя, который выполняет задачу пакетная служба Azure.

Имя	Тип	Описание
elevationLevel	ElevationLevel	Уровень повышения прав автоматического пользователя. Значение по умолчанию — nonAdmin.
scope	AutoUserScope	Область для автоматического пользователя. Значение по умолчанию — пул. Если пул работает с Windows, значение Task должно быть указано, если требуется более строгая изоляция между задачами. Например, если задача изменяет реестр таким образом, что это может повлиять на другие задачи.

AzureBlobFileSystemConfiguration

Объект

Информация, используемая для подключения к контейнеру служба хранилища Azure с помощью Blobfuse.

Имя	Тип	Описание
accountKey	string (password)	Ключ учетной записи служба хранилища Azure. Это свойство является взаимоисключающим как с sasKey, так и с удостоверением; необходимо указать именно один.
accountName	string	Имя аккаунта служба хранилища Azure.
blobfuseOptions	string	Дополнительные параметры командной строки для передачи команде подключения. Это опции 'net use' в Windows и опции 'mount' в Linux.
containerName	string	The Хранилище BLOB-объектов Azure Container name.
identityReference	BatchNodeIdentityReference	Ссылка на назначенную пользователю идентичность для доступа к containerName. Это свойство является взаимоисключающим как с accountKey, так и sasKey; необходимо указать именно один.
relativeMountPath	string	Относительный путь на вычислительном узле, куда будет монтирована файловая система. Все файловые системы подключены относительно каталога подключений пакетной службы, доступные с помощью переменной среды AZ_BATCH_NODE_MOUNTS_DIR.
sasKey	string (password)	Токен служба хранилища Azure SAS. Это свойство является взаимоисключающим как с accountKey, так и с удостоверением; необходимо указать именно один.

AzureFileShareConfiguration

Объект

Информация, используемая для подключения к файловому ресурсу Azure.

Имя	Тип	Описание
accountKey	string (password)	Ключ учетной записи служба хранилища Azure.
accountName	string	Имя аккаунта служба хранилища Azure.
azureFileUrl	string (uri)	URL Файлы Azure. Это форма "https://{account}.file.core.windows.net/".
mountOptions	string	Дополнительные параметры командной строки для передачи команде подключения. Это опции 'net use' в Windows и опции 'mount' в Linux.
relativeMountPath	string	Относительный путь на вычислительном узле, куда будет монтирована файловая система. Все файловые системы подключены относительно каталога подключений пакетной службы, доступные с помощью переменной среды AZ_BATCH_NODE_MOUNTS_DIR.

BatchApplicationPackageReference

Объект

Ссылка на пакет для развертывания на вычислительных узлах.

Имя	Тип	Описание
applicationId	string	ID приложения для развертывания. При создании пула идентификатор приложения пакета должен быть полностью квалифицирован (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Майкрософт. Batch/batchAccounts/{accountName}/applications/{applicationName}).
version	string	Версия приложения для развертывания. Если опущено, будет развернута версия по умолчанию. Если это опущено в пуле, и для этого приложения не указана стандартная версия, запрос не выполняется с кодом ошибки InvalidApplicationPackageReferences и HTTP-кодом статуса 409. Если это опущено в задаче, и для этого приложения не указана стандартная версия, задача проваливается с ошибкой предварительной обработки.

BatchContainerConfiguration

Объект

Конфигурация пулов с поддержкой контейнера.

Имя	Тип	Описание
containerImageNames	string[]	Коллекция имён изображений контейнеров. Это полная ссылка на изображение, как было бы указано в «docker pull». Изображение будет взято из стандартного реестра Docker, если только оно не полностью квалифицировано с альтернативным реестром.
containerRegistries	ContainerRegistryReference[]	Дополнительные частные реестры, из которых можно извлечь контейнеры. Если какие-либо изображения необходимо скачать из приватного реестра, требующего учетных данных, эти учетные данные должны быть предоставлены здесь.
type	ContainerType	Используемая технология контейнера.

BatchDiffDiskSettings

Объект

Указывает временные параметры диска для диска операционной системы, используемого вычислительным узлом (vm).

Имя	Тип	Описание
placement	DiffDiskPlacement	Указывает временное размещение дисков для диска операционной системы для всех виртуальных машин в пуле. Это свойство можно использовать пользователем в запросе, чтобы выбрать расположение, например место на диске кэша для подготовки диска Эфемеральной ОС. Для получения дополнительной информации о требованиях к размеру диска Ephemeral OS, пожалуйста, обратитесь к требованиям к размеру диска для Windows виртуальных машин на https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements и Linux VM на https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.

BatchError

Объект

Получена ошибка от сервиса пакетная служба Azure.

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования.
message	BatchErrorMessage	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.
values	BatchErrorDetail[]	Коллекция пар "ключ-значение", содержащая дополнительные сведения об ошибке.

BatchErrorDetail

Объект

Дополнительная информация, включённая в ответ на ошибку пакетная служба Azure.

Имя	Тип	Описание
key	string	Идентификатор, указывающий значение свойства Value.
value	string	Дополнительные сведения, включенные в ответ на ошибку.

BatchErrorMessage

Объект

Сообщение об ошибке, полученное в ответе на ошибку пакетная служба Azure.

Имя	Тип	Описание
lang	string	Языковой код сообщения об ошибке.
value	string	Текст сообщения.

BatchInboundNatPool

Объект

Входящий пул NAT, который можно использовать для решения конкретных портов на вычислительных узлах во внешнем пуле пакетной службы.

Имя	Тип	Описание
backendPort	integer (int32)	Номер порта на вычислительном узле. Это, должно быть, уникально для Batch Pool. Допустимые значения : от 1 до 65535, за исключением 29876 и 29877, так как они зарезервированы. Если указаны зарезервированные значения, запрос завершается ошибкой с кодом состояния HTTP 400.
frontendPortRangeEnd	integer (int32)	Последний номер порта в диапазоне внешних портов, которые будут использоваться для обеспечения входящего доступа к backendPort на отдельных вычислительных узлах. Допустимые значения варьируются от 1 до 65534, за исключением портов от 50000 до 55000, зарезервированных пакетной службой. Все диапазоны внутри пула должны быть разными и не могут пересекаться. В каждом диапазоне должно быть не менее 40 портов. Если указаны зарезервированные или перекрывающиеся значения, запрос завершается ошибкой с кодом состояния HTTP 400.
frontendPortRangeStart	integer (int32)	Первый номер порта в диапазоне внешних портов, которые будут использоваться для обеспечения входящего доступа к backendPort на отдельных вычислительных узлах. Допустимые значения варьируются от 1 до 65534, за исключением портов от 50000 до 55000, которые зарезервированы. Все диапазоны внутри пула должны быть разными и не могут пересекаться. В каждом диапазоне должно быть не менее 40 портов. Если указаны зарезервированные или перекрывающиеся значения, запрос завершается ошибкой с кодом состояния HTTP 400.
name	string	Имя конечной точки. Название должно быть уникальным в рамках Batch Pool, может содержать буквы, цифры, подчеркнутые, точки и дефисы. Имена должны начинаться с буквы или числа, заканчиваться буквой, числом или подчеркиванием и не может превышать 77 символов. Если указаны недопустимые значения, запрос завершается ошибкой с кодом состояния HTTP 400.
networkSecurityGroupRules	NetworkSecurityGroupRule[]	Список правил группы безопасности сети, которые будут применены к конечной точке. Максимальное количество правил, которые можно задать для всех конечных точек в пакетном пуле, составляет 25. Если правила группы безопасности сети не указаны, будет создано правило по умолчанию, чтобы разрешить входящий доступ к указанному внутреннему порту. Если максимальное число правил группы безопасности сети превышается, запрос завершается ошибкой с кодом состояния HTTP 400.
protocol	InboundEndpointProtocol	Протокол конечной точки.

BatchJobDefaultOrder

Перечисление

Enums BatchJobDefaultOrder

Значение	Описание
none	Задачи должны планироваться равномерно по всем работам с равным приоритетом в пуле.
creationtime	Если задачи имеют равный приоритет, задачи из ранее созданных задач должны планироваться первыми.

BatchMetadataItem

Объект

Пакетная служба не назначает никакое значение этим метаданным; он предназначен исключительно для использования пользовательского кода.

Имя	Тип	Описание
name	string	Имя элемента метаданных.
value	string	Значение элемента метаданных.

BatchNodeFillType

Перечисление

BatchNodeFillType enums

Значение	Описание
spread	Задачи должны быть равномерно распределены между всеми вычислительными узлами пула.
pack	Как можно больше задач (taskSlotsPerNode) должно быть назначено каждому вычислительному узлу пула до назначения задач следующему вычислительному узлу пула.

BatchNodeIdentityReference

Объект

Ссылка на назначенное пользователем удостоверение, связанное с пулом пакетной службы, который будет использовать вычислительный узел.

Имя	Тип	Описание
resourceId	string (arm-id)	Идентификатор ресурса ARM назначенного пользователем удостоверения.

BatchNodePlacementConfiguration

Объект

Для регионального размещения узлы в пуле будут выделены в одном регионе. Для зонального размещения узлы в пуле будут распространяться по разным зонам с оптимальной балансировкой усилий.

Имя	Тип	Описание
policy	BatchNodePlacementPolicyType	Тип политики размещения узлов в пулах пакетной службы. Политика выделения, используемая пакетной службой для подготовки узлов. Если оно не указано, пакетная служба будет использовать региональную политику.

BatchNodePlacementPolicyType

Перечисление

BatchNodePlacementPolicyType enums

Значение	Описание
regional	Все узлы в пуле будут выделены в одном регионе.
zonal	Узлы пула будут распределены по разным зонам доступности с оптимальным балансом усилий.

BatchOsDisk

Объект

Параметры диска операционной системы вычислительного узла (VM).

Имя	Тип	Описание
caching	CachingType	Указывает требования к кэшированию. Возможные значения: None, ReadOnly, ReadWrite. Значения по умолчанию: нет для хранилища уровня "Стандартный". ReadOnly для хранилища Premium.
diskSizeGB	integer (int32)	Начальный размер диска в ГБ при создании нового диска ОС.
ephemeralOSDiskSettings	BatchDiffDiskSettings	Указывает временные параметры диска для диска операционной системы, используемого вычислительным узлом (vm).
managedDisk	ManagedDisk	Параметры управляемого диска.
writeAcceleratorEnabled	boolean	Указывает, следует ли включить или отключить записьAccelerator на диске.

BatchPoolCreateOptions

Объект

Parameters for creating a пакетная служба Azure Pool.

Имя	Тип	Описание
applicationPackageReferences	BatchApplicationPackageReference[]	Список пакетов, установленных на каждом вычислительном узле в пуле. При создании пула идентификатор приложения пакета должен быть полностью квалифицирован (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Майкрософт. Batch/batchAccounts/{accountName}/applications/{applicationName}). Изменения ссылок на пакеты влияют на все новые узлы, присоединенные к пулу, но не влияют на вычислительные узлы, которые уже находятся в пуле, пока они не перезагрузятся или переимыслятся. В любом пуле имеется не более 10 ссылок на пакеты.
autoScaleEvaluationInterval	string (duration)	Интервал времени, с помощью которого автоматически настраивается размер пула в соответствии с формулой автомасштабирования. Значение по умолчанию — 15 минут. Минимальное и максимальное значение — 5 минут и 168 часов соответственно. Если указать значение менее 5 минут или больше 168 часов, служба пакетной службы возвращает ошибку; Если вы вызываете REST API напрямую, код состояния HTTP равен 400 (недопустимый запрос). Длительность времени указана в формате ISO 8601.
autoScaleFormula	string	Формула для требуемого количества вычислительных узлов в пуле. Это свойство не должно быть указано, если параметр enableAutoScale имеет значение false. Требуется, если параметр enableAutoScale имеет значение true. Формула проверяется на допустимость перед созданием пула. Если формула недопустима, служба пакетной службы отклоняет запрос с подробными сведениями об ошибке. Для получения дополнительной информации о задании этой формулы см. «Автоматическое масштабирование вычислительных узлов в пакетная служба Azure пуле» (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).
displayName	string	Отображаемое имя пула. Отображаемое имя не должно быть уникальным и может содержать любые символы Юникода до максимальной длины 1024.
enableAutoScale	boolean	Следует ли автоматически настраивать размер пула с течением времени. Если значение false, необходимо указать по крайней мере один из targetDedicatedNodes и targetLowPriorityNodes. Если значение true, требуется свойство autoScaleFormula, а пул автоматически изменяет размер в соответствии с формулой. По умолчанию используется значение false.
enableInterNodeCommunication	boolean	Разрешает ли пул прямой обмен данными между вычислительными узлами. Включение обмена данными между узлами ограничивает максимальный размер пула из-за ограничений развертывания на вычислительных узлах пула. Это может привести к тому, что пул не достигает требуемого размера. По умолчанию используется значение false.
id	string	Строка, которая однозначно идентифицирует пул в учетной записи. Идентификатор может содержать любое сочетание буквенно-цифровых символов, включая дефисы и символы подчеркивания, и не может содержать более 64 символов. Идентификатор сохраняет регистр и не учитывает регистр (т. е. у вас могут не быть двух идентификаторов пула в учетной записи, которые отличаются только по регистру).
metadata	BatchMetadataItem[]	Список пар "имя-значение", связанных с пулом в качестве метаданных. Пакетная служба не назначает никакое значение метаданным; он предназначен исключительно для использования пользовательского кода.
mountConfiguration	MountConfiguration[]	Монтирование хранилища с использованием указанной файловой системы на весь срок жизни пула. Монтировать хранилище с помощью файловой системы Azure, NFS, CIFS или файловой системы на базе Blobfuse.
networkConfiguration	NetworkConfiguration	Конфигурация сети для пула.
resizeTimeout	string (duration)	Время ожидания выделения вычислительных узлов в пул. Это время ожидания применяется только к масштабированию вручную; Он не действует, если параметр enableAutoScale имеет значение true. Значение по умолчанию — 15 минут. Минимальное значение — 5 минут. Если указать значение менее 5 минут, пакетная служба возвращает ошибку; Если вы вызываете REST API напрямую, код состояния HTTP равен 400 (недопустимый запрос). Длительность времени указана в формате ISO 8601.
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. Максимальное значение меньше 4 раза меньше числа ядер vmSize пула или 256.
upgradePolicy	UpgradePolicy	Политика обновления для пула. Описывает политику обновления — автоматическую, ручную или перекатную.
userAccounts	UserAccount[]	Список учетных записей пользователей, создаваемых на каждом вычислительном узле в пуле.
virtualMachineConfiguration	VirtualMachineConfiguration	Конфигурация виртуальной машины для пула. Задание этого свойства обязательно.
vmSize	string	Размер виртуальных машин в пуле. Все виртуальные машины в пуле имеют одинаковый размер. Для информации о доступных размерах виртуальных машин для пулов, использующих изображения с Виртуальные машины Marketplace (пулы, созданные с помощью virtualMachineConfiguration), см. раздел Размеры для Виртуальные машины в Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). Пакетный режим поддерживает все Azure размеры виртуальных машин, кроме STANDARD_A0 и тех, что имеют премиальный накопитель (серии STANDARD_GS, STANDARD_DS и STANDARD_DSV2).

BatchPoolEndpointConfiguration

Объект

Конфигурация конечной точки для пула.

Имя	Тип	Описание
inboundNATPools	BatchInboundNatPool[]	Список входящих NAT-пулов, которые могут использоваться для внешнего адресации конкретных портов на отдельном вычислительном узле. Максимальное количество входящих NAT пулов на один пакетный пул составляет 5. Если превышается максимальное количество входящих NAT-пулов, запрос неудачно с HTTP-кодом статуса 400. Это невозможно указать, если IPAddressProvisioningType — NoPublicIPAddresses.

BatchPoolIdentityReference

Объект

Ссылка на один из идентификаторов пула для шифрования диска. Это удостоверение будет использоваться для доступа к хранилищу ключей.

Имя	Тип	Описание
resourceId	string (arm-id)	Идентификатор ресурса ARM назначенного пользователем удостоверения. Эта ссылка должна быть включена в идентификаторы пула.

BatchPublicIpAddressConfiguration

Объект

Конфигурация общедоступного IP-адреса конфигурации сети пула.

Имя	Тип	Описание
ipAddressIds	string[] (arm-id)	Список общедоступных IP-адресов, которые будет использоваться пакетной службой при подготовке вычислительных узлов. Количество IP-адресов, указанных здесь, ограничивает максимальный размер пула — 100 выделенных узлов или 100 узлов с низким приоритетом для каждого общедоступного IP-адреса. Например, для пула, нуждающегося в 250 выделенных виртуальных машинах, потребуется не менее 3 общедоступных IP-адресов. Каждый элемент этой коллекции имеет вид: /subscriptions/{subscription}/resourceGroups/{group}/providers/Майкрософт. Network/publicIPAddresses/{ip}.
ipFamilies	IPFamily[]	Семейства IP-адресов, используемые для указания версий IP-адресов, доступных для пула. Семейства IP-адресов используются для определения пулов с одним или двумя стеками. Для одного стека ожидаемое значение — IPv4. Для двойного стека ожидаемые значения — IPv4 и IPv6.
ipTags	IPTag[]	Список IP-тегов, связанных с публичными IP-адресами пула. IP-теги используются для категоризации и фильтрации общедоступных IP-адресов в целях выставления счетов и управления.
provision	IpAddressProvisioningType	Тип подготовки для общедоступных IP-адресов пула. Значение по умолчанию — BatchManaged.

BatchStartTask

Объект

Пакетная служба будет повторять задачи при активации операции восстановления на узле. Примеры операций восстановления включают (но не ограничиваются) при перезагрузке неработоспособного узла или вычислительном узле исчезли из-за сбоя узла. Повторные попытки из-за операций восстановления не учитываются и не учитываются для maxTaskRetryCount. Даже если значение maxTaskRetryCount равно 0, может произойти внутренняя повторная попытка из-за операции восстановления. Из-за этого все задачи должны быть идемпотентными. Это означает, что задачи должны терпеть прерывание и перезапуск без повреждения или дублирования данных. Рекомендуется использовать определенную форму контрольных точек для длительных задач. В некоторых случаях запуск StartTask может выполняться повторно, даже если вычислительный узел не был перезагружен. Следует учесть, чтобы избежать запуска StartTasks, создающих отсортовый процесс или установку или запуск служб из рабочего каталога StartTask, так как это приведет к тому, что пакетная служба сможет повторно запустить StartTask.

Имя	Тип	Описание
commandLine	string	Командная строка StartTask. Командная строка не выполняется под оболочкой и поэтому не может воспользоваться преимуществами функций оболочки, таких как расширение переменной среды. Если вы хотите воспользоваться такими возможностями, стоит вызвать оболочку в командной строке, например, используя "cmd /c MyCommand" в Windows или "/bin/sh -c MyCommand" в Linux. Если командная строка ссылается на пути к файлам, она должна использовать относительный путь (относительно рабочего каталога задачи) или использовать указанную пакетную переменную среды (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables).
containerSettings	BatchTaskContainerSettings	Настройки контейнера, под которым работает StartTask. Когда это указано, все каталоги рекурсивно ниже AZ_BATCH_NODE_ROOT_DIR (корня пакетная служба Azure каталогов на узле) отображаются в контейнер, все переменные среды задачи отображаются в контейнер, и в контейнере выполняется командная строка задачи. Файлы, созданные в контейнере вне AZ_BATCH_NODE_ROOT_DIR, могут не отражаться на хост-диске, что означает, что API пакетных файлов не смогут получить доступ к этим файлам.
environmentSettings	EnvironmentSetting[]	Список параметров переменной среды для StartTask.
maxTaskRetryCount	integer (int32)	Максимальное количество повторных попыток задачи. Пакетная служба повторяет задачу, если его код выхода не является ненулевой. Обратите внимание, что это значение специально управляет числом повторных попыток. Пакетная служба попытается выполнить задачу один раз, а затем повторите попытку до этого ограничения. Например, если максимальное число повторных попыток равно 3, пакет пытается выполнить задачу до 4 раз (одна начальная попытка и 3 повторные попытки). Если максимальное число повторных попыток равно 0, пакетная служба не повторяет задачу. Если максимальное число повторных попыток равно -1, пакетная служба повторяет задачу без ограничения, однако это не рекомендуется для начальной задачи или любой задачи. Значение по умолчанию равно 0 (без повторных попыток).
resourceFiles	ResourceFile[]	Список файлов, которые служба пакетной службы скачивает на вычислительный узел перед выполнением командной строки. Существует максимальный размер списка файлов ресурсов. При превышении максимального размера запрос завершится ошибкой, и код ошибки ответа будет RequestEntityTooLarge. В этом случае коллекция ResourceFiles должна быть уменьшена. Это можно сделать с помощью .zip файлов, пакетов приложений или контейнеров Docker. Файлы, перечисленные в этом элементе, находятся в рабочем каталоге задачи.
userIdentity	UserIdentity	Идентификатор пользователя, под которым работает StartTask. Если задача опущена, она выполняется как неадминистративный пользователь, уникальный для задачи.
waitForSuccess	boolean	Следует ли пакетной службе ждать успешного завершения startTask (т. е. выйти с кодом выхода 0) перед планированием любых задач на вычислительном узле. Если значение true и startTask завершается сбоем на узле, пакетная служба повторяет запускTask до максимального количества повторных попыток (maxTaskRetryCount). Если задача по-прежнему не выполнена успешно после всех повторных попыток, служба пакетной службы помечает узел неиспользуемой и не будет планировать задачи. Это условие можно обнаружить с помощью сведений о состоянии вычислительного узла и сведения о сбоях. Если значение false, служба пакетной службы не будет ожидать завершения запускаTask. В этом случае другие задачи могут запускаться на вычислительном узле во время запуска StartTask; и даже если сбой StartTask, новые задачи будут продолжать планироваться на вычислительном узле. Значение по умолчанию — true.

BatchTaskContainerSettings

Объект

Параметры контейнера для задачи.

Имя	Тип	Описание
containerHostBatchBindMounts	ContainerHostBatchBindMountEntry[]	Пути, которые необходимо подключить к задаче контейнера. Если этот массив имеет значение NULL или отсутствует, задача контейнера будет подключать весь временный диск диска в окнах (или AZ_BATCH_NODE_ROOT_DIR в Linux). Он не будет подключать пути к данным в контейнер, если этот массив задан как пустой.
containerRunOptions	string	Дополнительные параметры команды создания контейнера. Эти дополнительные параметры предоставляются в качестве аргументов в команду docker create, а также те, которые управляются пакетной службой.
imageName	string	Изображение для создания контейнера, в котором будет выполняться задача. Это полная ссылка на изображение, как было бы указано в «docker pull». Если в названии изображения нет тега, по умолчанию используется тег «:latest».
registry	ContainerRegistryReference	Частный реестр, содержащий контейнер Image. Эта настройка может быть опущена, если она уже была предоставлена при создании пула.
workingDirectory	ContainerWorkingDirectory	Расположение рабочего каталога задач контейнера. Значение по умолчанию — taskWorkingDirectory.

BatchTaskSchedulingPolicy

Объект

Указывает, как задачи должны распределяться по вычислительным узлам.

Имя	Тип	Default value	Описание
jobDefaultOrder	BatchJobDefaultOrder	none	Порядок планирования задач из разных заданий с одинаковым приоритетом. Если не указано, по умолчанию используется значение none.
nodeFillType	BatchNodeFillType		Распределение задач между вычислительными узлами в пуле. Если значение не указано, по умолчанию распространяется.

BatchUefiSettings

Объект

Указывает параметры безопасности, такие как безопасная загрузка и vTPM, используемые при создании виртуальной машины.

Имя	Тип	Описание
secureBootEnabled	boolean	Указывает, следует ли включить безопасную загрузку на виртуальной машине.
vTpmEnabled	boolean	Указывает, следует ли включить vTPM на виртуальной машине.

BatchVmDiskSecurityProfile

Объект

Задает параметры профиля безопасности для управляемого диска. Примечание: Он может быть установлен только для конфиденциальных виртуальных машин и необходим при использовании конфиденциальных виртуальных машин.

Имя	Тип	Описание
securityEncryptionType	SecurityEncryptionTypes	Указывает тип шифрования управляемого диска. Он имеет значение VMGuestStateOnly для шифрования только большого двоичного объекта VMGuestState и NonPersistedTPM для сохранения состояния встроенного ПО в BLOB-объекте VMGuestState. Примечание: Он может быть установлен только для конфиденциальных виртуальных машин и требуется при использовании конфиденциальных виртуальных машин.

BatchVmImageReference

Объект

Ссылка на Виртуальные машины Azure Marketplace Image или Azure Compute Gallery Image. Чтобы получить список всех ссылок на изображения Azure Marketplace, проверенных пакетная служба Azure, смотрите операцию 'List Supported Images'.

Имя	Тип	Описание
communityGalleryImageId	string	Уникальный идентификатор изображения в галерее сообщества. Это свойство является взаимоисключающим с другими свойствами и может быть получено из вызова GET коллекции сообщества.
exactVersion	string	Конкретная версия изображения платформы или изображения маркетплейса, используемая для создания узла. Это поле только для чтения отличается от 'version' только в том случае, если значение 'version', указанное при создании пула, было 'последним'.
offer	string	Тип предложения изображения Виртуальные машины Azure Marketplace. Например, UbuntuServer или WindowsServer.
publisher	string	Издатель изображения Виртуальные машины Azure Marketplace. Например, Canonical или MicrosoftWindowsServer.
sharedGalleryImageId	string	Уникальный идентификатор изображения общей галереи. Это свойство является взаимоисключающим с другими свойствами и может быть получено из вызова GET образа общей коллекции.
sku	string	SKU изображения Виртуальные машины Azure Marketplace. Например, 18.04-LTS или 2019-Datacenter.
version	string	Версия изображения Виртуальные машины Azure Marketplace. Для выбора последней версии изображения можно задать значение 'lastest'. Если опущено, значение по умолчанию — "последняя".
virtualMachineImageId	string (arm-id)	Идентификатор ресурса ARM образа Azure Compute Gallery. Вычислительные узлы в пуле будут созданы с использованием этого идентификатора изображения. Это в виде /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Майкрософт. Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} или /subscriptions/{subscriptionId}/resourceGroup/{resourceGroup}/providers/Майкрософт. Compute/galleries/{galleryName}/images/{imageDefinitionName} для постоянной настройки последней версии изображения по умолчанию. Это свойство взаимоисключается с другими свойствами ImageReference. Образ Azure Compute Gallery должен иметь реплики в том же регионе и иметь ту же подписку, что и аккаунт пакетная служба Azure. Если версия изображения не указана в imageId, будет использована последняя версия. Для получения информации о настройках межсетевого экрана для агента Batch Compute Node для взаимодействия с сервисом Batch см. https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration.

CachingType

Перечисление

Энумы CachingType

Значение	Описание
none	Режим кэширования для диска не включен.
readonly	Режим кэширования для диска доступен только для чтения.
readwrite	Режим кэширования для диска считывается и записывается.

CifsMountConfiguration

Объект

Сведения, используемые для подключения к файловой системе CIFS.

Имя	Тип	Описание
mountOptions	string	Дополнительные параметры командной строки для передачи команде подключения. Это опции 'net use' в Windows и опции 'mount' в Linux.
password	string (password)	Пароль, используемый для проверки подлинности в файловой системе CIFS.
relativeMountPath	string	Относительный путь на вычислительном узле, куда будет монтирована файловая система. Все файловые системы подключены относительно каталога подключений пакетной службы, доступные с помощью переменной среды AZ_BATCH_NODE_MOUNTS_DIR.
source	string	Универсальный код ресурса (URI) файловой системы для подключения.
username	string	Пользователь, используемый для проверки подлинности в файловой системе CIFS.

ContainerHostBatchBindMountEntry

Объект

Вход пути и режима подключения, который требуется подключить к контейнеру задач.

Имя	Тип	Описание
isReadOnly	boolean	Подключите этот исходный путь как режим только для чтения или нет. Значение по умолчанию равно false (режим чтения и записи). Если вы подключаете этот путь как режим чтения и записи, это не означает, что у всех пользователей в контейнере есть доступ на чтение и запись для пути, он зависит от доступа на виртуальной машине узла. Если этот путь подключен только для чтения, все пользователи в контейнере не смогут изменить путь.
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 enums

Значение	Описание
dockerCompatible	Для запуска контейнеров будет использоваться технология совместимого контейнера Docker.
criCompatible	Технология на основе CRI будет использоваться для запуска контейнеров.

ContainerWorkingDirectory

Перечисление

ContainerWorkingDirectory enums

Значение	Описание
taskWorkingDirectory	Используйте стандартную рабочую директорию задачи пакетного сервиса, которая будет содержать файлы ресурсов задач, заполненные batch.
containerImageDefault	Используйте рабочую директорию, определённую в контейнере Image. Обратите внимание, что эта папка не будет содержать файлы ресурсов, загруженные Batch.

DataDisk

Объект

Параметры, которые будут использоваться дисками данных, связанными с вычислительными узлами в пуле. При использовании подключенных дисков данных необходимо подключить и отформатировать диски из виртуальной машины, чтобы использовать их.

Имя	Тип	Описание
caching	CachingType	Тип кэширования для дисков данных. Значение по умолчанию для кэширования — readwrite. Сведения о параметрах кэширования см. в статье https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.
diskSizeGB	integer (int32)	Начальный размер диска в гигабайтах.
lun	integer (int32)	Номер логического блока. Параметр logicalUnitNumber используется для уникальной идентификации каждого диска данных. При присоединении нескольких дисков каждый должен иметь отдельный логический номерUnitNumber. Значение должно быть от 0 до 63 включительно.
managedDisk	ManagedDisk	Параметры управляемого диска.

DiffDiskPlacement

Перечисление

Задаёт эфемерное расположение диска для диска операционной системы для всех вычислительных узлов (VM) пула. Это свойство можно использовать пользователем в запросе, чтобы выбрать расположение операционной системы. Например, кэшировать место на диске для подготовки диска Эфемеральной ОС. Для получения дополнительной информации о требованиях к размеру диска Ephemeral OS, пожалуйста, обратитесь к требованиям к размеру диска для Windows виртуальных машин на https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements и Linux VM на https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements

Значение	Описание
cachedisk	Диск операционной системы в эфемерном режиме хранится в кэше виртуальной машины.

DiskCustomerManagedKey

Объект

Ссылка на ключ, управляемый клиентом, для шифрования диска.

Имя	Тип	Описание
identityReference	BatchPoolIdentityReference	Ссылка на один из идентификаторов пула для шифрования диска. Это удостоверение будет использоваться для доступа к KeyVault.
keyUrl	string	Полный url-адрес ключа версии, указывающий на ключ в KeyVault. Сегмент версии URL-адреса требуется независимо от значения rotationToLatestKeyVersionEnabled.
rotationToLatestKeyVersionEnabled	boolean	Установите этот флаг в значение true, чтобы включить автоматическое обновление шифрования диска до последней версии ключа. По умолчанию — false.

DiskEncryptionConfiguration

Объект

Конфигурация шифрования дисков, примененная к вычислительным узлам в пуле. Конфигурация шифрования диска не поддерживается в пуле Linux, созданном с помощью образа Azure Compute Gallery.

Имя	Тип	Описание
customerManagedKey	DiskCustomerManagedKey	Ссылка на ключ, управляемый клиентом, для шифрования диска ОС. Ключ, управляемый клиентом, зашифрует диск ОС с помощью EncryptionAtRest, и по умолчанию мы также зашифруем диск с данными. Его можно использовать только в том случае, если пул настроен с помощью удостоверения и OsDisk установлен в качестве одного из целевых объектов DiskEncryption.
targets	DiskEncryptionTarget[]	Список целевых объектов дисков пакетной службы будет шифроваться на вычислительном узле. Список целевых объектов дисков пакетной службы будет шифроваться на вычислительном узле.

DiskEncryptionSetParameters

Объект

Идентификатор ресурса ARM набора шифрования диска.

Имя	Тип	Описание
id	string (arm-id)	Идентификатор ресурса ARM набора шифрования диска. Ресурс должен находиться в той же подписке, что и аккаунт пакетной службы.

DiskEncryptionTarget

Перечисление

Enums DiskEncryptionTarget

Значение	Описание
osdisk	Диск ОС на вычислительном узле шифруется.
temporarydisk	Временный диск на вычислительном узле шифруется. В Linux это шифрование применяется к другим секциям (например, на подключенных дисках данных) при выполнении шифрования во время загрузки.

DynamicVNetAssignmentScope

Перечисление

DynamicVNetAssignmentScope enums

Значение	Описание
none	Динамическое назначение виртуальной сети не включено.
job	Динамическое назначение виртуальной сети выполняется для каждого задания.

ElevationLevel

Перечисление

Enums ElevationLevel

Значение	Описание
nonadmin	Пользователь является стандартным пользователем без повышенного доступа.
admin	Пользователь является пользователем с повышенными правами доступа и работает с полными разрешениями администратора.

EnvironmentSetting

Объект

Переменная среды, устанавливаемая в процессе задачи.

Имя	Тип	Описание
name	string	Имя переменной среды.
value	string	Значение переменной среды.

HostEndpointSettings

Объект

Указывает определенные параметры конечной точки узла.

Имя	Тип	Описание
inVMAccessControlProfileReferenceId	string	Указывает ссылку на идентификатор ресурса InVMAccessControlProfileVersion в виде /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Майкрософт. Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version}.
mode	HostEndpointSettingsModeTypes	Указывает режим выполнения политики управления доступом.

HostEndpointSettingsModeTypes

Перечисление

HostEndpointSettingsModeTypes enums

Значение	Описание
Audit	В режиме аудита система действует так, как если бы она применяла политику управления доступом, включая выдачу записей отказа в доступе в журналах, но фактически не запрещает какие-либо запросы на размещение конечных точек.
Enforce	Режим принудительного применения — рекомендуемый режим работы, и система будет применять политику контроля доступа. Это свойство нельзя использовать вместе с 'inVMAccessControlProfileReferenceId'.

InboundEndpointProtocol

Перечисление

Enums InboundEndpointProtocol

Значение	Описание
tcp	Используйте TCP для конечной точки.
udp	Используйте UDP для конечной точки.

IpAddressProvisioningType

Перечисление

IPAddressProvisioningType enums

Значение	Описание
batchmanaged	Общедоступный IP-адрес будет создан и управляется пакетной службой. В зависимости от размера пула может быть несколько общедоступных 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)	Идентификатор группы для учётной записи пользователя. Свойства пользовательского интерфейса и gid должны быть указаны вместе или не вообще. Если не указана базовая операционная система, выбирает гиб.
sshPrivateKey	string (password)	Приватный ключ SSH для учётной записи пользователя. Закрытый ключ не должен быть защищен паролем. Приватный ключ используется для автоматической настройки асимметричной аутентификации на основе SSH между вычислительными узлами в Linux-пуле, когда свойство enableInterNodeCommunication пула верно (оно игнорируется, если enableInterNodeCommunication ошибочно). Для этого поместите пару ключей в каталог SSH пользователя. Если не указано, SSH без пароля не настраивается между вычислительными узлами (не изменяется каталог .ssh пользователя).
uid	integer (int32)	Идентификатор пользователя аккаунта пользователя. Свойства пользовательского интерфейса и gid должны быть указаны вместе или не вообще. Если базовая операционная система не указана, выбирает пользовательский интерфейс.

LoginMode

Перечисление

Enums LoginMode

Значение	Описание
batch	Режим входа LOGON32_LOGON_BATCH Win32. Для длительных параллельных процессов рекомендуется использовать режим входа пакетной службы.
interactive	Режим входа LOGON32_LOGON_INTERACTIVE Win32. UAC активирован в пулах Windows VirtualMachineConfiguration. Если эта опция используется с повышенной пользовательской идентичностью в пуле конфигураций Windows VirtualMachine, пользовательская сессия не будет повышена, если только приложение, выполняемое командной строкой задачи, не настроено всегда требовать административных прав или всегда требовать максимальные привилегии.

ManagedDisk

Объект

Параметры управляемого диска.

Имя	Тип	Описание
diskEncryptionSet	DiskEncryptionSetParameters	Указывает идентификатор ресурса набора шифрования управляемых пользователем дисков для управляемого диска. Его можно установить только в режиме UserSubscription.
securityProfile	BatchVmDiskSecurityProfile	Задает параметры профиля безопасности для управляемого диска.
storageAccountType	StorageAccountType	Тип учетной записи хранения для управляемого диска.

MountConfiguration

Объект

Файловая система для подключения на каждом узле.

Имя	Тип	Описание
azureBlobFileSystemConfiguration	AzureBlobFileSystemConfiguration	Контейнер служба хранилища Azure для монтирования с помощью blob FUSE на каждом узле. Это свойство является взаимоисключающим со всеми другими свойствами.
azureFileShareConfiguration	AzureFileShareConfiguration	Azure File Share для монтировки на каждом узле. Это свойство является взаимоисключающим со всеми другими свойствами.
cifsMountConfiguration	CifsMountConfiguration	Файловая система CIFS/SMB для подключения на каждом узле. Это свойство является взаимоисключающим со всеми другими свойствами.
nfsMountConfiguration	NfsMountConfiguration	Файловая система NFS для подключения на каждом узле. Это свойство является взаимоисключающим со всеми другими свойствами.

NetworkConfiguration

Объект

Конфигурация сети для пула.

Имя	Тип	Описание
dynamicVNetAssignmentScope	DynamicVNetAssignmentScope	Область динамического назначения виртуальной сети.
enableAcceleratedNetworking	boolean	Следует ли включить ускоренную сеть в этом пуле. Ускорение сети обеспечивает виртуализацию одно корневых операций ввода-вывода (SR-IOV) к виртуальной машине, что может привести к повышению производительности сети. Дополнительные сведения см. в статье https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview.
endpointConfiguration	BatchPoolEndpointConfiguration	Конфигурация конечных точек на вычислительных узлах в пакетном пуле.
publicIPAddressConfiguration	BatchPublicIpAddressConfiguration	Конфигурация public IPAddress для вычислительных узлов в пуле пакетной службы.
subnetId	string	Идентификатор ресурса ARM подсети виртуальной сети, к которой присоединяются вычислительные узлы пула. Это форма /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}}. Виртуальная сеть должна находиться в том же регионе и подписке, что и аккаунт пакетная служба Azure. Указанная подсеть должна иметь достаточно свободных IP-адресов для размещения количества вычислительных узлов в пуле. Если в подсети недостаточно свободных IP-адресов, пул частично выделит узлы, и возникает ошибка изменения размера. Принципал сервиса 'MicrosoftAzureBatch' должен иметь роль 'Classic Virtual Machine Contributor' Role-Based контроль доступа (RBAC) для указанной VNet. Указанная подсеть должна обеспечивать связь из сервиса пакетная служба Azure для планирования задач на узлах. Это можно проверить, проверьте, имеет ли указанная виртуальная сеть любые связанные группы безопасности сети (NSG). Если связь с узлами в указанной подсети запрещена группой безопасности сети, служба пакетной службы установит состояние вычислительных узлов неиспользуемым. Только виртуальные сети ARM ('Майкрософт. Поддерживаются Network/virtualNetworks'). Если в указанной VNet есть соответствующие группы сетевой безопасности (NSG), то для входящей связи необходимо включить несколько зарезервированных системных портов, включая порты 29876 и 29877. Также включите исходящие соединения с служба хранилища Azure на порте 443. Дополнительные сведения см. в статье 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 enums

Значение	Описание
allow	Разрешить доступ.
deny	Запретить доступ.

NfsMountConfiguration

Объект

Сведения, используемые для подключения к файловой системе NFS.

Имя	Тип	Описание
mountOptions	string	Дополнительные параметры командной строки для передачи команде подключения. Это опции 'net use' в Windows и опции 'mount' в Linux.
relativeMountPath	string	Относительный путь на вычислительном узле, куда будет монтирована файловая система. Все файловые системы подключены относительно каталога подключений пакетной службы, доступные с помощью переменной среды 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	Префикс blob для загрузки blob из контейнера служба хранилища Azure. Будут загружены только большие двоичные объекты, имена которых начинаются с указанного префикса. Свойство допустимо, только если используется autoStorageContainerName или storageContainerUrl. Этот префикс может быть частичным именем файла или подкаталогом. Если префикс не указан, все файлы в контейнере будут скачаны.
fileMode	string	Атрибут режима разрешений файла в восьмимерном формате. Это свойство применяется только к файлам, загружаемым в вычислительные узлы Linux. Он будет игнорирован, если он указан для resourceFile, который будет загружен на вычислительный узел Windows. Если это свойство не указано для вычислительного узла Linux, то к файлу применяется значение по умолчанию 0770.
filePath	string	Местоположение на Вычислительном узле, куда можно скачать файл(ы), относительно рабочей директории задачи. Если задано свойство httpUrl, файлPath является обязательным и описывает путь, в который будет скачан файл, включая имя файла. В противном случае, если задано свойство autoStorageContainerName или storageContainerUrl, filePath является необязательным и является каталогом для скачивания файлов. В случае, когда filePath используется в качестве каталога, любая структура каталогов, уже связанная с входными данными, будет сохранена в полном объеме и добавлена в указанный каталог filePath. Указанный относительный путь не может выйти из рабочего каталога задачи (например, используя '..').
httpUrl	string (uri)	URL-адрес скачиваемого файла. Свойства autoStorageContainerName, storageContainerUrl и httpUrl являются взаимоисключающими, и один из них должен быть указан. Если URL указывает на Хранилище BLOB-объектов Azure, он должен быть читаем с вычислительных узлов. Существует три способа получить такой URL для blob в хранилище Azure: добавить Shared Access Signature (SAS), предоставляющую права на чтение blob, использовать управляемую идентичность с разрешением на чтение или установить ACL для blob или его контейнера для публичного доступа.
identityReference	BatchNodeIdentityReference	Ссылка на назначенную пользователю идентичность для доступа к Хранилище BLOB-объектов Azure, указанная через storageContainerUrl или httpUrl.
storageContainerUrl	string (uri)	URL blob container внутри Хранилище BLOB-объектов Azure. Свойства autoStorageContainerName, storageContainerUrl и httpUrl являются взаимоисключающими, и один из них должен быть указан. Этот URL-адрес должен быть доступен для чтения и перечисления из вычислительных узлов. Существует три способа получить такой URL для контейнера в хранилище Azure: включить Shared Access Signature (SAS), предоставляющую права на чтение и список контейнера, использовать управляемую идентичность с правами на чтение и список, либо установить ACL для контейнера для публичного доступа.

RollingUpgradePolicy

Объект

Параметры конфигурации, используемые при выполнении последовательного обновления.

Имя	Тип	Описание
enableCrossZoneUpgrade	boolean	Разрешить VMSS игнорировать границы AZ при создании пакетов обновления. Учитывайте домен обновления и maxBatchInstancePercent, чтобы определить размер пакета. Это поле может иметь значение true или false только при использовании NodePlacementConfiguration в качестве зонального.
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

Перечисление

Enums SecurityEncryptionTypes

Значение	Описание
DiskWithVMGuestState	Для параметра EncryptionType управляемого диска задано значение DiskWithVMGuestState для шифрования управляемого диска вместе с большим двоичным объектом VMGuestState. Он не поддерживается в дисках с данными.
NonPersistedTPM	Для параметра EncryptionType управляемого диска задано значение NonPersistedTPM, чтобы состояние встроенного ПО не сохранялось в большом двоичном объекте VMGuestState.
VMGuestStateOnly	Для параметра EncryptionType управляемого диска задано значение VMGuestStateOnly для шифрования только большого двоичного объекта VMGuestState.

SecurityProfile

Объект

Задает параметры профиля безопасности для масштабируемого набора виртуальных машин или виртуальной машины.

Имя	Тип	Описание
encryptionAtHost	boolean	Это свойство можно использовать пользователем в запросе, чтобы включить или отключить шифрование узла для виртуальной машины или масштабируемого набора виртуальных машин. Это позволит включить шифрование для всех дисков, включая диск Resource/Temp на самом узле. Дополнительные сведения о шифровании в требованиях к узлам см. в https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizes.
proxyAgentSettings	ProxyAgentSettings	Задает параметры ProxyAgent при создании виртуальной машины.
securityType	SecurityTypes	Указывает тип безопасности виртуальной машины. Для включения UefiSettings необходимо задать любое указанное значение.
uefiSettings	BatchUefiSettings	Указывает параметры безопасности, такие как безопасная загрузка и vTPM, используемые при создании виртуальной машины. Указывает параметры безопасности, такие как безопасная загрузка и vTPM, используемые при создании виртуальной машины.

SecurityTypes

Перечисление

Указывает тип безопасности виртуальной машины. Для включения UefiSettings необходимо задать любое указанное значение.

Значение	Описание
trustedLaunch	Доверенный запуск защищает от сложных и постоянных атак.
confidentialvm	Azure Confidential Computing предлагает конфиденциальные виртуальные машины для арендаторов с высокими требованиями к безопасности и конфиденциальности. Эти виртуальные машины обеспечивают надежную, аппаратно защищенную границу, помогающую удовлетворить ваши потребности в безопасности. Конфиденциальные виртуальные машины можно использовать для миграции, не изменяя код, с помощью платформы, защищающей состояние виртуальной машины от чтения или изменения.

ServiceArtifactReference

Объект

Указывает идентификатор ссылки на артефакт службы, используемый для задания одной версии образа для всех виртуальных машин в масштабируемом наборе при использовании последней версии образа.

Имя	Тип	Описание
id	string	Идентификатор ссылки на сервисный артефакт в ServiceArtifactReference. Идентификатор артефакта сервиса в виде /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Майкрософт. Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

StorageAccountType

Перечисление

Перечисления StorageAccountType

Значение	Описание
standard_lrs	Диск данных должен использовать стандартное локально избыточное хранилище.
premium_lrs	Диск данных должен использовать локально избыточное хранилище класса "Премиум".
standardssd_lrs	Диск данных или диск ОС должен использовать локально избыточное хранилище SSD уровня "Стандартный".

UpgradeMode

Перечисление

Enums UpgradeMode

Значение	Описание
automatic	Все виртуальные машины в масштабируемом наборе автоматически обновляются одновременно.
manual	Вы управляете применением обновлений для виртуальных машин в масштабируемом наборе. Это можно сделать с помощью действия manualUpgrade.
rolling	Существующие экземпляры в масштабируемом наборе удаляются в пакетах для обновления. После завершения обновленного пакета экземпляры начнут принимать трафик снова, а следующий пакет начнется. Это продолжается до тех пор, пока все экземпляры не будут доставлены up-to-date.

UpgradePolicy

Объект

Описывает политику обновления — автоматическую, ручную или перекатную.

Имя	Тип	Описание
automaticOSUpgradePolicy	AutomaticOsUpgradePolicy	Параметры конфигурации, используемые для автоматического обновления ОС. Параметры конфигурации, используемые для автоматического обновления ОС.
mode	UpgradeMode	Задает режим обновления до виртуальных машин в масштабируемом наборе. Возможны следующие значения: вручную. Вы управляете приложением обновлений виртуальных машин в масштабируемом наборе. Это можно сделать с помощью действия manualUpgrade. автоматическое. Все виртуальные машины в масштабируемом наборе автоматически обновляются одновременно. Скользящей. Масштабируемый набор выполняет обновления в пакетах с необязательным временем приостановки между ними.
rollingUpgradePolicy	RollingUpgradePolicy	Параметры конфигурации, используемые при выполнении последовательного обновления.

UserAccount

Объект

Свойства, используемые для создания пользователя, используемого для выполнения задач на вычислительном узле пакетная служба Azure.

Имя	Тип	Описание
elevationLevel	ElevationLevel	Уровень высоты аккаунта пользователя. Значение по умолчанию — nonAdmin.
linuxUserConfiguration	LinuxUserConfiguration	Конфигурация пользователя, специфичная для Linux, для учетной записи пользователя. Это свойство игнорируется, если оно указано в пуле Windows. Если это не указано, пользователь создается с параметрами по умолчанию.
name	string	Имя учетной записи пользователя. Имена могут содержать любые символы Юникода до максимальной длины 20.
password	string (password)	Пароль от учётной записи пользователя.
windowsUserConfiguration	WindowsUserConfiguration	Специфическая для Windows пользовательская конфигурация для учетной записи пользователя. Это свойство можно задать только если пользователь находится в Windows Pool. Если это не указано и находится в Windows Pool, пользователь создаётся с использованием стандартных опций.

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 Marketplace или пользовательский образ виртуальной машины для использования.
licenseType	string	Это касается только образов, содержащих операционную систему Windows, и должно использоваться только при наличии действующих локальных лицензий для вычислительных узлов, которые будут развернуты. Если не указано, скидка на лицензирование в локальной среде не применяется. Значения: Windows_Server - Лицензия на работу на месте предназначена для Windows Server. Windows_Client - Локальная лицензия предназначена для Windows клиента.
nodeAgentSKUId	string	Номер SKU агента пакетного вычислительного узла для подготовки на вычислительных узлах в пуле. Агент пакетного вычислительного узла — это программа, которая выполняется на каждом вычислительном узле в пуле, а также предоставляет интерфейс управления между вычислительным узлом и пакетной службой. Существуют различные реализации агента вычислительного узла, известного как номера SKU для разных операционных систем. Необходимо указать номер SKU агента вычислительного узла, соответствующий выбранной ссылке на изображение. Чтобы получить список поддерживаемых номеров SKU агента вычислительных узлов вместе со списком проверенных ссылок на образы, см. в разделе "Список поддерживаемых номеров SKU агента вычислительных узлов".
nodePlacementConfiguration	BatchNodePlacementConfiguration	Конфигурация размещения узлов для пула. Эта конфигурация будет указывать правила по тому, как узлы в пуле будут физически выделены.
osDisk	BatchOsDisk	Параметры диска операционной системы виртуальной машины.
securityProfile	SecurityProfile	Задает параметры профиля безопасности для масштабируемого набора виртуальных машин или виртуальной машины.
serviceArtifactReference	ServiceArtifactReference	Указывает идентификатор ссылки на артефакт службы, используемый для задания одной версии образа для всех виртуальных машин в масштабируемом наборе при использовании последней версии образа. Идентификатор артефакта сервиса в виде /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Майкрософт. Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}
windowsConfiguration	WindowsConfiguration	Настройки операционной системы Windows на виртуальной машине. Это свойство не должно указываться, если imageReference указывает образ ОС Linux.

VMExtension

Объект

Конфигурация расширений виртуальных машин.

Имя	Тип	Описание
autoUpgradeMinorVersion	boolean	Указывает, следует ли использовать более новую дополнительную версию, если она доступна во время развертывания. Однако после развертывания расширение не будет обновлять дополнительные версии без повторного развертывания, даже если это свойство не имеет значения true.
enableAutomaticUpgrade	boolean	Указывает, следует ли автоматически обновлять расширение платформой, если доступна более новая версия расширения.
name	string	Имя расширения виртуальной машины.
protectedSettings	object	Расширение может содержать защищенные параметрыSettings или protectedSettingsFromKeyVault или не иметь защищенных параметров.
provisionAfterExtensions	string[]	Коллекция имен расширений. Коллекция имен расширений, после которой необходимо подготовить это расширение.
publisher	string	Имя издателя обработчика расширений.
settings	object	Форматированные общедоступные параметры JSON для расширения.
type	string	Тип расширения.
typeHandlerVersion	string	Версия обработчика скрипта.

WindowsConfiguration

Объект

Настройки операционной системы Windows для применения к виртуальной машине.

Имя	Тип	Описание
enableAutomaticUpdates	boolean	Включена ли автоматическая установка обновлений на виртуальной машине. Если опущено, значение по умолчанию имеет значение true.

WindowsUserConfiguration

Объект

Свойства, используемые для создания учетной записи пользователя на вычислительном узле Windows.

Имя	Тип	Описание
loginMode	LoginMode	Режим входа для пользователя. По умолчанию — «пакет».