Pool - Add

Ссылка

Service:: Batch Service

API Version:: 2022-01-01.15.0

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

POST {batchUrl}/pools?api-version=2022-01-01.15.0

With optional parameters:

POST {batchUrl}/pools?timeout={timeout}&api-version=2022-01-01.15.0

Параметры URI

Name	In	Required	Type	Description
batchUrl	path	True	string	Базовый URL-адрес для всех запросов на обслуживание пакетная служба Azure.
api-version	query	True	string	Версия КЛИЕНТСКОго API.
timeout	query		integer int32	Максимальное время, затрачивается сервером на обработку запроса в секундах. По умолчанию это 30 секунд.

Заголовок запроса

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

Name	Type	Description
client-request-id	string uuid	Удостоверение запроса, созданное вызывающим абонентом, в виде GUID без оформления, например фигурных скобок, например 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Должен ли сервер возвращать идентификатор client-request-id в ответе.
ocp-date	string date-time-rfc1123	Время выдачи запроса. Клиентские библиотеки обычно задают для текущего системного времени часов; задайте его явным образом, если вы вызываете REST API напрямую.

Текст запроса

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

Name	Required	Type	Description
id	True	string	Строка, однозначно идентифицирующая пул в учетной записи. Идентификатор может содержать любое сочетание буквенно-цифровых символов, включая дефисы и символы подчеркивания, и не может содержать более 64 символов. Идентификатор сохраняет регистр и не учитывает регистр (т. е. в учетной записи может не быть двух идентификаторов пула, которые отличаются только по регистру).
vmSize	True	string	Размер виртуальных машин в пуле. Все виртуальные машины в пуле имеют одинаковый размер. Сведения о доступных размерах виртуальных машин для пулов Облачные службы (пулы, созданные с помощью cloudServiceConfiguration), см. в разделе "Размеры" для Облачные службы (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Пакетная служба поддерживает все размеры виртуальных машин Облачные службы, кроме ExtraSmall, A1V2 и A2V2. Сведения о доступных размерах виртуальных машин для пулов с помощью образов из Виртуальные машины Marketplace (пулы, созданные с помощью virtualMachineConfiguration) см. в разделе "Размеры" для Виртуальные машины (Linux) илиhttps://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/ "Размеры" для Виртуальные машины (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Пакетная служба поддерживает все размеры виртуальных машин Azure, кроме STANDARD_A0 и хранилища класса Premium (серии STANDARD_GS, STANDARD_DS и STANDARD_DSV2).
applicationLicenses		string[]	Список лицензий приложений пакетной службы будет доступен на каждом вычислительном узле в пуле. Список лицензий приложений должен быть подмножеством доступных лицензий приложений пакетной службы. Если запрашивается лицензия, которая не поддерживается, создание пула завершится ошибкой.
applicationPackageReferences		ApplicationPackageReference[]	Список пакетов, устанавливаемых на каждом вычислительном узле в пуле. Изменения ссылок на пакеты влияют на все новые узлы, присоединенные к пулу, но не влияют на вычислительные узлы, которые уже находятся в пуле, пока они не будут перезагружены или переосмыслены. В любом пуле содержится не более 10 ссылок на пакеты.
autoScaleEvaluationInterval		string	Интервал времени для автоматической настройки размера пула в соответствии с формулой автомасштабирования. Значение по умолчанию — 15 минут. Минимальное и максимальное значение : 5 минут и 168 часов соответственно. Если указать значение менее 5 минут или больше 168 часов, пакетная служба возвращает ошибку; Если вы вызываете REST API напрямую, код состояния HTTP — 400 (недопустимый запрос).
autoScaleFormula		string	Формула для требуемого количества вычислительных узлов в пуле. Это свойство не должно быть указано, если параметр enableAutoScale имеет значение false. Это необходимо, если параметр enableAutoScale имеет значение true. Формула проверяется на допустимость до создания пула. Если формула недопустима, пакетная служба отклоняет запрос с подробными сведениями об ошибке. Дополнительные сведения об указании этой формулы см. в разделе "Автоматическое масштабирование вычислительных узлов в пуле пакетная служба Azure" (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/).
certificateReferences		CertificateReference[]	Список сертификатов, устанавливаемых на каждом вычислительном узле в пуле. Для Windows узлов пакетная служба устанавливает сертификаты в указанное хранилище сертификатов и расположение. Для вычислительных узлов Linux сертификаты хранятся в каталоге рабочей папки задачи, а переменная среды AZ_BATCH_CERTIFICATES_DIR предоставляется задаче для запроса этого расположения. Для сертификатов с видимостью remoteUser каталог certs создается в домашнем каталоге пользователя (например, /home/{user-name}/certs) и сертификаты помещаются в этот каталог.
cloudServiceConfiguration		CloudServiceConfiguration	Конфигурация облачной службы для пула. Это свойство и virtualMachineConfiguration являются взаимоисключающими, и необходимо указать одно из свойств. Это свойство нельзя указать, если учетная запись пакетной службы была создана со свойством poolAllocationMode, равным UserSubscription.
displayName		string	Отображаемое имя пула. Отображаемое имя не должно быть уникальным и может содержать любые символы Юникода до максимальной длины 1024.
enableAutoScale		boolean	Следует ли автоматически настраивать размер пула с течением времени. Если значение равно false, необходимо указать хотя бы один из targetDedicatedNodes и targetLowPriorityNodes. Если значение равно true, свойство autoScaleFormula является обязательным, а пул автоматически изменяет размер в соответствии с формулой. Значением по умолчанию является false.
enableInterNodeCommunication		boolean	Разрешает ли пул прямую связь между вычислительными узлами. Включение обмена данными между узлами ограничивает максимальный размер пула из-за ограничений развертывания на вычислительных узлах пула. Это может привести к тому, что пул не достигнет требуемого размера. Значением по умолчанию является false.
metadata		MetadataItem[]	Список пар "имя-значение", связанных с пулом в качестве метаданных. Пакетная служба не присваивает никакого значения метаданным; он предназначен исключительно для использования пользовательского кода.
mountConfiguration		MountConfiguration[]	Подключите хранилище с использованием указанной файловой системы в течение всего времени существования пула. Подключите хранилище с помощью общей папки Azure, NFS, CIFS или файловой системы на основе Blobfuse.
networkConfiguration		NetworkConfiguration	Конфигурация сети для пула. Конфигурация сети для пула.
resizeTimeout		string	Время ожидания для выделения вычислительных узлов в пул. Это время ожидания применяется только к масштабированию вручную; Он не действует, если параметр enableAutoScale имеет значение true. Значение по умолчанию — 15 минут. Минимальное значение — 5 минут. Если указать значение менее 5 минут, пакетная служба возвращает ошибку; Если вы вызываете REST API напрямую, код состояния HTTP — 400 (недопустимый запрос).
startTask		StartTask	Задача, указанная для выполнения на каждом вычислительном узле при присоединении к пулу. Задача выполняется при добавлении вычислительного узла в пул или при перезапуске вычислительного узла.
targetDedicatedNodes		integer	Требуемое количество выделенных вычислительных узлов в пуле. Это свойство не должно быть указано, если параметр enableAutoScale имеет значение true. Если параметр enableAutoScale имеет значение false, необходимо задать либо targetDedicatedNodes, targetLowPriorityNodes, либо оба параметра.
targetLowPriorityNodes		integer	Требуемое количество точечных или низкоприоритетных вычислительных узлов в пуле. Это свойство не должно быть указано, если параметр enableAutoScale имеет значение true. Если параметр enableAutoScale имеет значение false, необходимо задать либо targetDedicatedNodes, targetLowPriorityNodes, либо оба параметра.
taskSchedulingPolicy		TaskSchedulingPolicy	Распределение задач между вычислительными узлами в пуле. Если значение не указано, значение по умолчанию распространяется.
taskSlotsPerNode		integer	Количество слотов задач, которые могут использоваться для выполнения параллельных задач на одном вычислительном узле в пуле. Значение по умолчанию — 1. Максимальное значение меньше 4 раза больше числа ядер vmSize пула или 256.
userAccounts		UserAccount[]	Список учетных записей пользователей, создаваемых на каждом вычислительном узле в пуле.
virtualMachineConfiguration		VirtualMachineConfiguration	Конфигурация виртуальной машины для пула. Это свойство и cloudServiceConfiguration являются взаимоисключающими, и необходимо указать одно из свойств.

Ответы

Name	Type	Description
201 Created		Запрос к пакетной службе выполнен успешно. Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Ошибка пакетной службы.

Name

Type

Description

201 Created

Запрос к пакетной службе выполнен успешно.

Headers

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

Other Status Codes

BatchError

Ошибка пакетной службы.

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

azure_auth

Flow OAuth2 Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Олицетворение учетной записи пользователя

Authorization

Type: apiKey
In: header

Примеры

Add a CloudServiceConfiguration pool

Add a pool with mount drive specified

Add a VirtualMachineConfiguration pool

Add a VirtualMachineConfiguration pool with containers

Add a VirtualMachineConfiguration pool with extensions

Add a CloudServiceConfiguration pool

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2022-01-01.15.0



{
  "id": "poolId",
  "vmSize": "small",
  "cloudServiceConfiguration": {
    "osFamily": "4"
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false,
  "enableInterNodeCommunication": true,
  "metadata": [
    {
      "name": "myproperty",
      "value": "myvalue"
    }
  ]
}

Sample Response

Status code:: 201

Add a pool with mount drive specified

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2022-01-01.15.0


{
  "id": "pool2",
  "vmSize": "standard_a1",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "UbuntuServer",
      "sku": "20_04-lts"
    },
    "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
}

Sample Response

Status code:: 201

Add a VirtualMachineConfiguration pool

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2022-01-01.15.0



{
  "id": "pool2",
  "vmSize": "standard_a1",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "sku": "20_04-lts"
    },
    "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"
    }
  ]
}

