Поделиться через


Job Schedule - Update

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

PUT {batchUrl}/jobschedules/{jobScheduleId}?api-version=2024-07-01.20.0
PUT {batchUrl}/jobschedules/{jobScheduleId}?timeout={timeout}&api-version=2024-07-01.20.0

Параметры URI

Имя В Обязательно Тип Описание
batchUrl
path True

string

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

jobScheduleId
path True

string

Идентификатор расписания заданий для обновления.

api-version
query True

string

Версия КЛИЕНТСКОго API.

timeout
query

integer

int32

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

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

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

Имя Обязательно Тип Описание
client-request-id

string

uuid

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

return-client-request-id

boolean

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

ocp-date

string

date-time-rfc1123

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

If-Match

string

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

If-None-Match

string

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

If-Modified-Since

string

date-time-rfc1123

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

If-Unmodified-Since

string

date-time-rfc1123

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

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

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

Имя Обязательно Тип Описание
jobSpecification True

JobSpecification

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

schedule True

Schedule

Расписание, в соответствии с которым будут созданы задания.
Все время фиксируются в формате UTC и не влияют на летнее время. Если этот элемент не указан, он эквивалентен передаче расписания по умолчанию: то есть одно задание, запланированное немедленно.

metadata

MetadataItem[]

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

Ответы

Имя Тип Описание
200 OK

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

Заголовки

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

BatchError

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

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

azure_auth

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

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

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

Authorization

Тип: apiKey
В: header

Примеры

JobSchedule update

Образец запроса

PUT account.region.batch.azure.com/jobschedules/jobScheduleId?api-version=2024-07-01.20.0



{
  "schedule": {
    "doNotRunUntil": "2025-01-01T12:30:00Z"
  },
  "jobSpecification": {
    "priority": 0,
    "usesTaskDependencies": false,
    "constraints": {
      "maxWallClockTime": "P10675199DT2H48M5.4775807S",
      "maxTaskRetryCount": 0
    },
    "poolInfo": {
      "poolId": "poolId"
    }
  }
}

Пример ответа

Определения

Имя Описание
AccessScope

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

ApplicationPackageReference

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

AuthenticationTokenSettings

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

AutomaticOSUpgradePolicy

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

AutoPoolSpecification

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

AutoUserScope

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

AutoUserSpecification

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

AzureBlobFileSystemConfiguration

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

AzureFileShareConfiguration

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

BatchError

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

BatchErrorDetail

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

CachingType

Тип кэширования для диска.

CertificateReference

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

CertificateStoreLocation

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

CertificateVisibility

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

CIFSMountConfiguration

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

ComputeNodeFillType

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

ComputeNodeIdentityReference

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

ContainerConfiguration

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

ContainerHostBatchBindMountEntry

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

ContainerHostDataPath

Пути, которые будут подключены к контейнеру задачи контейнера.

ContainerRegistry

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

ContainerType

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

ContainerWorkingDirectory

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

DataDisk

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

DiffDiskPlacement

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

DiffDiskSettings

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

DiskEncryptionConfiguration

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

DiskEncryptionTarget

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

DynamicVNetAssignmentScope

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

ElevationLevel

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

EnvironmentSetting

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

ErrorMessage

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

HttpHeader

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

ImageReference

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

InboundEndpointProtocol

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

InboundNATPool

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

IPAddressProvisioningType

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

JobConstraints

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

JobManagerTask

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

JobNetworkConfiguration

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

JobPreparationTask

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

JobReleaseTask

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

JobScheduleUpdateParameter

Набор изменений, внесенных в расписание заданий.

JobSpecification

Указывает сведения о заданиях, создаваемых по расписанию.

LinuxUserConfiguration

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

LoginMode

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

ManagedDisk
MetadataItem

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

MountConfiguration

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

NetworkConfiguration

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

NetworkSecurityGroupRule

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

NetworkSecurityGroupRuleAccess

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

NFSMountConfiguration

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

NodeCommunicationMode

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

NodePlacementConfiguration

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

NodePlacementPolicyType

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

OnAllTasksComplete

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

OnTaskFailure

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

OSDisk

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

