Jobs - Create Job

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

POST {endpoint}/jobs?api-version=2025-06-01
POST {endpoint}/jobs?api-version=2025-06-01&timeOut={timeOut}

Параметры URI

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

string (uri)

Конечная точка учетной записи пакетной службы (например, https://batchaccount.eastus2.batch.azure.com).

api-version
query True

string

minLength: 1

Версия API, используемая для данной операции.

timeOut
query

integer (int32)

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

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

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

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

string

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

return-client-request-id

boolean

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

ocp-date

string (date-time-rfc7231)

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

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

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

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

string

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

poolInfo True

BatchPoolInfo

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

allowTaskPreemption

boolean

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

commonEnvironmentSettings

EnvironmentSetting[]

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

constraints

BatchJobConstraints

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

displayName

string

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

jobManagerTask

BatchJobManagerTask

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

jobPreparationTask

BatchJobPreparationTask

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

jobReleaseTask

BatchJobReleaseTask

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

maxParallelTasks

integer (int32)

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

metadata

BatchMetadataItem[]

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

networkConfiguration

BatchJobNetworkConfiguration

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

onAllTasksComplete

BatchAllTasksCompleteMode

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

onTaskFailure

BatchTaskFailureMode

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

priority

integer (int32)

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

usesTaskDependencies

boolean

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

Ответы

Имя Тип Описание
201 Created

Запрос успешно выполнен, и в результате был создан новый ресурс.

Заголовки

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

BatchError

Непредвиденное сообщение об ошибке.

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

OAuth2Auth

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

Области

Имя Описание
https://batch.core.windows.net//.default

Примеры

Creates a basic job
Creates a complex job

Creates a basic job

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

POST {endpoint}/jobs?api-version=2025-06-01



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

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

Creates a complex job

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

POST {endpoint}/jobs?api-version=2025-06-01



{
  "id": "jobId",
  "priority": 100,
  "constraints": {
    "maxWallClockTime": "PT1H",
    "maxTaskRetryCount": -1
  },
  "jobManagerTask": {
    "id": "taskId",
    "commandLine": "myprogram.exe",
    "resourceFiles": [
      {
        "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram.exe?sas",
        "filePath": "myprogram.exe"
      },
      {
        "storageContainerUrl": "http://mystorage1.blob.core.windows.net/data?sas",
        "filePath": "datafolder"
      }
    ],
    "environmentSettings": [
      {
        "name": "myvariable",
        "value": "myvalue"
      }
    ],
    "constraints": {
      "maxWallClockTime": "PT1H",
      "maxTaskRetryCount": 0,
      "retentionTime": "PT1H"
    },
    "requiredSlots": 2,
    "killJobOnCompletion": false,
    "userIdentity": {
      "autoUser": {
        "scope": "task",
        "elevationLevel": "admin"
      }
    },
    "runExclusive": true
  },
  "poolInfo": {
    "autoPoolSpecification": {
      "autoPoolIdPrefix": "mypool",
      "poolLifetimeOption": "job",
      "pool": {
        "vmSize": "Standard_D2ds_v5",
        "virtualMachineConfiguration": {
          "imageReference": {
            "publisher": "MicrosoftWindowsServer",
            "offer": "WindowsServer",
            "sku": "2025-datacenter-smalldisk",
            "version": "latest"
          },
          "nodeAgentSKUId": "batch.node.windows amd64",
          "windowsConfiguration": {
            "enableAutomaticUpdates": false
          },
          "nodePlacementConfiguration": {
            "policy": "zonal"
          }
        },
        "resizeTimeout": "PT15M",
        "targetDedicatedNodes": 3,
        "targetLowPriorityNodes": 0,
        "taskSlotsPerNode": 2,
        "taskSchedulingPolicy": {
          "nodeFillType": "spread"
        },
        "enableAutoScale": false,
        "enableInterNodeCommunication": true,
        "startTask": {
          "commandLine": "myprogram2.exe",
          "resourceFiles": [
            {
              "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram2.exe?sas",
              "filePath": "myprogram2.exe"
            }
          ],
          "environmentSettings": [
            {
              "name": "myvariable",
              "value": "myvalue"
            }
          ],
          "userIdentity": {
            "autoUser": {
              "scope": "task",
              "elevationLevel": "admin"
            }
          },
          "maxTaskRetryCount": 2,
          "waitForSuccess": true
        },
        "metadata": [
          {
            "name": "myproperty",
            "value": "myvalue"
          }
        ]
      }
    }
  },
  "metadata": [
    {
      "name": "myproperty",
      "value": "myvalue"
    }
  ]
}

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

Определения

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

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

AutoUserScope

AutoUserScope enums

AutoUserSpecification

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

AzureBlobFileSystemConfiguration

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

AzureFileShareConfiguration

Информация, используемая для подключения к файловому ресурсу Azure.

BatchAllTasksCompleteMode

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

BatchApplicationPackageReference

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

BatchAutoPoolSpecification

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

BatchContainerConfiguration

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

BatchDiffDiskSettings

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

BatchError

Получена ошибка от сервиса пакетная служба Azure.

BatchErrorDetail

Дополнительная информация, включённая в ответ на ошибку пакетная служба Azure.

BatchErrorMessage

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

BatchInboundNatPool

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

BatchJobConstraints

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

BatchJobCreateOptions

Parameters for creating an пакетная служба Azure Job.

BatchJobDefaultOrder

Enums BatchJobDefaultOrder

BatchJobManagerTask

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

BatchJobNetworkConfiguration

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

BatchJobPreparationTask

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

BatchJobReleaseTask

Задача выпуска задания для выполнения задания на любом вычислительном узле, где выполняется задание. Задача выпуска задания выполняется, когда задание заканчивается, из-за одного из следующих: пользователь вызывает API завершения задания или API удаления заданий, пока задание по-прежнему активно, достигнуто максимальное ограничение времени на стенные часы задания, а задание по-прежнему активно или задача диспетчера заданий завершена, и задание настроено на завершение после завершения диспетчера заданий. Задача выпуска задания выполняется на каждом узле, где выполняются задачи задания, а задача подготовки задания выполняется и завершена. Если вы повторно создайте узел после запуска задачи подготовки задания, а задание завершается без дальнейших задач задания, запущенного на этом узле (и, следовательно, задача подготовки задания не выполняется повторно), задача выпуска задания не запускается на этом вычислительном узле. Если узел перезагрузится, пока задача выпуска задания по-прежнему запущена, задача выпуска задания снова запускается при запуске вычислительного узла. Задание не помечается как завершенное до завершения всех задач выпуска задания. Задача выпуска задания выполняется в фоновом режиме. Он не занимает слот планирования; То есть он не учитывается в отношении ограничения taskSlotsPerNode, указанного в пуле.

BatchMetadataItem

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

BatchNodeFillType

BatchNodeFillType enums

BatchNodeIdentityReference

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

BatchNodePlacementConfiguration

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

BatchNodePlacementPolicyType

BatchNodePlacementPolicyType enums

BatchOsDisk

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

BatchPoolEndpointConfiguration

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

BatchPoolIdentityReference

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

BatchPoolInfo

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

BatchPoolLifetimeOption

Enums BatchPoolLifetimeOption

BatchPoolSpecification

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

BatchPublicIpAddressConfiguration

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

BatchStartTask

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

BatchTaskConstraints

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

BatchTaskContainerSettings

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

BatchTaskFailureMode

Enums TaskFailure

BatchTaskSchedulingPolicy

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

BatchUefiSettings

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

BatchVmDiskSecurityProfile

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

BatchVmImageReference

Ссылка на Виртуальные машины Azure Marketplace Image или Azure Compute Gallery Image. Чтобы получить список всех ссылок на изображения Azure Marketplace, проверенных пакетная служба Azure, смотрите операцию 'List Supported Images'.

CachingType

Энумы CachingType

CifsMountConfiguration

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

ContainerHostBatchBindMountEntry

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

ContainerHostDataPath

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

ContainerRegistryReference

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

ContainerType

ContainerType enums

ContainerWorkingDirectory

ContainerWorkingDirectory enums

DataDisk

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

DiffDiskPlacement

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

DiskCustomerManagedKey

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

DiskEncryptionConfiguration

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

DiskEncryptionSetParameters

Идентификатор ресурса ARM набора шифрования диска.

DiskEncryptionTarget

Enums DiskEncryptionTarget

DynamicVNetAssignmentScope

DynamicVNetAssignmentScope enums

ElevationLevel

Enums ElevationLevel

EnvironmentSetting

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

HostEndpointSettings

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

HostEndpointSettingsModeTypes

HostEndpointSettingsModeTypes enums

InboundEndpointProtocol

Enums InboundEndpointProtocol

IpAddressProvisioningType

IPAddressProvisioningType enums

IPFamily

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

IPTag

Содержит тег IP, связанный с общедоступным IP-адресом.

LinuxUserConfiguration

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

LoginMode

Enums LoginMode

ManagedDisk

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

MountConfiguration

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

NetworkConfiguration

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

NetworkSecurityGroupRule

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

NetworkSecurityGroupRuleAccess

NetworkSecurityGroupRuleAccess enums

NfsMountConfiguration

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

OutputFile

При каждой отправке файлов пакетная служба записывает два файла журнала на вычислительный узелfileuploadout.txtиfileuploaderr.txt. Эти файлы журналов используются для получения дополнительных сведений о конкретном сбое.

OutputFileBlobContainerDestination

Указывает место для загрузки файла внутри хранилища blob Azure.

OutputFileDestination

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

OutputFileUploadCondition

Enums OutputFileUploadCondition

OutputFileUploadConfig

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

OutputFileUploadHeader

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

ProxyAgentSettings

Задает параметры ProxyAgent при создании виртуальной машины.

ResourceFile

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

RollingUpgradePolicy

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

SecurityEncryptionTypes

Enums SecurityEncryptionTypes

SecurityProfile

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

SecurityTypes

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

ServiceArtifactReference

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

StorageAccountType

Перечисления StorageAccountType

UpgradeMode

Enums UpgradeMode

UpgradePolicy

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

UserAccount

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

UserIdentity

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

VirtualMachineConfiguration

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

VMExtension

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

WindowsConfiguration

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

WindowsUserConfiguration

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

AutomaticOsUpgradePolicy

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

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

boolean

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

enableAutomaticOSUpgrade

boolean

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

Если это установлено в true для пулов на базе Windows, то WindowsConfiguration.enableAutomaticUpdates нельзя установить true.

osRollingUpgradeDeferral

boolean

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

useRollingUpgradePolicy

boolean

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

AutoUserScope

AutoUserScope enums

Значение Описание
task

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

pool

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

AutoUserSpecification

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

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

ElevationLevel

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

scope

AutoUserScope

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

AzureBlobFileSystemConfiguration

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

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

string (password)

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

accountName

string

Имя аккаунта служба хранилища Azure.

blobfuseOptions

string

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

containerName

string

The Хранилище BLOB-объектов Azure Container name.

identityReference

BatchNodeIdentityReference

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

relativeMountPath

string

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

sasKey

string (password)

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

AzureFileShareConfiguration

Информация, используемая для подключения к файловому ресурсу Azure.

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

string (password)

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

accountName

string

Имя аккаунта служба хранилища Azure.

azureFileUrl

string (uri)

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

mountOptions

string

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

relativeMountPath

string

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

BatchAllTasksCompleteMode

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

Значение Описание
noaction

Никакие действия не выполняются. Работа остаётся активной, если не была уволена или отключена каким-либо другим способом.

terminatejob

Уволить работу. Причина прекращения работы установлена в «Все задачи выполнены».

BatchApplicationPackageReference

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

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

string

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

version

string

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

BatchAutoPoolSpecification

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

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

string

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

keepAlive

boolean

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

pool

BatchPoolSpecification

Спецификация Pool для Auto Pool.

poolLifetimeOption

BatchPoolLifetimeOption

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

BatchContainerConfiguration

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

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

string[]

Коллекция имён изображений контейнеров. Это полная ссылка на изображение, как было бы указано в «docker pull». Изображение будет взято из стандартного реестра Docker, если только оно не полностью квалифицировано с альтернативным реестром.

containerRegistries

ContainerRegistryReference[]

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

type

ContainerType

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

BatchDiffDiskSettings

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

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

DiffDiskPlacement

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

BatchError

Получена ошибка от сервиса пакетная служба Azure.

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

string

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

message

BatchErrorMessage

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

values

BatchErrorDetail[]

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

BatchErrorDetail

Дополнительная информация, включённая в ответ на ошибку пакетная служба Azure.

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

string

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

value

string

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

BatchErrorMessage

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

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

string

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

value

string

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

BatchInboundNatPool

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

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

integer (int32)

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

frontendPortRangeEnd

integer (int32)

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

frontendPortRangeStart

integer (int32)

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

name

string

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

networkSecurityGroupRules

NetworkSecurityGroupRule[]

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

protocol

InboundEndpointProtocol

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

BatchJobConstraints

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

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

integer (int32)

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

maxWallClockTime

string (duration)

Максимальное прошедшее время, которое может выполнить Задание, измеряемое с момента её создания. Если задание не завершается в отведённое время, пакетная служба завершает её и все выполняющиеся задачи. В этом случае причиной прекращения будет MaxWallClockTimeExpiry. Если это свойство не указано, нет ограничения по времени на продолжительность Работы. Длительность времени указана в формате ISO 8601.

BatchJobCreateOptions

Parameters for creating an пакетная служба Azure Job.

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

boolean

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

commonEnvironmentSettings

EnvironmentSetting[]

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

constraints

BatchJobConstraints

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

displayName

string

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

id

string

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

jobManagerTask

BatchJobManagerTask

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

jobPreparationTask

BatchJobPreparationTask

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

jobReleaseTask

BatchJobReleaseTask

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

maxParallelTasks

integer (int32)

-1

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

metadata

BatchMetadataItem[]

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

networkConfiguration

BatchJobNetworkConfiguration

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

onAllTasksComplete

BatchAllTasksCompleteMode

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

onTaskFailure

BatchTaskFailureMode

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

poolInfo

BatchPoolInfo

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

priority

integer (int32)

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

usesTaskDependencies

boolean

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

BatchJobDefaultOrder

Enums BatchJobDefaultOrder

Значение Описание
none

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

creationtime

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

BatchJobManagerTask

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

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

boolean

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

applicationPackageReferences

BatchApplicationPackageReference[]

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

commandLine

string

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

constraints

BatchTaskConstraints

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

containerSettings

BatchTaskContainerSettings

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

displayName

string

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

environmentSettings

EnvironmentSetting[]

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

id

string

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

killJobOnCompletion

boolean

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

outputFiles

OutputFile[]

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

requiredSlots

integer (int32)

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

resourceFiles

ResourceFile[]

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

runExclusive

boolean

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

userIdentity

UserIdentity

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

BatchJobNetworkConfiguration

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

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

boolean

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

subnetId

string

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

BatchJobPreparationTask

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

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

string

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

constraints

BatchTaskConstraints

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

containerSettings

BatchTaskContainerSettings

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

environmentSettings

EnvironmentSetting[]

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

id

string

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

rerunOnNodeRebootAfterSuccess

boolean

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

resourceFiles

ResourceFile[]

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

userIdentity

UserIdentity

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

waitForSuccess

boolean

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

BatchJobReleaseTask

Задача выпуска задания для выполнения задания на любом вычислительном узле, где выполняется задание. Задача выпуска задания выполняется, когда задание заканчивается, из-за одного из следующих: пользователь вызывает API завершения задания или API удаления заданий, пока задание по-прежнему активно, достигнуто максимальное ограничение времени на стенные часы задания, а задание по-прежнему активно или задача диспетчера заданий завершена, и задание настроено на завершение после завершения диспетчера заданий. Задача выпуска задания выполняется на каждом узле, где выполняются задачи задания, а задача подготовки задания выполняется и завершена. Если вы повторно создайте узел после запуска задачи подготовки задания, а задание завершается без дальнейших задач задания, запущенного на этом узле (и, следовательно, задача подготовки задания не выполняется повторно), задача выпуска задания не запускается на этом вычислительном узле. Если узел перезагрузится, пока задача выпуска задания по-прежнему запущена, задача выпуска задания снова запускается при запуске вычислительного узла. Задание не помечается как завершенное до завершения всех задач выпуска задания. Задача выпуска задания выполняется в фоновом режиме. Он не занимает слот планирования; То есть он не учитывается в отношении ограничения taskSlotsPerNode, указанного в пуле.

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

string

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

containerSettings

BatchTaskContainerSettings

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

environmentSettings

EnvironmentSetting[]

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

id

string

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

maxWallClockTime

string (duration)

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

resourceFiles

ResourceFile[]

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

retentionTime

string (duration)

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

userIdentity

UserIdentity

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

BatchMetadataItem

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

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

string

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

value

string

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

BatchNodeFillType

BatchNodeFillType enums

Значение Описание
spread

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

pack

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

BatchNodeIdentityReference

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

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

string (arm-id)

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

BatchNodePlacementConfiguration

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

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

BatchNodePlacementPolicyType

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

BatchNodePlacementPolicyType

BatchNodePlacementPolicyType enums

Значение Описание
regional

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

zonal

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

BatchOsDisk

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

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

CachingType

Указывает требования к кэшированию. Возможные значения: None, ReadOnly, ReadWrite. Значения по умолчанию: нет для хранилища уровня "Стандартный". ReadOnly для хранилища Premium.

diskSizeGB

integer (int32)

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

ephemeralOSDiskSettings

BatchDiffDiskSettings

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

managedDisk

ManagedDisk

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

writeAcceleratorEnabled

boolean

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

BatchPoolEndpointConfiguration

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

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

BatchInboundNatPool[]

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

BatchPoolIdentityReference

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

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

string (arm-id)

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

BatchPoolInfo

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

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

BatchAutoPoolSpecification

Характеристики временного «автопула». Пакетная служба создаст этот автоматический пул при отправке задания. Если создание автоматического пула не удаётся, пакетная служба переводит задание в состояние завершения, и ошибка создания пула устанавливается в свойстве ошибки планирования Job. Пакетная служба управляет сроком жизни (как созданием, так и, если не указано keepAlive, удалением) автопула. Любые действия пользователя, влияющие на срок службы автопула, пока работа активна, приведут к неожиданному поведению. Вам нужно указать либо Pool ID, либо спецификацию Auto Pool, но не оба.

poolId

string

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

BatchPoolLifetimeOption

Enums BatchPoolLifetimeOption

Значение Описание
jobschedule

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

job

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

BatchPoolSpecification

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

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

BatchApplicationPackageReference[]

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

autoScaleEvaluationInterval

string (duration)

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

autoScaleFormula

string

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

displayName

string

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

enableAutoScale

boolean

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

enableInterNodeCommunication

boolean

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

metadata

BatchMetadataItem[]

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

mountConfiguration

MountConfiguration[]

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

networkConfiguration

NetworkConfiguration

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

resizeTimeout

string (duration)

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

startTask

BatchStartTask

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

targetDedicatedNodes

integer (int32)

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

targetLowPriorityNodes

integer (int32)

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

taskSchedulingPolicy

BatchTaskSchedulingPolicy

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

taskSlotsPerNode

integer (int32)

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

upgradePolicy

UpgradePolicy

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

userAccounts

UserAccount[]

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

virtualMachineConfiguration

VirtualMachineConfiguration

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

vmSize

string

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

BatchPublicIpAddressConfiguration

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

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

string[] (arm-id)

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

ipFamilies

IPFamily[]

Семейства IP-адресов, используемые для указания версий IP-адресов, доступных для пула. Семейства IP-адресов используются для определения пулов с одним или двумя стеками. Для одного стека ожидаемое значение — IPv4. Для двойного стека ожидаемые значения — IPv4 и IPv6.

ipTags

IPTag[]

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

provision

IpAddressProvisioningType

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

BatchStartTask

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

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

string

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

containerSettings

BatchTaskContainerSettings

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

environmentSettings

EnvironmentSetting[]

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

maxTaskRetryCount

integer (int32)

Максимальное количество повторных попыток задачи. Пакетная служба повторяет задачу, если его код выхода не является ненулевой. Обратите внимание, что это значение специально управляет числом повторных попыток. Пакетная служба попытается выполнить задачу один раз, а затем повторите попытку до этого ограничения. Например, если максимальное число повторных попыток равно 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.

BatchTaskConstraints

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

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

integer (int32)

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

maxWallClockTime

string (duration)

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

retentionTime

string (duration)

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

BatchTaskContainerSettings

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

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

ContainerHostBatchBindMountEntry[]

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

containerRunOptions

string

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

imageName

string

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

registry

ContainerRegistryReference

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

workingDirectory

ContainerWorkingDirectory

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

BatchTaskFailureMode

Enums TaskFailure

Значение Описание
noaction

Никакие действия не выполняются. Работа остаётся активной, если не была уволена или отключена каким-либо другим способом.

performexitoptionsjobaction

Уволить работу. Причина прекращения работы установлена в «Все задачи выполнены».

BatchTaskSchedulingPolicy

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

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

BatchJobDefaultOrder

none

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

nodeFillType

BatchNodeFillType

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

BatchUefiSettings

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

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

boolean

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

vTpmEnabled

boolean

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

BatchVmDiskSecurityProfile

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

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

SecurityEncryptionTypes

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

BatchVmImageReference

Ссылка на Виртуальные машины Azure Marketplace Image или Azure Compute Gallery Image. Чтобы получить список всех ссылок на изображения Azure Marketplace, проверенных пакетная служба Azure, смотрите операцию 'List Supported Images'.

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

string

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

exactVersion

string

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

offer

string

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

publisher

string

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

sharedGalleryImageId

string

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

sku

string

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

version

string

Версия изображения Виртуальные машины Azure Marketplace. Для выбора последней версии изображения можно задать значение 'lastest'. Если опущено, значение по умолчанию — "последняя".

virtualMachineImageId

string (arm-id)

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

CachingType

Энумы CachingType

Значение Описание
none

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

readonly

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

readwrite

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

CifsMountConfiguration

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

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

string

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

password

string (password)

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

relativeMountPath

string

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

source

string

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

username

string

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

ContainerHostBatchBindMountEntry

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

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

boolean

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

source

ContainerHostDataPath

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

ContainerHostDataPath

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

Значение Описание
Shared

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

Startup

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

VfsMounts

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

Task

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

JobPrep

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

Applications

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

ContainerRegistryReference

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

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

BatchNodeIdentityReference

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

password

string (password)

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

registryServer

string (uri)

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

username

string

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

ContainerType

ContainerType enums

Значение Описание
dockerCompatible

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

criCompatible

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

ContainerWorkingDirectory

ContainerWorkingDirectory enums

Значение Описание
taskWorkingDirectory

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

containerImageDefault

Используйте рабочую директорию, определённую в контейнере Image. Обратите внимание, что эта папка не будет содержать файлы ресурсов, загруженные Batch.

DataDisk

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

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

CachingType

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

diskSizeGB

integer (int32)

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

lun

integer (int32)

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

managedDisk

ManagedDisk

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

DiffDiskPlacement

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

Значение Описание
cachedisk

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

DiskCustomerManagedKey

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

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

BatchPoolIdentityReference

Ссылка на один из идентификаторов пула для шифрования диска. Это удостоверение будет использоваться для доступа к KeyVault.

keyUrl

string

Полный url-адрес ключа версии, указывающий на ключ в KeyVault. Сегмент версии URL-адреса требуется независимо от значения rotationToLatestKeyVersionEnabled.

rotationToLatestKeyVersionEnabled

boolean

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

DiskEncryptionConfiguration

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

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

DiskCustomerManagedKey

Ссылка на ключ, управляемый клиентом, для шифрования диска ОС. Ключ, управляемый клиентом, зашифрует диск ОС с помощью EncryptionAtRest, и по умолчанию мы также зашифруем диск с данными. Его можно использовать только в том случае, если пул настроен с помощью удостоверения и OsDisk установлен в качестве одного из целевых объектов DiskEncryption.

targets

DiskEncryptionTarget[]

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

DiskEncryptionSetParameters

Идентификатор ресурса ARM набора шифрования диска.

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

string (arm-id)

Идентификатор ресурса ARM набора шифрования диска. Ресурс должен находиться в той же подписке, что и аккаунт пакетной службы.

DiskEncryptionTarget

Enums DiskEncryptionTarget

Значение Описание
osdisk

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

temporarydisk

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

DynamicVNetAssignmentScope

DynamicVNetAssignmentScope enums

Значение Описание
none

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

job

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

ElevationLevel

Enums ElevationLevel

Значение Описание
nonadmin

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

admin

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

EnvironmentSetting

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

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

string

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

value

string

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

HostEndpointSettings

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

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

string

Указывает ссылку на идентификатор ресурса InVMAccessControlProfileVersion в виде /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Майкрософт. Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version}.

