Pool - Add

Service:

Batch Service

API Version:

2023-11-01.18.0

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

POST {batchUrl}/pools?api-version=2023-11-01.18.0

With optional parameters:

POST {batchUrl}/pools?timeout={timeout}&api-version=2023-11-01.18.0

Параметры URI

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

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

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

Имя	Обязательно	Тип	Описание
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"

Имя	Обязательно	Тип	Описание
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[]	Список пакетов, устанавливаемых на каждом вычислительном узле в пуле. При создании пула идентификатор приложения пакета должен быть полным (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Изменения ссылок на пакеты влияют на все новые узлы, присоединенные к пулу, но не влияют на вычислительные узлы, которые уже находятся в пуле, пока они не будут перезагружены или перезагружены. В любом пуле имеется не более 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/{имя_пользователя}/certs), а сертификаты помещаются в этот каталог. Предупреждение. Это свойство устарело и будет удалено после февраля 2024 г. Вместо этого используйте расширение Azure KeyVault .
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 (недопустимый запрос).
resourceTags		object	Пользовательские теги, связанные с пулом. Определяемые пользователем теги, связанные с пулом пакетная служба Azure. Если они указаны, эти теги распространяются на резервные ресурсы Azure, связанные с пулом. Это свойство можно указать, только если учетная запись пакетной службы была создана с свойством poolAllocationMode, для свойства задано значение UserSubscription.
startTask		StartTask	Задача, указанная для выполнения на каждом вычислительном узле при присоединении к пулу. Задача выполняется при добавлении вычислительного узла в пул или при перезапуске вычислительного узла.
targetDedicatedNodes		integer	Требуемое количество выделенных вычислительных узлов в пуле. Это свойство не должно указываться, если для параметра enableAutoScale задано значение true. Если для параметра enableAutoScale задано значение false, необходимо задать либо targetDedicatedNodes, targetLowPriorityNodes, либо и то, и другое.
targetLowPriorityNodes		integer	Требуемое количество точечных или низкоприоритетных вычислительных узлов в пуле. Это свойство не должно указываться, если для параметра enableAutoScale задано значение true. Если для параметра enableAutoScale задано значение false, необходимо задать либо targetDedicatedNodes, targetLowPriorityNodes, либо и то, и другое.
targetNodeCommunicationMode		NodeCommunicationMode	Требуемый режим связи узла для пула. Если этот параметр опущен, значение по умолчанию — Default.
taskSchedulingPolicy		TaskSchedulingPolicy	Распределение задач между вычислительными узлами в пуле. Если значение не указано, по умолчанию используется spread.
taskSlotsPerNode		integer	Количество слотов задач, которые могут использоваться для выполнения параллельных задач на одном вычислительном узле в пуле. Значение по умолчанию — 1. Максимальное значение — в 4 раза меньше числа ядер vmSize пула или 256.
userAccounts		UserAccount[]	Список учетных записей пользователей, создаваемых на каждом вычислительном узле в пуле.
virtualMachineConfiguration		VirtualMachineConfiguration	Конфигурация виртуальной машины для пула. Это свойство и cloudServiceConfiguration являются взаимоисключающими, и необходимо указать одно из свойств.

Ответы

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

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

azure_auth

поток кода проверки подлинности Microsoft Entra OAuth 2.0

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

Scopes

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

Authorization

Type: apiKey
In: header

Примеры

Add a CloudServiceConfiguration pool

Add a pool with accelerated networking

Add a pool with mount drive specified

Add a pool with SecurityProfile

Add a simple pool with resourceTags

Add a VirtualMachineConfiguration pool

Add a VirtualMachineConfiguration pool with containers

Add a VirtualMachineConfiguration pool with extensions

Add a VirtualMachineConfiguration pool with OS disk

Add a VirtualMachineConfiguration pool with ServiceArtifactReference

Add a CloudServiceConfiguration pool

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.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 accelerated networking

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.0



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

