Job - Add

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

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

Параметры URI

Name In Required Type Description
batchUrl
path True
  • string

Базовый URL-адрес для всех запросов на обслуживание пакетная служба Azure.

api-version
query True
  • string

Версия API клиента.

timeout
query
  • integer
int32

Максимальное время, которое сервер может потратить на обработку запроса в секундах. По умолчанию это 30 секунд.

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

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

Name Required Type Description
client-request-id
  • string
uuid

Удостоверение запроса, созданное вызывающим абонентом, в виде GUID без оформления, например фигурных скобок, например 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-id
  • boolean

Должен ли сервер возвращать идентификатор client-request-id в ответе.

ocp-date
  • string
date-time-rfc1123

Время выдачи запроса. Клиентские библиотеки обычно задают для текущего системного времени часов; Задайте его явным образом, если вы вызываете REST API напрямую.

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

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

Name Required Type Description
id True
  • string

Строка, однозначно идентифицирующая задание в учетной записи.
Идентификатор может содержать любое сочетание буквенно-цифровых символов, включая дефисы и символы подчеркивания, и не может содержать более 64 символов. Идентификатор сохраняет регистр и не учитывает регистр (т. е. в учетной записи не учитывается два идентификатора, которые отличаются только по регистру).

poolInfo True

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

allowTaskPreemption
  • boolean

Можно ли упрещать задачи в этом задании другими заданиями с высоким приоритетом
Если задано значение True, то другие задания с высоким приоритетом, отправленные в систему, будут иметь приоритет и смогут повторно отправить задачи из этого задания. После создания задания с помощью API задания обновления можно обновить allowTaskPreemption.

commonEnvironmentSettings

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

constraints

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

displayName
  • string

Отображаемое имя задания.
Отображаемое имя не должно быть уникальным и может содержать любые символы Юникода до максимальной длины 1024.

jobManagerTask

Сведения о задаче диспетчера заданий, запускаемой при запуске задания.
Если задание не указывает задачу диспетчера заданий, пользователь должен явно добавить задачи в задание. Если задание указывает задачу диспетчера заданий, пакетная служба создает задачу диспетчера заданий при создании задания и попытается запланировать задачу диспетчера заданий перед планированием других задач в задании. Типичным назначением задачи диспетчера заданий является управление выполнением заданий и (или) мониторинг их выполнения, например путем принятия решения о выполнении дополнительных задач, определения завершения работы и т. д. (Однако задача диспетчера заданий не ограничивается этими действиями — это полноценная задача в системе и выполнение любых действий, необходимых для задания.) Например, задача диспетчера заданий может скачать файл, указанный в качестве параметра, проанализировать содержимое этого файла и отправить дополнительные задачи на основе этого содержимого.

jobPreparationTask

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

jobReleaseTask

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

maxParallelTasks
  • integer

Максимальное количество задач, которые могут выполняться параллельно для задания.
Если задано значение maxParallelTasks, должно быть равно -1 или больше 0. Если значение не указано, значение по умолчанию равно -1, то есть количество задач, которые могут выполняться одновременно, не ограничено. Вы можете обновить maxParallelTasks задания после его создания с помощью API задания обновления.

metadata

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

networkConfiguration

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

onAllTasksComplete

Действие пакетной службы должно выполняться, когда все задачи в задании находятся в состоянии завершения.
Обратите внимание, что если задание не содержит задач, все задачи считаются завершенными. Поэтому этот параметр чаще всего используется с задачей диспетчера заданий; Если вы хотите использовать автоматическое завершение задания без диспетчера заданий, сначала необходимо задать для onAllTasksComplete значение noaction и обновить свойства задания, чтобы задать для onAllTasksComplete завершение работы после завершения добавления задач. Значение по умолчанию — noaction.

onTaskFailure

Действие пакетной службы должно выполняться при сбое любой задачи в задании.
Задача считается неудачной, если имеет значение failureInfo. Значение failureInfo задается, если задача завершается с кодом выхода, отличного от нуля, после исчерпания числа повторных попыток или если возникла ошибка при запуске задачи, например из-за ошибки скачивания файла ресурсов. Значение по умолчанию — noaction.

priority
  • integer

Приоритет задания.
Значения приоритета могут указываться в диапазоне от -1000 до 1000, где -1000 является самым низким приоритетом, а 1000 — самым высшим. Значение по умолчанию — 0.

usesTaskDependencies
  • boolean

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

Ответы

Name Type Description
201 Created

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

Headers

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • DataServiceId: string
Other Status Codes

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

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

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

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

Authorization

Type: apiKey
In: header

Примеры

Add a basic job
Add a complex job

Add a basic job

Sample Request

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



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

Sample Response

Add a complex job

Sample Request

POST account.region.batch.azure.com/jobs?api-version=2022-01-01.15.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"
          }
        ]
      }
    }
  },
  "metadata": [
    {
      "name": "myproperty",
      "value": "myvalue"
    }
  ]
}

Sample Response

Определения

ApplicationPackageReference

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

AuthenticationTokenSettings

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

AutoPoolSpecification

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

AutoUserScope

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

AutoUserSpecification

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

AzureBlobFileSystemConfiguration

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

AzureFileShareConfiguration

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

BatchError

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

BatchErrorDetail

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

CachingType

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

CertificateReference

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

CertificateStoreLocation

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

CIFSMountConfiguration

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

CloudServiceConfiguration

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

ComputeNodeFillType

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

ComputeNodeIdentityReference

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

ContainerConfiguration

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

ContainerRegistry

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

ContainerType

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

ContainerWorkingDirectory

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

DataDisk

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

DiffDiskPlacement

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

DiffDiskSettings

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

DiskEncryptionConfiguration

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

DynamicVNetAssignmentScope

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

ElevationLevel

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

EnvironmentSetting

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

ErrorMessage

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

HttpHeader

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

ImageReference

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

InboundEndpointProtocol

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

InboundNATPool

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

IPAddressProvisioningType

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

JobAddParameter

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

JobConstraints

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

JobManagerTask

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

JobNetworkConfiguration

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

JobPreparationTask

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

JobReleaseTask

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

LinuxUserConfiguration

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

LoginMode

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

MetadataItem

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

MountConfiguration

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

NetworkConfiguration

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

NetworkSecurityGroupRule

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

NetworkSecurityGroupRuleAccess

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

NFSMountConfiguration

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

NodePlacementConfiguration

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

NodePlacementPolicyType

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

OnAllTasksComplete

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

OnTaskFailure

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

OSDisk

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

OutputFile

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

OutputFileBlobContainerDestination

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

OutputFileDestination

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

OutputFileUploadCondition

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

OutputFileUploadOptions

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

PoolEndpointConfiguration

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

PoolInformation

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

PoolLifetimeOption

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

PoolSpecification

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

PublicIPAddressConfiguration

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

ResourceFile

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

StartTask

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

StorageAccountType

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

TaskConstraints

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

TaskContainerSettings

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

TaskSchedulingPolicy

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

UserAccount

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

UserIdentity

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

VirtualMachineConfiguration

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

VMExtension

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

WindowsConfiguration

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

WindowsUserConfiguration

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

ApplicationPackageReference

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

Name Type Description
applicationId
  • string

Идентификатор развертываемого приложения.

version
  • string

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

AuthenticationTokenSettings

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

Name Type Description
access
  • string[]

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

AutoPoolSpecification

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

Name Type Description
autoPoolIdPrefix
  • string

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

keepAlive
  • boolean

Указывает, следует ли сохранять автоматический пул в активном режиме после истечения срока его существования.
Если значение равно false, пакетная служба удаляет пул после истечения срока его существования (как определено параметром poolLifetimeOption); то есть после завершения задания или расписания задания. Если значение равно true, пакетная служба не удаляет пул автоматически. Пользователь может удалить автоматические пулы, созданные с помощью этого параметра.