mode

HostEndpointSettingsModeTypes

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

HostEndpointSettingsModeTypes

HostEndpointSettingsModeTypes enums

Значение Описание
Audit

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

Enforce

Режим принудительного применения — рекомендуемый режим работы, и система будет применять политику контроля доступа. Это свойство нельзя использовать вместе с 'inVMAccessControlProfileReferenceId'.

InboundEndpointProtocol

Enums InboundEndpointProtocol

Значение Описание
tcp

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

udp

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

IpAddressProvisioningType

IPAddressProvisioningType enums

Значение Описание
batchmanaged

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

usermanaged

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

nopublicipaddresses

Публичный IP-адрес не будет создан.

IPFamily

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

Значение Описание
IPv4

IPv4 доступен для пула.

IPv6

IPv6 доступен для пула.

IPTag

Содержит тег IP, связанный с общедоступным IP-адресом.

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

string

Тип IP-тега. Пример: FirstPartyUsage.

tag

string

Значение тега IP, связанного с общедоступным IP-адресом. Пример: SQL.

LinuxUserConfiguration

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

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

integer (int32)

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

sshPrivateKey

string (password)

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

uid

integer (int32)

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

LoginMode

Enums LoginMode

Значение Описание
batch

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

interactive

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

ManagedDisk

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

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