Sample Response

Status code:: 201

Add a VirtualMachineConfiguration pool with containers

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2022-01-01.15.0



{
  "id": "pool2",
  "vmSize": "standard_a1",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "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
}

Sample Response

Status code:: 201

Add a VirtualMachineConfiguration pool with extensions

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2022-01-01.15.0



{
  "id": "pool2",
  "vmSize": "standard_a1",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "sku": "20_04-lts"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04",
    "extensions": [
      {
        "name": "batchextension1",
        "type": "SecurityMonitoringForLinux",
        "publisher": "Microsoft.Azure.Security.Monitoring",
        "typeHandlerVersion": "1.0",
        "autoUpgradeMinorVersion": true,
        "settings": "{\"settingsKey\":\"settingsValue\"}",
        "protectedSettings": "{\"protectedSettingsKey\":\"protectedSettingsValue\"}"
      }
    ]
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false,
  "enableInterNodeCommunication": true,
  "metadata": [
    {
      "name": "myproperty",
      "value": "myvalue"
    }
  ]
}

Sample Response

Status code:: 201

Определения

ApplicationPackageReference	Ссылка на пакет для развертывания на вычислительных узлах.
AutoUserScope	Область для автоматического пользователя
AutoUserSpecification	Задает параметры для автоматического пользователя, выполняющего задачу в пакетной службе.
AzureBlobFileSystemConfiguration	Сведения, используемые для подключения к контейнеру служба хранилища Azure с помощью Blobfuse.
AzureFileShareConfiguration	Сведения, используемые для подключения к общей папке Azure.
BatchError	Ответ об ошибке, полученный от службы пакетная служба Azure.
BatchErrorDetail	Элемент дополнительных сведений, включенных в ответ на ошибку пакетная служба Azure.
CachingType	Тип кэширования, который необходимо включить для диска.
CertificateReference	Ссылка на сертификат, устанавливаемый на вычислительных узлах в пуле.
CertificateStoreLocation	Расположение хранилища сертификатов на вычислительном узле, в которое необходимо установить сертификат.
CIFSMountConfiguration	Сведения, используемые для подключения к файловой системе CIFS.
CloudServiceConfiguration	Конфигурация вычислительных узлов в пуле на основе платформы Azure Облачные службы.
ComputeNodeFillType	Распределение задач между вычислительными узлами в пуле.
ComputeNodeIdentityReference	Ссылка на назначенное пользователем удостоверение, связанное с пулом пакетной службы, который будет использовать вычислительный узел.
ContainerConfiguration	Конфигурация пулов с поддержкой контейнеров.
ContainerRegistry	Частный реестр контейнеров.
ContainerType	Используемая технология контейнера.
ContainerWorkingDirectory	Расположение рабочего каталога задачи контейнера.
DataDisk	Параметры, которые будут использоваться дисками данных, связанными с вычислительными узлами в пуле. При использовании подключенных дисков данных необходимо подключить и отформатировать диски в виртуальной машине, чтобы использовать их.
DiffDiskPlacement	Задает временное размещение дисков для диска операционной системы для всех вычислительных узлов (виртуальных машин) в пуле.
DiffDiskSettings	Указывает временный Параметры диска операционной системы, используемого вычислительным узлом (vm).
DiskEncryptionConfiguration	Конфигурация шифрования дисков, применяемая к вычислительным узлам в пуле. Конфигурация шифрования дисков не поддерживается в пуле Linux, созданном с помощью образа Общая коллекция образов.
DynamicVNetAssignmentScope	Область динамического назначения виртуальной сети.
ElevationLevel	Уровень повышения прав пользователя.
EnvironmentSetting	Переменная среды, устанавливаемая в процессе задачи.
ErrorMessage	Сообщение об ошибке, полученное в ответе на ошибку пакетная служба Azure.
ImageReference	Ссылка на образ azure Виртуальные машины Marketplace или образ Общая коллекция образов. Список всех ссылок на изображения Azure Marketplace, проверенных пакетная служба Azure, см. в разделе "Список поддерживаемых образов".
InboundEndpointProtocol	Протокол конечной точки.
InboundNATPool	Входящий пул NAT, который можно использовать для адресирования определенных портов на вычислительных узлах во внешнем пуле пакетной службы.
IPAddressProvisioningType	Тип подготовки для общедоступных IP-адресов для пула.
LinuxUserConfiguration	Свойства, используемые для создания учетной записи пользователя на вычислительном узле Linux.
LoginMode	Режим входа для пользователя
MetadataItem	Пара "имя-значение", связанная с ресурсом пакетной службы.
MountConfiguration	Файловая система для подключения на каждом узле.
NetworkConfiguration	Конфигурация сети для пула.
NetworkSecurityGroupRule	Правило группы безопасности сети для применения к входящей конечной точке.
NetworkSecurityGroupRuleAccess	Действие, которое необходимо предпринять для указанного IP-адреса, диапазона подсети или тега.
NFSMountConfiguration	Сведения, используемые для подключения к файловой системе NFS.
NodePlacementConfiguration	Конфигурация размещения узла для пула.
NodePlacementPolicyType	Политика размещения для выделения узлов в пуле.
OSDisk	Параметры для диска операционной системы вычислительного узла (VM).
PoolAddParameter	Добавляемый пул в службе пакетная служба Azure.
PoolEndpointConfiguration	Конфигурация конечной точки для пула.
PublicIPAddressConfiguration	Конфигурация общедоступного IP-адреса конфигурации сети пула.
ResourceFile	Один файл или несколько файлов, которые необходимо скачать на вычислительный узел.
StartTask	Задача, которая выполняется при присоединении узла к пулу в службе пакетная служба Azure или при перезагрузке или повторном создании вычислительного узла.
StorageAccountType	Тип учетной записи хранения для использования при создании дисков данных.
TaskContainerSettings	Параметры контейнера для задачи.
TaskSchedulingPolicy	Указывает, как задачи должны распределяться между вычислительными узлами.
UserAccount	Свойства, используемые для создания пользователя, используемого для выполнения задач на пакетная служба Azure вычислительном узле.
UserIdentity	Определение удостоверения пользователя, под которым выполняется задача.
VirtualMachineConfiguration	Конфигурация вычислительных узлов в пуле на основе инфраструктуры Виртуальные машины Azure.
VMExtension	Конфигурация расширений виртуальных машин.
WindowsConfiguration	Windows параметры операционной системы, применяемые к виртуальной машине.
WindowsUserConfiguration	Свойства, используемые для создания учетной записи пользователя на Windows вычислительном узле.