pool

Спецификация пула для автоматического пула.

poolLifetimeOption

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

AutoUserScope

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

Name Type Description
pool
  • string

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

task
  • string

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

AutoUserSpecification

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

Name Type Description
elevationLevel

Уровень высоты автоматического пользователя.
Значение по умолчанию — nonAdmin.

scope

Область для автоматического пользователя
Значение по умолчанию — пул. Если пул выполняется Windows необходимо указать значение задачи, если требуется более строгая изоляция между задачами. Например, если задача изменяет реестр таким образом, что может повлиять на другие задачи или сертификаты были указаны в пуле, который не должен быть доступен обычными задачами, но должен быть доступен startTasks.

AzureBlobFileSystemConfiguration

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

Name Type Description
accountKey
  • string

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

accountName
  • string

Имя учетной записи служба хранилища Azure.

blobfuseOptions
  • string

Дополнительные параметры командной строки для передачи команде подключения.
Это параметры net use в параметрах Windows и mount в Linux.

containerName
  • string

Имя контейнера Хранилище BLOB-объектов Azure.

identityReference

Ссылка на назначенное пользователем удостоверение для доступа к containerName
Это свойство является взаимоисключающим как с accountKey, так и с sasKey; необходимо указать именно один.

relativeMountPath
  • string

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

sasKey
  • string

Маркер SAS служба хранилища Azure.
Это свойство является взаимоисключающим как с accountKey, так и с удостоверением; необходимо указать именно один.

AzureFileShareConfiguration

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

Name Type Description
accountKey
  • string

Ключ учетной записи хранения Azure.

accountName
  • string

Имя учетной записи служба хранилища Azure.

azureFileUrl
  • string

URL-адрес Файлы Azure.
Это форма "https://{account}.file.core.windows.net/".

mountOptions
  • string

Дополнительные параметры командной строки для передачи команде подключения.
Это параметры net use в параметрах Windows и mount в Linux.

relativeMountPath
  • string

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

BatchError

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

Name Type Description
code
  • string

Идентификатор ошибки. Коды инвариантны и предназначены для программного использования.

message

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

values

Коллекция пар "ключ-значение", содержащая дополнительные сведения об ошибке.

BatchErrorDetail

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

Name Type Description
key
  • string

Идентификатор, указывающий значение свойства Value.

value
  • string

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

CachingType

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

Name Type Description
none
  • string

Режим кэширования для диска не включен.

readonly
  • string

Режим кэширования для диска доступен только для чтения.

readwrite
  • string

Режим кэширования для диска считывается и записывается.

CertificateReference

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

Name Type Description
storeLocation

Расположение хранилища сертификатов на вычислительном узле, в которое необходимо установить сертификат.
Значение по умолчанию — currentuser. Это свойство применимо только для пулов, настроенных с Windows вычислительных узлов (т. е. созданных с помощью cloudServiceConfiguration или virtualMachineConfiguration с помощью ссылки на образ Windows). Для вычислительных узлов Linux сертификаты хранятся в каталоге рабочей папки задачи, а переменная среды AZ_BATCH_CERTIFICATES_DIR предоставляется задаче для запроса этого расположения. Для сертификатов с видимостью remoteUser каталог "certs" создается в домашнем каталоге пользователя (например, /home/{user-name}/certs) и сертификаты помещаются в этот каталог.

storeName
  • string

Имя хранилища сертификатов на вычислительном узле, в который необходимо установить сертификат.
Это свойство применимо только для пулов, настроенных с Windows вычислительных узлов (т. е. созданных с помощью cloudServiceConfiguration или virtualMachineConfiguration с помощью ссылки на образ Windows). К общим именам хранилищ относятся: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, но также можно использовать любое имя пользовательского хранилища. Значение по умолчанию - «My».

thumbprint
  • string

Отпечаток сертификата.

thumbprintAlgorithm
  • string

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

visibility
  • string[]

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

CertificateStoreLocation

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

Name Type Description
currentuser
  • string

Сертификаты должны быть установлены в хранилище сертификатов CurrentUser.

localmachine
  • string

Сертификаты должны быть установлены в хранилище сертификатов LocalMachine.

CIFSMountConfiguration

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

Name Type Description
mountOptions
  • string

Дополнительные параметры командной строки для передачи команде подключения.
Это параметры net use в параметрах Windows и mount в Linux.

password
  • string

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

relativeMountPath
  • string

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

source
  • string

Универсальный код ресурса (URI) файловой системы для подключения.

username
  • string

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

CloudServiceConfiguration

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

Name Type Description
osFamily
  • string

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

osVersion
  • string

Версия гостевой ОС Azure, устанавливаемая на виртуальных машинах в пуле.
Значение по умолчанию — *, указывающее последнюю версию операционной системы для указанного семейства ОС.

ComputeNodeFillType

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

Name Type Description
pack
  • string

Максимально возможное количество задач (taskSlotsPerNode) должно быть назначено каждому вычислительному узлу в пуле, прежде чем все задачи будут назначены следующему вычислительному узлу в пуле.

spread
  • string

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

ComputeNodeIdentityReference

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

Name Type Description
resourceId
  • string

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

ContainerConfiguration

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

Name Type Description
containerImageNames
  • string[]

Коллекция имен образов контейнера.
Это полная ссылка на образ, как указано в "docker pull". Образ будет получен из реестра Docker по умолчанию, если образ не будет полностью заполнен альтернативным реестром.

containerRegistries

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

type

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

ContainerRegistry

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

Name Type Description
identityReference

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

password
  • string

Пароль для входа на сервер реестра.

registryServer
  • string

URL-адрес реестра.
Если этот параметр опущен, по умолчанию используется значение "docker.io".

username
  • string

Имя пользователя для входа на сервер реестра.

ContainerType

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

Name Type Description
dockerCompatible
  • string

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

ContainerWorkingDirectory

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

Name Type Description
containerImageDefault
  • string

Используйте рабочий каталог, определенный в образе контейнера. Будьте осторожны, что этот каталог не будет содержать файлы ресурсов, скачанные пакетной службой.

taskWorkingDirectory
  • string

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

DataDisk

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

Name Type Description
caching

Тип кэширования, который необходимо включить для дисков данных.
Значение по умолчанию для кэширования — readwrite. Сведения о параметрах кэширования см. в следующем разделе https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.

diskSizeGB
  • integer

Начальный размер диска в гигабайтах.

lun
  • integer

Номер логического блока.
Луна используется для уникальной идентификации каждого диска данных. При подключении нескольких дисков каждый из них должен иметь отдельную лунку. Значение должно быть от 0 до 63 включительно.

storageAccountType

Тип учетной записи хранения, используемый для диска данных.
Если этот параметр опущен, значение по умолчанию — "standard_lrs".

DiffDiskPlacement

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

Name Type Description
CacheDisk
  • string

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

DiffDiskSettings

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

Name Type Description
placement

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

DiskEncryptionConfiguration

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

Name Type Description
targets
  • string[]

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

DynamicVNetAssignmentScope

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

Name Type Description
job
  • string

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

none
  • string

Динамическое назначение виртуальной сети не включено.

ElevationLevel

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

Name Type Description
admin
  • string

Пользователь является пользователем с повышенными правами доступа и работает с полными разрешениями администратора.

nonadmin
  • string

Пользователь является стандартным пользователем без повышенного доступа.

EnvironmentSetting

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

Name Type Description
name
  • string

Имя переменной среды.

value
  • string

Значение переменной среды.

ErrorMessage

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