OutputFile

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

OutputFileBlobContainerDestination

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

OutputFileDestination

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

OutputFileUploadCondition

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

OutputFileUploadOptions

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

PoolEndpointConfiguration

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

PoolInformation

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

PoolLifetimeOption

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

PoolSpecification

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

PublicIPAddressConfiguration

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

ResourceFile

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

RollingUpgradePolicy

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

Schedule

Расписание, в соответствии с которым будут созданы задания. Все время фиксируются в формате UTC и не влияют на летнее время.

SecurityEncryptionTypes

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

SecurityProfile

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

SecurityTypes

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

ServiceArtifactReference

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

StartTask

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

StorageAccountType

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

TaskConstraints

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

TaskContainerSettings

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

TaskSchedulingPolicy

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

UefiSettings

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

UpgradeMode

Задает режим обновления до виртуальных машин в масштабируемом наборе.

Возможные значения:

вручную. Вы управляете приложением обновлений виртуальных машин в масштабируемом наборе. Это можно сделать с помощью действия manualUpgrade.

автоматическое. Все виртуальные машины в масштабируемом наборе автоматически обновляются одновременно.

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

UpgradePolicy

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

UserAccount

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

UserIdentity

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

VirtualMachineConfiguration

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

VMDiskSecurityProfile

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

VMExtension

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

WindowsConfiguration

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

WindowsUserConfiguration

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

AccessScope

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

Имя Тип Описание
job

string

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

ApplicationPackageReference

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

Имя Тип Описание
applicationId

string

Идентификатор развертываемого приложения.
При создании пула идентификатор приложения пакета должен быть полным (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).

version

string

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

AuthenticationTokenSettings

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

Имя Тип Описание
access

AccessScope[]

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

AutomaticOSUpgradePolicy

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

Имя Тип Описание
disableAutomaticRollback

boolean

Следует ли отключить функцию отката образа ОС.

enableAutomaticOSUpgrade

boolean

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

Если для пулов windows задано значение true, WindowsConfiguration.enableAutomaticUpdates не может быть задано значение true.

osRollingUpgradeDeferral

boolean

Отложить обновление ОС на телевизорах, если они выполняют задачи.

useRollingUpgradePolicy

boolean

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

AutoPoolSpecification

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

Имя Тип Описание
autoPoolIdPrefix

string

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

keepAlive

boolean

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

pool

PoolSpecification

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

poolLifetimeOption

PoolLifetimeOption

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

AutoUserScope

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

Имя Тип Описание
pool

string

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

task

string

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

AutoUserSpecification

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

Имя Тип Описание
elevationLevel

ElevationLevel

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

scope

AutoUserScope

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

AzureBlobFileSystemConfiguration

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

Имя Тип Описание
accountKey

string

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

accountName

string

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

blobfuseOptions

string

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

containerName

string

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

identityReference

ComputeNodeIdentityReference

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

relativeMountPath

string

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

sasKey

string

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

AzureFileShareConfiguration

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

Имя Тип Описание
accountKey

string

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

accountName

string

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

azureFileUrl

string

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

mountOptions

string

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

relativeMountPath

string

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

BatchError

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

Имя Тип Описание
code

string

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

message

ErrorMessage

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

values

BatchErrorDetail[]

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

BatchErrorDetail

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

Имя Тип Описание
key

string

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

value

string

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

CachingType

Тип кэширования для диска.

Имя Тип Описание
none

string

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

readonly

string

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

readwrite

string

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

CertificateReference

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

Имя Тип Описание
storeLocation

CertificateStoreLocation

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

storeName

string

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

thumbprint

string

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

thumbprintAlgorithm

string

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

visibility

CertificateVisibility[]

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

CertificateStoreLocation

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

Имя Тип Описание
currentuser

string

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

localmachine

string

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

CertificateVisibility

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

Имя Тип Описание
remoteuser

string

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

starttask

string

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

task

string

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

CIFSMountConfiguration

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

Имя Тип Описание
mountOptions

string

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

password

string

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

relativeMountPath

string

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

source

string

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

username

string

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

ComputeNodeFillType

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

Имя Тип Описание
pack