DiskEncryptionSetParameters

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

securityProfile

BatchVmDiskSecurityProfile

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

storageAccountType

StorageAccountType

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

MountConfiguration

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

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

AzureBlobFileSystemConfiguration

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

azureFileShareConfiguration

AzureFileShareConfiguration

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

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

BatchPoolEndpointConfiguration

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

publicIPAddressConfiguration

BatchPublicIpAddressConfiguration

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

subnetId

string

Идентификатор ресурса ARM подсети виртуальной сети, к которой присоединяются вычислительные узлы пула. Это форма /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}}. Виртуальная сеть должна находиться в том же регионе и подписке, что и аккаунт пакетная служба Azure. Указанная подсеть должна иметь достаточно свободных IP-адресов для размещения количества вычислительных узлов в пуле. Если в подсети недостаточно свободных IP-адресов, пул частично выделит узлы, и возникает ошибка изменения размера. Принципал сервиса 'MicrosoftAzureBatch' должен иметь роль 'Classic Virtual Machine Contributor' Role-Based контроль доступа (RBAC) для указанной VNet. Указанная подсеть должна обеспечивать связь из сервиса пакетная служба Azure для планирования задач на узлах. Это можно проверить, проверьте, имеет ли указанная виртуальная сеть любые связанные группы безопасности сети (NSG). Если связь с узлами в указанной подсети запрещена группой безопасности сети, служба пакетной службы установит состояние вычислительных узлов неиспользуемым. Только виртуальные сети ARM ('Майкрософт. Поддерживаются Network/virtualNetworks'). Если в указанной VNet есть соответствующие группы сетевой безопасности (NSG), то для входящей связи необходимо включить несколько зарезервированных системных портов, включая порты 29876 и 29877. Также включите исходящие соединения с служба хранилища Azure на порте 443. Дополнительные сведения см. в статье https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

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

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