Name Type Description
lang
  • string

Код языка сообщения об ошибке

value
  • string

Текст сообщения.

HttpHeader

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

Name Type Description
name
  • string

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

value
  • string

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

ImageReference

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

Name Type Description
exactVersion
  • string

Конкретная версия образа платформы или образа Marketplace, используемого для создания узла. Это поле только для чтения отличается от "версия", только если значение, указанное для "version", когда пул был создан", был "последним".

offer
  • string

Тип предложения образа azure Виртуальные машины Marketplace.
Например, UbuntuServer или WindowsServer.

publisher
  • string

Издатель образа Виртуальные машины Marketplace Azure.
Например, Canonical или MicrosoftWindowsServer.

sku
  • string

Номер SKU образа Azure Виртуальные машины Marketplace.
Например, 18.04-LTS или 2019-Datacenter.

version
  • string

Версия образа Виртуальные машины Marketplace Azure.
Можно указать значение latest, чтобы выбрать последнюю версию образа. Если этот параметр опущен, значение по умолчанию — latest.

virtualMachineImageId
  • string

Идентификатор ресурса ARM образа Общая коллекция образов. Вычислительные узлы в пуле будут созданы с помощью этого идентификатора образа. Это форма /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} или /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName} для постоянного использования последней версии образа.
Это свойство является взаимоисключающим с другими свойствами ImageReference. Образ Общая коллекция образов должен иметь реплики в том же регионе и должен находиться в той же подписке, что и учетная запись пакетная служба Azure. Если версия образа не указана в imageId, будет использоваться последняя версия. Сведения о параметрах брандмауэра для агента пакетного вычислительного узла для взаимодействия с пакетной службой см. в разделе https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

InboundEndpointProtocol

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

Name Type Description
tcp
  • string

Используйте TCP для конечной точки.

udp
  • string

Используйте UDP для конечной точки.

InboundNATPool

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

Name Type Description
backendPort
  • integer

Номер порта на вычислительном узле.
Он должен быть уникальным в пакетном пуле. Допустимые значения : от 1 до 65535, за исключением 22, 3389, 29876 и 29877, так как они зарезервированы. Если какие-либо зарезервированные значения предоставляются, запрос завершается ошибкой с кодом состояния HTTP 400.

frontendPortRangeEnd
  • integer

Последний номер порта в диапазоне внешних портов, которые будут использоваться для предоставления входящего доступа к внутреннему порту на отдельных вычислительных узлах.
Допустимые значения варьируются от 1 до 65534, за исключением портов от 50000 до 55000, зарезервированных пакетной службой. Все диапазоны в пуле должны быть уникальными и не могут перекрываться. Каждый диапазон должен содержать не менее 40 портов. Если какие-либо зарезервированные или перекрывающиеся значения предоставляются, запрос завершается ошибкой с кодом состояния HTTP 400.

frontendPortRangeStart
  • integer

Первый номер порта в диапазоне внешних портов, которые будут использоваться для предоставления входящего доступа к внутреннему порту на отдельных вычислительных узлах.
Допустимые значения варьируются от 1 до 65534, за исключением портов от 50000 до 55000, зарезервированных. Все диапазоны в пуле должны быть уникальными и не могут перекрываться. Каждый диапазон должен содержать не менее 40 портов. Если какие-либо зарезервированные или перекрывающиеся значения предоставляются, запрос завершается ошибкой с кодом состояния HTTP 400.

name
  • string

Имя конечной точки.
Имя должно быть уникальным в пуле пакетной службы, может содержать буквы, цифры, символы подчеркивания, точки и дефисы. Имена должны начинаться с буквы или цифры, заканчиваться буквой, цифрой или символом подчеркивания и не могут превышать 77 символов. Если какие-либо недопустимые значения предоставляются, запрос завершается ошибкой с кодом состояния HTTP 400.

networkSecurityGroupRules

Список правил группы безопасности сети, которые будут применяться к конечной точке.
Максимальное число правил, которые можно указать во всех конечных точках в пуле пакетной службы, равно 25. Если правила группы безопасности сети не указаны, будет создано правило по умолчанию, разрешающее входящий доступ к указанному внутреннему порту. Если максимальное число правил группы безопасности сети превышается, запрос завершается ошибкой с кодом состояния HTTP 400.

protocol

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

IPAddressProvisioningType

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

Name Type Description
batchmanaged
  • string

Общедоступный IP-адрес будет создан и управляется пакетной службой. В зависимости от размера пула может быть несколько общедоступных IP-адресов.

nopublicipaddresses
  • string

Общедоступный IP-адрес не будет создан.

usermanaged
  • string

Общедоступные IP-адреса предоставляются пользователем и будут использоваться для подготовки вычислительных узлов.

JobAddParameter

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

Name Type Default Value Description
allowTaskPreemption
  • boolean

Могут ли задачи в этом задании быть упрежены другими высокоприоритетными заданиями
Если задано значение True, другие задания с высоким приоритетом, отправленные в систему, будут иметь приоритет и смогут перезапускать задачи из этого задания. После создания задания с помощью API задания обновления можно обновить allowTaskPreemption.

commonEnvironmentSettings

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

constraints

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

displayName
  • string

Отображаемое имя задания.
Отображаемое имя не должно быть уникальным и может содержать любые символы Юникода до максимальной длины 1024.

id
  • string

Строка, однозначно идентифицирующая задание в учетной записи.
Идентификатор может содержать любое сочетание буквенно-цифровых символов, включая дефисы и символы подчеркивания, и не может содержать более 64 символов. Идентификатор сохраняет регистр и не учитывает регистр (т. е. у вас нет двух идентификаторов в учетной записи, которые отличаются только по регистру).

jobManagerTask

Сведения о задаче диспетчера заданий, запускаемой при запуске задания.
Если задание не указывает задачу диспетчера заданий, пользователь должен явно добавить задачи в задание. Если задание указывает задачу диспетчера заданий, пакетная служба создает задачу диспетчера заданий при создании задания и попытается запланировать задачу диспетчера заданий перед планированием других задач в задании. Типичным назначением задачи диспетчера заданий является управление выполнением заданий или их мониторинг, например путем принятия решения о выполнении дополнительных задач, определения завершения работы и т. д. (Однако задача диспетчера заданий не ограничена этими действиями — это полностью целая задача в системе и выполнение любых действий, необходимых для задания.) Например, задача диспетчера заданий может скачать файл, указанный в качестве параметра, проанализировать содержимое этого файла и отправить дополнительные задачи на основе этого содержимого.

jobPreparationTask

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

jobReleaseTask

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

maxParallelTasks
  • integer
-1

Максимальное количество задач, которые могут выполняться параллельно для задания.
Значение maxParallelTasks должно быть равно -1 или больше 0, если указано. Если значение не указано, значение по умолчанию равно -1. Это означает, что количество задач, которые могут выполняться одновременно, не ограничено. После создания задания с помощью API задания обновления можно обновить maxParallelTasks.

metadata

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

networkConfiguration

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

onAllTasksComplete

Действие пакетной службы должно выполняться, когда все задачи в задании находятся в состоянии завершения.
Обратите внимание, что если задание не содержит задач, все задачи считаются завершенными. Поэтому этот параметр чаще всего используется с задачей диспетчера заданий; Если вы хотите использовать автоматическое завершение задания без диспетчера заданий, сначала необходимо задать для onAllTasksComplete значение noaction и обновить свойства задания, чтобы задать для onAllTasksComplete завершение работы после завершения добавления задач. Значение по умолчанию — noaction.

onTaskFailure