string

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

spread

string

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

ComputeNodeIdentityReference

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

Имя Тип Описание
resourceId

string

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

ContainerConfiguration

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

Имя Тип Описание
containerImageNames

string[]

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

containerRegistries

ContainerRegistry[]

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

type

ContainerType

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

ContainerHostBatchBindMountEntry

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

Имя Тип Описание
isReadOnly

boolean

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

source

ContainerHostDataPath

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

ContainerHostDataPath

Пути, которые будут подключены к контейнеру задачи контейнера.

Имя Тип Описание
Applications

string

Путь к приложениям.

JobPrep

string

Путь задачи подготовки задания.

Shared

string

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

Startup

string

Путь к задаче запуска.

Task

string

Путь к задаче.

VfsMounts

string

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

ContainerRegistry

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

Имя Тип Описание
identityReference

ComputeNodeIdentityReference

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

password

string

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

registryServer

string

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

username

string

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

ContainerType

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

Имя Тип Описание
criCompatible

string

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

dockerCompatible

string

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

ContainerWorkingDirectory

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

Имя Тип Описание
containerImageDefault

string

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

taskWorkingDirectory

string

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

DataDisk

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

Имя Тип Описание
caching

CachingType

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

diskSizeGB

integer

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

lun

integer

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

storageAccountType

StorageAccountType

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

DiffDiskPlacement

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

Имя Тип Описание
CacheDisk

string

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

DiffDiskSettings

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

Имя Тип Описание
placement

DiffDiskPlacement

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

DiskEncryptionConfiguration

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

Имя Тип Описание
targets

DiskEncryptionTarget[]

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

DiskEncryptionTarget

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

Имя Тип Описание
osdisk

string

Диск ОС на вычислительном узле шифруется.

temporarydisk

string

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

DynamicVNetAssignmentScope

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

Имя Тип Описание
job

string

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

none

string

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

ElevationLevel

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

Имя Тип Описание
admin

string

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

nonadmin

string

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

EnvironmentSetting

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

Имя Тип Описание
name

string

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

value

string

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

ErrorMessage

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

Имя Тип Описание
lang

string

Языковой код сообщения об ошибке

value

string

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

HttpHeader

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

Имя Тип Описание
name

string

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

value

string

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

ImageReference

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

Имя Тип Описание
communityGalleryImageId

string

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

exactVersion

string

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

offer

string

Тип предложения образа Azure Virtual Machines Marketplace.
Например, UbuntuServer или WindowsServer.

publisher

string

Издатель образа Azure Virtual Machines Marketplace.
Например, Canonical или MicrosoftWindowsServer.

sharedGalleryImageId

string

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

sku

string

Номер SKU образа Azure Virtual Machines Marketplace.
Например, 18.04-LTS или 2019-Datacenter.

version

string

Версия образа Azure Virtual Machines Marketplace.
Чтобы выбрать последнюю версию образа, можно указать значение "последняя". Если опущено, значение по умолчанию — "последняя".

virtualMachineImageId

string

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

InboundEndpointProtocol

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

Имя Тип Описание
tcp

string

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

udp

string

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

InboundNATPool

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

Имя Тип Описание
backendPort

integer

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

frontendPortRangeEnd

integer

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

frontendPortRangeStart

integer

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

name

string

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

networkSecurityGroupRules

NetworkSecurityGroupRule[]

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

protocol

InboundEndpointProtocol

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

IPAddressProvisioningType

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

Имя Тип Описание
batchmanaged

string

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

nopublicipaddresses

string

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

usermanaged

string

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

JobConstraints

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

Имя Тип Описание
maxTaskRetryCount

integer

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

maxWallClockTime

string

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

JobManagerTask

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

Имя Тип Описание
allowLowPriorityNode

boolean

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

applicationPackageReferences

ApplicationPackageReference[]

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

authenticationTokenSettings

AuthenticationTokenSettings

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

commandLine

string

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

constraints

TaskConstraints

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

containerSettings

TaskContainerSettings

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

displayName

string

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

environmentSettings

EnvironmentSetting[]

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

id

string

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

killJobOnCompletion