Sample Response

Status code:

201

Add a pool with mount drive specified

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.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 pool with SecurityProfile

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.0



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

Sample Response

Status code:

201

Add a simple pool with resourceTags

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.0



{
  "id": "mypool001",
  "vmSize": "STANDARD_DC2s_V2",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "UbuntuServer",
      "sku": "18_04-lts-gen2",
      "version": "latest"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 18.04"
  },
  "targetDedicatedNodes": 1,
  "resourceTags": {
    "TagName1": "TagValue1",
    "TagName2": "TagValue2"
  }
}

Sample Response

Status code:

201

Add a VirtualMachineConfiguration pool

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.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=2023-11-01.18.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=2023-11-01.18.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": "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"
    }
  ],
  "targetNodeCommunicationMode": "simplified"
}

Sample Response

Status code:

201

Add a VirtualMachineConfiguration pool with OS disk

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.0



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

Sample Response

Status code:

201

Add a VirtualMachineConfiguration pool with ServiceArtifactReference

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.0



{
  "id": "mypool002",
  "vmSize": "Standard_A1_v2",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2016-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
}

Sample Response

Status code:

201

Определения

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

ApplicationPackageReference

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

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

AutoUserScope

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

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

AutoUserSpecification

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

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

AzureBlobFileSystemConfiguration

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

Имя	Тип	Описание
accountKey	string	Ключ учетной записи хранения Azure. Это свойство является взаимоисключающим как с sasKey, так и с идентификатором; Необходимо указать только один.
accountName	string	Имя учетной записи хранения Azure.
blobfuseOptions	string	Дополнительные параметры командной строки для передачи в команду mount. Это параметры 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.

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

BatchError

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

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

BatchErrorDetail

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

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

CachingType

Тип кэширования, включаемого для диска.

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

CertificateReference

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

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

CertificateStoreLocation

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

Имя	Тип	Описание
currentuser	string	Сертификаты должны быть установлены в хранилище сертификатов CurrentUser.
localmachine	string	Сертификаты должны быть установлены в хранилище сертификатов LocalMachine.

CertificateVisibility

Какие учетные записи пользователей на вычислительном узле должны иметь доступ к частным данным сертификата.

Имя	Тип	Описание
remoteuser	string	Сертификат должен быть виден учетным записям пользователей, с помощью которых пользователи удаленно получают доступ к вычислительному узлу.
starttask	string	Сертификат должен быть виден учетной записи пользователя, под которой выполняется StartTask. Обратите внимание, что если областью автопользователя является Пул для начальной задачи и задачи, этот сертификат будет виден и для задачи.
task	string	Сертификат должен быть виден учетным записям пользователей, с которыми выполняются задачи задания.

CIFSMountConfiguration

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

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

CloudServiceConfiguration

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

Имя	Тип	Описание
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

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

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

ComputeNodeIdentityReference

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

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

ContainerConfiguration

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

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

ContainerRegistry

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

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

ContainerType

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

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

ContainerWorkingDirectory

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

Имя	Тип	Описание
containerImageDefault	string	Используйте рабочий каталог, определенный в образе контейнера. Помните, что этот каталог не будет содержать файлы ресурсов, скачанные пакетной службой.
taskWorkingDirectory	string	Используйте стандартный рабочий каталог задачи пакетной службы, который будет содержать файлы ресурсов задачи, заполненные пакетной службой.

DataDisk

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

Имя	Тип	Описание
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

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

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

DiffDiskSettings

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

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

DiskEncryptionConfiguration

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

Имя	Тип	Описание
targets	DiskEncryptionTarget[]	Список целевых дисков пакетная служба будет шифровать на вычислительном узле. Если этот параметр опущен, диски на вычислительных узлах в пуле не будут зашифрованы. В пуле Linux поддерживается только "TemporaryDisk"; В пуле Windows необходимо указать "OsDisk" и "TemporaryDisk".

