Job - Add
Добавляет задание в указанную учетную запись.
Пакетная служба поддерживает два способа управления работой, выполняемой в рамках задания. В первом подходе пользователь указывает задачу диспетчера заданий. Пакетная служба запускает эту задачу, когда она будет готова к запуску задания. Задача диспетчера заданий управляет всеми остальными задачами, выполняемыми в рамках этого задания, с помощью API задач. Во втором подходе пользователь непосредственно управляет выполнением задач в активном задании с помощью API задач. Также обратите внимание: при именовании заданий не следует включать конфиденциальную информацию, например имена пользователей или имена секретных проектов. Эти сведения могут отображаться в журналах телеметрии, доступных инженерам службы поддержки Майкрософт.
POST {batchUrl}/jobs?api-version=2023-11-01.18.0
POST {batchUrl}/jobs?timeout={timeout}&api-version=2023-11-01.18.0
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
batch
|
path | True |
string |
Базовый URL-адрес для всех пакетная служба Azure запросов на обслуживание. |
api-version
|
query | True |
string |
Версия API клиента. |
timeout
|
query |
integer int32 |
Максимальное время, которое сервер может потратить на обработку запроса, в секундах. По умолчанию это 30 секунд. |
Заголовок запроса
Media Types: "application/json; odata=minimalmetadata"
Имя | Обязательно | Тип | Описание |
---|---|---|---|
client-request-id |
string uuid |
Удостоверение запроса, созданное вызывающим абонентом, в виде GUID без оформления, например фигурные скобки, например 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Должен ли сервер возвращать идентификатор client-request-id в ответе. |
|
ocp-date |
string date-time-rfc1123 |
Время выдачи запроса. Клиентские библиотеки обычно устанавливают текущее системное время; задайте его явным образом, если вы вызываете REST API напрямую. |
Текст запроса
Media Types: "application/json; odata=minimalmetadata"
Имя | Обязательно | Тип | Описание |
---|---|---|---|
id | True |
string |
Строка, однозначно идентифицирующая задание в учетной записи. |
poolInfo | True |
Пул, в котором пакетная служба выполняет задачи задания. |
|
allowTaskPreemption |
boolean |
Можно ли вытеснять задачи в этом задании другими высокоприоритетными заданиями |
|
commonEnvironmentSettings |
Список общих параметров переменных среды. Эти переменные среды задаются для всех задач в задании (включая диспетчер заданий, задачи подготовки заданий и задачи выпуска задания). |
||
constraints |
Ограничения выполнения для задания. |
||
displayName |
string |
Отображаемое имя задания. |
|
jobManagerTask |
Сведения о задаче диспетчера заданий, запускаемой при запуске задания. |
||
jobPreparationTask |
Задача подготовки задания. |
||
jobReleaseTask |
Задача выпуска задания. |
||
maxParallelTasks |
integer |
Максимальное количество задач, которые могут выполняться параллельно для задания. |
|
metadata |
Список пар "имя-значение", связанных с заданием в качестве метаданных. |
||
networkConfiguration |
Конфигурация сети для задания. |
||
onAllTasksComplete |
Действие, которое должна выполнять пакетная служба, если все задачи в задании находятся в состоянии завершения. |
||
onTaskFailure |
Действие, выполняемого пакетной службой при сбое любой задачи в задании. |
||
priority |
integer |
Приоритет задания. |
|
usesTaskDependencies |
boolean |
Могут ли задачи в задании определять зависимости друг от друга. Значение по умолчанию — false. |
Ответы
Имя | Тип | Описание |
---|---|---|
201 Created |
Запрос к пакетной службе выполнен успешно. Заголовки
|
|
Other Status Codes |
Ошибка из пакетной службы. |
Безопасность
azure_auth
поток кода проверки подлинности Microsoft Entra OAuth 2.0
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
Имя | Описание |
---|---|
user_impersonation | Олицетворение учетной записи пользователя |
Authorization
Тип:
apiKey
В:
header
Примеры
Add a basic job |
Add a complex job |
Add a basic job
Образец запроса
POST account.region.batch.azure.com/jobs?api-version=2023-11-01.18.0
{
"id": "jobId",
"priority": 0,
"poolInfo": {
"poolId": "poolId"
}
}
Пример ответа
Add a complex job
Образец запроса
POST account.region.batch.azure.com/jobs?api-version=2023-11-01.18.0
{
"id": "jobId",
"priority": 100,
"constraints": {
"maxWallClockTime": "PT1H",
"maxTaskRetryCount": -1
},
"jobManagerTask": {
"id": "taskId",
"commandLine": "myprogram.exe",
"resourceFiles": [
{
"httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram.exe?sas",
"filePath": "myprogram.exe"
},
{
"storageContainerUrl": "http://mystorage1.blob.core.windows.net/data?sas",
"filePath": "datafolder"
}
],
"environmentSettings": [
{
"name": "myvariable",
"value": "myvalue"
}
],
"constraints": {
"maxWallClockTime": "PT1H",
"maxTaskRetryCount": 0,
"retentionTime": "PT1H"
},
"requiredSlots": 2,
"killJobOnCompletion": false,
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "admin"
}
},
"runExclusive": true
},
"poolInfo": {
"autoPoolSpecification": {
"autoPoolIdPrefix": "mypool",
"poolLifetimeOption": "job",
"pool": {
"vmSize": "small",
"cloudServiceConfiguration": {
"osFamily": "4",
"osVersion": "*"
},
"resizeTimeout": "PT15M",
"targetDedicatedNodes": 3,
"targetLowPriorityNodes": 0,
"taskSlotsPerNode": 2,
"taskSchedulingPolicy": {
"nodeFillType": "spread"
},
"enableAutoScale": false,
"enableInterNodeCommunication": true,
"startTask": {
"commandLine": "myprogram2.exe",
"resourceFiles": [
{
"httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram2.exe?sas",
"filePath": "myprogram2.exe"
}
],
"environmentSettings": [
{
"name": "myvariable",
"value": "myvalue"
}
],
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "admin"
}
},
"maxTaskRetryCount": 2,
"waitForSuccess": true
},
"certificateReferences": [
{
"thumbprint": "0123456789abcdef0123456789abcdef01234567",
"thumbprintAlgorithm": "sha1",
"storeLocation": "localmachine",
"storeName": "Root",
"visibility": [
"task"
]
}
],
"metadata": [
{
"name": "myproperty",
"value": "myvalue"
}
],
"targetNodeCommunicationMode": "default"
}
}
},
"metadata": [
{
"name": "myproperty",
"value": "myvalue"
}
]
}
Пример ответа
Определения
Имя | Описание |
---|---|
Access |
Ресурсы пакетной службы, к которым маркер предоставляет доступ. |
Application |
Ссылка на пакет, развертываемый на вычислительных узлах. |
Authentication |
Параметры маркера проверки подлинности, который задача может использовать для выполнения операций пакетной службы. |
Auto |
Задает характеристики для временного "автоматического пула". Пакетная служба создаст этот автоматический пул при отправке задания. |
Auto |
область для автоматического пользователя |
Auto |
Задает параметры для автоматического пользователя, который запускает задачу в пакетной службе. |
Azure |
Сведения, используемые для подключения к контейнеру службы хранилища Azure с помощью Blobfuse. |
Azure |
Сведения, используемые для подключения к общей папке Azure. |
Batch |
Ответ об ошибке, полученный от службы пакетная служба Azure. |
Batch |
Элемент с дополнительными сведениями, включенными в ответ на ошибку пакетная служба Azure. |
Caching |
Тип кэширования, который необходимо включить для диска. |
Certificate |
Ссылка на сертификат, устанавливаемый на вычислительные узлы в пуле. |
Certificate |
Расположение хранилища сертификатов на вычислительном узле, в котором устанавливается сертификат. |
Certificate |
Какие учетные записи пользователей на вычислительном узле должны иметь доступ к частным данным сертификата. |
CIFSMount |
Сведения, используемые для подключения к файловой системе CIFS. |
Cloud |
Конфигурация для вычислительных узлов в пуле на основе платформы Azure Облачные службы. |
Compute |
Распределение задач между вычислительными узлами в пуле. |
Compute |
Ссылка на назначенное пользователем удостоверение, связанное с пулом пакетной службы, которое будет использоваться вычислительным узлом. |
Container |
Конфигурация для пулов с поддержкой контейнеров. |
Container |
Частный реестр контейнеров. |
Container |
Используемая технология контейнера. |
Container |
Расположение рабочего каталога задачи контейнера. |
Data |
Параметры, которые будут использоваться дисками данных, связанными с вычислительными узлами в пуле. При использовании подключенных дисков данных необходимо подключить и отформатировать диски в виртуальной машине, чтобы использовать их. |
Diff |
Указывает временное размещение диска операционной системы для всех вычислительных узлов (виртуальных машин) в пуле. |
Diff |
Задает временные параметры диска для диска операционной системы, используемого вычислительным узлом (ВМ). |
Disk |
Конфигурация шифрования дисков, примененная к вычислительным узлам в пуле. Конфигурация шифрования дисков не поддерживается в пуле Linux, созданном с помощью образа коллекции вычислений Azure. |
Disk |
Список целевых дисков пакетная служба будет шифровать на вычислительном узле. |
Dynamic |
область динамического назначения виртуальной сети. |
Elevation |
Уровень прав пользователя. |
Environment |
Переменная среды, устанавливаемая в процессе задачи. |
Error |
Сообщение об ошибке, полученное в ответе об ошибке пакетная служба Azure. |
Http |
Пара "имя-значение" заголовка HTTP |
Image |
Ссылка на образ Azure Виртуальные машины Marketplace или образ коллекции вычислений Azure. Чтобы получить список всех Azure Marketplace ссылок на образы, проверенные пакетная служба Azure, см. операцию "Список поддерживаемых образов". |
Inbound |
Протокол конечной точки. |
Inbound |
Пул NAT для входящего трафика, который можно использовать для обращения к определенным портам на вычислительных узлах в пуле пакетной службы извне. |
IPAddress |
Тип подготовки для общедоступных IP-адресов пула. |
Job |
Добавляемое задание пакетная служба Azure. |
Job |
Ограничения выполнения для задания. |
Job |
Указывает сведения о задаче диспетчера заданий. |
Job |
Конфигурация сети для задания. |
Job |
Задача подготовки задания, выполняемая перед любыми задачами задания на любом вычислительном узле. |
Job |
Задача выпуска задания, выполняемая при завершении задания на любом вычислительном узле, где было запущено задание. |
Linux |
Свойства, используемые для создания учетной записи пользователя на вычислительном узле Linux. |
Login |
Режим входа для пользователя |
Managed |
|
Metadata |
Пара "имя-значение", связанная с ресурсом пакетной службы. |
Mount |
Файловая система для подключения к каждому узлу. |
Network |
Конфигурация сети для пула. |
Network |
Правило группы безопасности сети для применения к входящей конечной точке. |
Network |
Действие, которое необходимо выполнить для указанного IP-адреса, диапазона подсети или тега. |
NFSMount |
Сведения, используемые для подключения к файловой системе NFS. |
Node |
Определяет, как пул взаимодействует с пакетной службой. |
Node |
Конфигурация размещения узла для пула. |
Node |
Политика размещения для выделения узлов в пуле. |
On |
Действие, которое пакетная служба должна выполнять, когда все задачи в задании находятся в состоянии завершения. |
On |
Действие, выполняемого пакетной службой при сбое любой задачи в задании. |
OSDisk |
Параметры диска операционной системы вычислительного узла (ВМ). |
Output |
Спецификация для отправки файлов из вычислительного узла пакетная служба Azure в другое расположение после того, как пакетная служба завершит выполнение процесса задачи. |
Output |
Указывает назначение отправки файлов в контейнере хранилища BLOB-объектов Azure. |
Output |
Место назначения, в которое должен быть отправлен файл. |
Output |
Условия, при которых должен отправляться выходной файл задачи или набор файлов. |
Output |
Сведения об операции отправки выходных файлов, в том числе о том, при каких условиях следует выполнить отправку. |
Pool |
Конфигурация конечной точки для пула. |
Pool |
Указывает, как задание должно быть назначено пулу. |
Pool |
Минимальное время существования созданных автоматических пулов и назначение пулам нескольких заданий по расписанию. |
Pool |
Спецификация для создания нового пула. |
Public |
Конфигурация общедоступного IP-адреса конфигурации сети пула. |
Resource |
Один файл или несколько файлов для загрузки на вычислительный узел. |
Security |
Задает параметры профиля безопасности для виртуальной машины или масштабируемого набора виртуальных машин. |
Security |
Указывает тип безопасности виртуальной машины. Для включения UefiSettings ему необходимо задать любое указанное значение. |
Service |
Указывает идентификатор ссылки на артефакт службы, используемый для задания одинаковой версии образа для всех виртуальных машин в масштабируемом наборе при использовании последней версии образа. |
Start |
Задача, которая выполняется при присоединении узла к пулу в службе пакетная служба Azure либо при перезагрузке или повторном создании образа вычислительного узла. |
Storage |
Тип учетной записи хранения, используемый при создании дисков данных или диска ОС. |
Task |
Ограничения выполнения, применяемые к задаче. |
Task |
Параметры контейнера для задачи. |
Task |
Указывает, как задачи должны распределяться между вычислительными узлами. |
Uefi |
Указывает параметры безопасности, такие как безопасная загрузка и vTPM, используемые при создании виртуальной машины. |
User |
Свойства, используемые для создания пользователя, используемого для выполнения задач на пакетная служба Azure вычислительном узле. |
User |
Определение удостоверения пользователя, с которым выполняется задача. |
Virtual |
Конфигурация вычислительных узлов в пуле на основе инфраструктуры azure Виртуальные машины. |
VMExtension |
Конфигурация для расширений виртуальных машин. |
Windows |
Параметры операционной системы Windows, применяемые к виртуальной машине. |
Windows |
Свойства, используемые для создания учетной записи пользователя на вычислительном узле Windows. |
AccessScope
Ресурсы пакетной службы, к которым маркер предоставляет доступ.
Имя | Тип | Описание |
---|---|---|
job |
string |
Предоставляет доступ для выполнения всех операций с заданием, содержащим задачу. |
ApplicationPackageReference
Ссылка на пакет, развертываемый на вычислительных узлах.
Имя | Тип | Описание |
---|---|---|
applicationId |
string |
Идентификатор развертываемого приложения. |
version |
string |
Версия развертываемого приложения. Если этот параметр опущен, развертывается версия по умолчанию. |
AuthenticationTokenSettings
Параметры маркера проверки подлинности, который задача может использовать для выполнения операций пакетной службы.
Имя | Тип | Описание |
---|---|---|
access |
Ресурсы пакетной службы, к которым маркер предоставляет доступ. |
AutoPoolSpecification
Задает характеристики для временного "автоматического пула". Пакетная служба создаст этот автоматический пул при отправке задания.
Имя | Тип | Описание |
---|---|---|
autoPoolIdPrefix |
string |
Префикс, добавляемый к уникальному идентификатору при автоматическом создании пула. |
keepAlive |
boolean |
Следует ли сохранять автоматический пул в активном состоянии по истечении срока его существования. |
pool |
Спецификация пула для автоматического пула. |
|
poolLifetimeOption |
Минимальное время существования созданных автоматических пулов и назначение пулам нескольких заданий по расписанию. |
AutoUserScope
область для автоматического пользователя
Имя | Тип | Описание |
---|---|---|
pool |
string |
Указывает, что задача выполняется как общая автоматическая учетная запись пользователя, которая создается на каждом вычислительном узле в пуле. |
task |
string |
Указывает, что служба должна создать пользователя для задачи. |
AutoUserSpecification
Задает параметры для автоматического пользователя, который запускает задачу в пакетной службе.
Имя | Тип | Описание |
---|---|---|
elevationLevel |
Уровень прав автоматического пользователя. |
|
scope |
область для автоматического пользователя |
AzureBlobFileSystemConfiguration
Сведения, используемые для подключения к контейнеру службы хранилища Azure с помощью Blobfuse.
Имя | Тип | Описание |
---|---|---|
accountKey |
string |
Ключ учетной записи хранения Azure. |
accountName |
string |
Имя учетной записи хранения Azure. |
blobfuseOptions |
string |
Дополнительные параметры командной строки для передачи в команду подключения. |
containerName |
string |
Имя контейнера Хранилище BLOB-объектов Azure. |
identityReference |
Ссылка на назначенное пользователем удостоверение для доступа к containerName |
|
relativeMountPath |
string |
Относительный путь на вычислительном узле, к которому будет подключена файловая система. |
sasKey |
string |
Маркер SAS службы хранилища Azure. |
AzureFileShareConfiguration
Сведения, используемые для подключения к общей папке Azure.
Имя | Тип | Описание |
---|---|---|
accountKey |
string |
Ключ учетной записи хранения Azure. |
accountName |
string |
Имя учетной записи хранения Azure. |
azureFileUrl |
string |
URL-адрес Файлы Azure. |
mountOptions |
string |
Дополнительные параметры командной строки для передачи в команду подключения. |
relativeMountPath |
string |
Относительный путь на вычислительном узле, к которому будет подключена файловая система. |
BatchError
Ответ об ошибке, полученный от службы пакетная служба Azure.
Имя | Тип | Описание |
---|---|---|
code |
string |
Идентификатор ошибки. Коды инвариантны и предназначены для программного использования. |
message |
Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе. |
|
values |
Коллекция пар "ключ-значение", содержащих дополнительные сведения об ошибке. |
BatchErrorDetail
Элемент с дополнительными сведениями, включенными в ответ на ошибку пакетная служба Azure.
Имя | Тип | Описание |
---|---|---|
key |
string |
Идентификатор, указывающий значение свойства Value. |
value |
string |
Дополнительные сведения, включенные в ответ об ошибке. |
CachingType
Тип кэширования, который необходимо включить для диска.
Имя | Тип | Описание |
---|---|---|
none |
string |
Режим кэширования для диска не включен. |
readonly |
string |
Режим кэширования для диска доступен только для чтения. |
readwrite |
string |
Режим кэширования для диска — чтение и запись. |
CertificateReference
Ссылка на сертификат, устанавливаемый на вычислительные узлы в пуле.
Имя | Тип | Описание |
---|---|---|
storeLocation |
Расположение хранилища сертификатов на вычислительном узле, в котором устанавливается сертификат. |
|
storeName |
string |
Имя хранилища сертификатов на вычислительном узле, в который устанавливается сертификат. |
thumbprint |
string |
Отпечаток сертификата. |
thumbprintAlgorithm |
string |
Алгоритм, с которым связан отпечаток. Это должно быть sha1. |
visibility |
Какие учетные записи пользователей на вычислительном узле должны иметь доступ к частным данным сертификата. |
CertificateStoreLocation
Расположение хранилища сертификатов на вычислительном узле, в котором устанавливается сертификат.
Имя | Тип | Описание |
---|---|---|
currentuser |
string |
Сертификаты должны быть установлены в хранилище сертификатов CurrentUser. |
localmachine |
string |
Сертификаты должны быть установлены в хранилище сертификатов LocalMachine. |
CertificateVisibility
Какие учетные записи пользователей на вычислительном узле должны иметь доступ к частным данным сертификата.
Имя | Тип | Описание |
---|---|---|
remoteuser |
string |
Сертификат должен быть виден учетным записям пользователей, с помощью которых пользователи удаленно получают доступ к вычислительному узлу. |
starttask |
string |
Сертификат должен быть виден учетной записи пользователя, под которой выполняется StartTask. Обратите внимание, что если областью автопользователя является Пул для начальной задачи и задачи, этот сертификат будет виден и для задачи. |
task |
string |
Сертификат должен быть виден учетным записям пользователей, с которыми выполняются задачи задания. |
CIFSMountConfiguration
Сведения, используемые для подключения к файловой системе CIFS.
Имя | Тип | Описание |
---|---|---|
mountOptions |
string |
Дополнительные параметры командной строки для передачи в команду подключения. |
password |
string |
Пароль, используемый для проверки подлинности в файловой системе CIFS. |
relativeMountPath |
string |
Относительный путь на вычислительном узле, к которому будет подключена файловая система. |
source |
string |
Универсальный код ресурса (URI) подключаемой файловой системы. |
username |
string |
Пользователь, используемый для проверки подлинности в файловой системе CIFS. |
CloudServiceConfiguration
Конфигурация для вычислительных узлов в пуле на основе платформы Azure Облачные службы.
Имя | Тип | Описание |
---|---|---|
osFamily |
string |
Семейство гостевых ОС Azure, устанавливаемое на виртуальных машинах в пуле. |
osVersion |
string |
Версия гостевой ОС Azure, устанавливаемая на виртуальных машинах в пуле. |
ComputeNodeFillType
Распределение задач между вычислительными узлами в пуле.
Имя | Тип | Описание |
---|---|---|
pack |
string |
Как можно больше задач (taskSlotsPerNode) должно быть назначено каждому вычислительному узлу в пуле, прежде чем все задачи будут назначены следующему вычислительному узлу в пуле. |
spread |
string |
Задачи должны назначаться равномерно на всех вычислительных узлах в пуле. |
ComputeNodeIdentityReference
Ссылка на назначенное пользователем удостоверение, связанное с пулом пакетной службы, которое будет использоваться вычислительным узлом.
Имя | Тип | Описание |
---|---|---|
resourceId |
string |
Идентификатор ресурса ARM для удостоверения, назначаемого пользователем. |
ContainerConfiguration
Конфигурация для пулов с поддержкой контейнеров.
Имя | Тип | Описание |
---|---|---|
containerImageNames |
string[] |
Коллекция имен образов контейнера. |
containerRegistries |
Дополнительные частные реестры, из которых можно извлечь контейнеры. |
|
type |
Используемая технология контейнера. |
ContainerRegistry
Частный реестр контейнеров.
Имя | Тип | Описание |
---|---|---|
identityReference |
Ссылка на назначенное пользователем удостоверение, используемое для доступа к Реестр контейнеров Azure вместо имени пользователя и пароля. |
|
password |
string |
Пароль для входа на сервер реестра. |
registryServer |
string |
URL-адрес реестра. |
username |
string |
Имя пользователя для входа на сервер реестра. |
ContainerType
Используемая технология контейнера.
Имя | Тип | Описание |
---|---|---|
criCompatible |
string |
Для запуска контейнеров будет использоваться технология на основе CRI. |
dockerCompatible |
string |
Для запуска контейнеров будет использоваться технология контейнеров, совместимая с Docker. |
ContainerWorkingDirectory
Расположение рабочего каталога задачи контейнера.
Имя | Тип | Описание |
---|---|---|
containerImageDefault |
string |
Используйте рабочий каталог, определенный в образе контейнера. Помните, что этот каталог не будет содержать файлы ресурсов, скачанные пакетной службой. |
taskWorkingDirectory |
string |
Используйте стандартный рабочий каталог задачи пакетной службы, который будет содержать файлы ресурсов задачи, заполненные пакетной службой. |
DataDisk
Параметры, которые будут использоваться дисками данных, связанными с вычислительными узлами в пуле. При использовании подключенных дисков данных необходимо подключить и отформатировать диски в виртуальной машине, чтобы использовать их.
Имя | Тип | Описание |
---|---|---|
caching |
Тип кэширования, включаемого для дисков данных. |
|
diskSizeGB |
integer |
Начальный размер диска в гигабайтах. |
lun |
integer |
Номер логической единицы. |
storageAccountType |
Тип учетной записи хранения, используемый для диска данных. |
DiffDiskPlacement
Указывает временное размещение диска операционной системы для всех вычислительных узлов (виртуальных машин) в пуле.
Имя | Тип | Описание |
---|---|---|
CacheDisk |
string |
Временный диск ОС хранится в кэше виртуальной машины. |
DiffDiskSettings
Задает временные параметры диска для диска операционной системы, используемого вычислительным узлом (ВМ).
Имя | Тип | Описание |
---|---|---|
placement |
Указывает временное размещение диска операционной системы для всех виртуальных машин в пуле. |
DiskEncryptionConfiguration
Конфигурация шифрования дисков, примененная к вычислительным узлам в пуле. Конфигурация шифрования дисков не поддерживается в пуле Linux, созданном с помощью образа коллекции вычислений Azure.
Имя | Тип | Описание |
---|---|---|
targets |
Список целевых дисков пакетная служба будет шифровать на вычислительном узле. |
DiskEncryptionTarget
Список целевых дисков пакетная служба будет шифровать на вычислительном узле.
Имя | Тип | Описание |
---|---|---|
osdisk |
string |
Диск ОС на вычислительном узле зашифрован. |
temporarydisk |
string |
Временный диск на вычислительном узле зашифрован. В Linux это шифрование применяется к другим секциям (например, к подключенным дискам данных), когда шифрование происходит во время загрузки. |
DynamicVNetAssignmentScope
область динамического назначения виртуальной сети.
Имя | Тип | Описание |
---|---|---|
job |
string |
Динамическое назначение виртуальной сети выполняется для каждого задания. |
none |
string |
Динамическое назначение виртуальной сети не включено. |
ElevationLevel
Уровень прав пользователя.
Имя | Тип | Описание |
---|---|---|
admin |
string |
Пользователь является пользователем с повышенным уровнем доступа и работает с полными разрешениями администратора. |
nonadmin |
string |
Пользователь является обычным пользователем без повышенных прав доступа. |
EnvironmentSetting
Переменная среды, устанавливаемая в процессе задачи.
Имя | Тип | Описание |
---|---|---|
name |
string |
Имя переменной среды. |
value |
string |
Значение переменной среды. |
ErrorMessage
Сообщение об ошибке, полученное в ответе об ошибке пакетная служба Azure.
Имя | Тип | Описание |
---|---|---|
lang |
string |
Код языка сообщения об ошибке |
value |
string |
Текст сообщения. |
HttpHeader
Пара "имя-значение" заголовка HTTP
Имя | Тип | Описание |
---|---|---|
name |
string |
Имя заголовка без учета регистра, которое будет использоваться при отправке выходных файлов |
value |
string |
Значение заголовка, используемого при отправке выходных файлов |
ImageReference
Ссылка на образ Azure Виртуальные машины Marketplace или образ коллекции вычислений Azure. Чтобы получить список всех Azure Marketplace ссылок на образы, проверенные пакетная служба Azure, см. операцию "Список поддерживаемых образов".
Имя | Тип | Описание |
---|---|---|
exactVersion |
string |
Конкретная версия образа платформы или образа Marketplace, используемого для создания узла. Это поле , доступное только для чтения, отличается от "version" только в том случае, если значение , указанное для "version" при создании пула, было "latest". |
offer |
string |
Тип предложения образа Azure Виртуальные машины Marketplace. |
publisher |
string |
Издатель образа Azure Виртуальные машины Marketplace. |
sku |
string |
Номер SKU образа Azure Виртуальные машины Marketplace. |
version |
string |
Версия образа Azure Виртуальные машины Marketplace. |
virtualMachineImageId |
string |
Идентификатор ресурса ARM образа коллекции вычислений Azure. Вычислительные узлы в пуле будут созданы с помощью этого идентификатора образа. Он имеет форму /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} или /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName} для использования по умолчанию последней версии образа. |
InboundEndpointProtocol
Протокол конечной точки.
Имя | Тип | Описание |
---|---|---|
tcp |
string |
Используйте TCP для конечной точки. |
udp |
string |
Используйте UDP для конечной точки. |
InboundNATPool
Пул NAT для входящего трафика, который можно использовать для обращения к определенным портам на вычислительных узлах в пуле пакетной службы извне.
Имя | Тип | Описание |
---|---|---|
backendPort |
integer |
Номер порта на вычислительном узле. |
frontendPortRangeEnd |
integer |
Последний номер порта в диапазоне внешних портов, который будет использоваться для предоставления входящего доступа к внутреннему порту на отдельных вычислительных узлах. |
frontendPortRangeStart |
integer |
Первый номер порта в диапазоне внешних портов, который будет использоваться для предоставления входящего доступа к внутреннему порту на отдельных вычислительных узлах. |
name |
string |
Имя конечной точки. |
networkSecurityGroupRules |
Список правил группы безопасности сети, которые будут применяться к конечной точке. |
|
protocol |
Протокол конечной точки. |
IPAddressProvisioningType
Тип подготовки для общедоступных IP-адресов пула.
Имя | Тип | Описание |
---|---|---|
batchmanaged |
string |
Общедоступный IP-адрес будет создаваться и управляться пакетной службой. В зависимости от размера пула может быть несколько общедоступных IP-адресов. |
nopublicipaddresses |
string |
Общедоступный IP-адрес не будет создан. |
usermanaged |
string |
Общедоступные IP-адреса предоставляются пользователем и будут использоваться для подготовки вычислительных узлов. |
JobAddParameter
Добавляемое задание пакетная служба Azure.
Имя | Тип | Default value | Описание |
---|---|---|---|
allowTaskPreemption |
boolean |
Могут ли задачи в этом задании быть вытеснены другими заданиями с высоким приоритетом |
|
commonEnvironmentSettings |
Список общих параметров переменных среды. Эти переменные среды задаются для всех задач в задании (включая диспетчер заданий, задачи подготовки и освобождения заданий). |
||
constraints |
Ограничения выполнения для задания. |
||
displayName |
string |
Отображаемое имя задания. |
|
id |
string |
Строка, однозначно идентифицирующая задание в учетной записи. |
|
jobManagerTask |
Сведения о задаче диспетчера заданий, запускаемой при запуске задания. |
||
jobPreparationTask |
Задача подготовки задания. |
||
jobReleaseTask |
Задача освобождения задания. |
||
maxParallelTasks |
integer |
-1 |
Максимальное число задач, которые могут выполняться параллельно для задания. |
metadata |
Список пар "имя-значение", связанных с заданием в качестве метаданных. |
||
networkConfiguration |
Конфигурация сети для задания. |
||
onAllTasksComplete |
Действие, которое пакетная служба должна выполнять, когда все задачи в задании находятся в состоянии завершения. |
||
onTaskFailure |
Действие, выполняемого пакетной службой при сбое любой задачи в задании. |
||
poolInfo |
Пул, в котором пакетная служба выполняет задачи задания. |
||
priority |
integer |
Приоритет задания. |
|
usesTaskDependencies |
boolean |
Могут ли задачи в задании определять зависимости друг от друга. Значение по умолчанию — false. |
JobConstraints
Ограничения выполнения для задания.
Имя | Тип | Описание |
---|---|---|
maxTaskRetryCount |
integer |
Максимальное число повторных попыток каждой задачи. Пакетная служба выполняет повторную попытку задачи, если ее код выхода не является нулевым. |
maxWallClockTime |
string |
Максимальное время, затраченное на выполнение задания, измеряемое с момента создания задания. |
JobManagerTask
Указывает сведения о задаче диспетчера заданий.
Имя | Тип | Описание |
---|---|---|
allowLowPriorityNode |
boolean |
Может ли задача диспетчера заданий выполняться на точечных или низкоприоритетных вычислительных узлах. |
applicationPackageReferences |
Список пакетов приложений, которые пакетная служба будет развертывать на вычислительном узле перед запуском командной строки. |
|
authenticationTokenSettings |
Параметры маркера проверки подлинности, который задача может использовать для выполнения операций пакетной службы. |
|
commandLine |
string |
Командная строка задачи диспетчера заданий. |
constraints |
Ограничения, применяемые к задаче диспетчера заданий. |
|
containerSettings |
Параметры контейнера, в котором выполняется задача диспетчера заданий. |
|
displayName |
string |
Отображаемое имя задачи диспетчера заданий. |
environmentSettings |
Список параметров переменных среды для задачи диспетчера заданий. |
|
id |
string |
Строка, однозначно идентифицирующая задачу диспетчера заданий в задании. |
killJobOnCompletion |
boolean |
Указывает, означает ли завершение задачи диспетчера заданий завершение всего задания. |
outputFiles |
Список файлов, которые пакетная служба будет отправлять с вычислительного узла после запуска командной строки. |
|
requiredSlots |
integer |
Количество слотов планирования, необходимых для выполнения задачи. |
resourceFiles |
Список файлов, которые пакетная служба скачает на вычислительный узел перед запуском командной строки. |
|
runExclusive |
boolean |
Требуется ли для задачи диспетчера заданий монопольное использование вычислительного узла, на котором она выполняется. |
userIdentity |
Удостоверение пользователя, под которым выполняется задача диспетчера заданий. |
JobNetworkConfiguration
Конфигурация сети для задания.
Имя | Тип | Описание |
---|---|---|
subnetId |
string |
Идентификатор ресурса ARM подсети виртуальной сети, к которой будут присоединены вычислительные узлы, выполняющие задачи из задания, в течение всего времени выполнения задачи. Это будет работать только с пулом VirtualMachineConfiguration. |
JobPreparationTask
Задача подготовки задания, выполняемая перед любыми задачами задания на любом вычислительном узле.
Имя | Тип | Описание |
---|---|---|
commandLine |
string |
Командная строка задачи подготовки задания. |
constraints |
Ограничения, применяемые к задаче подготовки задания. |
|
containerSettings |
Параметры контейнера, в котором выполняется задача подготовки задания. |
|
environmentSettings |
Список параметров переменных среды для задачи подготовки задания. |
|
id |
string |
Строка, однозначно идентифицирующая задачу подготовки задания в задании. |
rerunOnNodeRebootAfterSuccess |
boolean |
Указывает, должна ли пакетная служба повторно запускать задачу подготовки задания после перезагрузки вычислительного узла. |
resourceFiles |
Список файлов, которые пакетная служба скачает на вычислительный узел перед запуском командной строки. |
|
userIdentity |
Удостоверение пользователя, под которым выполняется задача подготовки задания. |
|
waitForSuccess |
boolean |
Должна ли пакетная служба ожидать успешного завершения задачи подготовки задания перед планированием других задач задания на вычислительном узле. Задача подготовки задания успешно завершена, если она завершается с кодом выхода 0. |
JobReleaseTask
Задача выпуска задания, выполняемая при завершении задания на любом вычислительном узле, где было запущено задание.
Имя | Тип | Описание |
---|---|---|
commandLine |
string |
Командная строка задачи освобождения задания. |
containerSettings |
Параметры контейнера, в котором выполняется задача освобождения задания. |
|
environmentSettings |
Список параметров переменных среды для задачи выпуска задания. |
|
id |
string |
Строка, однозначно идентифицирующая задачу освобождения задания в задании. |
maxWallClockTime |
string |
Максимальное затраченное время, затраченное на выполнение задачи выпуска задания на заданном вычислительном узле, измеренное с момента запуска задачи. Если задача не завершается в течение предельного времени, пакетная служба завершает ее. Значение по умолчанию — 15 минут. Вы не можете указать время ожидания, превышающее 15 минут. В этом случае пакетная служба отклоняет его с ошибкой; Если вы вызываете REST API напрямую, код состояния HTTP — 400 (недопустимый запрос). |
resourceFiles |
Список файлов, которые пакетная служба скачает на вычислительный узел перед запуском командной строки. Существует максимальный размер списка файлов ресурсов. При превышении максимального размера запрос завершится ошибкой и кодом ошибки ответа будет RequestEntityTooLarge. В этом случае размер коллекции ResourceFiles должен быть уменьшен. Это можно сделать с помощью .zip файлов, пакетов приложений или контейнеров Docker. |
|
retentionTime |
string |
Минимальное время хранения каталога задачи для задачи выпуска задания на вычислительном узле. По истечении этого времени пакетная служба может удалить каталог Задач и все его содержимое. |
userIdentity |
Удостоверение пользователя, под которым выполняется задача выпуска задания. |
LinuxUserConfiguration
Свойства, используемые для создания учетной записи пользователя на вычислительном узле Linux.
Имя | Тип | Описание |
---|---|---|
gid |
integer |
Идентификатор группы для учетной записи пользователя. |
sshPrivateKey |
string |
Закрытый ключ SSH для учетной записи пользователя. |
uid |
integer |
Идентификатор учетной записи пользователя. |
LoginMode
Режим входа для пользователя
Имя | Тип | Описание |
---|---|---|
batch |
string |
Режим входа LOGON32_LOGON_BATCH Win32. Для длительных параллельных процессов рекомендуется использовать пакетный режим входа. |
interactive |
string |
Режим входа LOGON32_LOGON_INTERACTIVE Win32. UAC включен в пулах Конфигурации Windows VirtualMachine. Если этот параметр используется с удостоверением пользователя с повышенными привилегиями в пуле Windows VirtualMachineConfiguration, пользовательский сеанс не будет повышен, если приложение, выполняемое в командной строке задачи, не настроено так, чтобы всегда требовать права администратора или всегда требовать максимальные привилегии. |
ManagedDisk
Имя | Тип | Описание |
---|---|---|
storageAccountType |
Тип учетной записи хранения для управляемого диска. |
MetadataItem
Пара "имя-значение", связанная с ресурсом пакетной службы.
Имя | Тип | Описание |
---|---|---|
name |
string |
Имя элемента метаданных. |
value |
string |
Значение элемента метаданных. |
MountConfiguration
Файловая система для подключения к каждому узлу.
Имя | Тип | Описание |
---|---|---|
azureBlobFileSystemConfiguration |
Контейнер службы хранилища Azure для подключения с помощью FUSE BLOB-объектов на каждом узле. |
|
azureFileShareConfiguration |
Общая папка Azure для подключения к каждому узлу. |
|
cifsMountConfiguration |
Файловая система CIFS/SMB для подключения к каждому узлу. |
|
nfsMountConfiguration |
Файловая система NFS для подключения на каждом узле. |
NetworkConfiguration
Конфигурация сети для пула.
Имя | Тип | Описание |
---|---|---|
dynamicVNetAssignmentScope |
Область динамического назначения виртуальной сети. |
|
enableAcceleratedNetworking |
boolean |
Должен ли этот пул включать ускорение сети. |
endpointConfiguration |
Конфигурация конечных точек на вычислительных узлах в пуле пакетной службы. |
|
publicIPAddressConfiguration |
Конфигурация public IPAddress для вычислительных узлов в пуле пакетной службы. |
|
subnetId |
string |
Идентификатор ресурса ARM подсети виртуальной сети, к которой будут присоединены вычислительные узлы пула. Имеет вид /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. |
NetworkSecurityGroupRule
Правило группы безопасности сети для применения к входящей конечной точке.
Имя | Тип | Описание |
---|---|---|
access |
Действие, которое необходимо выполнить для указанного IP-адреса, диапазона подсети или тега. |
|
priority |
integer |
Приоритет для этого правила. |
sourceAddressPrefix |
string |
Префикс или тег исходного адреса, соответствующий правилу. |
sourcePortRanges |
string[] |
Диапазоны исходных портов, соответствующие правилу. |
NetworkSecurityGroupRuleAccess
Действие, которое необходимо выполнить для указанного IP-адреса, диапазона подсети или тега.
Имя | Тип | Описание |
---|---|---|
allow |
string |
Разрешить доступ. |
deny |
string |
Запретить доступ. |
NFSMountConfiguration
Сведения, используемые для подключения к файловой системе NFS.
Имя | Тип | Описание |
---|---|---|
mountOptions |
string |
Дополнительные параметры командной строки для передачи в команду подключения. |
relativeMountPath |
string |
Относительный путь на вычислительном узле, к которому будет подключена файловая система. |
source |
string |
Универсальный код ресурса (URI) подключаемой файловой системы. |
NodeCommunicationMode
Определяет, как пул взаимодействует с пакетной службой.
Имя | Тип | Описание |
---|---|---|
classic |
string |
Узлам, использующим классический режим связи, требуется входящий tcp-обмен данными через порты 29876 и 29877 из BatchNodeManagement. Тег службы {region}и исходящий tcp-обмен данными через порт 443 с storage.region и BatchNodeManagement. Теги службы {регион}". |
default |
string |
Режим связи с узлом автоматически задается пакетной службой. |
simplified |
string |
Узлам, использующим упрощенный режим связи, требуется исходящий TCP-обмен данными через порт 443 с BatchNodeManagement. Тег службы {регион}. Открытые входящие порты не требуются. |
NodePlacementConfiguration
Конфигурация размещения узла для пула.
Имя | Тип | Описание |
---|---|---|
policy |
Тип политики размещения узла в пулах пакетной службы. |
NodePlacementPolicyType
Политика размещения для выделения узлов в пуле.
Имя | Тип | Описание |
---|---|---|
regional |
string |
Все узлы в пуле будут выделены в одном регионе. |
zonal |
string |
Узлы в пуле будут распределены по разным зонам доступности с максимальной балансировкой усилий. |
OnAllTasksComplete
Действие, которое пакетная служба должна выполнять, когда все задачи в задании находятся в состоянии завершения.
Имя | Тип | Описание |
---|---|---|
noaction |
string |
Не делать ничего. Задание остается активным, если не будет завершено или отключено другими способами. |
terminatejob |
string |
Завершите задание. Параметр terminateReason задания имеет значение AllTasksComplete. |
OnTaskFailure
Действие, выполняемого пакетной службой при сбое любой задачи в задании.
Имя | Тип | Описание |
---|---|---|
noaction |
string |
Не делать ничего. Задание остается активным, если не будет завершено или отключено другими способами. |
performexitoptionsjobaction |
string |
Выполните действие, связанное с условием выхода Task, в коллекции Task's exitConditions. (Это может по-прежнему привести к тому, что действия не будут предприниматься, если это указано в задаче.) |
OSDisk
Параметры диска операционной системы вычислительного узла (ВМ).
Имя | Тип | Описание |
---|---|---|
caching |
Указывает требования к кэшированию. Возможные значения: None, ReadOnly, ReadWrite. Значения по умолчанию: None для хранилища уровня "Стандартный". ReadOnly для хранилища класса Premium. |
|
diskSizeGB |
integer |
Начальный размер диска в ГБ при создании нового диска ОС. |
ephemeralOSDiskSettings |
Задает временные параметры диска для диска операционной системы, используемого вычислительным узлом . |
|
managedDisk |
Параметры управляемого диска. |
|
writeAcceleratorEnabled |
boolean |
Указывает, следует ли включить или отключить writeAccelerator на диске. |
OutputFile
Спецификация для отправки файлов из вычислительного узла пакетная служба Azure в другое расположение после того, как пакетная служба завершит выполнение процесса задачи.
Имя | Тип | Описание |
---|---|---|
destination |
Назначение для выходных файлов. |
|
filePattern |
string |
Шаблон, указывающий, какие файлы следует отправить. |
uploadOptions |
Дополнительные параметры для операции отправки, включая условия для выполнения отправки. |
OutputFileBlobContainerDestination
Указывает назначение отправки файлов в контейнере хранилища BLOB-объектов Azure.
Имя | Тип | Описание |
---|---|---|
containerUrl |
string |
URL-адрес контейнера в Хранилище BLOB-объектов Azure, в который отправляются файлы. |
identityReference |
Ссылка на назначенное пользователем удостоверение, используемое для доступа к Хранилище BLOB-объектов Azure, заданное containerUrl. |
|
path |
string |
Целевой большой двоичный объект или виртуальный каталог в контейнере службы хранилища Azure. |
uploadHeaders |
Список пар "имя-значение" для заголовков, используемых при отправке выходных файлов |
OutputFileDestination
Место назначения, в которое должен быть отправлен файл.
Имя | Тип | Описание |
---|---|---|
container |
Расположение в хранилище BLOB-объектов Azure, в которое отправляются файлы. |
OutputFileUploadCondition
Условия, при которых должен отправляться выходной файл задачи или набор файлов.
Имя | Тип | Описание |
---|---|---|
taskcompletion |
string |
Отправьте файлы после завершения процесса задачи, независимо от того, какой код выхода был. |
taskfailure |
string |
Отправляйте файлы только после завершения процесса задачи с ненулевым кодом выхода. |
tasksuccess |
string |
Отправляйте файлы только после завершения процесса задачи с кодом выхода 0. |
OutputFileUploadOptions
Сведения об операции отправки выходных файлов, в том числе о том, при каких условиях следует выполнить отправку.
Имя | Тип | Описание |
---|---|---|
uploadCondition |
Условия, при которых должен отправляться выходной файл задачи или набор файлов. |
PoolEndpointConfiguration
Конфигурация конечной точки для пула.
Имя | Тип | Описание |
---|---|---|
inboundNATPools |
Список входящих пулов NAT, которые можно использовать для обращения к определенным портам на отдельном вычислительном узле извне. |
PoolInformation
Указывает, как задание должно быть назначено пулу.
Имя | Тип | Описание |
---|---|---|
autoPoolSpecification |
Характеристики временного "автоматического пула". Пакетная служба создаст этот автоматический пул при отправке задания. |
|
poolId |
string |
Идентификатор существующего пула. Все задачи задания будут выполняться в указанном пуле. |
PoolLifetimeOption
Минимальное время существования созданных автоматических пулов и назначение пулам нескольких заданий по расписанию.
Имя | Тип | Описание |
---|---|---|
job |
string |
Пул существует в течение всего времени существования задания, которому он посвящен. Пакетная служба создает пул при создании задания. Если параметр "задание" применяется к расписанию заданий, пакетная служба создает новый автоматический пул для каждого задания, созданного по расписанию. |
jobschedule |
string |
Пул существует в течение всего времени существования расписания заданий. Пакетная служба создает пул при создании первого задания по расписанию. Этот параметр можно применять только к расписаниям заданий, а не к заданиям. |
PoolSpecification
Спецификация для создания нового пула.
Имя | Тип | Описание |
---|---|---|
applicationLicenses |
string[] |
Список лицензий приложений, доступных пакетной службе на каждом вычислительном узле в пуле. |
applicationPackageReferences |
Список пакетов, устанавливаемых на каждом вычислительном узле в пуле. |
|
autoScaleEvaluationInterval |
string |
Интервал времени, в который автоматически настраивается размер пула в соответствии с формулой автомасштабирования. |
autoScaleFormula |
string |
Формула для требуемого числа вычислительных узлов в пуле. |
certificateReferences |
Список сертификатов, устанавливаемых на каждом вычислительном узле в пуле. Предупреждение. Это свойство устарело и будет удалено после февраля 2024 г. Вместо этого используйте расширение Azure KeyVault . |
|
cloudServiceConfiguration |
Конфигурация облачной службы для пула. |
|
displayName |
string |
Отображаемое имя пула. |
enableAutoScale |
boolean |
Указывает, должен ли размер пула автоматически изменяться с течением времени. |
enableInterNodeCommunication |
boolean |
Разрешает ли пул прямой обмен данными между вычислительными узлами. |
metadata |
Список пар "имя-значение", связанных с пулом в качестве метаданных. |
|
mountConfiguration |
Список файловых систем для подключения к каждому узлу в пуле. |
|
networkConfiguration |
Конфигурация сети для пула. |
|
resizeTimeout |
string |
Время ожидания для выделения вычислительных узлов в пул. |
resourceTags |
object |
Пользовательские теги, связанные с пулом. |
startTask |
Задача, выполняемая на каждом вычислительном узле при присоединении к пулу. Задача выполняется при добавлении вычислительного узла в пул или при перезапуске вычислительного узла. |
|
targetDedicatedNodes |
integer |
Требуемое количество выделенных вычислительных узлов в пуле. |
targetLowPriorityNodes |
integer |
Требуемое количество точечных или низкоприоритетных вычислительных узлов в пуле. |
targetNodeCommunicationMode |
Требуемый режим связи узла для пула. |
|
taskSchedulingPolicy |
Распределение задач между вычислительными узлами в пуле. |
|
taskSlotsPerNode |
integer |
Количество слотов задач, которые могут использоваться для выполнения параллельных задач на одном вычислительном узле в пуле. |
userAccounts |
Список учетных записей пользователей, создаваемых на каждом вычислительном узле в пуле. |
|
virtualMachineConfiguration |
Конфигурация виртуальной машины для пула. |
|
vmSize |
string |
Размер виртуальных машин в пуле. Все виртуальные машины в пуле имеют одинаковый размер. |
PublicIPAddressConfiguration
Конфигурация общедоступного IP-адреса конфигурации сети пула.
Имя | Тип | Описание |
---|---|---|
ipAddressIds |
string[] |
Список общедоступных IP-адресов, которые пакетная служба будет использовать при подготовке вычислительных узлов. |
provision |
Тип подготовки для общедоступных IP-адресов пула. |
ResourceFile
Один файл или несколько файлов для загрузки на вычислительный узел.
Имя | Тип | Описание |
---|---|---|
autoStorageContainerName |
string |
Имя контейнера хранилища в учетной записи автоматического хранения. |
blobPrefix |
string |
Префикс большого двоичного объекта, используемый при скачивании больших двоичных объектов из контейнера службы хранилища Azure. Будут загружены только большие двоичные объекты, имена которых начинаются с указанного префикса. |
fileMode |
string |
Атрибут режима разрешений для файлов в восьмеричном формате. |
filePath |
string |
Расположение на вычислительном узле, в который нужно скачать файлы, относительно рабочего каталога задачи. |
httpUrl |
string |
URL-адрес для скачивания файла. |
identityReference |
Ссылка на назначенное пользователем удостоверение для доступа к Хранилище BLOB-объектов Azure, указанное storageContainerUrl или httpUrl. |
|
storageContainerUrl |
string |
URL-адрес контейнера больших двоичных объектов в Хранилище BLOB-объектов Azure. |
SecurityProfile
Задает параметры профиля безопасности для виртуальной машины или масштабируемого набора виртуальных машин.
Имя | Тип | Описание |
---|---|---|
encryptionAtHost |
boolean |
Это свойство может использоваться пользователем в запросе для включения или отключения шифрования узла для виртуальной машины или масштабируемого набора виртуальных машин. Это позволит включить шифрование для всех дисков, включая ресурс или временный диск на самом узле. |
securityType |
Указывает тип безопасности виртуальной машины. Чтобы включить UefiSettings, ему необходимо задать любое указанное значение. |
|
uefiSettings |
Указывает параметры безопасности, такие как безопасная загрузка и vTPM, используемые при создании виртуальной машины. |
SecurityTypes
Указывает тип безопасности виртуальной машины. Для включения UefiSettings ему необходимо задать любое указанное значение.
Имя | Тип | Описание |
---|---|---|
trustedLaunch |
string |
Доверенный запуск защищает от сложных и постоянных атак. |
ServiceArtifactReference
Указывает идентификатор ссылки на артефакт службы, используемый для задания одинаковой версии образа для всех виртуальных машин в масштабируемом наборе при использовании последней версии образа.
Имя | Тип | Описание |
---|---|---|
id |
string |
Идентификатор ссылки на артефакт службы объекта ServiceArtifactReference |
StartTask
Задача, которая выполняется при присоединении узла к пулу в службе пакетная служба Azure либо при перезагрузке или повторном создании образа вычислительного узла.
Имя | Тип | Описание |
---|---|---|
commandLine |
string |
Командная строка StartTask. |
containerSettings |
Параметры для контейнера, в котором выполняется StartTask. |
|
environmentSettings |
Список параметров переменных среды для StartTask. |
|
maxTaskRetryCount |
integer |
Максимальное количество повторных попыток задачи. |
resourceFiles |
Список файлов, которые пакетная служба скачает на вычислительный узел перед запуском командной строки. Существует максимальный размер списка файлов ресурсов. При превышении максимального размера запрос завершится ошибкой и кодом ошибки ответа будет RequestEntityTooLarge. В этом случае размер коллекции ResourceFiles должен быть уменьшен. Это можно сделать с помощью .zip файлов, пакетов приложений или контейнеров Docker. |
|
userIdentity |
Удостоверение пользователя, с которым выполняется StartTask. |
|
waitForSuccess |
boolean |
Указывает, должна ли пакетная служба ожидать успешного завершения StartTask (т. е. выхода с кодом выхода 0) перед планированием задач на вычислительном узле. |
StorageAccountType
Тип учетной записи хранения, используемый при создании дисков данных или диска ОС.
Имя | Тип | Описание |
---|---|---|
premium_lrs |
string |
Диск данных или диск ОС должен использовать локально избыточное хранилище класса Premium. |
standard_lrs |
string |
Диск данных или диск ОС должны использовать стандартное локально избыточное хранилище. |
standardssd_lrs |
string |
Диск данных или диск ОС должны использовать локально избыточное хранилище SSD (цен. категория "Стандартный"). |
TaskConstraints
Ограничения выполнения, применяемые к задаче.
Имя | Тип | Описание |
---|---|---|
maxTaskRetryCount |
integer |
Максимальное количество повторных попыток задачи. Пакетная служба повторяет задачу, если ее код выхода не равен нулю. |
maxWallClockTime |
string |
Максимальное затраченное время выполнения задачи, измеряемое с момента запуска задачи. Если задача не завершается в течение предельного времени, пакетная служба завершает ее. |
retentionTime |
string |
Минимальное время хранения каталога задачи на вычислительном узле, где он запущен, с момента завершения выполнения. По истечении этого времени пакетная служба может удалить каталог Задач и все его содержимое. |
TaskContainerSettings
Параметры контейнера для задачи.
Имя | Тип | Описание |
---|---|---|
containerRunOptions |
string |
Дополнительные параметры команды создания контейнера. |
imageName |
string |
Образ, используемый для создания контейнера, в котором будет выполняться задача. |
registry |
Частный реестр, содержащий образ контейнера. |
|
workingDirectory |
Расположение рабочего каталога задачи контейнера. |
TaskSchedulingPolicy
Указывает, как задачи должны распределяться между вычислительными узлами.
Имя | Тип | Описание |
---|---|---|
nodeFillType |
Распределение задач между вычислительными узлами в пуле. |
UefiSettings
Указывает параметры безопасности, такие как безопасная загрузка и vTPM, используемые при создании виртуальной машины.
Имя | Тип | Описание |
---|---|---|
secureBootEnabled |
boolean |
Указывает, должна ли на виртуальной машине быть включена безопасная загрузка. |
vTpmEnabled |
boolean |
Указывает, следует ли включить vTPM на виртуальной машине. |
UserAccount
Свойства, используемые для создания пользователя, используемого для выполнения задач на пакетная служба Azure вычислительном узле.
Имя | Тип | Описание |
---|---|---|
elevationLevel |
Уровень прав учетной записи пользователя. |
|
linuxUserConfiguration |
Конфигурация конкретного пользователя Linux для учетной записи пользователя. |
|
name |
string |
Имя учетной записи пользователя. Имена могут содержать любые символы Юникода длиной не более 20. |
password |
string |
Пароль для учетной записи пользователя. |
windowsUserConfiguration |
Конфигурация пользователя, зависят от Windows, для учетной записи пользователя. |
UserIdentity
Определение удостоверения пользователя, с которым выполняется задача.
Имя | Тип | Описание |
---|---|---|
autoUser |
Автоматический пользователь, под которым выполняется задача. |
|
username |
string |
Имя удостоверения пользователя, с которым выполняется задача. |
VirtualMachineConfiguration
Конфигурация вычислительных узлов в пуле на основе инфраструктуры azure Виртуальные машины.
Имя | Тип | Описание |
---|---|---|
containerConfiguration |
Конфигурация контейнера для пула. |
|
dataDisks |
Data |
Конфигурация дисков данных, подключенных к вычислительным узлам в пуле. |
diskEncryptionConfiguration |
Конфигурация шифрования дисков для пула. |
|
extensions |
Расширение виртуальной машины для пула. |
|
imageReference |
Ссылка на образ Azure Виртуальные машины Marketplace или пользовательский образ виртуальной машины для использования. |
|
licenseType |
string |
Тип локальной лицензии, используемой при развертывании операционной системы. Windows_Server — локальная лицензия для Windows Server. Windows_Client — локальная лицензия для клиента Windows. |
nodeAgentSKUId |
string |
Номер SKU агента пакетного вычислительного узла для подготовки на вычислительных узлах в пуле. |
nodePlacementConfiguration |
Конфигурация размещения узла для пула. |
|
osDisk |
Параметры диска операционной системы виртуальной машины. |
|
securityProfile |
Задает параметры профиля безопасности для виртуальной машины или масштабируемого набора виртуальных машин. |
|
serviceArtifactReference |
Указывает идентификатор ссылки на артефакт службы, используемый для установки одной и той же версии образа для всех виртуальных машин в масштабируемом наборе при использовании последней версии образа. |
|
windowsConfiguration |
Параметры операционной системы Windows на виртуальной машине. |
VMExtension
Конфигурация для расширений виртуальных машин.
Имя | Тип | Описание |
---|---|---|
autoUpgradeMinorVersion |
boolean |
Указывает, должно ли расширение использовать более новую дополнительную версию, если она доступна во время развертывания. Однако после развертывания расширение не будет обновляться до дополнительных версий, кроме случаев повторного развертывания, даже если это свойство имеет значение true. |
enableAutomaticUpgrade |
boolean |
Указывает, должно ли расширение автоматически обновляться платформой, если доступна более новая версия расширения. |
name |
string |
Имя расширения виртуальной машины. |
protectedSettings |
object |
Расширение может содержать protectedSettings или protectedSettingsFromKeyVault или вообще не иметь защищенных параметров. |
provisionAfterExtensions |
string[] |
Коллекция имен расширений. |
publisher |
string |
Имя издателя обработчика расширений. |
settings |
object |
Общедоступные параметры расширения в формате JSON. |
type |
string |
Тип расширения. |
typeHandlerVersion |
string |
Версия обработчика скрипта. |
WindowsConfiguration
Параметры операционной системы Windows, применяемые к виртуальной машине.
Имя | Тип | Описание |
---|---|---|
enableAutomaticUpdates |
boolean |
Указывает, включены ли автоматические обновления на виртуальной машине. |
WindowsUserConfiguration
Свойства, используемые для создания учетной записи пользователя на вычислительном узле Windows.
Имя | Тип | Описание |
---|---|---|
loginMode |
Режим входа для пользователя |