boolean

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

outputFiles

OutputFile[]

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

requiredSlots

integer

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

resourceFiles

ResourceFile[]

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

runExclusive

boolean

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

userIdentity

UserIdentity

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

JobNetworkConfiguration

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

Имя Тип Описание
skipWithdrawFromVNet

boolean

Следует ли удалять вычислительные узлы из виртуальной сети в DNC при завершении или удалении задания.
Если значение true, узлы останутся присоединенными к виртуальной сети с DNC. Если значение false, узлы автоматически отступят после завершения задания. По умолчанию используется значение false.

subnetId

string

Идентификатор ресурса ARM подсети виртуальной сети, в которой вычислительные узлы, выполняющие задачи из задания, присоединяются в течение длительности задачи.
Виртуальная сеть должна находиться в том же регионе и подписке, что и учетная запись пакетной службы 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/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

JobPreparationTask

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

Имя Тип Описание
commandLine

string

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

constraints

TaskConstraints

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

containerSettings

TaskContainerSettings

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

environmentSettings

EnvironmentSetting[]

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

id

string

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

rerunOnNodeRebootAfterSuccess

boolean

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

resourceFiles

ResourceFile[]

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

userIdentity

UserIdentity

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

waitForSuccess

boolean

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

JobReleaseTask

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

Имя Тип Описание
commandLine

string

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

containerSettings

TaskContainerSettings

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

environmentSettings

EnvironmentSetting[]

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

id

string

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

maxWallClockTime

string

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

resourceFiles

ResourceFile[]

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

retentionTime

string

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

userIdentity

UserIdentity

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

JobScheduleUpdateParameter

Набор изменений, внесенных в расписание заданий.

Имя Тип Описание
jobSpecification

JobSpecification

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

metadata

MetadataItem[]

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

schedule

Schedule

Расписание, в соответствии с которым будут созданы задания.
Все время фиксируются в формате UTC и не влияют на летнее время. Если этот элемент не указан, он эквивалентен передаче расписания по умолчанию: то есть одно задание, запланированное немедленно.

JobSpecification

Указывает сведения о заданиях, создаваемых по расписанию.

Имя Тип Default value Описание
allowTaskPreemption

boolean

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

commonEnvironmentSettings

EnvironmentSetting[]

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

constraints

JobConstraints

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

displayName

string

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

jobManagerTask

JobManagerTask

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

jobPreparationTask

JobPreparationTask

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

jobReleaseTask

JobReleaseTask

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

maxParallelTasks

integer

-1

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

metadata

MetadataItem[]

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

networkConfiguration

JobNetworkConfiguration

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

onAllTasksComplete

OnAllTasksComplete

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

onTaskFailure

OnTaskFailure

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

poolInfo

PoolInformation

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

priority

integer

Приоритет заданий, созданных в рамках этого расписания.
Значения приоритета могут варьироваться от -1000 до 1000, при этом -1000 является самым низким приоритетом, а 1000 — самым высоким приоритетом. Значение по умолчанию — 0. Этот приоритет используется в качестве значения по умолчанию для всех заданий в разделе "Расписание заданий". Вы можете обновить приоритет задания после его создания с помощью API обновления задания.

usesTaskDependencies

boolean

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

LinuxUserConfiguration

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

Имя Тип Описание
gid

integer

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

sshPrivateKey

string

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

uid

integer

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

LoginMode

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

Имя Тип Описание
batch

string

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

interactive

string

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

ManagedDisk

Имя Тип Описание
securityProfile

VMDiskSecurityProfile

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

storageAccountType

StorageAccountType

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

MetadataItem

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

Имя Тип Описание
name

string

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

value

string

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

MountConfiguration

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

Имя Тип Описание
azureBlobFileSystemConfiguration

AzureBlobFileSystemConfiguration

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

azureFileShareConfiguration

AzureFileShareConfiguration

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

cifsMountConfiguration

CIFSMountConfiguration

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

nfsMountConfiguration

NFSMountConfiguration

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

NetworkConfiguration

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

Имя Тип Описание
dynamicVNetAssignmentScope

DynamicVNetAssignmentScope

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