NetworkSecurityGroupRuleAccess

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

priority

integer (int32)

Приоритет для этого правила. Приоритеты внутри пула должны быть уникальными и оцениваться в порядке приоритета. Чем ниже число, тем выше приоритет. Например, правила можно указать с номерами заказов 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

NetworkSecurityGroupRuleAccess enums

Значение Описание
allow

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

deny

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

NfsMountConfiguration

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

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

string

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

relativeMountPath

string

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

source

string

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

OutputFile

При каждой отправке файлов пакетная служба записывает два файла журнала на вычислительный узелfileuploadout.txtиfileuploaderr.txt. Эти файлы журналов используются для получения дополнительных сведений о конкретном сбое.

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

OutputFileDestination

Пункт назначения для выходных файлов.

filePattern

string

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

uploadOptions

OutputFileUploadConfig

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

OutputFileBlobContainerDestination

Указывает место для загрузки файла внутри хранилища blob Azure.

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

string (uri)

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

identityReference

BatchNodeIdentityReference

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

path

string

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

uploadHeaders

OutputFileUploadHeader[]

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

OutputFileDestination

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

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

OutputFileBlobContainerDestination

Место в хранилище blob Azure, куда загружаются файлы.

OutputFileUploadCondition

Enums OutputFileUploadCondition