Действие пакетной службы должно выполняться при сбое любой задачи в задании.
Задача считается неудачной, если имеет значение failureInfo. Значение failureInfo задается, если задача завершается с кодом выхода, отличного от нуля, после исчерпания числа повторных попыток или если возникла ошибка при запуске задачи, например из-за ошибки скачивания файла ресурсов. Значение по умолчанию — noaction.

poolInfo

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

priority
  • integer

Приоритет задания.
Значения приоритета могут указываться в диапазоне от -1000 до 1000, где -1000 является самым низким приоритетом, а 1000 — самым высшим. Значение по умолчанию — 0.

usesTaskDependencies
  • boolean

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

JobConstraints

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

Name Type Description
maxTaskRetryCount
  • integer

Максимальное число повторных попыток каждой задачи. Пакетная служба повторяет задачу, если ее код выхода не является нулевым.
Обратите внимание, что это значение определяет количество повторных попыток. Пакетная служба будет пытаться выполнить каждую задачу один раз, а затем может повторить до этого ограничения. Например, если максимальное число повторных попыток равно 3, пакетная служба пытается выполнить задачу до 4 раз (одна начальная попытка и 3 повторных попытки). Если максимальное число повторных попыток равно 0, пакетная служба не выполняет повторные задачи. Если максимальное число повторных попыток равно –1, пакетная служба повторяет задачу без ограничения, однако это не рекомендуется для задачи запуска или любой задачи. Значение по умолчанию — 0 (без повторных попыток)

maxWallClockTime
  • string

Максимальное затраченное время выполнения задания, измеряемое с момента создания задания.
Если задание не завершается в течение срока, пакетная служба завершает ее и все задачи, которые по-прежнему выполняются. В этом случае причиной завершения будет MaxWallClockTimeExpiry. Если это свойство не указано, ограничение времени на продолжительность выполнения задания отсутствует.

JobManagerTask

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

Name Type Description
allowLowPriorityNode
  • boolean

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

applicationPackageReferences

Список пакетов приложений, которые пакетная служба будет развертывать на вычислительном узле перед запуском командной строки.
Пакеты приложений загружаются и развертываются в общем каталоге, а не в рабочем каталоге задач. Поэтому, если указанный пакет приложения уже находится на вычислительном узле и обновлен, он не скачан повторно; Используется существующая копия на вычислительном узле. Если не удается установить указанный пакет приложения, например из-за удаления пакета или из-за сбоя скачивания, задача завершается ошибкой.

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

Ограничения, применяемые к задаче диспетчера заданий.

containerSettings

Параметры контейнера, в котором выполняется задача диспетчера заданий.
Если пул, который будет выполнять эту задачу, имеет набор containerConfiguration, его также необходимо задать. Если пул, который будет выполнять эту задачу, не имеет набора containerConfiguration, это не должно быть задано. Если это указано, все каталоги рекурсивно под AZ_BATCH_NODE_ROOT_DIR (корень каталогов пакетная служба Azure на узле) сопоставляются с контейнером, все переменные среды задач сопоставляются с контейнером, а командная строка задачи выполняется в контейнере. Файлы, созданные в контейнере за пределами AZ_BATCH_NODE_ROOT_DIR, могут не отражаться на диске узла, что означает, что API пакетного файла не смогут получить доступ к этим файлам.

displayName
  • string

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

environmentSettings

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

id
  • string

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

killJobOnCompletion
  • boolean

Указывает, означает ли завершение задачи диспетчера заданий, что означает завершение всего задания.
Если значение равно true, по завершении задачи диспетчера заданий пакетная служба помечает задание как завершенное. Если в настоящее время все еще выполняются какие-либо задачи (кроме выпуска задания), эти задачи завершаются. Если значение равно false, завершение задачи диспетчера заданий не влияет на состояние задания. В этом случае следует использовать атрибут onAllTasksComplete для завершения задания или явного завершения задания или клиента или пользователя. Например, если диспетчер заданий создает набор задач, но затем не принимает никакой дополнительной роли в их выполнении. Значение по умолчанию — true. Если вы используете атрибуты onAllTasksComplete и onTaskFailure для управления временем существования задания и используете задачу диспетчера заданий только для создания задач для задания (не для отслеживания хода выполнения), важно установить для killJobOnCompletion значение false.

outputFiles

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

requiredSlots
  • integer

Количество слотов планирования, необходимых задаче для выполнения.
Значение по умолчанию — 1. Задача может выполняться только на вычислительном узле, если на узле достаточно свободных слотов планирования. Для задач с несколькими экземплярами это свойство не поддерживается и не должно быть указано.

resourceFiles

Список файлов, скачиваемых пакетной службой на вычислительный узел перед запуском командной строки.
Файлы, перечисленные в этом элементе, находятся в рабочем каталоге task. Максимальный размер списка файлов ресурсов. При превышении максимального размера запрос завершится ошибкой, и код ошибки ответа будет RequestEntityTooLarge. В этом случае необходимо уменьшить размер коллекции ResourceFiles. Это можно сделать с помощью .zip файлов, пакетов приложений или контейнеров Docker.

runExclusive
  • boolean

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

userIdentity

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

JobNetworkConfiguration

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

Name Type Description
subnetId
  • string