ApplicationPackageReference

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

Name	Type	Description
applicationId	string	Идентификатор развертываемого приложения.
version	string	Версия развертываемого приложения. Если этот параметр опущен, будет развернута версия по умолчанию. Если этот параметр опущен в пуле и для этого приложения не указана версия по умолчанию, запрос завершается ошибкой с кодом invalidApplicationPackageReferences и кодом состояния HTTP 409. Если это опущено для задачи, и для этого приложения не указана версия по умолчанию, задача завершается сбоем с ошибкой предварительной обработки.

AutoUserScope

Область для автоматического пользователя

Name	Type	Description
pool	string	Указывает, что задача выполняется в качестве общей автоматической учетной записи пользователя, созданной на каждом вычислительном узле в пуле.
task	string	Указывает, что служба должна создать нового пользователя для задачи.

AutoUserSpecification

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

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

AzureBlobFileSystemConfiguration

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

Name	Type	Description
accountKey	string	Ключ учетной записи служба хранилища Azure. Это свойство является взаимоисключающим как с sasKey, так и с удостоверением; Необходимо указать именно один.
accountName	string	Имя учетной записи служба хранилища Azure.
blobfuseOptions	string	Дополнительные параметры командной строки для передачи в команду подключения. Это параметры net use в Windows и параметрах подключения в Linux.
containerName	string	Имя контейнера Хранилище BLOB-объектов Azure.
identityReference	ComputeNodeIdentityReference	Ссылка на назначенное пользователем удостоверение, используемое для доступа к containerName. Это свойство является взаимоисключающим как с accountKey, так и sasKey; Необходимо указать именно один.
relativeMountPath	string	Относительный путь на вычислительном узле, где будет подключена файловая система. Все файловые системы подключаются относительно каталога подключений пакетной службы, доступных через переменную среды AZ_BATCH_NODE_MOUNTS_DIR.
sasKey	string	Маркер SAS служба хранилища Azure. Это свойство является взаимоисключающим как с accountKey, так и с удостоверением; Необходимо указать именно один.

AzureFileShareConfiguration

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

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

BatchError

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

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

BatchErrorDetail

Элемент дополнительных сведений, включенных в ответ на ошибку пакетная служба Azure.

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

CachingType

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

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

CertificateReference

Ссылка на сертификат, устанавливаемый на вычислительных узлах в пуле.

