Job - Add

Service:

Batch Service

API Version:

2023-11-01.18.0

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

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

With optional parameters:

POST {batchUrl}/jobs?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 символов. Идентификатор сохраняет регистр и не учитывает регистр (то есть у вас может не быть двух идентификаторов в учетной записи, которые отличаются только по регистру).
poolInfo	True	PoolInformation	Пул, в котором пакетная служба выполняет задачи задания.
allowTaskPreemption		boolean	Можно ли вытеснять задачи в этом задании другими высокоприоритетными заданиями Если задано значение True, другие высокоприоритетные задания, отправленные в систему, будут иметь приоритет и смогут повторно отправлять задачи из этого задания. Вы можете обновить allowTaskPreemption задания после его создания с помощью API задания обновления.
commonEnvironmentSettings		EnvironmentSetting[]	Список общих параметров переменных среды. Эти переменные среды задаются для всех задач в задании (включая диспетчер заданий, задачи подготовки заданий и задачи выпуска задания). Отдельные задачи могут переопределить указанный здесь параметр среды, указав то же имя параметра с другим значением.
constraints		JobConstraints	Ограничения выполнения для задания. Ограничения выполнения для задания.
displayName		string	Отображаемое имя задания. Отображаемое имя не должно быть уникальным и может содержать любые символы Юникода длиной до 1024.
jobManagerTask		JobManagerTask	Сведения о задаче диспетчера заданий, запускаемой при запуске задания. Если задание не указывает задачу диспетчера заданий, пользователь должен явно добавить задачи в задание. Если задание указывает задачу диспетчера заданий, пакетная служба создает задачу диспетчера заданий при создании задания и попытается запланировать задачу диспетчера заданий перед планированием других задач в задании. Типичная цель задачи диспетчера заданий — контролировать и (или) отслеживать выполнение заданий, например путем принятия решения о выполнении дополнительных задач, определения времени завершения работы и т. д. (Однако задача диспетчера заданий не ограничивается этими действиями — это полноценная задача в системе и выполнение любых действий, необходимых для задания.) Например, задача диспетчера заданий может скачать файл, указанный в качестве параметра, проанализировать содержимое этого файла и отправить дополнительные задачи на основе этого содержимого.
jobPreparationTask		JobPreparationTask	Задача подготовки задания. Если задание имеет задачу подготовки задания, пакетная служба выполнит задачу подготовки задания на узле перед запуском любых задач этого задания на этом вычислительном узле.
jobReleaseTask		JobReleaseTask	Задача выпуска задания. Задача выпуска задания не может быть указана без указания задачи подготовки задания для задания. Пакетная служба выполняет задачу выпуска задания на узлах, на которых запущена задача подготовки задания. Основной целью задачи выпуска задания является отмена изменений на вычислительных узлах, внесенных задачей подготовки задания. Примеры действий включают удаление локальных файлов или завершение работы служб, которые были запущены в рамках подготовки задания.
maxParallelTasks		integer	Максимальное количество задач, которые могут выполняться параллельно для задания. Значение maxParallelTasks должно быть равно -1 или больше 0, если указано. Если не указано, значение по умолчанию — -1, что означает отсутствие ограничений на количество задач, которые можно выполнять одновременно. Вы можете обновить maxParallelTasks задания после его создания с помощью API задания обновления.
metadata		MetadataItem[]	Список пар "имя-значение", связанных с заданием в качестве метаданных. Пакетная служба не присваивает метаданным никакого значения; он предназначен исключительно для использования пользовательского кода.
networkConfiguration		JobNetworkConfiguration	Конфигурация сети для задания.
onAllTasksComplete		OnAllTasksComplete	Действие, которое должна выполнять пакетная служба, если все задачи в задании находятся в состоянии завершения. Обратите внимание, что если задание не содержит задач, все задачи считаются завершенными. Поэтому этот параметр чаще всего используется с задачей диспетчера заданий; Если вы хотите использовать автоматическое завершение задания без диспетчера заданий, сначала присвойте параметру onAllTasksComplete значение noaction и обновите свойства задания, чтобы присвоить onAllTasksComplete значение terminatejob после завершения добавления задач. Значение по умолчанию — noaction.
onTaskFailure		OnTaskFailure	Действие, выполняемого пакетной службой при сбое любой задачи в задании. Задача считается неудачной, если имеет failureInfo. Значение failureInfo устанавливается, если задача завершается с ненулевым кодом выхода после исчерпания числа повторных попыток или если произошла ошибка при запуске задачи, например из-за ошибки скачивания файла ресурсов. Значение по умолчанию — noaction.
priority		integer	Приоритет задания. Значения приоритета могут указываться в диапазоне от -1000 до 1000, где -1000 является самым низким приоритетом, а 1000 — самым высшим. Значение по умолчанию — 0.
usesTaskDependencies		boolean	Могут ли задачи в задании определять зависимости друг от друга. Значение по умолчанию — false.

Ответы

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

Add a complex job

Add a basic job

Sample Request

HTTP

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



{
  "id": "jobId",
  "priority": 0,
  "poolInfo": {
    "poolId": "poolId"
  }
}

Sample Response

Status code:

201

Add a complex job

Sample Request

HTTP

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