Идентификатор ресурса ARM подсети виртуальной сети, в которой вычислительные узлы, на которых выполняются задачи из задания, будут присоединяться в течение длительности задачи. Это будет работать только с пулом VirtualMachineConfiguration.
Виртуальная сеть должна находиться в том же регионе и подписке, что и учетная запись пакетная служба Azure. Указанная подсеть должна иметь достаточно свободных IP-адресов для размещения количества вычислительных узлов, которые будут выполнять задачи из задания. Это может быть до количества вычислительных узлов в пуле. Субъект-служба MicrosoftAzureBatch должна иметь роль "Участник классической виртуальной машины" Role-Based контроль доступа (RBAC) для указанной виртуальной сети, чтобы служба пакетная служба Azure может планировать задачи на узлах. Это можно проверить, проверив, есть ли в указанной виртуальной сети какие-либо связанные группы безопасности сети (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

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

Name Type Description
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

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

containerSettings

Параметры контейнера, в котором выполняется задача подготовки заданий.
Если это указано, все каталоги рекурсивно под AZ_BATCH_NODE_ROOT_DIR (корень каталогов пакетная служба Azure на узле) сопоставляются с контейнером, все переменные среды задач сопоставляются с контейнером, а командная строка задачи выполняется в контейнере. Файлы, созданные в контейнере за пределами AZ_BATCH_NODE_ROOT_DIR, могут не отражаться на диске узла, что означает, что API пакетного файла не смогут получить доступ к этим файлам.

environmentSettings

Список параметров переменной среды для задачи подготовки заданий.

id
  • string

Строка, однозначно идентифицирующая задачу подготовки задания в задании.
Идентификатор может содержать любое сочетание буквенно-цифровых символов, включая дефисы и символы подчеркивания, и не может содержать более 64 символов. Если это свойство не указано, пакетная служба назначает значение по умолчанию jobpreparation. Ни одна другая задача в задании не может иметь тот же идентификатор, что и задача подготовки задания. При попытке отправить задачу с таким же идентификатором пакетная служба отклоняет запрос с кодом ошибки TaskIdSameAsJobPreparationTask; Если вы вызываете REST API напрямую, код состояния HTTP — 409 (конфликт).

rerunOnNodeRebootAfterSuccess
  • boolean

Следует ли пакетной службе повторно запускать задачу подготовки заданий после перезагрузки вычислительного узла.
Задача подготовки заданий всегда выполняется повторно, если вычислительный узел переосмыслен или если задача подготовки задания не завершена (например, из-за перезагрузки во время выполнения задачи). Поэтому всегда следует писать задачу подготовки заданий, чтобы быть идемпотентной и вести себя правильно при многократном выполнении. Значение по умолчанию — true.

resourceFiles

Список файлов, скачиваемых пакетной службой на вычислительный узел перед запуском командной строки.
Файлы, перечисленные в этом элементе, находятся в рабочем каталоге task. Максимальный размер списка файлов ресурсов. При превышении максимального размера запрос завершится ошибкой, и код ошибки ответа будет RequestEntityTooLarge. В этом случае необходимо уменьшить размер коллекции ResourceFiles. Это можно сделать с помощью .zip файлов, пакетов приложений или контейнеров Docker.

userIdentity

Удостоверение пользователя, под которым выполняется задача подготовки заданий.
Если этот параметр не указан, задача выполняется как пользователь без прав администратора, уникальный для задачи на Windows вычислительных узлах, или пользователь, не являющийся административным, уникальным для пула на вычислительных узлах Linux.

waitForSuccess
  • boolean

Следует ли пакетной службе ждать успешного завершения задачи подготовки заданий перед планированием других задач задания на вычислительном узле. Задача подготовки заданий успешно завершена, если она завершается с кодом выхода 0.
Если значение true и задача подготовки заданий завершается сбоем на узле, пакетная служба повторяет задачу подготовки заданий до максимального числа повторных попыток (как указано в элементе ограничений). Если задача по-прежнему не завершена после всех повторных попыток, пакетная служба не будет планировать задачи задания на узел. Узел остается активным и может выполнять задачи других заданий. Если значение равно false, пакетная служба не будет ожидать завершения задачи подготовки заданий. В этом случае другие задачи задания могут запускаться на вычислительном узле во время выполнения задачи подготовки задания; и даже если задача подготовки заданий завершается сбоем, новые задачи будут по-прежнему планироваться на вычислительном узле. Значение по умолчанию — true.

JobReleaseTask

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

Name Type Description
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

Параметры контейнера, в котором выполняется задача выпуска задания.
Если этот параметр указан, все каталоги рекурсивно под AZ_BATCH_NODE_ROOT_DIR (корень каталогов пакетная служба Azure на узле) сопоставляются с контейнером, все переменные среды задач сопоставляются с контейнером, а командная строка задачи выполняется в контейнере. Файлы, созданные в контейнере за пределами AZ_BATCH_NODE_ROOT_DIR, могут не отражаться на диске узла, то есть API пакетной службы не смогут получить доступ к этим файлам.

environmentSettings

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

id
  • string

Строка, однозначно идентифицирующая задачу выпуска задания в задании.
Идентификатор может содержать любое сочетание буквенно-цифровых символов, включая дефисы и символы подчеркивания, и не может содержать более 64 символов. Если это свойство не указано, пакетная служба назначает значение по умолчанию jobrelease. Другая задача в задании не может иметь тот же идентификатор, что и задача выпуска задания. При попытке отправить задачу с таким же идентификатором пакетная служба отклоняет запрос с кодом ошибки TaskIdSameAsJobReleaseTask; Если вы вызываете REST API напрямую, код состояния HTTP — 409 (конфликт).

maxWallClockTime
  • string

Максимальное затраченное время, затраченное на выполнение задачи выпуска задания на заданном вычислительном узле, измеряемое с момента запуска задачи. Если задача не завершается в течение периода времени, пакетная служба завершает ее. Значение по умолчанию — 15 минут. Вы не можете указать время ожидания дольше 15 минут. В этом случае пакетная служба отклоняет ее с ошибкой; Если вы вызываете REST API напрямую, код состояния HTTP — 400 (недопустимый запрос).

resourceFiles

Список файлов, скачиваемых пакетной службой на вычислительный узел перед выполнением командной строки. Максимальный размер списка файлов ресурсов. При превышении максимального размера запрос завершится ошибкой, и код ошибки ответа будет RequestEntityTooLarge. В этом случае необходимо уменьшить размер коллекции ResourceFiles. Это можно сделать с помощью .zip файлов, пакетов приложений или контейнеров Docker.
Файлы, перечисленные в этом элементе, находятся в рабочем каталоге task.

retentionTime
  • string

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

userIdentity

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

LinuxUserConfiguration

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

Name Type Description
gid
  • integer

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

sshPrivateKey
  • string

Закрытый ключ SSH для учетной записи пользователя.
Закрытый ключ не должен быть защищен паролем. Закрытый ключ используется для автоматической настройки проверки подлинности на основе асимметричного ключа для SSH между вычислительными узлами в пуле Linux, если свойство enableInterNodeCommunication пула имеет значение true (оно игнорируется, если enableInterNodeCommunication имеет значение false). Для этого поместите пару ключей в каталог SSH пользователя. Если этот параметр не указан, SSH без пароля не настраивается между вычислительными узлами (не выполняется изменение каталога SSH пользователя).

uid
  • integer

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

LoginMode

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

Name Type Description
batch
  • string

Режим входа LOGON32_LOGON_BATCH Win32. Для длительных параллельных процессов рекомендуется использовать режим входа пакетной службы.

interactive
  • string

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

MetadataItem

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

Name Type Description
name
  • string

Имя элемента метаданных.

value
  • string

Значение элемента метаданных.

MountConfiguration

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

Name Type Description
azureBlobFileSystemConfiguration

Контейнер служба хранилища Azure для подключения с помощью FUSE BLOB-объектов на каждом узле.
Это свойство является взаимоисключающим со всеми остальными свойствами.

azureFileShareConfiguration

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

cifsMountConfiguration

Файловая система CIFS/SMB для подключения на каждом узле.
Это свойство является взаимоисключающим со всеми остальными свойствами.

nfsMountConfiguration

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

NetworkConfiguration

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

Name Type Description
dynamicVNetAssignmentScope

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

endpointConfiguration

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

publicIPAddressConfiguration

Конфигурация общедоступного IPAddress для вычислительных узлов в пуле пакетной службы.
Свойство конфигурации общедоступного IP-адреса поддерживается только в пулах со свойством virtualMachineConfiguration.

subnetId
  • string

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

NetworkSecurityGroupRule

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

Name Type Description
access

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

priority
  • integer

Приоритет для этого правила.
Приоритеты в пуле должны быть уникальными и оцениваться в порядке приоритета. Чем меньше число, тем выше приоритет. Например, правила можно указать с номерами порядка 150, 250 и 350. Правило с порядком 150 имеет приоритет над правилом с порядком 250. Допустимые приоритеты — от 150 до 4096. Если какие-либо зарезервированные или повторяющиеся значения предоставляются, запрос завершается ошибкой с кодом состояния HTTP 400.

sourceAddressPrefix
  • string

Префикс исходного адреса или тег, соответствующий правилу.
Допустимые значения: один IP-адрес (т. е. 10.10.10.10), IP-подсеть (т. е. 192.168.1.0/24), тег по умолчанию или * (для всех адресов). Если какие-либо другие значения предоставляются, запрос завершается ошибкой с кодом состояния HTTP 400.

sourcePortRanges
  • string[]

Диапазоны исходных портов, которые должны совпадать с правилом.
Допустимые значения: '' (для всех портов 0 – 65535), определенный порт (т. е. 22) или диапазон портов (т. е. 100–200). Порты должны находиться в диапазоне от 0 до 65535. Каждая запись в этой коллекции не должна перекрывать другую запись (диапазон или отдельный порт). Если какие-либо другие значения предоставляются, запрос завершается ошибкой с кодом состояния HTTP 400. Значение по умолчанию — ''.

NetworkSecurityGroupRuleAccess

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

Name Type Description
allow
  • string

Разрешить доступ.

deny
  • string

Запретить доступ.

NFSMountConfiguration

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

Name Type Description
mountOptions
  • string

Дополнительные параметры командной строки для передачи команде подключения.
Это параметры net use в параметрах Windows и mount в Linux.

relativeMountPath
  • string

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

source
  • string

Универсальный код ресурса (URI) файловой системы для подключения.

NodePlacementConfiguration

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

Name Type Description
policy

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

NodePlacementPolicyType

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

Name Type Description
regional
  • string

Все узлы в пуле будут выделены в одном регионе.

zonal
  • string

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

OnAllTasksComplete

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

Name Type Description
noaction
  • string

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

terminatejob
  • string

Завершение задания. Для задания terminateReason задано значение AllTasksComplete.

OnTaskFailure

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

Name Type Description
noaction
  • string

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

performexitoptionsjobaction
  • string

Выполните действие, связанное с условием выхода задачи в коллекции exitConditions задачи. (Это может по-прежнему привести к отсутствии действий, если это то, что указывает задача.)

OSDisk

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

Name Type Description
ephemeralOSDiskSettings

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

OutputFile

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

Name Type Description
destination

Назначение для выходных файлов.

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

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

OutputFileBlobContainerDestination

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

Name Type Description
containerUrl
  • string

URL-адрес контейнера в Хранилище BLOB-объектов Azure, в который нужно отправить файлы.
Если не используется управляемое удостоверение, URL-адрес должен содержать подписанный URL-адрес (SAS), предоставляющий разрешения на запись для контейнера.

identityReference

Ссылка на назначенное пользователем удостоверение, используемое для доступа к Хранилище BLOB-объектов Azure, заданному containerUrl
Удостоверение должно иметь доступ на запись в контейнер Хранилище BLOB-объектов Azure

path
  • string

Целевой большой двоичный объект или виртуальный каталог в контейнере служба хранилища Azure.
Если filePattern ссылается на определенный файл (т. е. не содержит подстановочных знаков), путь — это имя большого двоичного объекта, в который нужно отправить этот файл. Если filePattern содержит один или несколько подстановочных знаков (и, следовательно, может совпадать с несколькими файлами), путь — это имя виртуального каталога большого двоичного объекта (который добавляется к каждому имени большого двоичного объекта), в который нужно передать файлы. Если этот параметр опущен, файлы отправляются в корень контейнера с именем большого двоичного объекта, соответствующим их имени файла.

uploadHeaders

Список пар "имя-значение" для заголовков, используемых при отправке выходных файлов
Эти заголовки будут указаны при отправке файлов в служба хранилища Azure. Дополнительные сведения см. в разделе "Заголовки запросов " (все типы BLOB-объектов)".

OutputFileDestination

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

Name Type Description
container

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

OutputFileUploadCondition

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

Name Type Description
taskcompletion
  • string

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

taskfailure
  • string

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

tasksuccess
  • string

Отправьте файлы только после завершения процесса задачи с кодом выхода 0.

OutputFileUploadOptions

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

Name Type Description
uploadCondition

Условия отправки выходного файла задачи или набора файлов.
Значение по умолчанию — taskcompletion.

PoolEndpointConfiguration

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

Name Type Description
inboundNATPools

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

PoolInformation

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

Name Type Description
autoPoolSpecification

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

poolId
  • string

Идентификатор существующего пула. Все задачи задания будут выполняться в указанном пуле.
Необходимо убедиться, что пул, на который ссылается это свойство. Если пул не существует в то время, когда пакетная служба пытается запланировать задание, никакие задачи для задания не будут выполняться, пока не создадите пул с этим идентификатором. Обратите внимание, что пакетная служба не отклоняет запрос задания; он просто не будет выполнять задачи до тех пор, пока пул не существует. Необходимо указать идентификатор пула или спецификацию автоматического пула, но не оба.

PoolLifetimeOption

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

Name Type Description
job
  • string

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

jobschedule
  • string

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

PoolSpecification

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

Name Type Description
applicationLicenses
  • string[]

Список лицензий приложений пакетной службы будет доступен на каждом вычислительном узле в пуле.
Список лицензий приложений должен быть подмножеством доступных лицензий приложений пакетной службы. Если запрашивается лицензия, которая не поддерживается, создание пула завершится ошибкой. Разрешенные лицензии, доступные в пуле: maya, vray, 3dsmax, arnold. Дополнительная плата взимается за каждую лицензию приложения, добавленную в пул.

applicationPackageReferences

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

autoScaleEvaluationInterval
  • string

Интервал времени для автоматической настройки размера пула в соответствии с формулой автомасштабирования.
Значение по умолчанию — 15 минут. Минимальное и максимальное значение : 5 минут и 168 часов соответственно. Если указать значение менее 5 минут или больше 168 часов, пакетная служба отклоняет запрос с ошибкой недопустимого значения свойства; Если вы вызываете REST API напрямую, код состояния HTTP — 400 (недопустимый запрос).

autoScaleFormula
  • string

Формула для требуемого количества вычислительных узлов в пуле.
Это свойство не должно быть указано, если параметр enableAutoScale имеет значение false. Это необходимо, если для параметра enableAutoScale задано значение true. Формула проверяется на допустимость до создания пула. Если формула недопустима, пакетная служба отклоняет запрос с подробными сведениями об ошибке.

certificateReferences

Список сертификатов, устанавливаемых на каждом вычислительном узле в пуле.
Для Windows узлов пакетная служба устанавливает сертификаты в указанное хранилище сертификатов и расположение. Для вычислительных узлов Linux сертификаты хранятся в каталоге рабочей папки задачи, а переменная среды AZ_BATCH_CERTIFICATES_DIR предоставляется задаче для запроса этого расположения. Для сертификатов с видимостью remoteUser каталог certs создается в домашнем каталоге пользователя (например, /home/{user-name}/certs) и сертификаты помещаются в этот каталог.

cloudServiceConfiguration

Конфигурация облачной службы для пула.
Это свойство необходимо указать, если пул необходимо создать с виртуальными машинами Azure PaaS. Это свойство и virtualMachineConfiguration являются взаимоисключающими, и необходимо указать одно из свойств. Если ни указано, пакетная служба возвращает ошибку; Если вы вызываете REST API напрямую, код состояния HTTP — 400 (недопустимый запрос). Это свойство не может быть указано, если учетная запись пакетной службы была создана со свойством poolAllocationMode с значением UserSubscription.

displayName
  • string

Отображаемое имя пула.
Отображаемое имя не должно быть уникальным и может содержать любые символы Юникода до максимальной длины 1024.

enableAutoScale
  • boolean

Следует ли автоматически настраивать размер пула с течением времени.
Если значение равно false, необходимо указать по крайней мере один из целевых объектовNodes и targetLowPriorityNodes. Если значение равно true, требуется элемент autoScaleFormula. Размер пула автоматически изменяется в соответствии с формулой. Значением по умолчанию является false.

enableInterNodeCommunication
  • boolean

Разрешает ли пул прямую связь между вычислительными узлами.
Включение обмена данными между узлами ограничивает максимальный размер пула из-за ограничений развертывания на вычислительных узлах пула. Это может привести к тому, что пул не достигнет требуемого размера. Значением по умолчанию является false.

metadata

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

mountConfiguration

Список файловых систем для подключения на каждом узле в пуле.
Это поддерживает Файлы Azure, NFS, CIFS/SMB и Blobfuse.

networkConfiguration

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

resizeTimeout
  • string

Время ожидания для выделения вычислительных узлов в пул.
Это время ожидания применяется только к ручному масштабированию; Он не действует, если для параметра enableAutoScale задано значение true. Значение по умолчанию — 15 минут. Минимальное значение — 5 минут. Если указать значение менее 5 минут, пакетная служба отклоняет запрос с ошибкой; Если вы вызываете REST API напрямую, код состояния HTTP — 400 (недопустимый запрос).

startTask

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

targetDedicatedNodes
  • integer

Требуемое количество выделенных вычислительных узлов в пуле.
Это свойство не должно быть указано, если параметр enableAutoScale имеет значение true. Если параметр enableAutoScale имеет значение false, необходимо задать либо targetDedicatedNodes, targetLowPriorityNodes, либо оба параметра.

targetLowPriorityNodes
  • integer

Требуемое количество точечных или низкоприоритетных вычислительных узлов в пуле.
Это свойство не должно быть указано, если параметр enableAutoScale имеет значение true. Если параметр enableAutoScale имеет значение false, необходимо задать либо targetDedicatedNodes, targetLowPriorityNodes, либо оба параметра.

taskSchedulingPolicy

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

taskSlotsPerNode
  • integer

Количество слотов задач, которые могут использоваться для выполнения параллельных задач на одном вычислительном узле в пуле.
Значение по умолчанию — 1. Максимальное значение меньше 4 раза больше числа ядер vmSize пула или 256.

userAccounts

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

virtualMachineConfiguration

Конфигурация виртуальной машины для пула.
Это свойство необходимо указать, если пул необходимо создать с виртуальными машинами Azure IaaS. Это свойство и cloudServiceConfiguration являются взаимоисключающими, и необходимо указать одно из свойств. Если ни указано, пакетная служба возвращает ошибку; Если вы вызываете REST API напрямую, код состояния HTTP — 400 (недопустимый запрос).

vmSize
  • string

Размер виртуальных машин в пуле. Все виртуальные машины в пуле имеют одинаковый размер.
Сведения о доступных размерах виртуальных машин в пулах см. в разделе "Выбор размера виртуальной машины для вычислительных узлов" в пуле пакетная служба Azure (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

PublicIPAddressConfiguration

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

Name Type Description
ipAddressIds
  • string[]

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

provision

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

ResourceFile

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

Name Type Description
autoStorageContainerName
  • string

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

blobPrefix
  • string

Префикс большого двоичного объекта, используемый при скачивании больших двоичных объектов из контейнера служба хранилища Azure. Будут загружены только большие двоичные объекты, имена которых начинаются с указанного префикса.
Свойство допустимо только при использовании autoStorageContainerName или storageContainerUrl. Этот префикс может быть частичным именем файла или подкаталогом. Если префикс не указан, скачиваются все файлы в контейнере.

fileMode
  • string

Атрибут режима разрешений файла в восьмеричном формате.
Это свойство применяется только к файлам, скачиваемых на вычислительные узлы Linux. Он будет игнорироваться, если он указан для resourceFile, который будет скачан на вычислительный узел Windows. Если это свойство не указано для вычислительного узла Linux, к файлу применяется значение по умолчанию 0770.

filePath
  • string

Расположение на вычислительном узле, на который нужно скачать файлы, относительно рабочего каталога задачи.
Если задано свойство httpUrl, параметр filePath является обязательным и описывает путь, в который будет скачан файл, включая имя файла. В противном случае, если указано свойство autoStorageContainerName или storageContainerUrl, filePath является необязательным и является каталогом для скачивания файлов. Если filePath используется в качестве каталога, любая структура каталогов, уже связанная с входными данными, будет сохранена в полном объеме и добавлена в указанный каталог filePath. Указанный относительный путь не может выйти из рабочего каталога задачи (например, с помощью "..").

httpUrl
  • string

URL-адрес для скачивания файла.
Свойства autoStorageContainerName, storageContainerUrl и httpUrl являются взаимоисключающими и должны быть указаны. Если URL-адрес указывает на Хранилище BLOB-объектов Azure, он должен быть доступен для чтения с вычислительных узлов. Существует три способа получить такой URL-адрес для большого двоичного объекта в службе хранилища Azure: включить подписанный URL-адрес (SAS), предоставляющий разрешения на чтение для большого двоичного объекта, использовать управляемое удостоверение с разрешением на чтение или задать ACL для большого двоичного объекта или его контейнера, чтобы разрешить общий доступ.

identityReference

Ссылка на назначенное пользователем удостоверение, используемое для доступа к Хранилище BLOB-объектов Azure, заданному storageContainerUrl или httpUrl.
Ссылка на назначенное пользователем удостоверение, связанное с пулом пакетной службы, который будет использовать вычислительный узел.

storageContainerUrl
  • string

URL-адрес контейнера больших двоичных объектов в Хранилище BLOB-объектов Azure.
Свойства autoStorageContainerName, storageContainerUrl и httpUrl являются взаимоисключающими и должны быть указаны. Этот URL-адрес должен быть доступен для чтения и перечисления из вычислительных узлов. Существует три способа получить такой URL-адрес для контейнера в службе хранилища Azure: включить подписанный URL-адрес (SAS), предоставляющий разрешения на чтение и список для контейнера, использовать управляемое удостоверение с разрешениями на чтение и перечисление, или задать ACL для контейнера, чтобы разрешить общий доступ.

StartTask

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

Name Type Description
commandLine
  • string

Командная строка StartTask.
Командная строка не выполняется под оболочкой и, следовательно, не может воспользоваться преимуществами таких функций оболочки, как расширение переменной среды. Если вы хотите воспользоваться преимуществами таких функций, следует вызвать оболочку в командной строке, например с помощью cmd /c MyCommand в Windows или "/bin/sh -c MyCommand" в Linux. Если командная строка ссылается на пути к файлам, она должна использовать относительный путь (относительно рабочего каталога задачи) или использовать предоставленную пакетную переменную среды (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).

containerSettings

Параметры контейнера, в котором выполняется StartTask.
Если это указано, все каталоги рекурсивно под AZ_BATCH_NODE_ROOT_DIR (корень каталогов пакетная служба Azure на узле) сопоставляются с контейнером, все переменные среды задач сопоставляются с контейнером, а командная строка задачи выполняется в контейнере. Файлы, созданные в контейнере за пределами AZ_BATCH_NODE_ROOT_DIR, могут не отражаться на диске узла, что означает, что API пакетного файла не смогут получить доступ к этим файлам.

environmentSettings

Список параметров переменной среды для StartTask.

maxTaskRetryCount
  • integer

Максимальное число повторных попыток задачи.
Пакетная служба повторяет задачу, если ее код выхода не является нулевым. Обратите внимание, что это значение определяет количество повторных попыток. Пакетная служба попытается выполнить задачу один раз, а затем может повторить попытку до этого ограничения. Например, если максимальное число повторных попыток равно 3, пакетная служба пытается выполнить задачу до 4 раз (одна начальная попытка и 3 повторных попытки). Если максимальное число повторных попыток равно 0, пакетная служба не повторяет задачу. Если максимальное число повторных попыток равно –1, пакетная служба повторяет задачу без ограничения, однако это не рекомендуется для задачи запуска или любой задачи. Значение по умолчанию — 0 (без повторных попыток)

resourceFiles

Список файлов, скачиваемых пакетной службой на вычислительный узел перед запуском командной строки. Максимальный размер списка файлов ресурсов. При превышении максимального размера запрос завершится ошибкой, и код ошибки ответа будет RequestEntityTooLarge. В этом случае необходимо уменьшить размер коллекции ResourceFiles. Это можно сделать с помощью .zip файлов, пакетов приложений или контейнеров Docker.
Файлы, перечисленные в этом элементе, находятся в рабочем каталоге task.

userIdentity

Удостоверение пользователя, под которым выполняется StartTask.
Если этот параметр опущен, задача выполняется как пользователь без прав администратора, уникальный для задачи.

waitForSuccess
  • boolean

Следует ли пакетной службе ждать успешного завершения Начальной базы данных (т. е. выхода с кодом выхода 0) перед планированием задач на вычислительном узле.
Если значение true и startTask завершается сбоем на узле, пакетная служба повторно повторяет startTask до максимального числа повторных попыток (maxTaskRetryCount). Если задача по-прежнему не завершена после всех повторных попыток, пакетная служба помечает узел непригодным для использования и не будет планировать задачи. Это условие можно обнаружить с помощью сведений о состоянии вычислительного узла и сведения о сбое. Если значение равно false, пакетная служба не будет ожидать завершения Начальной базы данных. В этом случае другие задачи могут запускаться на вычислительном узле во время выполнения StartTask; и даже в случае сбоя StartTask новые задачи будут по-прежнему запланированы на вычислительном узле. Значение по умолчанию — true.

StorageAccountType

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

Name Type Description
premium_lrs
  • string

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

standard_lrs
  • string

Диск данных должен использовать стандартное локально избыточное хранилище.

TaskConstraints

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

Name Type Description
maxTaskRetryCount
  • integer

Максимальное число повторных попыток задачи. Пакетная служба повторяет задачу, если ее код выхода не является нулевым.
Обратите внимание, что это значение определяет количество повторных попыток для исполняемого файла Task из-за ненулевого кода выхода. Пакетная служба попытается выполнить задачу один раз, а затем может повторить попытку до этого ограничения. Например, если максимальное число повторных попыток равно 3, пакетная служба пытается выполнить задачу до 4 раз (одна начальная попытка и 3 повторных попытки). Если максимальное число повторных попыток равно 0, пакетная служба не повторяет задачу после первой попытки. Если максимальное число повторных попыток равно –1, пакетная служба повторяет задачу без ограничения, однако это не рекомендуется для задачи запуска или любой задачи. Значение по умолчанию — 0 (без повторных попыток)

maxWallClockTime
  • string

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

retentionTime
  • string

Минимальное время хранения каталога задач на вычислительном узле, где он выполнялся, с момента завершения выполнения. После этого пакетная служба может удалить каталог задач и все его содержимое.
Значение по умолчанию — 7 дней, т. е. каталог задач будет храниться в течение 7 дней, если вычислительный узел не удален или задание не будет удалено.

TaskContainerSettings

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

Name Type Description
containerRunOptions
  • string

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

imageName
  • string

Образ, используемый для создания контейнера, в котором будет выполняться задача.
Это полная ссылка на образ, как указано в параметре docker pull. Если тег не указан как часть имени образа, тег ":latest" используется в качестве значения по умолчанию.

registry

Частный реестр, содержащий образ контейнера.
Этот параметр можно опустить, если он уже был указан при создании пула.

workingDirectory

Расположение рабочего каталога задачи контейнера.
Значение по умолчанию — taskWorkingDirectory.

TaskSchedulingPolicy

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

Name Type Description
nodeFillType

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

UserAccount

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

Name Type Description
elevationLevel

Уровень повышения прав учетной записи пользователя.
Значение по умолчанию — nonAdmin.

linuxUserConfiguration

Конфигурация пользователя, зависят от Linux для учетной записи пользователя.
Это свойство игнорируется, если оно указано в пуле Windows. Если этот параметр не указан, пользователь создается с параметрами по умолчанию.

name
  • string

Имя учетной записи пользователя.

password
  • string

Пароль для учетной записи пользователя.

windowsUserConfiguration

Конфигурация пользователя Windows для учетной записи пользователя.
Это свойство можно указать только в том случае, если пользователь находится в пуле Windows. Если он не указан и в пуле Windows, пользователь создается с параметрами по умолчанию.

UserIdentity

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

Name Type Description
autoUser

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

username
  • string

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

VirtualMachineConfiguration

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

Name Type Description
containerConfiguration

Конфигурация контейнера для пула.
Если этот параметр указан, программа установки выполняется на каждом вычислительном узле в пуле, чтобы разрешить выполнение задач в контейнерах. Все обычные задачи и задачи диспетчера заданий, выполняемые в этом пуле, должны указывать свойство containerSettings, а все остальные задачи могут указывать его.

dataDisks

Конфигурация дисков данных, подключенных к вычислительным узлам в пуле.
Это свойство необходимо указать, если вычислительные узлы в пуле должны иметь пустые диски данных, подключенные к ним. Это не может быть обновлено. Каждый вычислительный узел получает свой собственный диск (диск не является общей папкой). Существующие диски не могут быть подключены, каждый подключенный диск пуст. При удалении вычислительного узла из пула диск и все связанные с ним данные также удаляются. Диск не отформатирован после подключения, его необходимо отформатировать перед использованием. Дополнительные сведения см. в разделе 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

Конфигурация шифрования дисков для пула.
Если этот параметр указан, шифрование выполняется на каждом узле в пуле во время подготовки узла.

extensions

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

imageReference

Ссылка на образ Azure Виртуальные машины Marketplace или пользовательский образ виртуальной машины для использования.

licenseType
  • string

Тип локальной лицензии, используемой при развертывании операционной системы.
Это относится только к образам, содержащим Windows операционной системе, и их следует использовать только при наличии допустимых локальных лицензий для вычислительных узлов, которые будут развернуты. Если этот параметр опущен, скидка на локальное лицензирование не применяется. Возможны следующие значения.

Windows_Server — локальная лицензия предназначена для сервера Windows. Windows_Client — локальная лицензия предназначена для клиента Windows.

nodeAgentSKUId
  • string

Номер SKU агента пакетного вычислительного узла, который будет подготовлен на вычислительных узлах в пуле.
Агент вычислительного узла пакетной службы — это программа, которая выполняется на каждом вычислительном узле в пуле и предоставляет интерфейс командной и управляемой между вычислительным узлом и пакетной службой. Для разных операционных систем существуют различные реализации агента вычислительного узла, известного как номера SKU. Необходимо указать номер SKU агента вычислительного узла, соответствующий выбранной ссылке на образ. Чтобы получить список поддерживаемых номеров SKU агента вычислительных узлов вместе со списком проверенных ссылок на образы, см. операцию "Список поддерживаемых номеров SKU агента вычислительного узла".

nodePlacementConfiguration

Конфигурация размещения узла для пула.
Эта конфигурация определяет правила физического выделения узлов в пуле.

osDisk

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

windowsConfiguration

Windows параметры операционной системы на виртуальной машине.
Это свойство не должно быть указано, если свойство imageReference указывает образ ОС Linux.

VMExtension

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

Name Type Description
autoUpgradeMinorVersion
  • boolean

Указывает, должно ли расширение использовать более новую дополнительную версию, если она доступна во время развертывания. Однако после развертывания расширение не будет обновляться до дополнительных версий, кроме случаев повторного развертывания, даже если это свойство имеет значение true.

name
  • string

Имя расширения виртуальной машины.

protectedSettings
  • object

Расширение может содержать защищенные параметрыSettings или protectedSettingsFromKeyVault или вообще не иметь защищенных параметров.

provisionAfterExtensions
  • string[]

Коллекция имен расширений.
Коллекция имен расширений, после которой необходимо подготовить это расширение.

publisher
  • string

Имя издателя обработчика расширений.

settings
  • object

Форматированные общедоступные параметры JSON для расширения.

type
  • string

Тип расширения.

typeHandlerVersion
  • string

Версия обработчика скрипта.

WindowsConfiguration

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

Name Type Description
enableAutomaticUpdates
  • boolean

Указывает, включены ли автоматические обновления на виртуальной машине.
Если значение не указано, значение по умолчанию — true.

WindowsUserConfiguration

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

Name Type Description
loginMode

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