DiskEncryptionTarget

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

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

DynamicVNetAssignmentScope

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

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

ElevationLevel

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

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

EnvironmentSetting

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

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

ErrorMessage

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

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

ImageReference

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

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

InboundEndpointProtocol

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

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

InboundNATPool

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

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

IPAddressProvisioningType

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

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

LinuxUserConfiguration

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

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

LoginMode

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

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

ManagedDisk

Имя	Тип	Описание
storageAccountType	StorageAccountType	Тип учетной записи хранения для управляемого диска.

MetadataItem

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

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

MountConfiguration

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

Имя	Тип	Описание
azureBlobFileSystemConfiguration	AzureBlobFileSystemConfiguration	Контейнер службы хранилища Azure для подключения с помощью FUSE BLOB-объектов на каждом узле. Это свойство является взаимоисключающим со всеми другими свойствами.
azureFileShareConfiguration	AzureFileShareConfiguration	Общая папка Azure для подключения к каждому узлу. Это свойство является взаимоисключающим со всеми другими свойствами.
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	PoolEndpointConfiguration	Конфигурация конечных точек на вычислительных узлах в пуле пакетной службы. Конфигурация конечной точки пула поддерживается только в пулах со свойством virtualMachineConfiguration.
publicIPAddressConfiguration	PublicIPAddressConfiguration	Конфигурация public 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). Если 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

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

Имя	Тип	Описание
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-адреса, диапазона подсети или тега.

Имя	Тип	Описание
allow	string	Разрешить доступ.
deny	string	Запретить доступ.

NFSMountConfiguration

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

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

NodeCommunicationMode

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

Имя	Тип	Описание
classic	string	Узлам, использующим классический режим связи, требуется входящий tcp-обмен данными через порты 29876 и 29877 из BatchNodeManagement. Тег службы {region}и исходящий tcp-обмен данными через порт 443 с storage.region и BatchNodeManagement. Теги службы {регион}".
default	string	Режим связи с узлом автоматически задается пакетной службой.
simplified	string	Узлам, использующим упрощенный режим связи, требуется исходящий TCP-обмен данными через порт 443 с BatchNodeManagement. Тег службы {регион}. Открытые входящие порты не требуются.

NodePlacementConfiguration

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

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

NodePlacementPolicyType

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

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

OSDisk

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

Имя	Тип	Описание
caching	CachingType	Указывает требования к кэшированию. Возможные значения: None, ReadOnly, ReadWrite. Значения по умолчанию: Нет для хранилища уровня "Стандартный". ReadOnly для хранилища класса Premium. Значение по умолчанию для кэширования — none. Сведения о параметрах кэширования см. в разделе https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.
diskSizeGB	integer	Начальный размер диска в ГБ при создании нового диска ОС.
ephemeralOSDiskSettings	DiffDiskSettings	Задает временные параметры диска для диска операционной системы, используемого вычислительным узлом (ВМ).
managedDisk	ManagedDisk	Параметры управляемого диска.
writeAcceleratorEnabled	boolean	Указывает, следует ли включить или отключить writeAccelerator на диске.

PoolAddParameter

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