Значение Описание
tasksuccess

Загружайте файл(ы) только после выхода процесса задачи с кодом выхода 0.

taskfailure

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

taskcompletion

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

OutputFileUploadConfig

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

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

OutputFileUploadCondition

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

OutputFileUploadHeader

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

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

string

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

value

string

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

ProxyAgentSettings

Задает параметры ProxyAgent при создании виртуальной машины.

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

boolean

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

imds

HostEndpointSettings

Настройки для конечной точки IMDS.

wireServer

HostEndpointSettings

Параметры конечной точки WireServer.

ResourceFile

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

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

string

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

blobPrefix

string

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

fileMode

string

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

filePath

string

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

httpUrl

string (uri)

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

identityReference

BatchNodeIdentityReference

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

storageContainerUrl

string (uri)

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

RollingUpgradePolicy

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

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

boolean

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

maxBatchInstancePercent

integer (int32)

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

maxUnhealthyInstancePercent

integer (int32)

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

maxUnhealthyUpgradedInstancePercent

integer (int32)

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

pauseTimeBetweenBatches

string (duration)

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

prioritizeUnhealthyInstances

boolean

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

rollbackFailedInstancesOnPolicyBreach

boolean

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

SecurityEncryptionTypes

Enums SecurityEncryptionTypes