{
  "id": "jobId",
  "priority": 100,
  "constraints": {
    "maxWallClockTime": "PT1H",
    "maxTaskRetryCount": -1
  },
  "jobManagerTask": {
    "id": "taskId",
    "commandLine": "myprogram.exe",
    "resourceFiles": [
      {
        "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram.exe?sas",
        "filePath": "myprogram.exe"
      },
      {
        "storageContainerUrl": "http://mystorage1.blob.core.windows.net/data?sas",
        "filePath": "datafolder"
      }
    ],
    "environmentSettings": [
      {
        "name": "myvariable",
        "value": "myvalue"
      }
    ],
    "constraints": {
      "maxWallClockTime": "PT1H",
      "maxTaskRetryCount": 0,
      "retentionTime": "PT1H"
    },
    "requiredSlots": 2,
    "killJobOnCompletion": false,
    "userIdentity": {
      "autoUser": {
        "scope": "task",
        "elevationLevel": "admin"
      }
    },
    "runExclusive": true
  },
  "poolInfo": {
    "autoPoolSpecification": {
      "autoPoolIdPrefix": "mypool",
      "poolLifetimeOption": "job",
      "pool": {
        "vmSize": "small",
        "cloudServiceConfiguration": {
          "osFamily": "4",
          "osVersion": "*"
        },
        "resizeTimeout": "PT15M",
        "targetDedicatedNodes": 3,
        "targetLowPriorityNodes": 0,
        "taskSlotsPerNode": 2,
        "taskSchedulingPolicy": {
          "nodeFillType": "spread"
        },
        "enableAutoScale": false,
        "enableInterNodeCommunication": true,
        "startTask": {
          "commandLine": "myprogram2.exe",
          "resourceFiles": [
            {
              "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram2.exe?sas",
              "filePath": "myprogram2.exe"
            }
          ],
          "environmentSettings": [
            {
              "name": "myvariable",
              "value": "myvalue"
            }
          ],
          "userIdentity": {
            "autoUser": {
              "scope": "task",
              "elevationLevel": "admin"
            }
          },
          "maxTaskRetryCount": 2,
          "waitForSuccess": true
        },
        "certificateReferences": [
          {
            "thumbprint": "0123456789abcdef0123456789abcdef01234567",
            "thumbprintAlgorithm": "sha1",
            "storeLocation": "localmachine",
            "storeName": "Root",
            "visibility": [
              "task"
            ]
          }
        ],
        "metadata": [
          {
            "name": "myproperty",
            "value": "myvalue"
          }
        ],
        "targetNodeCommunicationMode": "default"
      }
    }
  },
  "metadata": [
    {
      "name": "myproperty",
      "value": "myvalue"
    }
  ]
}

Sample Response

Status code:

201

Определения

Имя	Описание
AccessScope	Ресурсы пакетной службы, к которым маркер предоставляет доступ.
ApplicationPackageReference	Ссылка на пакет, развертываемый на вычислительных узлах.
AuthenticationTokenSettings	Параметры маркера проверки подлинности, который задача может использовать для выполнения операций пакетной службы.
AutoPoolSpecification	Задает характеристики для временного "автоматического пула". Пакетная служба создаст этот автоматический пул при отправке задания.
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.
HttpHeader	Пара "имя-значение" заголовка HTTP
ImageReference	Ссылка на образ Azure Виртуальные машины Marketplace или образ коллекции вычислений Azure. Чтобы получить список всех Azure Marketplace ссылок на образы, проверенные пакетная служба Azure, см. операцию "Список поддерживаемых образов".
InboundEndpointProtocol	Протокол конечной точки.
InboundNATPool	Пул NAT для входящего трафика, который можно использовать для обращения к определенным портам на вычислительных узлах в пуле пакетной службы извне.
IPAddressProvisioningType	Тип подготовки для общедоступных IP-адресов пула.
JobAddParameter	Добавляемое задание пакетная служба Azure.
JobConstraints	Ограничения выполнения для задания.
JobManagerTask	Указывает сведения о задаче диспетчера заданий.
JobNetworkConfiguration	Конфигурация сети для задания.
JobPreparationTask	Задача подготовки задания, выполняемая перед любыми задачами задания на любом вычислительном узле.
JobReleaseTask	Задача выпуска задания, выполняемая при завершении задания на любом вычислительном узле, где было запущено задание.
LinuxUserConfiguration	Свойства, используемые для создания учетной записи пользователя на вычислительном узле Linux.
LoginMode	Режим входа для пользователя
ManagedDisk
MetadataItem	Пара "имя-значение", связанная с ресурсом пакетной службы.
MountConfiguration	Файловая система для подключения к каждому узлу.
NetworkConfiguration	Конфигурация сети для пула.
NetworkSecurityGroupRule	Правило группы безопасности сети для применения к входящей конечной точке.
NetworkSecurityGroupRuleAccess	Действие, которое необходимо выполнить для указанного IP-адреса, диапазона подсети или тега.
NFSMountConfiguration	Сведения, используемые для подключения к файловой системе NFS.
NodeCommunicationMode	Определяет, как пул взаимодействует с пакетной службой.
NodePlacementConfiguration	Конфигурация размещения узла для пула.
NodePlacementPolicyType	Политика размещения для выделения узлов в пуле.
OnAllTasksComplete	Действие, которое пакетная служба должна выполнять, когда все задачи в задании находятся в состоянии завершения.
OnTaskFailure	Действие, выполняемого пакетной службой при сбое любой задачи в задании.
OSDisk	Параметры диска операционной системы вычислительного узла (ВМ).
OutputFile	Спецификация для отправки файлов из вычислительного узла пакетная служба Azure в другое расположение после того, как пакетная служба завершит выполнение процесса задачи.
OutputFileBlobContainerDestination	Указывает назначение отправки файлов в контейнере хранилища BLOB-объектов Azure.
OutputFileDestination	Место назначения, в которое должен быть отправлен файл.
OutputFileUploadCondition	Условия, при которых должен отправляться выходной файл задачи или набор файлов.
OutputFileUploadOptions	Сведения об операции отправки выходных файлов, в том числе о том, при каких условиях следует выполнить отправку.
PoolEndpointConfiguration	Конфигурация конечной точки для пула.
PoolInformation	Указывает, как задание должно быть назначено пулу.
PoolLifetimeOption	Минимальное время существования созданных автоматических пулов и назначение пулам нескольких заданий по расписанию.
PoolSpecification	Спецификация для создания нового пула.
PublicIPAddressConfiguration	Конфигурация общедоступного IP-адреса конфигурации сети пула.
ResourceFile	Один файл или несколько файлов для загрузки на вычислительный узел.
SecurityProfile	Задает параметры профиля безопасности для виртуальной машины или масштабируемого набора виртуальных машин.
SecurityTypes	Указывает тип безопасности виртуальной машины. Для включения UefiSettings ему необходимо задать любое указанное значение.
ServiceArtifactReference	Указывает идентификатор ссылки на артефакт службы, используемый для задания одинаковой версии образа для всех виртуальных машин в масштабируемом наборе при использовании последней версии образа.
StartTask	Задача, которая выполняется при присоединении узла к пулу в службе пакетная служба Azure либо при перезагрузке или повторном создании образа вычислительного узла.
StorageAccountType	Тип учетной записи хранения, используемый при создании дисков данных или диска ОС.
TaskConstraints	Ограничения выполнения, применяемые к задаче.
TaskContainerSettings	Параметры контейнера для задачи.
TaskSchedulingPolicy	Указывает, как задачи должны распределяться между вычислительными узлами.
UefiSettings	Указывает параметры безопасности, такие как безопасная загрузка и vTPM, используемые при создании виртуальной машины.
UserAccount	Свойства, используемые для создания пользователя, используемого для выполнения задач на пакетная служба Azure вычислительном узле.
UserIdentity	Определение удостоверения пользователя, с которым выполняется задача.
VirtualMachineConfiguration	Конфигурация вычислительных узлов в пуле на основе инфраструктуры azure Виртуальные машины.
VMExtension	Конфигурация для расширений виртуальных машин.
WindowsConfiguration	Параметры операционной системы Windows, применяемые к виртуальной машине.
WindowsUserConfiguration	Свойства, используемые для создания учетной записи пользователя на вычислительном узле Windows.