Name	Type	Description
storeLocation	CertificateStoreLocation	Расположение хранилища сертификатов на вычислительном узле, в которое необходимо установить сертификат. Значение по умолчанию — currentuser. Это свойство применимо только для пулов, настроенных с Windows вычислительных узлов (т. е. созданных с помощью cloudServiceConfiguration или virtualMachineConfiguration с помощью ссылки на образ Windows). Для вычислительных узлов Linux сертификаты хранятся в каталоге рабочей папки задачи, а переменная среды AZ_BATCH_CERTIFICATES_DIR предоставляется задаче для запроса этого расположения. Для сертификатов с видимостью remoteUser каталог certs создается в домашнем каталоге пользователя (например, /home/{user-name}/certs) и сертификаты помещаются в этот каталог.
storeName	string	Имя хранилища сертификатов на вычислительном узле, в который необходимо установить сертификат. Это свойство применимо только для пулов, настроенных с Windows вычислительных узлов (т. е. созданных с помощью cloudServiceConfiguration или virtualMachineConfiguration с помощью ссылки на образ Windows). Распространенные имена хранилищ: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, но также можно использовать любое имя пользовательского хранилища. Значение по умолчанию - «My».
thumbprint	string	Отпечаток сертификата.
thumbprintAlgorithm	string	Алгоритм, с которым связан отпечаток. Это должно быть sha1.
visibility	string[]	Какие учетные записи пользователей на вычислительном узле должны иметь доступ к частным данным сертификата. В этой коллекции можно указать несколько видимостей. Значение по умолчанию — все учетные записи.

CertificateStoreLocation

Расположение хранилища сертификатов на вычислительном узле, в которое необходимо установить сертификат.

Name	Type	Description
currentuser	string	Сертификаты должны быть установлены в хранилище сертификатов CurrentUser.
localmachine	string	Сертификаты должны быть установлены в хранилище сертификатов LocalMachine.

CIFSMountConfiguration

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

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

CloudServiceConfiguration

Конфигурация вычислительных узлов в пуле на основе платформы Azure Облачные службы.

Name	Type	Description
osFamily	string	Семейство гостевой ОС Azure, устанавливаемое на виртуальных машинах в пуле. Возможные значения: 2 — семейство ОС 2, эквивалентное Windows Server 2008 R2 с пакетом обновления 1 (SP1). 3 — семейство ОС 3, эквивалентное Windows Server 2012. 4 — семейство ОС 4, эквивалентное Windows Server 2012 R2. 5 — семейство ОС 5, эквивалентное Windows Server 2016. 6 — семейство ОС 6, эквивалентное Windows Server 2019. Дополнительные сведения см. в выпусках гостевой ОС Azure (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases).
osVersion	string	Версия гостевой ОС Azure, устанавливаемая на виртуальных машинах в пуле. Значение по умолчанию — *, указывающее последнюю версию операционной системы для указанного семейства ОС.

ComputeNodeFillType

Распределение задач между вычислительными узлами в пуле.

Name	Type	Description
pack	string	Максимальное количество задач (taskSlotsPerNode) должно быть назначено каждому вычислительному узлу в пуле, прежде чем все задачи будут назначены следующему вычислительному узлу в пуле.
spread	string	Задачи должны назначаться равномерно на всех вычислительных узлах в пуле.

ComputeNodeIdentityReference

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

Name	Type	Description
resourceId	string	Идентификатор ресурса ARM удостоверения, назначаемого пользователем.

ContainerConfiguration

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

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

ContainerRegistry

Частный реестр контейнеров.

Name	Type	Description
identityReference	ComputeNodeIdentityReference	Ссылка на назначенное пользователем удостоверение для доступа к Реестр контейнеров Azure вместо имени пользователя и пароля. Ссылка на назначенное пользователем удостоверение, связанное с пулом пакетной службы, который будет использовать вычислительный узел.
password	string	Пароль для входа на сервер реестра.
registryServer	string	URL-адрес реестра. Если этот параметр опущен, значение по умолчанию — "docker.io".
username	string	Имя пользователя для входа на сервер реестра.

ContainerType

Используемая технология контейнера.

Name	Type	Description
dockerCompatible	string	Для запуска контейнеров будет использоваться технология контейнеров, совместимая с Docker.

ContainerWorkingDirectory

Расположение рабочего каталога задачи контейнера.

Name	Type	Description
containerImageDefault	string	Используйте рабочий каталог, определенный в образе контейнера. Убедитесь, что этот каталог не будет содержать файлы ресурсов, скачанные пакетной службой.
taskWorkingDirectory	string	Используйте стандартный рабочий каталог задачи пакетной службы, который будет содержать файлы ресурсов задач, заполненные пакетной службой.

DataDisk

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

Name	Type	Description
caching	CachingType	Тип кэширования, который необходимо включить для дисков данных. Значение по умолчанию для кэширования — readwrite. Сведения о параметрах кэширования см. в следующем разделе. https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/
diskSizeGB	integer	Начальный размер диска в гигабайтах.
lun	integer	Номер логической единицы. Lun используется для уникальной идентификации каждого диска данных. При подключении нескольких дисков каждый из них должен иметь отдельный lun. Значение должно быть от 0 до 63 включительно.
storageAccountType	StorageAccountType	Тип учетной записи хранения, используемый для диска данных. Если этот параметр опущен, значение по умолчанию — "standard_lrs".

DiffDiskPlacement

Задает временное размещение дисков для диска операционной системы для всех вычислительных узлов (виртуальных машин) в пуле.

Name	Type	Description
CacheDisk	string	Временный диск ОС хранится в кэше виртуальной машины.

DiffDiskSettings

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

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

DiskEncryptionConfiguration

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

Name	Type	Description
targets	string[]	Список целевых дисков пакетной службы будет зашифрован на вычислительном узле. Если этот параметр опущен, диски на вычислительных узлах в пуле не будут зашифрованы. В пуле Linux поддерживается только temporaryDisk; в пуле Windows необходимо указать osDisk и TemporaryDisk.

DynamicVNetAssignmentScope

Область динамического назначения виртуальной сети.

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

ElevationLevel

Уровень повышения прав пользователя.

Name	Type	Description
admin	string	Пользователь является пользователем с повышенным уровнем доступа и работает с полными разрешениями администратора.
nonadmin	string	Пользователь является стандартным пользователем без повышенных прав доступа.

EnvironmentSetting

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

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

ErrorMessage

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

Name	Type	Description
lang	string	Код языка сообщения об ошибке
value	string	Текст сообщения.

ImageReference

Ссылка на образ azure Виртуальные машины Marketplace или образ Общая коллекция образов. Список всех ссылок на изображения Azure Marketplace, проверенных пакетная служба Azure, см. в разделе "Список поддерживаемых образов".