Имя	Тип	Описание
applicationLicenses	string[]	Список лицензий приложений пакетной службы будет доступен на каждом вычислительном узле в пуле. Список лицензий приложений должен быть подмножеством доступных лицензий на приложения пакетной службы. Если запрашивается лицензия, которая не поддерживается, создание пула завершится ошибкой.
applicationPackageReferences	ApplicationPackageReference[]	Список пакетов, устанавливаемых на каждом вычислительном узле в пуле. При создании пула идентификатор приложения пакета должен быть полным (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Изменения ссылок на пакеты влияют на все новые узлы, присоединяющиеся к пулу, но не влияют на вычислительные узлы, которые уже находятся в пуле, пока они не будут перезагружены или перезагружены. В любом пуле имеется не более 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), а сертификаты помещаются в этот каталог. Предупреждение. Это свойство устарело и будет удалено после февраля 2024 г. Вместо этого используйте расширение Azure KeyVault .
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 (недопустимый запрос).
resourceTags	object	Указанные пользователем теги, связанные с пулом. Определяемые пользователем теги, связанные с пулом пакетная служба Azure. При указании эти теги распространяются на резервные ресурсы Azure, связанные с пулом. Это свойство можно указать, только если учетная запись пакетной службы была создана с свойством poolAllocationMode, равным UserSubscription.
startTask	StartTask	Задача, указанная для запуска на каждом вычислительном узле при присоединении к пулу. Задача выполняется при добавлении вычислительного узла в пул или при перезапуске вычислительного узла.
targetDedicatedNodes	integer	Требуемое количество выделенных вычислительных узлов в пуле. Это свойство не должно указываться, если для параметра enableAutoScale задано значение true. Если для параметра enableAutoScale задано значение false, необходимо задать либо targetDedicatedNodes, targetLowPriorityNodes, либо и то, и другое.
targetLowPriorityNodes	integer	Требуемое количество точечных или низкоприоритетных вычислительных узлов в пуле. Это свойство не должно указываться, если для параметра enableAutoScale задано значение true. Если для параметра enableAutoScale задано значение false, необходимо задать либо targetDedicatedNodes, targetLowPriorityNodes, либо и то, и другое.
targetNodeCommunicationMode	NodeCommunicationMode	Требуемый режим связи узла для пула. Если этот параметр опущен, значение по умолчанию — Default.
taskSchedulingPolicy	TaskSchedulingPolicy	Распределение задач между вычислительными узлами в пуле. Если значение не указано, по умолчанию используется spread.
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

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

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

PublicIPAddressConfiguration

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

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

ResourceFile

Один файл или несколько файлов для скачивания на вычислительный узел.

Имя	Тип	Описание
autoStorageContainerName	string	Имя контейнера хранилища в учетной записи автоматического хранения. Свойства autoStorageContainerName, storageContainerUrl и httpUrl являются взаимоисключающими и должны быть указаны.
blobPrefix	string	Префикс большого двоичного объекта, используемый при скачивании BLOB-объектов из контейнера службы хранилища 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-объектов в Хранилище BLOB-объектов Azure. Свойства autoStorageContainerName, storageContainerUrl и httpUrl являются взаимоисключающими и должны быть указаны. Этот URL-адрес должен быть удобочитаемым и отображаться на вычислительных узлах. Существует три способа получить такой URL-адрес для контейнера в службе хранилища Azure: включить подписанный URL-адрес (SAS), предоставляющий разрешения на чтение и перечисление в контейнере, использовать управляемое удостоверение с разрешениями на чтение и перечисление или задать список ACL для контейнера, чтобы разрешить общий доступ.

SecurityProfile

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

Имя	Тип	Описание
encryptionAtHost	boolean	Это свойство может использоваться пользователем в запросе, чтобы включить или отключить шифрование узла для виртуальной машины или масштабируемого набора виртуальных машин. Это позволит обеспечить шифрование для всех дисков, включая временный или ресурсный диск на самом узле.
securityType	SecurityTypes	Указывает тип безопасности виртуальной машины. Для включения UefiSettings ему необходимо задать любое указанное значение.
uefiSettings	UefiSettings	Указывает параметры безопасности, такие как безопасная загрузка и vTPM, используемые при создании виртуальной машины. Указывает параметры безопасности, такие как безопасная загрузка и vTPM, используемые при создании виртуальной машины.

SecurityTypes

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

Имя	Тип	Описание
trustedLaunch	string	Доверенный запуск защищает от сложных и постоянных атак.

ServiceArtifactReference

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

Имя	Тип	Описание
id	string	Идентификатор ссылки на артефакт службы объекта ServiceArtifactReference Идентификатор ссылки на артефакт службы в формате /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/serviceArtifacts/{serviceArtifacts}/vmArtifactsProfiles/{vmArtifactsProfilesName}