AccessScope

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

Имя	Тип	Описание
job	string	Предоставляет доступ для выполнения всех операций с заданием, содержащим задачу.

ApplicationPackageReference

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

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

AuthenticationTokenSettings

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

Имя	Тип	Описание
access	AccessScope[]	Ресурсы пакетной службы, к которым маркер предоставляет доступ. Маркер проверки подлинности предоставляет доступ к ограниченному набору операций пакетной службы. В настоящее время единственным поддерживаемым значением для свойства доступа является job, которое предоставляет доступ ко всем операциям, связанным с заданием, содержащим задачу.

AutoPoolSpecification

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

Имя	Тип	Описание
autoPoolIdPrefix	string	Префикс, добавляемый к уникальному идентификатору при автоматическом создании пула. Пакетная служба назначает каждому автоматическому пулу уникальный идентификатор при создании. Чтобы различать пулы, созданные для разных целей, можно указать этот элемент, чтобы добавить префикс к назначенному идентификатору. Значение префикса может иметь длину до 20 символов.
keepAlive	boolean	Следует ли сохранять автоматический пул в активном состоянии по истечении срока его существования. Если задано значение false, пакетная служба удаляет пул по истечении срока его существования (как определено параметром poolLifetimeOption). т. е. по завершении задания или расписания заданий. Если значение равно true, пакетная служба не удаляет пул автоматически. Пользователь может удалить автоматические пулы, созданные с помощью этого параметра.
pool	PoolSpecification	Спецификация пула для автоматического пула.
poolLifetimeOption	PoolLifetimeOption	Минимальное время существования созданных автоматических пулов и назначение пулам нескольких заданий по расписанию.

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	Дополнительные параметры командной строки для передачи в команду подключения. Это параметры 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	Дополнительные параметры командной строки для передачи в команду подключения. Это параметры 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	Дополнительные параметры командной строки для передачи в команду подключения. Это параметры 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	Текст сообщения.

HttpHeader

Пара "имя-значение" заголовка HTTP