Name	Type	Description
exactVersion	string	Конкретная версия образа платформы или образа Marketplace, используемого для создания узла. Это поле только для чтения отличается от "version" только в том случае, если значение, указанное для параметра "версия", когда был создан пул, был "latest".
offer	string	Тип предложения образа azure Виртуальные машины Marketplace. Например, UbuntuServer или WindowsServer.
publisher	string	Издатель образа Виртуальные машины Marketplace Azure. Например, Canonical или MicrosoftWindowsServer.
sku	string	Номер SKU образа Виртуальные машины Marketplace Azure. Например, 18.04-LTS или 2019-Datacenter.
version	string	Версия образа azure Виртуальные машины Marketplace. Можно указать значение latest, чтобы выбрать последнюю версию образа. Если этот параметр опущен, значение по умолчанию — latest.
virtualMachineImageId	string	Идентификатор ресурса ARM образа Общая коллекция образов. Вычислительные узлы в пуле будут созданы с помощью этого идентификатора образа. Это форма /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} или /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName} для постоянного использования последней версии образа. Это свойство является взаимоисключающим с другими свойствами ImageReference. Образ Общая коллекция образов должен иметь реплики в одном регионе и находиться в той же подписке, что и учетная запись пакетная служба Azure. Если версия образа не указана в imageId, будет использоваться последняя версия. Сведения о параметрах брандмауэра для агента пакетного вычислительного узла для взаимодействия с пакетной службой см. в разделе https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

InboundEndpointProtocol

Протокол конечной точки.

Name	Type	Description
tcp	string	Используйте TCP для конечной точки.
udp	string	Используйте UDP для конечной точки.

InboundNATPool

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

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

IPAddressProvisioningType

Тип подготовки для общедоступных IP-адресов для пула.

Name	Type	Description
batchmanaged	string	Общедоступный IP-адрес будет создан и управляется пакетной службой. В зависимости от размера пула может быть несколько общедоступных IP-адресов.
nopublicipaddresses	string	Общедоступный IP-адрес не будет создан.
usermanaged	string	Общедоступные IP-адреса предоставляются пользователем и будут использоваться для подготовки вычислительных узлов.

LinuxUserConfiguration

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

Name	Type	Description
gid	integer	Идентификатор группы для учетной записи пользователя. Свойства uid и gid должны быть указаны вместе или вообще не должны быть указаны. Если базовая операционная система не указана, выбирает gid.
sshPrivateKey	string	Закрытый ключ SSH для учетной записи пользователя. Закрытый ключ не должен быть защищен паролем. Закрытый ключ используется для автоматической настройки проверки подлинности на основе асимметричного ключа для SSH между вычислительными узлами в пуле Linux, если свойство enableInterNodeCommunication пула имеет значение true (оно игнорируется, если enableInterNodeCommunication имеет значение false). Для этого поместите пару ключей в каталог SSH пользователя. Если значение не указано, SSH без пароля не настраивается между вычислительными узлами (не выполняется изменение каталога SSH пользователя).
uid	integer	Идентификатор пользователя учетной записи пользователя. Свойства uid и gid должны быть указаны вместе или вообще не должны быть указаны. Если базовая операционная система не указана, выбирает пользовательский интерфейс.

LoginMode

Режим входа для пользователя

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

MetadataItem

Пара "имя-значение", связанная с ресурсом пакетной службы.

Name	Type	Description
name	string	Имя элемента метаданных.
value	string	Значение элемента метаданных.

MountConfiguration

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

Name	Type	Description
azureBlobFileSystemConfiguration	AzureBlobFileSystemConfiguration	Контейнер служба хранилища Azure для подключения с помощью FUSE BLOB-объектов на каждом узле. Это свойство является взаимоисключающим со всеми другими свойствами.
azureFileShareConfiguration	AzureFileShareConfiguration	Общая папка Azure для подключения на каждом узле. Это свойство является взаимоисключающим со всеми другими свойствами.
cifsMountConfiguration	CIFSMountConfiguration	Файловая система CIFS/SMB для подключения на каждом узле. Это свойство является взаимоисключающим со всеми другими свойствами.
nfsMountConfiguration	NFSMountConfiguration	Файловая система NFS для подключения на каждом узле. Это свойство является взаимоисключающим со всеми другими свойствами.

NetworkConfiguration

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

Name	Type	Description
dynamicVNetAssignmentScope	DynamicVNetAssignmentScope	Область динамического назначения виртуальной сети.
endpointConfiguration	PoolEndpointConfiguration	Конфигурация конечных точек на вычислительных узлах в пуле пакетной службы. Конфигурация конечной точки пула поддерживается только в пулах со свойством virtualMachineConfiguration.
publicIPAddressConfiguration	PublicIPAddressConfiguration	Конфигурация общедоступного IPAddress для вычислительных узлов в пуле пакетной службы. Свойство конфигурации общедоступного IP-адреса поддерживается только в пулах со свойством virtualMachineConfiguration.
subnetId	string	Идентификатор ресурса ARM подсети виртуальной сети, к которой присоединяются вычислительные узлы пула. Это форма /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. Виртуальная сеть должна находиться в том же регионе и подписке, что и учетная запись пакетная служба Azure. Указанная подсеть должна иметь достаточно свободных IP-адресов для размещения количества вычислительных узлов в пуле. Если в подсети недостаточно свободных IP-адресов, пул частично выделяет узлы и возникнет ошибка изменения размера. Субъект-служба MicrosoftAzureBatch должна иметь роль "Участник классической виртуальной машины" Role-Based контроль доступа (RBAC) для указанной виртуальной сети. Указанная подсеть должна разрешать обмен данными со службы пакетная служба Azure, чтобы иметь возможность планировать задачи на узлах. Это можно проверить, проверив, есть ли в указанной виртуальной сети какие-либо связанные группы безопасности сети (NSG). Если связь с узлами в указанной подсети запрещена группой безопасности сети, пакетная служба установит состояние вычислительных узлов в непригодный для использования. Для пулов, созданных с помощью virtualMachineConfiguration, поддерживаются только виртуальные сети ARM (Microsoft.Network/virtualNetworks), но для пулов, созданных с помощью cloudServiceConfiguration, поддерживаются как ARM, так и классические виртуальные сети. Если у виртуальной сети есть связанные группы безопасности сети (NSG), необходимо включить несколько зарезервированных системных портов для входящего трафика. Для пулов, созданных с конфигурацией виртуальной машины, включите порты 29876 и 29877, а также порт 22 для Linux и порт 3389 для Windows. Для пулов, созданных с конфигурацией облачной службы, включите порты 10100, 20100 и 30100. Также включите исходящие подключения к служба хранилища Azure через порт 443. Дополнительные сведения см. в следующем разделе: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

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