enableAcceleratedNetworking

boolean

Следует ли включить ускоренную сеть в этом пуле.
Ускорение сети обеспечивает виртуализацию одно корневых операций ввода-вывода (SR-IOV) к виртуальной машине, что может привести к повышению производительности сети. Дополнительные сведения см. в статье https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview.

endpointConfiguration

PoolEndpointConfiguration

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

publicIPAddressConfiguration

PublicIPAddressConfiguration

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

subnetId

string

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

NetworkSecurityGroupRule

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

Имя Тип Описание
access

NetworkSecurityGroupRuleAccess

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

priority

integer

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

sourceAddressPrefix

string

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

sourcePortRanges

string[]

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

NetworkSecurityGroupRuleAccess

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

Имя Тип Описание
allow

string

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

deny

string

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

NFSMountConfiguration

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

Имя Тип Описание
mountOptions

string

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

relativeMountPath

string

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

source

string

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

NodeCommunicationMode

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

Имя Тип Описание
classic

string

Для узлов, использующих классический режим связи, требуется входящий TCP-обмен данными через порты 29876 и 29877 из пакета BatchNodeManagement. Тег службы {region}" и исходящий TCP-обмен данными через порт 443 в хранилище.регион и BatchNodeManagement. Теги службы {region}".

default

string

Режим связи узла автоматически устанавливается пакетной службой.

simplified

string

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

NodePlacementConfiguration

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

Имя Тип Описание
policy

NodePlacementPolicyType

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

NodePlacementPolicyType

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

Имя Тип Описание
regional

string

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

zonal

string

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

OnAllTasksComplete

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

Имя Тип Описание
noaction

string

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

terminatejob

string

Завершение задания. Значение "AllTasksComplete" имеет значение "AllTasksComplete".

OnTaskFailure

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

Имя Тип Описание
noaction

string

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

performexitoptionsjobaction

string

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

OSDisk

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

Имя Тип Описание
caching

CachingType

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

diskSizeGB

integer

Начальный размер диска в ГБ при создании нового диска ОС.

ephemeralOSDiskSettings

DiffDiskSettings

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

managedDisk

ManagedDisk

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

writeAcceleratorEnabled

boolean

Указывает, следует ли включить или отключить записьAccelerator на диске.

OutputFile

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

Имя Тип Описание
destination

OutputFileDestination

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

filePattern

string

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

uploadOptions

OutputFileUploadOptions

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

OutputFileBlobContainerDestination

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

Имя Тип Описание
containerUrl

string

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

identityReference

ComputeNodeIdentityReference

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

path

string

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

uploadHeaders

HttpHeader[]

Список пар "имя-значение" для заголовков, используемых при отправке выходных файлов
Эти заголовки будут указаны при отправке файлов в службу хранилища Azure. Официальный документ по разрешенным заголовкам при отправке больших двоичных объектов: https://docs.microsoft.com/rest/api/storageservices/put-blob#request-headers-all-blob-types

OutputFileDestination

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

Имя Тип Описание
container

OutputFileBlobContainerDestination

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

OutputFileUploadCondition

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

Имя Тип Описание
taskcompletion

string

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

taskfailure

string

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

tasksuccess

string

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

OutputFileUploadOptions

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

Имя Тип Описание
uploadCondition

OutputFileUploadCondition

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

PoolEndpointConfiguration

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

Имя Тип Описание
inboundNATPools

InboundNATPool[]

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

PoolInformation

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

Имя Тип Описание
autoPoolSpecification

AutoPoolSpecification

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

poolId

string

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

PoolLifetimeOption

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

Имя Тип Описание
job

string

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

jobschedule

string

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

PoolSpecification

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

Имя Тип Описание
applicationPackageReferences

ApplicationPackageReference[]