Значение Описание
DiskWithVMGuestState

Для параметра EncryptionType управляемого диска задано значение DiskWithVMGuestState для шифрования управляемого диска вместе с большим двоичным объектом VMGuestState. Он не поддерживается в дисках с данными.

NonPersistedTPM

Для параметра EncryptionType управляемого диска задано значение NonPersistedTPM, чтобы состояние встроенного ПО не сохранялось в большом двоичном объекте VMGuestState.

VMGuestStateOnly

Для параметра EncryptionType управляемого диска задано значение VMGuestStateOnly для шифрования только большого двоичного объекта VMGuestState.

SecurityProfile

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

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

boolean

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

proxyAgentSettings

ProxyAgentSettings

Задает параметры ProxyAgent при создании виртуальной машины.

securityType

SecurityTypes

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

uefiSettings

BatchUefiSettings

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

SecurityTypes

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

Значение Описание
trustedLaunch

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

confidentialvm

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

ServiceArtifactReference

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

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

string

Идентификатор ссылки на сервисный артефакт в ServiceArtifactReference. Идентификатор артефакта сервиса в виде /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Майкрософт. Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

StorageAccountType

Перечисления StorageAccountType

Значение Описание
standard_lrs

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

premium_lrs

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

standardssd_lrs

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

UpgradeMode

Enums UpgradeMode

Значение Описание
automatic

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

manual

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

rolling

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

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

windowsUserConfiguration

WindowsUserConfiguration

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

UserIdentity

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

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

AutoUserSpecification

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

username

string

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

VirtualMachineConfiguration

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

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

BatchContainerConfiguration

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

dataDisks

DataDisk[]

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

diskEncryptionConfiguration

DiskEncryptionConfiguration

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

extensions

VMExtension[]

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

imageReference

BatchVmImageReference

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

licenseType

string

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

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

nodeAgentSKUId

string

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

nodePlacementConfiguration

BatchNodePlacementConfiguration

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

osDisk

BatchOsDisk

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

securityProfile

SecurityProfile

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

serviceArtifactReference

ServiceArtifactReference

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

windowsConfiguration

WindowsConfiguration

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

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

Режим входа для пользователя. По умолчанию — «пакет».