Name	Type	Description
access	NetworkSecurityGroupRuleAccess	Действие, которое необходимо предпринять для указанного IP-адреса, диапазона подсети или тега.
priority	integer	Приоритет для этого правила. Приоритеты в пуле должны быть уникальными и оцениваться в порядке приоритета. Чем меньше число, тем выше приоритет. Например, правила можно указать с номерами порядка 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

Действие, которое необходимо предпринять для указанного IP-адреса, диапазона подсети или тега.

Name	Type	Description
allow	string	Разрешить доступ.
deny	string	Запретить доступ.

NFSMountConfiguration

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

Name	Type	Description
mountOptions	string	Дополнительные параметры командной строки для передачи в команду подключения. Это параметры net use в Windows и параметрах подключения в Linux.
relativeMountPath	string	Относительный путь на вычислительном узле, где будет подключена файловая система. Все файловые системы подключаются относительно каталога подключений пакетной службы, доступных через переменную среды AZ_BATCH_NODE_MOUNTS_DIR.
source	string	Универсальный код ресурса (URI) подключаемой файловой системы.

NodePlacementConfiguration

Конфигурация размещения узла для пула.

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

NodePlacementPolicyType

Политика размещения для выделения узлов в пуле.

Name	Type	Description
regional	string	Все узлы в пуле будут выделены в одном регионе.
zonal	string	Узлы в пуле будут распределяться между разными зонами доступности с оптимальной балансировкой усилий.

OSDisk

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

Name	Type	Description
ephemeralOSDiskSettings	DiffDiskSettings	Указывает временный Параметры диска операционной системы, используемого вычислительным узлом (VM).

PoolAddParameter

Добавляемый пул в службе пакетная служба Azure.