Список пакетов, установленных на каждом вычислительном узле в пуле.
При создании пула идентификатор приложения пакета должен быть полным (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Изменения ссылок на пакеты влияют на все новые узлы, присоединенные к пулу, но не влияют на вычислительные узлы, которые уже находятся в пуле, пока они не перезагрузятся или переимыслятся. В любом пуле имеется не более 10 ссылок на пакеты.

autoScaleEvaluationInterval

string

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

autoScaleFormula

string

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

certificateReferences

CertificateReference[]

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

Предупреждение. Это свойство устарело и будет удалено после февраля 2024 года. Вместо этого используйте расширения Azure KeyVault .

displayName

string

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

enableAutoScale

boolean

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

enableInterNodeCommunication

boolean

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

metadata

MetadataItem[]

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

mountConfiguration

MountConfiguration[]

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

networkConfiguration

NetworkConfiguration

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

resizeTimeout

string

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

resourceTags

object

Указанные пользователем теги, связанные с пулом.
Определяемые пользователем теги, связанные с пулом пакетной службы Azure. При указании эти теги распространяются на резервные ресурсы Azure, связанные с пулом. Это свойство можно указать только при создании учетной записи пакетной службы с свойством poolAllocationMode с значением UserSubscription.

startTask

StartTask

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

targetDedicatedNodes

integer

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

targetLowPriorityNodes

integer

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

targetNodeCommunicationMode

NodeCommunicationMode

Требуемый режим связи узла для пула.
Если опущено, значение по умолчанию — Default.

taskSchedulingPolicy

TaskSchedulingPolicy

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

taskSlotsPerNode

integer

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

upgradePolicy

UpgradePolicy

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

userAccounts

UserAccount[]

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

virtualMachineConfiguration

VirtualMachineConfiguration

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

vmSize

string

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

PublicIPAddressConfiguration

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

Имя Тип Описание
ipAddressIds

string[]

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

provision

IPAddressProvisioningType

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

ResourceFile

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

Имя Тип Описание
autoStorageContainerName

string

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

blobPrefix

string

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

fileMode

string

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

filePath

string

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

httpUrl

string

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

identityReference

ComputeNodeIdentityReference

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

storageContainerUrl

string

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

RollingUpgradePolicy

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

Имя Тип Описание
enableCrossZoneUpgrade

boolean

Разрешить VMSS игнорировать границы AZ при создании пакетов обновления. Учитывайте домен обновления и maxBatchInstancePercent, чтобы определить размер пакета. Это поле может иметь значение true или false только при использовании NodePlacementConfiguration в качестве зонального.

maxBatchInstancePercent

integer

Максимальный процент общих экземпляров виртуальных машин, которые будут обновляться одновременно путем последовательного обновления в одном пакете. Так как это максимальный, неработоспособные экземпляры в предыдущих или будущих пакетах могут привести к снижению процента экземпляров в пакете, чтобы обеспечить более высокую надежность. Значение этого поля должно составлять от 5 до 100 включительно. Если значение maxBatchInstancePercent и maxUnhealthyInstancePercent присваивается значением, значение maxBatchInstancePercent не должно превышать maxUnhealthyInstancePercent.

maxUnhealthyInstancePercent

integer

Максимальный процент всех экземпляров виртуальных машин в масштабируемом наборе, которые могут быть одновременно неработоспособными, либо в результате обновления, либо путем обнаружения в неработоспособном состоянии проверки работоспособности виртуальной машины до завершения последовательного обновления. Это ограничение будет проверено перед запуском любого пакета. Значение этого поля должно составлять от 5 до 100 включительно. Если значение maxBatchInstancePercent и maxUnhealthyInstancePercent присваивается значением, значение maxBatchInstancePercent не должно превышать maxUnhealthyInstancePercent.

maxUnhealthyUpgradedInstancePercent

integer

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

pauseTimeBetweenBatches

string

Время ожидания между завершением обновления для всех виртуальных машин в одном пакете и запуском следующего пакета. Длительность времени должна быть указана в формате ISO 8601.

prioritizeUnhealthyInstances

boolean

Обновите все неработоспособные экземпляры в масштабируемом наборе до всех здоровых экземпляров.

rollbackFailedInstancesOnPolicyBreach

boolean

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

Schedule

Расписание, в соответствии с которым будут созданы задания. Все время фиксируются в формате UTC и не влияют на летнее время.

Имя Тип Описание
doNotRunAfter

string

Время, после которого задание не будет создано в рамках этого расписания заданий. Расписание перейдет к завершенному состоянию, как только этот крайний срок истек и в этом расписании задания нет активного задания.
Если не указать время doNotRunAfter и вы создаете повторяющееся расписание заданий, расписание заданий будет оставаться активным до явного завершения.

doNotRunUntil

string

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

recurrenceInterval

string

Интервал времени между временем начала двух последовательных заданий в рамках расписания заданий. Расписание заданий может иметь по крайней мере одно активное задание в любое время.
Так как расписание заданий может быть не более одного активного задания в любое время, если время создать новое задание в рамках расписания заданий, но предыдущее задание по-прежнему выполняется, пакетная служба не создаст новое задание до завершения предыдущего задания. Если предыдущее задание не завершается в период startWindow нового повторенияInterval, новое задание не будет запланировано на этот интервал. Для повторяющихся заданий обычно следует указать jobManagerTask в задании. Если вы не используете jobManagerTask, вам потребуется внешний процесс для мониторинга при создании заданий, добавьте задачи в задания и завершите работу заданий, готовых к следующему повторении. Значение по умолчанию заключается в том, что расписание не повторяется: создается одно задание в рамках startWindow после времени doNotRunUntil и расписание будет завершено сразу после завершения задания. Минимальное значение составляет 1 минуту. Если указать меньшее значение, служба пакетной службы отклоняет расписание с ошибкой; Если вы вызываете REST API напрямую, код состояния HTTP равен 400 (недопустимый запрос).

startWindow

string

Интервал времени, начиная с момента создания расписания, в котором должно быть создано задание.
Если задание не создается в интервале startWindow, то функция "возможность" теряется; Задание не будет создано до следующего повторения расписания. Если расписание повторяется, а начальноеwindow больше интервала повторения, то это эквивалентно бесконечному начальной операцииWindow, так как задание, которое является "из-за" в одном повторенииInterval, не переносится в следующий интервал повторения. Значение по умолчанию бесконечно. Минимальное значение составляет 1 минуту. Если указать меньшее значение, служба пакетной службы отклоняет расписание с ошибкой; Если вы вызываете REST API напрямую, код состояния HTTP равен 400 (недопустимый запрос).

SecurityEncryptionTypes

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

Имя Тип Описание
NonPersistedTPM

string

VMGuestStateOnly

string

SecurityProfile

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

Имя Тип Описание
encryptionAtHost

boolean

Это свойство можно использовать пользователем в запросе, чтобы включить или отключить шифрование узла для виртуальной машины или масштабируемого набора виртуальных машин. Это позволит включить шифрование для всех дисков, включая диск Resource/Temp на самом узле. Дополнительные сведения о шифровании в требованиях к узлам см. в https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizes.

securityType

SecurityTypes

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

uefiSettings

UefiSettings

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

SecurityTypes

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

Имя Тип Описание
confidentialVM

string

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

trustedLaunch

string

Доверенный запуск защищает от расширенных и постоянных методов атак.

ServiceArtifactReference

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

Имя Тип Описание
id

string

Идентификатор ссылки на артефакт службы ServiceArtifactReference
Идентификатор ссылки на артефакт службы в виде /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

StartTask

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

Имя Тип Описание
commandLine

string

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

containerSettings

TaskContainerSettings

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

environmentSettings

EnvironmentSetting[]

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

maxTaskRetryCount

integer

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

resourceFiles

ResourceFile[]

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

userIdentity

UserIdentity

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

waitForSuccess

boolean

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

StorageAccountType

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

Имя Тип Описание
premium_lrs

string

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

standard_lrs

string

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

standardssd_lrs

string

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

TaskConstraints

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

Имя Тип Описание
maxTaskRetryCount

integer

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

maxWallClockTime

string

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

retentionTime

string

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

TaskContainerSettings

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

Имя Тип Описание
containerHostBatchBindMounts

ContainerHostBatchBindMountEntry[]

Пути, которые необходимо подключить к задаче контейнера.
Если этот массив имеет значение NULL или отсутствует, задача контейнера будет подключать весь временный диск диска в окнах (или AZ_BATCH_NODE_ROOT_DIR в Linux). Он не будет подключать пути к данным в контейнер, если этот массив задан как пустой.

containerRunOptions

string

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

imageName

string

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

registry

ContainerRegistry

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

workingDirectory

ContainerWorkingDirectory

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

TaskSchedulingPolicy

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

Имя Тип Описание
nodeFillType

ComputeNodeFillType

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

UefiSettings

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

Имя Тип Описание
secureBootEnabled

boolean

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

vTpmEnabled

boolean

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

UpgradeMode

Задает режим обновления до виртуальных машин в масштабируемом наборе.

Возможные значения:

вручную. Вы управляете приложением обновлений виртуальных машин в масштабируемом наборе. Это можно сделать с помощью действия manualUpgrade.

автоматическое. Все виртуальные машины в масштабируемом наборе автоматически обновляются одновременно.

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

Имя Тип Описание
automatic

string

Все виртуальные машины в масштабируемом наборе автоматически обновляются одновременно.

manual

string

Вы управляете применением обновлений для виртуальных машин в масштабируемом наборе. Это можно сделать с помощью действия manualUpgrade.

rolling

string

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

UpgradePolicy

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

Имя Тип Описание
automaticOSUpgradePolicy

AutomaticOSUpgradePolicy

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

mode

UpgradeMode

Задает режим обновления до виртуальных машин в масштабируемом наборе.

Возможные значения:

вручную. Вы управляете приложением обновлений виртуальных машин в масштабируемом наборе. Это можно сделать с помощью действия manualUpgrade.

автоматическое. Все виртуальные машины в масштабируемом наборе автоматически обновляются одновременно.

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

rollingUpgradePolicy

RollingUpgradePolicy

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

UserAccount

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

Имя Тип Описание
elevationLevel

ElevationLevel

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

linuxUserConfiguration

LinuxUserConfiguration

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

name

string

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

password

string

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

windowsUserConfiguration

WindowsUserConfiguration

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

UserIdentity

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

Имя Тип Описание
autoUser

AutoUserSpecification

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

username

string

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

VirtualMachineConfiguration

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

Имя Тип Описание
containerConfiguration

ContainerConfiguration

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

dataDisks

DataDisk[]

Конфигурация дисков данных, подключенных к вычислительным узлам в пуле.
Это свойство должно быть указано, если вычислительные узлы в пуле должны иметь пустые диски данных, подключенные к ним. Это невозможно обновить. Каждый вычислительный узел получает свой собственный диск (диск не является общим файлом). Существующие диски не могут быть присоединены, каждый подключенный диск пуст. При удалении вычислительного узла из пула диск и все данные, связанные с ним, также удаляются. Диск не отформатирован после подключения, его необходимо отформатировать перед использованием. Дополнительные сведения см. в https://docs.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux и https://docs.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine.

diskEncryptionConfiguration

DiskEncryptionConfiguration

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

extensions

VMExtension[]

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

imageReference

ImageReference

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

licenseType

string

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

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

nodeAgentSKUId

string

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

nodePlacementConfiguration

NodePlacementConfiguration

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

osDisk

OSDisk

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

securityProfile

SecurityProfile

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

serviceArtifactReference

ServiceArtifactReference

Указывает идентификатор ссылки на артефакт службы, используемый для задания одной версии образа для всех виртуальных машин в масштабируемом наборе при использовании последней версии образа.
Идентификатор ссылки на артефакт службы в виде /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

windowsConfiguration

WindowsConfiguration

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

VMDiskSecurityProfile

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

Имя Тип Описание
securityEncryptionType

SecurityEncryptionTypes

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

VMExtension

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

Имя Тип Описание
autoUpgradeMinorVersion

boolean

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

enableAutomaticUpgrade

boolean

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

name

string

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

protectedSettings

object

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

provisionAfterExtensions

string[]

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

publisher

string

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

settings

object

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

type

string

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

typeHandlerVersion

string

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

WindowsConfiguration

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

Имя Тип Описание
enableAutomaticUpdates

boolean

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

WindowsUserConfiguration

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

Имя Тип Описание
loginMode

LoginMode

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