Имя	Тип	Описание
name	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/gallerys/{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-адреса предоставляются пользователем и будут использоваться для подготовки вычислительных узлов.

JobAddParameter

Добавляемое задание пакетная служба Azure.

Имя	Тип	Значение по умолчанию	Описание
allowTaskPreemption	boolean		Могут ли задачи в этом задании быть вытеснены другими заданиями с высоким приоритетом Если для параметра задано значение True, другие задания с высоким приоритетом, отправленные в систему, будут иметь приоритет и смогут перезапускать задачи из этого задания. Вы можете обновить allowTaskPreemption задания после его создания с помощью API задания обновления.
commonEnvironmentSettings	EnvironmentSetting[]		Список общих параметров переменных среды. Эти переменные среды задаются для всех задач в задании (включая диспетчер заданий, задачи подготовки и освобождения заданий). Отдельные задачи могут переопределить параметр среды, указанный здесь, указав то же имя параметра с другим значением.
constraints	JobConstraints		Ограничения выполнения для задания. Ограничения выполнения для задания.
displayName	string		Отображаемое имя задания. Отображаемое имя не обязательно должно быть уникальным и может содержать любые символы Юникода длиной до 1024.
id	string		Строка, однозначно идентифицирующая задание в учетной записи. Идентификатор может содержать любое сочетание буквенно-цифровых символов, включая дефисы и символы подчеркивания, и не может содержать более 64 символов. Идентификатор сохраняет регистр и не учитывает регистр (то есть у вас может не быть двух идентификаторов в учетной записи, которые отличаются только регистром).
jobManagerTask	JobManagerTask		Сведения о задаче диспетчера заданий, запускаемой при запуске задания. Если в задании не указана задача диспетчера заданий, пользователь должен явно добавить задачи в задание. Если задание указывает задачу диспетчера заданий, пакетная служба создает задачу диспетчера заданий при создании задания и попытается запланировать задачу диспетчера заданий перед планированием других задач в задании. Типичная цель задачи диспетчера заданий заключается в управлении выполнением заданий и (или) мониторинге, например путем выбора дополнительных задач для выполнения, определения времени завершения работы и т. д. (Однако задача диспетчера заданий не ограничивается этими действиями — это полноценная задача в системе и выполнение любых действий, необходимых для задания.) Например, задача диспетчера заданий может скачать файл, указанный в качестве параметра, проанализировать содержимое этого файла и отправить дополнительные задачи на основе этого содержимого.
jobPreparationTask	JobPreparationTask		Задача подготовки задания. Если задание содержит задачу подготовки задания, пакетная служба выполнит задачу подготовки задания на узле перед запуском всех задач этого задания на этом вычислительном узле.
jobReleaseTask	JobReleaseTask		Задача освобождения задания. Задачу освобождения задания нельзя указать без указания задачи подготовки задания для задания. Пакетная служба выполняет задачу освобождения задания на узлах, на которых выполняется задача подготовки задания. Основная цель задачи выпуска задания — отменить изменения в вычислительных узлах, внесенные задачей подготовки задания. Примеры действий включают удаление локальных файлов или завершение работы служб, которые были запущены в рамках подготовки задания.
maxParallelTasks	integer	-1	Максимальное число задач, которые могут выполняться параллельно для задания. Значение maxParallelTasks должно быть равно -1 или больше 0, если указано. Если значение не указано, значение по умолчанию равно -1, что означает, что количество задач, которые можно выполнять одновременно, не ограничено. Вы можете обновить maxParallelTasks задания после его создания с помощью API задания обновления.
metadata	MetadataItem[]		Список пар "имя-значение", связанных с заданием в качестве метаданных. Пакетная служба не присваивает метаданным никакого значения; он предназначен исключительно для использования пользовательского кода.
networkConfiguration	JobNetworkConfiguration		Конфигурация сети для задания.
onAllTasksComplete	OnAllTasksComplete		Действие, которое пакетная служба должна выполнять, когда все задачи в задании находятся в состоянии завершения. Обратите внимание, что если задание не содержит задач, все задачи считаются завершенными. Поэтому этот параметр чаще всего используется с задачей диспетчера заданий; Если вы хотите использовать автоматическое завершение задания без диспетчера заданий, сначала присвойте параметру onAllTasksComplete значение noaction и обновите свойства задания, чтобы присвоить onAllTasksComplete значение terminatejob после завершения добавления задач. Значение по умолчанию — noaction.
onTaskFailure	OnTaskFailure		Действие, выполняемого пакетной службой при сбое любой задачи в задании. Задача считается неудачной, если имеет failureInfo. Значение failureInfo устанавливается, если задача завершается с ненулевым кодом выхода после исчерпания числа повторных попыток или если произошла ошибка при запуске задачи, например из-за ошибки скачивания файла ресурсов. Значение по умолчанию — noaction.
poolInfo	PoolInformation		Пул, в котором пакетная служба выполняет задачи задания.
priority	integer		Приоритет задания. Значения приоритета могут указываться в диапазоне от -1000 до 1000, где -1000 является самым низким приоритетом, а 1000 — самым высшим. Значение по умолчанию — 0.
usesTaskDependencies	boolean		Могут ли задачи в задании определять зависимости друг от друга. Значение по умолчанию — false.

JobConstraints

Ограничения выполнения для задания.

Имя	Тип	Описание
maxTaskRetryCount	integer	Максимальное число повторных попыток каждой задачи. Пакетная служба выполняет повторную попытку задачи, если ее код выхода не является нулевым. Обратите внимание, что это значение определяет количество повторных попыток. Пакетная служба будет пытаться выполнить каждую задачу один раз, а затем может повторить попытку до этого ограничения. Например, если максимальное число повторных попыток равно 3, пакетная служба пытается выполнить задачу до 4 раз (одна начальная попытка и 3 повторных попытки). Если максимальное число повторных попыток равно 0, пакетная служба не повторяет задачи. Если максимальное число повторных попыток равно -1, пакетная служба выполняет повторную попытку "Задачи" без ограничений. Значение по умолчанию — 0 (без повторных попыток).
maxWallClockTime	string	Максимальное время, затраченное на выполнение задания, измеряемое с момента создания задания. Если задание не завершается в течение предельного времени, пакетная служба завершает его и все задачи, которые все еще выполняются. В этом случае причиной завершения будет MaxWallClockTimeExpiry. Если это свойство не указано, нет ограничений по времени на время выполнения задания.

JobManagerTask

Указывает сведения о задаче диспетчера заданий.

Имя	Тип	Описание
allowLowPriorityNode	boolean	Может ли задача диспетчера заданий выполняться на точечных или низкоприоритетных вычислительных узлах. Значение по умолчанию — true.
applicationPackageReferences	ApplicationPackageReference[]	Список пакетов приложений, которые пакетная служба будет развертывать на вычислительном узле перед запуском командной строки. Пакеты приложений скачиваются и развертываются в общем каталоге, а не в рабочий каталог задачи. Таким образом, если пакет приложения, на который ссылается ссылка, уже находится на вычислительном узле и обновлен, он не будет повторно скачан; Используется существующая копия на вычислительном узле. Если не удается установить указанный пакет приложения, например из-за удаления пакета или из-за сбоя скачивания, задача завершается сбоем.
authenticationTokenSettings	AuthenticationTokenSettings	Параметры маркера проверки подлинности, который задача может использовать для выполнения операций пакетной службы. Если это свойство задано, пакетная служба предоставляет задаче маркер проверки подлинности, который можно использовать для проверки подлинности операций пакетной службы без необходимости ключа доступа учетной записи. Маркер предоставляется с помощью переменной среды AZ_BATCH_AUTHENTICATION_TOKEN. Операции, которые задача может выполнять с помощью маркера, зависят от параметров. Например, задача может запрашивать разрешения задания для добавления других задач в задание или проверка состояние задания или других задач в задании.
commandLine	string	Командная строка задачи диспетчера заданий. Командная строка не выполняется в оболочке и поэтому не может использовать преимущества таких функций оболочки, как расширение переменной среды. Если вы хотите воспользоваться преимуществами таких функций, следует вызвать оболочку в командной строке, например с помощью cmd /c MyCommand в Windows или /bin/sh -c MyCommand в Linux. Если командная строка ссылается на пути к файлам, она должна использовать относительный путь (относительно рабочего каталога задачи) или переменную среды, предоставленную пакетной службой (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
constraints	TaskConstraints	Ограничения, применяемые к задаче диспетчера заданий.
containerSettings	TaskContainerSettings	Параметры контейнера, в котором выполняется задача диспетчера заданий. Если в пуле, в который будет выполняться эта задача, задан параметр containerConfiguration, его также необходимо задать. Если в пуле, в который будет выполняться эта задача, не задан параметр containerConfiguration, его не следует задавать. Если этот параметр указан, все каталоги рекурсивно под AZ_BATCH_NODE_ROOT_DIR (корневой каталог пакетная служба Azure на узле) сопоставляются с контейнером, все переменные среды задач сопоставляются с контейнером, а командная строка задачи выполняется в контейнере. Файлы, созданные в контейнере за пределами AZ_BATCH_NODE_ROOT_DIR, могут не отражаться на диске узла, а это означает, что API пакетной службы не смогут получить доступ к этим файлам.
displayName	string	Отображаемое имя задачи диспетчера заданий. Он не должен быть уникальным и может содержать любые символы Юникода длиной до 1024.
environmentSettings	EnvironmentSetting[]	Список параметров переменных среды для задачи диспетчера заданий.
id	string	Строка, однозначно идентифицирующая задачу диспетчера заданий в задании. Идентификатор может содержать любое сочетание буквенно-цифровых символов, включая дефисы и символы подчеркивания, и не может содержать более 64 символов.
killJobOnCompletion	boolean	Указывает, означает ли завершение задачи диспетчера заданий завершение всего задания. Если значение равно true, то после завершения задачи диспетчера заданий пакетная служба помечает задание как завершенное. Если в это время все еще выполняются какие-либо задачи (кроме выпуска задания), эти задачи завершаются. Если значение равно false, завершение задачи диспетчера заданий не влияет на состояние задания. В этом случае следует либо использовать атрибут onAllTasksComplete, чтобы завершить задание, либо явно завершить задание клиентом или пользователем. Например, диспетчер заданий создает набор задач, но затем не принимает никаких дополнительных ролей в их выполнении. Значение по умолчанию — true. Если атрибуты onAllTasksComplete и onTaskFailure используются для управления временем существования задания, а задача диспетчера заданий используется только для создания задач для задания (а не для отслеживания хода выполнения), важно задать для killJobOnCompletion значение false.
outputFiles	OutputFile[]	Список файлов, которые пакетная служба будет отправлять с вычислительного узла после запуска командной строки. Для задач с несколькими экземплярами файлы будут отправляться только с вычислительного узла, на котором выполняется основная задача.
requiredSlots	integer	Количество слотов планирования, необходимых для выполнения задачи. Значение по умолчанию — 1. Задача может быть запланирована на выполнение на вычислительном узле, только если на узле достаточно свободных слотов планирования. Для задач с несколькими экземплярами это свойство не поддерживается и не должно указываться.
resourceFiles	ResourceFile[]	Список файлов, которые пакетная служба скачает на вычислительный узел перед запуском командной строки. Файлы, перечисленные в этом элементе, находятся в рабочем каталоге задачи. Существует максимальный размер списка файлов ресурсов. При превышении максимального размера запрос завершится ошибкой, а код ошибки ответа — RequestEntityTooLarge. В этом случае необходимо уменьшить размер коллекции ResourceFiles. Это можно сделать с помощью .zip файлов, пакетов приложений или контейнеров Docker.
runExclusive	boolean	Требуется ли для задачи диспетчера заданий монопольное использование вычислительного узла, на котором она выполняется. Если задано значение true, другие задачи не будут выполняться на том же узле до тех пор, пока запущен диспетчер заданий. Если значение равно false, другие задачи могут выполняться одновременно с диспетчером заданий на вычислительном узле. Задача диспетчера заданий обычно учитывается по отношению к ограничению параллельных задач вычислительного узла, поэтому это актуально только в том случае, если вычислительный узел допускает несколько параллельных задач. Значение по умолчанию — true.
userIdentity	UserIdentity	Удостоверение пользователя, под которым выполняется задача диспетчера заданий. Если этот параметр опущен, задача выполняется от имени пользователя, не являющегося административным, уникальным для задачи.

JobNetworkConfiguration

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

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

JobPreparationTask

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

Имя	Тип	Описание
commandLine	string	Командная строка задачи подготовки задания. Командная строка не выполняется в оболочке и поэтому не может использовать преимущества таких функций оболочки, как расширение переменной среды. Если вы хотите воспользоваться преимуществами таких функций, следует вызвать оболочку в командной строке, например с помощью cmd /c MyCommand в Windows или /bin/sh -c MyCommand в Linux. Если командная строка ссылается на пути к файлам, она должна использовать относительный путь (относительно рабочего каталога задачи) или переменную среды, предоставленную пакетной службой (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
constraints	TaskConstraints	Ограничения, применяемые к задаче подготовки задания.
containerSettings	TaskContainerSettings	Параметры контейнера, в котором выполняется задача подготовки задания. Если этот параметр указан, все каталоги рекурсивно под AZ_BATCH_NODE_ROOT_DIR (корневой каталог пакетная служба Azure на узле) сопоставляются с контейнером, все переменные среды задач сопоставляются с контейнером, а командная строка задачи выполняется в контейнере. Файлы, созданные в контейнере за пределами AZ_BATCH_NODE_ROOT_DIR, могут не отражаться на диске узла, а это означает, что API пакетной службы не смогут получить доступ к этим файлам.
environmentSettings	EnvironmentSetting[]	Список параметров переменных среды для задачи подготовки задания.
id	string	Строка, однозначно идентифицирующая задачу подготовки задания в задании. Идентификатор может содержать любое сочетание буквенно-цифровых символов, включая дефисы и символы подчеркивания, и не может содержать более 64 символов. Если это свойство не указано, пакетная служба назначает значение по умолчанию jobpreparation. Никакая другая задача в задании не может иметь тот же идентификатор, что и задача подготовки задания. При попытке отправить задачу с тем же идентификатором пакетная служба отклоняет запрос с кодом ошибки TaskIdSameAsJobPreparationTask; Если вы вызываете REST API напрямую, код состояния HTTP — 409 (конфликт).
rerunOnNodeRebootAfterSuccess	boolean	Указывает, должна ли пакетная служба повторно запускать задачу подготовки задания после перезагрузки вычислительного узла. Задача подготовки задания всегда выполняется повторно, если выполняется переосмысление образа вычислительного узла или если задача подготовки задания не была завершена (например, из-за перезагрузки во время выполнения задачи). Поэтому всегда следует писать задачу подготовки задания, чтобы она была идемпотентной и правильно функционировала при многократном выполнении. Значение по умолчанию — true.
resourceFiles	ResourceFile[]	Список файлов, которые пакетная служба скачает на вычислительный узел перед запуском командной строки. Файлы, перечисленные в этом элементе, находятся в рабочем каталоге задачи. Существует максимальный размер списка файлов ресурсов. При превышении максимального размера запрос завершится ошибкой, а код ошибки ответа — RequestEntityTooLarge. В этом случае необходимо уменьшить размер коллекции ResourceFiles. Это можно сделать с помощью .zip файлов, пакетов приложений или контейнеров Docker.
userIdentity	UserIdentity	Удостоверение пользователя, под которым выполняется задача подготовки задания. Если этот параметр опущен, задача выполняется от имени пользователя без прав администратора, уникального для задачи на вычислительных узлах Windows, или от имени пользователя, не являющегося административным, уникальным для пула на вычислительных узлах Linux.
waitForSuccess	boolean	Должна ли пакетная служба ожидать успешного завершения задачи подготовки задания перед планированием других задач задания на вычислительном узле. Задача подготовки задания успешно завершена, если она завершается с кодом выхода 0. Если значение true и задача подготовки задания на узле завершается сбоем, пакетная служба повторяет задачу подготовки задания до максимального количества повторных попыток (как указано в элементе constraints). Если задача по-прежнему не была успешно завершена после всех повторных попыток, пакетная служба не будет планировать задачи задания на узел. Узел остается активным и может выполнять задачи других заданий. Если значение равно false, пакетная служба не будет ожидать завершения задачи подготовки задания. В этом случае другие задачи задания могут начать выполнение на вычислительном узле во время выполнения задачи подготовки задания. и даже если задача подготовки задания завершается сбоем, новые задачи будут по-прежнему планироваться на вычислительном узле. Значение по умолчанию — true.

JobReleaseTask

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

Имя	Тип	Описание
commandLine	string	Командная строка задачи освобождения задания. Командная строка не выполняется в оболочке и поэтому не может воспользоваться такими функциями оболочки, как расширение переменной среды. Если вы хотите воспользоваться преимуществами таких функций, следует вызвать оболочку в командной строке, например с помощью команды "cmd /c MyCommand" в Windows или "/bin/sh -c MyCommand" в Linux. Если командная строка ссылается на пути к файлам, она должна использовать относительный путь (относительно рабочего каталога задачи) или переменную среды, предоставляемую пакетной службой (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
containerSettings	TaskContainerSettings	Параметры контейнера, в котором выполняется задача освобождения задания. Если этот параметр указан, все каталоги рекурсивно под AZ_BATCH_NODE_ROOT_DIR (корень каталогов пакетная служба Azure на узле) сопоставляются с контейнером, все переменные среды задач сопоставляются с контейнером, а в контейнере выполняется командная строка Task. Файлы, созданные в контейнере за пределами AZ_BATCH_NODE_ROOT_DIR, могут не отражаться на диске узла, а это означает, что API пакетных файлов не смогут получить доступ к этим файлам.
environmentSettings	EnvironmentSetting[]	Список параметров переменных среды для задачи выпуска задания.
id	string	Строка, однозначно идентифицирующая задачу освобождения задания в задании. Идентификатор может содержать любое сочетание буквенно-цифровых символов, включая дефисы и символы подчеркивания, и не может содержать более 64 символов. Если это свойство не указано, пакетная служба назначает значение по умолчанию jobrelease. Никакие другие задачи в задании не могут иметь тот же идентификатор, что и задача освобождения задания. При попытке отправить задачу с тем же идентификатором пакетная служба отклоняет запрос с кодом ошибки TaskIdSameAsJobReleaseTask; Если вы вызываете REST API напрямую, код состояния HTTP — 409 (конфликт).
maxWallClockTime	string	Максимальное затраченное время, затраченное на выполнение задачи выпуска задания на заданном вычислительном узле, измеренное с момента запуска задачи. Если задача не завершается в течение предельного времени, пакетная служба завершает ее. Значение по умолчанию — 15 минут. Вы не можете указать время ожидания, превышающее 15 минут. В этом случае пакетная служба отклоняет его с ошибкой; Если вы вызываете REST API напрямую, код состояния HTTP — 400 (недопустимый запрос).
resourceFiles	ResourceFile[]	Список файлов, которые пакетная служба скачает на вычислительный узел перед запуском командной строки. Существует максимальный размер списка файлов ресурсов. При превышении максимального размера запрос завершится ошибкой и кодом ошибки ответа будет RequestEntityTooLarge. В этом случае размер коллекции ResourceFiles должен быть уменьшен. Это можно сделать с помощью .zip файлов, пакетов приложений или контейнеров Docker. Файлы, перечисленные в этом элементе, находятся в рабочем каталоге задачи.
retentionTime	string	Минимальное время хранения каталога задачи для задачи выпуска задания на вычислительном узле. По истечении этого времени пакетная служба может удалить каталог Задач и все его содержимое. Значение по умолчанию — 7 дней, т. е. каталог задач будет храниться в течение 7 дней, если вычислительный узел не будет удален или задание не будет удалено.
userIdentity	UserIdentity	Удостоверение пользователя, под которым выполняется задача выпуска задания. Если этот параметр опущен, задача выполняется от имени пользователя, не являющегося администратором, уникальным для задачи.

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. UAC включен в пулах Конфигурации Windows VirtualMachine. Если этот параметр используется с удостоверением пользователя с повышенными привилегиями в пуле 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), 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	Дополнительные параметры командной строки для передачи в команду подключения. Это параметры 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	Узлы в пуле будут распределены по разным зонам доступности с максимальной балансировкой усилий.

OnAllTasksComplete

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

Имя	Тип	Описание
noaction	string	Не делать ничего. Задание остается активным, если не будет завершено или отключено другими способами.
terminatejob	string	Завершите задание. Параметр terminateReason задания имеет значение AllTasksComplete.

OnTaskFailure

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

Имя	Тип	Описание
noaction	string	Не делать ничего. Задание остается активным, если не будет завершено или отключено другими способами.
performexitoptionsjobaction	string	Выполните действие, связанное с условием выхода Task, в коллекции Task's exitConditions. (Это может по-прежнему привести к тому, что действия не будут предприниматься, если это указано в задаче.)

OSDisk

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

Имя	Тип	Описание
caching	CachingType	Указывает требования к кэшированию. Возможные значения: None, ReadOnly, ReadWrite. Значения по умолчанию: None для хранилища уровня "Стандартный". 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 на диске.

OutputFile

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

Имя	Тип	Описание
destination	OutputFileDestination	Назначение для выходных файлов.
filePattern	string	Шаблон, указывающий, какие файлы следует отправить. Поддерживаются как относительные, так и абсолютные пути. Относительные пути относятся к рабочему каталогу Задачи. Поддерживаются следующие подстановочные знаки: * соответствует 0 или более символам (например, шаблон abc* соответствует abc или abcdef), ** соответствует любому каталогу, ? соответствует любому одному символу, [abc] соответствует одному символу в квадратных скобках, а [a-c] соответствует одному символу в диапазоне. Квадратные скобки могут содержать отрицание для соответствия любому не указанному символу (например, [!abc] соответствует любому символу, но a, b или c). Если имя файла начинается с ".", оно игнорируется по умолчанию, но может быть сопоставлено явным образом (например ,.gif не будет соответствовать .a.gif, но ..gif будет). Простой пример: ***.txt соответствует любому файлу, который не начинается с . И заканчивается .txt в рабочем каталоге задачи или любом подкаталоге. Если имя файла содержит подстановочный знак, его можно экранировать с помощью квадратных скобок (например, abc[] будет соответствовать файлу с именем abc). Обратите внимание, что и \ и / обрабатываются как разделители каталогов в Windows, но только / — в Linux. Переменные среды (%var% в Windows или $var в Linux) расширяются до применения шаблона.
uploadOptions	OutputFileUploadOptions	Дополнительные параметры для операции отправки, включая условия для выполнения отправки.

OutputFileBlobContainerDestination

Указывает назначение отправки файлов в контейнере хранилища BLOB-объектов Azure.

Имя	Тип	Описание
containerUrl	string	URL-адрес контейнера в Хранилище BLOB-объектов Azure, в который отправляются файлы. Если управляемое удостоверение не используется, URL-адрес должен содержать подписанный URL-адрес (SAS), предоставляющий разрешения на запись в контейнер.
identityReference	ComputeNodeIdentityReference	Ссылка на назначенное пользователем удостоверение, используемое для доступа к Хранилище BLOB-объектов Azure, заданное containerUrl. Удостоверение должно иметь доступ на запись в контейнер Хранилище BLOB-объектов Azure
path	string	Целевой большой двоичный объект или виртуальный каталог в контейнере службы хранилища Azure. Если filePattern ссылается на конкретный файл (т. е. не содержит подстановочных знаков), то путь — это имя большого двоичного объекта, в который нужно отправить этот файл. Если filePattern содержит один или несколько подстановочных знаков (и, следовательно, может соответствовать нескольким файлам), то путь — это имя виртуального каталога BLOB-объекта (который добавляется к имени каждого большого двоичного объекта), в который нужно отправить файлы. Если этот параметр опущен, файлы отправляются в корень контейнера с именем большого двоичного объекта, соответствующим их имени.
uploadHeaders	HttpHeader[]	Список пар "имя-значение" для заголовков, используемых при отправке выходных файлов Эти заголовки будут указаны при отправке файлов в службу хранилища Azure. Официальный документ о разрешенных заголовках при отправке больших двоичных объектов: https://docs.microsoft.com/en-us/rest/api/storageservices/put-blob#request-headers-all-blob-types

OutputFileDestination

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

Имя	Тип	Описание
container	OutputFileBlobContainerDestination	Расположение в хранилище BLOB-объектов Azure, в которое отправляются файлы.

OutputFileUploadCondition

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

Имя	Тип	Описание
taskcompletion	string	Отправьте файлы после завершения процесса задачи, независимо от того, какой код выхода был.
taskfailure	string	Отправляйте файлы только после завершения процесса задачи с ненулевым кодом выхода.
tasksuccess	string	Отправляйте файлы только после завершения процесса задачи с кодом выхода 0.

OutputFileUploadOptions

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

Имя	Тип	Описание
uploadCondition	OutputFileUploadCondition	Условия, при которых должен отправляться выходной файл задачи или набор файлов. Значение по умолчанию — taskcompletion.

PoolEndpointConfiguration

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

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

PoolInformation

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

Имя	Тип	Описание
autoPoolSpecification	AutoPoolSpecification	Характеристики временного "автоматического пула". Пакетная служба создаст этот автоматический пул при отправке задания. Если автоматическое создание пула завершается сбоем, пакетная служба перемещает задание в завершенное состояние, а ошибка создания пула устанавливается в свойстве ошибки планирования задания. Пакетная служба управляет временем существования (как созданием, так и, если не указан параметр keepAlive, удалением) автоматического пула. Любые действия пользователя, влияющие на время существования автоматического пула во время активности задания, приведут к непредвиденному поведению. Необходимо указать идентификатор пула или автоматическую спецификацию пула, но не оба.
poolId	string	Идентификатор существующего пула. Все задачи задания будут выполняться в указанном пуле. Необходимо убедиться, что пул, на который ссылается это свойство, существует. Если пул не существует на момент, когда пакетная служба пытается запланировать задание, задачи для задания не будут выполняться до тех пор, пока вы не создадите пул с этим идентификатором. Обратите внимание, что пакетная служба не отклоняет запрос задания. Он просто не будет выполнять задачи, пока не будет создан пул. Необходимо указать идентификатор пула или автоматическую спецификацию пула, но не оба.

PoolLifetimeOption

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

Имя	Тип	Описание
job	string	Пул существует в течение всего времени существования задания, которому он посвящен. Пакетная служба создает пул при создании задания. Если параметр "задание" применяется к расписанию заданий, пакетная служба создает новый автоматический пул для каждого задания, созданного по расписанию.
jobschedule	string	Пул существует в течение всего времени существования расписания заданий. Пакетная служба создает пул при создании первого задания по расписанию. Этот параметр можно применять только к расписаниям заданий, а не к заданиям.

PoolSpecification

Спецификация для создания нового пула.

Имя	Тип	Описание
applicationLicenses	string[]	Список лицензий приложений, доступных пакетной службе на каждом вычислительном узле в пуле. Список лицензий приложений должен быть подмножеством доступных лицензий на приложения пакетной службы. Если запрашивается лицензия, которая не поддерживается, создание пула завершится ошибкой. Разрешенные лицензии, доступные в пуле: maya, vray, 3dsmax, arnold. За каждую лицензию приложения, добавленную в пул, взимается дополнительная плата.
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. Формула проверяется на допустимость перед созданием пула. Если формула недопустима, пакетная служба отклоняет запрос с подробными сведениями об ошибке.
certificateReferences	CertificateReference[]	Список сертификатов, устанавливаемых на каждом вычислительном узле в пуле. Для узлов Windows пакетная служба устанавливает сертификаты в указанное хранилище сертификатов и расположение. Для вычислительных узлов Linux сертификаты хранятся в каталоге в рабочем каталоге Задачи, а переменная среды AZ_BATCH_CERTIFICATES_DIR предоставляется задаче для запроса этого расположения. Для сертификатов с видимостью remoteUser каталог certs создается в домашнем каталоге пользователя (например, /home/{имя_пользователя}/certs), а сертификаты помещаются в этот каталог. Предупреждение. Это свойство устарело и будет удалено после февраля 2024 г. Вместо этого используйте расширение Azure KeyVault .
cloudServiceConfiguration	CloudServiceConfiguration	Конфигурация облачной службы для пула. Это свойство необходимо указать, если пул необходимо создать с виртуальными машинами Azure PaaS. Это свойство и virtualMachineConfiguration являются взаимоисключающими, и необходимо указать одно из свойств. Если ни указан, то пакетная служба возвращает ошибку; Если вы вызываете REST API напрямую, код состояния HTTP — 400 (недопустимый запрос). Это свойство нельзя указать, если учетная запись пакетной службы была создана со свойством poolAllocationMode, для свойства задано значение UserSubscription.
displayName	string	Отображаемое имя пула. Отображаемое имя не обязательно должно быть уникальным и может содержать любые символы Юникода длиной до 1024.
enableAutoScale	boolean	Указывает, должен ли размер пула автоматически изменяться с течением времени. Если значение равно false, необходимо указать хотя бы один из targetDedicatedNodes и targetLowPriorityNodes. Если значение равно true, требуется элемент autoScaleFormula. Размер пула автоматически изменяется в соответствии с формулой. Значением по умолчанию является false.
enableInterNodeCommunication	boolean	Разрешает ли пул прямой обмен данными между вычислительными узлами. Включение обмена данными между узлами ограничивает максимальный размер пула из-за ограничений развертывания на вычислительных узлах пула. Это может привести к тому, что пул не достигнет нужного размера. Значением по умолчанию является false.
metadata	MetadataItem[]	Список пар "имя-значение", связанных с пулом в качестве метаданных. Пакетная служба не присваивает метаданным никакого значения; он предназначен исключительно для использования пользовательского кода.
mountConfiguration	MountConfiguration[]	Список файловых систем для подключения к каждому узлу в пуле. Поддерживает Файлы Azure, NFS, CIFS/SMB и Blobfuse.
networkConfiguration	NetworkConfiguration	Конфигурация сети для пула. Конфигурация сети для пула.
resizeTimeout	string	Время ожидания для выделения вычислительных узлов в пул. Это время ожидания применяется только к ручному масштабированию; Он не действует, если для параметра enableAutoScale задано значение true. Значение по умолчанию — 15 минут. Минимальное значение — 5 минут. Если указать значение менее 5 минут, пакетная служба отклоняет запрос с ошибкой. Если вы вызываете REST API напрямую, код состояния HTTP — 400 (недопустимый запрос).
resourceTags	object	Пользовательские теги, связанные с пулом. Определяемые пользователем теги, связанные с пулом пакетная служба Azure. Если они указаны, эти теги распространяются на резервные ресурсы Azure, связанные с пулом. Это свойство можно указать, только если учетная запись пакетной службы была создана с свойством poolAllocationMode, для свойства задано значение UserSubscription.
startTask	StartTask	Задача, выполняемая на каждом вычислительном узле при присоединении к пулу. Задача выполняется при добавлении вычислительного узла в пул или при перезапуске вычислительного узла. Пакетная служба будет повторять задачи при активации операции восстановления на узле. Примеры операций восстановления включают (но не ограничиваются) перезагрузкой неработоспособного узла или исчезновения вычислительного узла из-за сбоя узла. Повторные попытки из-за операций восстановления не зависят от maxTaskRetryCount и не учитываются. Даже если maxTaskRetryCount имеет значение 0, может произойти внутренняя повторная попытка из-за операции восстановления. По этой причине все задачи должны быть идемпотентными. Это означает, что задачи должны допускать прерывание и перезапуск без повреждения или дублирования данных. Для длительных задач рекомендуется использовать определенную форму создания контрольных точек. В некоторых случаях StartTask можно повторно запустить, даже если вычислительный узел не был перезагружен. Следует соблюдать особую осторожность, чтобы избежать startTasks, которые создают отколовшийся процесс или установку или запуск служб из рабочего каталога 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	Конфигурация виртуальной машины для пула. Это свойство необходимо указать, если пул необходимо создать с виртуальными машинами Azure IaaS. Это свойство и cloudServiceConfiguration являются взаимоисключающими, и необходимо указать одно из свойств. Если ни указан, то пакетная служба возвращает ошибку; Если вы вызываете REST API напрямую, код состояния HTTP — 400 (недопустимый запрос).
vmSize	string	Размер виртуальных машин в пуле. Все виртуальные машины в пуле имеют одинаковый размер. Сведения о доступных размерах виртуальных машин в пулах см. в статье Выбор размера виртуальной машины для вычислительных узлов в пуле пакетная служба Azure (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

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

TaskConstraints

Ограничения выполнения, применяемые к задаче.

Имя	Тип	Описание
maxTaskRetryCount	integer	Максимальное количество повторных попыток задачи. Пакетная служба повторяет задачу, если ее код выхода не равен нулю. Обратите внимание, что это значение определяет количество повторных попыток для исполняемого файла задачи из-за ненулевого кода выхода. Пакетная служба попытается выполнить задачу один раз, а затем может повторить попытку до этого предела. Например, если максимальное число повторных попыток равно 3, пакетная служба пытается выполнить задачу до 4 раз (одна начальная попытка и 3 повторных попытки). Если максимальное число повторных попыток равно 0, пакетная служба не повторяет задачу после первой попытки. Если максимальное число повторных попыток равно -1, пакетная служба повторяет задачу без ограничений, однако это не рекомендуется для задачи запуска или любой задачи. Значение по умолчанию — 0 (без повторных попыток).
maxWallClockTime	string	Максимальное затраченное время выполнения задачи, измеряемое с момента запуска задачи. Если задача не завершается в течение предельного времени, пакетная служба завершает ее. Если этот параметр не указан, срок выполнения задачи не ограничен.
retentionTime	string	Минимальное время хранения каталога задачи на вычислительном узле, где он запущен, с момента завершения выполнения. По истечении этого времени пакетная служба может удалить каталог Задач и все его содержимое. Значение по умолчанию — 7 дней, т. е. каталог задач будет храниться в течение 7 дней, если вычислительный узел не будет удален или задание не будет удалено.

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.