Name	Type	Description
applicationLicenses	string[]	Список лицензий приложений пакетной службы будет доступен на каждом вычислительном узле в пуле. Список лицензий приложений должен быть подмножеством доступных лицензий приложений пакетной службы. Если запрашивается лицензия, которая не поддерживается, создание пула завершится ошибкой.
applicationPackageReferences	ApplicationPackageReference[]	Список пакетов, устанавливаемых на каждом вычислительном узле в пуле. Изменения ссылок на пакеты влияют на все новые узлы, присоединенные к пулу, но не влияют на вычислительные узлы, которые уже находятся в пуле, пока они не будут перезагружены или переосмыслены. В любом пуле существует не более 10 ссылок на пакеты.
autoScaleEvaluationInterval	string	Интервал времени для автоматической настройки размера пула в соответствии с формулой автомасштабирования. Значение по умолчанию — 15 минут. Минимальное и максимальное значение : 5 минут и 168 часов соответственно. Если указать значение менее 5 минут или больше 168 часов, пакетная служба возвращает ошибку; Если вы вызываете REST API напрямую, код состояния HTTP — 400 (недопустимый запрос).
autoScaleFormula	string	Формула для требуемого количества вычислительных узлов в пуле. Это свойство не должно быть указано, если параметр enableAutoScale имеет значение false. Это необходимо, если параметр enableAutoScale имеет значение true. Формула проверяется на допустимость до создания пула. Если формула недопустима, пакетная служба отклоняет запрос с подробными сведениями об ошибке. Дополнительные сведения об указании этой формулы см. в разделе "Автоматическое масштабирование вычислительных узлов в пуле пакетная служба Azure" (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/).
certificateReferences	CertificateReference[]	Список сертификатов, устанавливаемых на каждом вычислительном узле в пуле. Для узлов Windows пакетная служба устанавливает сертификаты в указанное хранилище сертификатов и расположение. Для вычислительных узлов Linux сертификаты хранятся в каталоге рабочей папки задачи, а переменная среды AZ_BATCH_CERTIFICATES_DIR предоставляется задаче для запроса этого расположения. Для сертификатов с видимостью remoteUser каталог "certs" создается в домашнем каталоге пользователя (например, /home/{user-name}/certs) и сертификаты помещаются в этот каталог.
cloudServiceConfiguration	CloudServiceConfiguration	Конфигурация облачной службы для пула. Это свойство и virtualMachineConfiguration являются взаимоисключающими, и необходимо указать одно из свойств. Это свойство нельзя указать, если учетная запись пакетной службы была создана со свойством poolAllocationMode, равным UserSubscription.
displayName	string	Отображаемое имя пула. Отображаемое имя не должно быть уникальным и может содержать любые символы Юникода до максимальной длины 1024.
enableAutoScale	boolean	Следует ли автоматически настраивать размер пула с течением времени. Если значение равно false, необходимо указать хотя бы один из targetDedicatedNodes и targetLowPriorityNodes. Если значение равно true, свойство autoScaleFormula является обязательным, а пул автоматически изменяет размер в соответствии с формулой. Значением по умолчанию является false.
enableInterNodeCommunication	boolean	Разрешает ли пул прямую связь между вычислительными узлами. Включение обмена данными между узлами ограничивает максимальный размер пула из-за ограничений развертывания на вычислительных узлах пула. Это может привести к тому, что пул не достигнет требуемого размера. Значением по умолчанию является false.
id	string	Строка, однозначно идентифицирующая пул в учетной записи. Идентификатор может содержать любое сочетание буквенно-цифровых символов, включая дефисы и символы подчеркивания, и не может содержать более 64 символов. Идентификатор сохраняет регистр и не учитывает регистр (т. е. в учетной записи может не быть двух идентификаторов пула, которые отличаются только по регистру).
metadata	MetadataItem[]	Список пар "имя-значение", связанных с пулом в качестве метаданных. Пакетная служба не присваивает никакого значения метаданным; он предназначен исключительно для использования пользовательского кода.
mountConfiguration	MountConfiguration[]	Подключите хранилище с помощью указанной файловой системы в течение всего времени существования пула. Подключите хранилище с помощью общей папки Azure, NFS, CIFS или файловой системы на основе Blobfuse.
networkConfiguration	NetworkConfiguration	Конфигурация сети для пула. Конфигурация сети для пула.
resizeTimeout	string	Время ожидания для выделения вычислительных узлов в пул. Это время ожидания применяется только к масштабированию вручную; Он не действует, если параметр enableAutoScale имеет значение true. Значение по умолчанию — 15 минут. Минимальное значение — 5 минут. Если указать значение менее 5 минут, пакетная служба возвращает ошибку; Если вы вызываете REST API напрямую, код состояния HTTP — 400 (недопустимый запрос).
startTask	StartTask	Задача, указанная для выполнения на каждом вычислительном узле при присоединении к пулу. Задача выполняется при добавлении вычислительного узла в пул или при перезапуске вычислительного узла.
targetDedicatedNodes	integer	Требуемое количество выделенных вычислительных узлов в пуле. Это свойство не должно быть указано, если параметр enableAutoScale имеет значение true. Если параметр enableAutoScale имеет значение false, необходимо задать либо targetDedicatedNodes, targetLowPriorityNodes, либо оба параметра.
targetLowPriorityNodes	integer	Требуемое количество точечных или низкоприоритетных вычислительных узлов в пуле. Это свойство не должно быть указано, если параметр enableAutoScale имеет значение true. Если параметр enableAutoScale имеет значение false, необходимо задать либо targetDedicatedNodes, targetLowPriorityNodes, либо оба параметра.
taskSchedulingPolicy	TaskSchedulingPolicy	Распределение задач между вычислительными узлами в пуле. Если значение не указано, значение по умолчанию распространяется.
taskSlotsPerNode	integer	Количество слотов задач, которые могут использоваться для выполнения параллельных задач на одном вычислительном узле в пуле. Значение по умолчанию — 1. Максимальное значение меньше 4 раза больше числа ядер vmSize пула или 256.
userAccounts	UserAccount[]	Список учетных записей пользователей, создаваемых на каждом вычислительном узле в пуле.
virtualMachineConfiguration	VirtualMachineConfiguration	Конфигурация виртуальной машины для пула. Это свойство и cloudServiceConfiguration являются взаимоисключающими, и необходимо указать одно из свойств.
vmSize	string	Размер виртуальных машин в пуле. Все виртуальные машины в пуле имеют одинаковый размер. Сведения о доступных размерах виртуальных машин для пулов Облачные службы (пулы, созданные с помощью cloudServiceConfiguration), см. в разделе "Размеры" для Облачные службы (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Пакетная служба поддерживает все размеры виртуальных машин Облачные службы, кроме ExtraSmall, A1V2 и A2V2. Сведения о доступных размерах виртуальных машин для пулов с помощью образов из Виртуальные машины Marketplace (пулы, созданные с помощью virtualMachineConfiguration) см. в разделе "Размеры" для Виртуальные машины (Linux) илиhttps://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/ "Размеры" для Виртуальные машины (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Пакетная служба поддерживает все размеры виртуальных машин Azure, кроме STANDARD_A0 и хранилища класса Premium (серии STANDARD_GS, STANDARD_DS и STANDARD_DSV2).

PoolEndpointConfiguration

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

Name	Type	Description
inboundNATPools	InboundNATPool[]	Список входящих пулов NAT, которые можно использовать для адресирования определенных портов на отдельном вычислительном узле за пределами. Максимальное число входящих пулов NAT на пул пакетной службы составляет 5. Если превышено максимальное число входящих пулов NAT, запрос завершается ошибкой с кодом состояния HTTP 400. Это невозможно указать, если ipAddressProvisioningType имеет значение NoPublicIPAddresses.

PublicIPAddressConfiguration

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

Name	Type	Description
ipAddressIds	string[]	Список общедоступных IP-адресов, которые будет использовать пакетная служба при подготовке вычислительных узлов. Количество IP-адресов, указанных здесь, ограничивает максимальный размер пула — 100 выделенных узлов или 100 точечных и низкоприоритетных узлов можно выделить для каждого общедоступного IP-адреса. Например, для пула, нуждающегося в 250 выделенных виртуальных машинах, потребуется не менее 3 общедоступных IP-адресов. Каждый элемент этой коллекции имеет вид: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.
provision	IPAddressProvisioningType	Тип подготовки для общедоступных IP-адресов для пула. Значение по умолчанию — BatchManaged.

ResourceFile

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

Name	Type	Description
autoStorageContainerName	string	Имя контейнера хранилища в учетной записи автоматического хранения. Свойства autoStorageContainerName, storageContainerUrl и httpUrl являются взаимоисключающими и должны быть указаны.
blobPrefix	string	Префикс большого двоичного объекта, используемый при скачивании больших двоичных объектов из контейнера служба хранилища Azure. Будут загружены только большие двоичные объекты, имена которых начинаются с указанного префикса. Свойство допустимо только при использовании autoStorageContainerName или storageContainerUrl. Этот префикс может быть частичным именем файла или подкаталогом. Если префикс не указан, скачиваются все файлы в контейнере.
fileMode	string	Атрибут режима разрешений файла в восьмеричном формате. Это свойство применяется только к файлам, скачиваемых на вычислительные узлы Linux. Он будет игнорироваться, если он указан для resourceFile, который будет скачан на вычислительный узел Windows. Если это свойство не указано для вычислительного узла Linux, к файлу применяется значение по умолчанию 0770.
filePath	string	Расположение на вычислительном узле, на который нужно скачать файлы, относительно рабочего каталога задачи. Если задано свойство httpUrl, параметр filePath является обязательным и описывает путь, в который будет скачан файл, включая имя файла. В противном случае, если указано свойство autoStorageContainerName или storageContainerUrl, filePath является необязательным и является каталогом для скачивания файлов. Если filePath используется в качестве каталога, любая структура каталогов, уже связанная с входными данными, будет сохранена в полном объеме и добавлена в указанный каталог filePath. Указанный относительный путь не может выйти из рабочего каталога задачи (например, с помощью "..").
httpUrl	string	URL-адрес для скачивания файла. Свойства autoStorageContainerName, storageContainerUrl и httpUrl являются взаимоисключающими и должны быть указаны. Если URL-адрес указывает на Хранилище BLOB-объектов Azure, он должен быть доступен для чтения с вычислительных узлов. Существует три способа получить такой URL-адрес для большого двоичного объекта в службе хранилища Azure: включить подписанный URL-адрес (SAS), предоставляющий разрешения на чтение для большого двоичного объекта, использовать управляемое удостоверение с разрешением на чтение или задать ACL для большого двоичного объекта или его контейнера, чтобы разрешить общий доступ.
identityReference	ComputeNodeIdentityReference	Ссылка на назначенное пользователем удостоверение, используемое для доступа к Хранилище BLOB-объектов Azure, заданному storageContainerUrl или httpUrl. Ссылка на назначенное пользователем удостоверение, связанное с пулом пакетной службы, который будет использовать вычислительный узел.
storageContainerUrl	string	URL-адрес контейнера больших двоичных объектов в Хранилище BLOB-объектов Azure. Свойства autoStorageContainerName, storageContainerUrl и httpUrl являются взаимоисключающими и должны быть указаны. Этот URL-адрес должен быть доступен для чтения и перечисления из вычислительных узлов. Существует три способа получить такой URL-адрес для контейнера в службе хранилища Azure: включить подписанный URL-адрес (SAS), предоставляющий разрешения на чтение и список для контейнера, использовать управляемое удостоверение с разрешениями на чтение и перечисление, или задать ACL для контейнера, чтобы разрешить общий доступ.

StartTask

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

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

StorageAccountType

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

Name	Type	Description
premium_lrs	string	Диск данных должен использовать локально избыточное хранилище класса Premium.
standard_lrs	string	Диск данных должен использовать стандартное локально избыточное хранилище.

TaskContainerSettings

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

Name	Type	Description
containerRunOptions	string	Дополнительные параметры команды создания контейнера. Эти дополнительные параметры предоставляются в качестве аргументов для команды docker create в дополнение к тем, которые управляются пакетной службой.
imageName	string	Образ, используемый для создания контейнера, в котором будет выполняться задача. Это полная ссылка на образ, как указано в параметре docker pull. Если тег не указан как часть имени образа, тег ":latest" используется в качестве значения по умолчанию.
registry	ContainerRegistry	Частный реестр, содержащий образ контейнера. Этот параметр можно опустить, если он уже был указан при создании пула.
workingDirectory	ContainerWorkingDirectory	Расположение рабочего каталога задачи контейнера. Значение по умолчанию — taskWorkingDirectory.

TaskSchedulingPolicy

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

Name	Type	Description
nodeFillType	ComputeNodeFillType	Распределение задач между вычислительными узлами в пуле. Если значение не указано, значение по умолчанию распространяется.

UserAccount

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

Name	Type	Description
elevationLevel	ElevationLevel	Уровень повышения прав учетной записи пользователя. Значение по умолчанию — nonAdmin.
linuxUserConfiguration	LinuxUserConfiguration	Конфигурация пользователя linux для учетной записи пользователя. Это свойство игнорируется, если указано в пуле Windows. Если значение не указано, пользователь создается с параметрами по умолчанию.
name	string	Имя учетной записи пользователя.
password	string	Пароль для учетной записи пользователя.
windowsUserConfiguration	WindowsUserConfiguration	Конфигурация пользователя Windows для учетной записи пользователя. Это свойство можно указать только в том случае, если пользователь находится в пуле Windows. Если он не указан и в пуле Windows, пользователь создается с параметрами по умолчанию.

UserIdentity

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

Name	Type	Description
autoUser	AutoUserSpecification	Автоматический пользователь, под которым выполняется задача. Свойства userName и autoUser являются взаимоисключающими; Необходимо указать один, но не оба.
username	string	Имя удостоверения пользователя, под которым выполняется задача. Свойства userName и autoUser являются взаимоисключающими; Необходимо указать один, но не оба.

VirtualMachineConfiguration

Конфигурация вычислительных узлов в пуле на основе инфраструктуры Виртуальные машины Azure.

Name	Type	Description
containerConfiguration	ContainerConfiguration	Конфигурация контейнера для пула. Если этот параметр задан, настройка выполняется на каждом вычислительном узле в пуле, чтобы разрешить выполнение задач в контейнерах. Все обычные задачи и задачи диспетчера заданий, выполняемые в этом пуле, должны указывать свойство containerSettings, а все остальные задачи могут указать его.
dataDisks	DataDisk[]	Конфигурация дисков данных, подключенных к вычислительным узлам в пуле. Это свойство должно быть указано, если вычислительные узлы в пуле должны быть подключены к ним пустые диски данных. Это невозможно обновить. Каждый вычислительный узел получает свой собственный диск (диск не является файловой папкой). Существующие диски не могут быть подключены, каждый подключенный диск пуст. При удалении вычислительного узла из пула диск и все связанные с ним данные также удаляются. Диск не отформатирован после подключения, его необходимо отформатировать перед использованием. Дополнительные сведения см. в разделе https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux и https://docs.microsoft.com/en-us/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine.
diskEncryptionConfiguration	DiskEncryptionConfiguration	Конфигурация шифрования дисков для пула. Если этот параметр задан, шифрование выполняется на каждом узле в пуле во время подготовки узла.
extensions	VMExtension[]	Расширение виртуальной машины для пула. Если этот параметр задан, расширения, упомянутые в этой конфигурации, будут установлены на каждом узле.
imageReference	ImageReference	Ссылка на образ Azure Виртуальные машины Marketplace или пользовательский образ виртуальной машины для использования.
licenseType	string	Тип локальной лицензии, используемой при развертывании операционной системы. Это относится только к образам, содержащим Windows операционной системы, и их следует использовать только при удержании допустимых локальных лицензий для вычислительных узлов, которые будут развернуты. Если этот параметр опущен, скидка на локальное лицензирование не применяется. Возможны следующие значения. Windows_Server — локальная лицензия предназначена для сервера Windows. Windows_Client — локальная лицензия предназначена для клиента Windows.
nodeAgentSKUId	string	Номер SKU агента пакетного вычислительного узла для подготовки на вычислительных узлах в пуле. Агент batch Compute Node — это программа, которая выполняется на каждом вычислительном узле в пуле и предоставляет интерфейс управления между вычислительным узлом и пакетной службой. Для разных операционных систем существуют различные реализации агента вычислительного узла, известного как номера SKU. Необходимо указать номер SKU агента вычислительного узла, соответствующий выбранной ссылке на образ. Список поддерживаемых номеров SKU агента вычислительных узлов вместе со списком проверенных ссылок на образы см. в разделе "Список поддерживаемых номеров SKU агента вычислительных узлов".
nodePlacementConfiguration	NodePlacementConfiguration	Конфигурация размещения узла для пула. Эта конфигурация определяет правила физического выделения узлов в пуле.
osDisk	OSDisk	Параметры для диска операционной системы виртуальной машины.
windowsConfiguration	WindowsConfiguration	Windows параметры операционной системы на виртуальной машине. Это свойство не должно быть указано, если свойство imageReference указывает образ ОС Linux.

VMExtension

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

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

WindowsConfiguration

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

Name	Type	Description
enableAutomaticUpdates	boolean	Указывает, включены ли автоматические обновления на виртуальной машине. Если этот параметр опущен, значение по умолчанию имеет значение true.

WindowsUserConfiguration

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

Name	Type	Description
loginMode	LoginMode	Режим входа для пользователя Значение по умолчанию для пулов VirtualMachineConfiguration — batch, а для пулов CloudServiceConfiguration — interactive.