StartTask

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

Имя	Тип	Описание
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 на узле) сопоставляются с контейнером, все переменные среды задач сопоставляются с контейнером, а в контейнере выполняется командная строка Task. Файлы, созданные в контейнере за пределами AZ_BATCH_NODE_ROOT_DIR, могут не отражаться на диске узла, а это означает, что API пакетных файлов не смогут получить доступ к этим файлам.
environmentSettings	EnvironmentSetting[]	Список параметров переменных среды для StartTask.
maxTaskRetryCount	integer	Максимальное количество повторных попыток задачи. Пакетная служба повторяет задачу, если ее код выхода не равен нулю. Обратите внимание, что это значение определяет количество повторных попыток. Пакетная служба попытается выполнить задачу один раз, а затем может повторить попытку до этого предела. Например, если максимальное число повторных попыток равно 3, пакетная служба пытается выполнить задачу до 4 раз (одна начальная попытка и 3 повторных попытки). Если максимальное число повторных попыток равно 0, пакетная служба не повторяет задачу. Если максимальное число повторных попыток равно -1, пакетная служба повторяет задачу без ограничений, однако это не рекомендуется для задачи запуска или любой задачи. Значение по умолчанию — 0 (без повторных попыток).
resourceFiles	ResourceFile[]	Список файлов, которые пакетная служба скачает на вычислительный узел перед запуском командной строки. Существует максимальный размер списка файлов ресурсов. При превышении максимального размера запрос завершится ошибкой и кодом ошибки ответа будет RequestEntityTooLarge. В этом случае размер коллекции ResourceFiles должен быть уменьшен. Это можно сделать с помощью .zip файлов, пакетов приложений или контейнеров Docker. Файлы, перечисленные в этом элементе, находятся в рабочем каталоге задачи.
userIdentity	UserIdentity	Удостоверение пользователя, с которым выполняется StartTask. Если этот параметр опущен, задача выполняется от имени пользователя, не являющегося администратором, уникальным для задачи.
waitForSuccess	boolean	Указывает, должна ли пакетная служба ожидать успешного завершения StartTask (т. е. выхода с кодом выхода 0) перед планированием задач на вычислительном узле. Если значение равно true и startTask завершается сбоем на узле, пакетная служба повторяет операцию StartTask до максимального числа повторных попыток (maxTaskRetryCount). Если задача по-прежнему не была успешно завершена после всех повторных попыток, пакетная служба помечает узел как непригодный для использования и не будет планировать для него задачи. Это условие можно обнаружить с помощью сведений о состоянии вычислительного узла и сведений о сбое. Если значение равно false, пакетная служба не будет ждать завершения startTask. В этом случае другие задачи могут начать выполнение на вычислительном узле, пока еще выполняется StartTask. и даже в случае сбоя StartTask новые задачи будут по-прежнему планироваться на вычислительном узле. Значение по умолчанию — true.

StorageAccountType

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

Имя	Тип	Описание
premium_lrs	string	Диск данных или диск ОС должны использовать локально избыточное хранилище класса Premium.
standard_lrs	string	Диск данных или диск ОС должен использовать стандартное локально избыточное хранилище.
standardssd_lrs	string	Диск данных или диск ОС должны использовать локально избыточное хранилище SSD (цен. категория "Стандартный").

TaskContainerSettings

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

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

TaskSchedulingPolicy

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

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

UefiSettings

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

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

UserAccount

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

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

UserIdentity

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

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

VirtualMachineConfiguration

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

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

VMExtension

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

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

WindowsConfiguration

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

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

WindowsUserConfiguration

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

Имя	Тип	Описание
loginMode	LoginMode	Режим входа для пользователя По умолчанию для пулов VirtualMachineConfiguration используется значение batch, а для пулов CloudServiceConfiguration — interactive.