Job Schedule - List
Выводит список всех расписаний заданий в указанной учетной записи.
GET {batchUrl}/jobschedules?api-version=2024-07-01.20.0
GET {batchUrl}/jobschedules?$filter={$filter}&$select={$select}&$expand={$expand}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
batch
|
path | True |
string |
Базовый URL-адрес для всех запросов пакетной службы Azure. |
api-version
|
query | True |
string |
Версия КЛИЕНТСКОго API. |
$expand
|
query |
string |
Предложение OData $expand. |
|
$filter
|
query |
string |
Предложение OData $filter. Дополнительные сведения о создании этого фильтра см. в https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-job-schedules. |
|
$select
|
query |
string |
Предложение OData $select. |
|
maxresults
|
query |
integer int32 |
Максимальное количество элементов, возвращаемых в ответе. Можно вернуть не более 1000 расписаний заданий. |
|
timeout
|
query |
integer int32 |
Максимальное время, которое сервер может тратить на обработку запроса в секундах. Значение по умолчанию — 30 секунд. Если значение больше 30, вместо этого будет использоваться значение по умолчанию. |
Заголовок запроса
Media Types: "application/json; odata=minimalmetadata"
Имя | Обязательно | Тип | Описание |
---|---|---|---|
client-request-id |
string uuid |
Удостоверение запроса, созданное вызывающим пользователем, в виде GUID без украшений, таких как фигурные скобки, например 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Должен ли сервер возвращать идентификатор client-request-id в ответе. |
|
ocp-date |
string date-time-rfc1123 |
Время выдачи запроса. Клиентские библиотеки обычно задают это в текущее время системных часов; задайте его явным образом, если вы вызываете REST API напрямую. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Ответ, содержащий список расписаний заданий. Заголовки
|
|
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
Примеры
JobSchedule list
Образец запроса
GET account.region.batch.azure.com/jobschedules?api-version=2024-07-01.20.0
Пример ответа
{
"value": [
{
"id": "jobSchedule1",
"url": "https://account.region.batch.azure.com/jobschedules/jobSchedule1",
"eTag": "0x8D40FFD2E10996A",
"lastModified": "2016-11-18T21:52:24.0064874Z",
"creationTime": "2016-11-18T21:52:22.5431125Z",
"state": "active",
"stateTransitionTime": "2016-11-18T21:52:24.0064874Z",
"previousState": "disabled",
"previousStateTransitionTime": "2016-11-18T21:52:23.6471782Z",
"jobSpecification": {
"priority": 0,
"maxParallelTasks": -1,
"allowTaskPreemption": false,
"usesTaskDependencies": false,
"onAllTasksComplete": "noaction",
"onTaskFailure": "noaction",
"constraints": {
"maxWallClockTime": "P10675199DT2H48M5.4775807S",
"maxTaskRetryCount": 0
},
"poolInfo": {
"poolId": "poolId"
}
},
"executionInfo": {
"recentJob": {
"url": "https://account.region.batch.azure.com/jobs/jobSchedule1:job-1",
"id": "jobSchedule1:job-1"
}
}
},
{
"id": "jobSchedule2",
"url": "https://account.region.batch.azure.com/jobschedules/jobSchedule2",
"eTag": "0x8D40FFCFF760B51",
"lastModified": "2016-11-18T21:51:05.8184017Z",
"creationTime": "2016-11-18T21:51:05.8184017Z",
"state": "active",
"stateTransitionTime": "2016-11-18T21:51:05.8184017Z",
"schedule": {
"doNotRunUntil": "2020-01-01T12:30:00Z"
},
"jobSpecification": {
"priority": 0,
"maxParallelTasks": -1,
"usesTaskDependencies": false,
"onAllTasksComplete": "noaction",
"onTaskFailure": "noaction",
"constraints": {
"maxWallClockTime": "P10675199DT2H48M5.4775807S",
"maxTaskRetryCount": 0
},
"poolInfo": {
"poolId": "testPool2"
}
},
"executionInfo": {
"nextRunTime": "2020-01-01T12:30:00Z"
}
}
]
}
Определения
Имя | Описание |
---|---|
Access |
Ресурсы пакетной службы, к которым маркер предоставляет доступ. |
Application |
Ссылка на пакет для развертывания на вычислительных узлах. |
Authentication |
Параметры маркера проверки подлинности, который задача может использовать для выполнения операций пакетной службы. |
Automatic |
Параметры конфигурации, используемые для автоматического обновления ОС. |
Auto |
Указывает характеристики для временного пула автозаполнения. Пакетная служба создаст этот автоматический пул при отправке задания. |
Auto |
Область для автоматического пользователя |
Auto |
Задает параметры для автоматического пользователя, выполняющего задачу в пакетной службе. |
Azure |
Сведения, используемые для подключения к контейнеру службы хранилища Azure с помощью Blobfuse. |
Azure |
Сведения, используемые для подключения к общей папке Azure. |
Batch |
Ответ об ошибке, полученный из пакетной службы Azure. |
Batch |
Элемент дополнительных сведений, включенных в ответ на ошибку пакетной службы Azure. |
Caching |
Тип кэширования для диска. |
Certificate |
Ссылка на сертификат, который необходимо установить на вычислительных узлах в пуле. |
Certificate |
Расположение хранилища сертификатов на вычислительном узле, в который необходимо установить сертификат. |
Certificate |
Какие учетные записи пользователей на вычислительном узле должны иметь доступ к частным данным сертификата. |
CIFSMount |
Сведения, используемые для подключения к файловой системе CIFS. |
Cloud |
Расписание заданий, позволяющее повторяющимся заданиям, указывая время выполнения заданий и спецификацию, используемую для создания каждого задания. |
Cloud |
Результат перечисления расписаний заданий в учетной записи. |
Compute |
Распределение задач между вычислительными узлами в пуле. |
Compute |
Ссылка на назначенное пользователем удостоверение, связанное с пулом пакетной службы, который будет использовать вычислительный узел. |
Container |
Конфигурация пулов с поддержкой контейнера. |
Container |
Вход пути и режима подключения, который требуется подключить к контейнеру задач. |
Container |
Пути, которые будут подключены к контейнеру задачи контейнера. |
Container |
Частный реестр контейнеров. |
Container |
Используемая технология контейнера. |
Container |
Расположение рабочего каталога задачи контейнера. |
Data |
Параметры, которые будут использоваться дисками данных, связанными с вычислительными узлами в пуле. При использовании подключенных дисков данных необходимо подключить и отформатировать диски из виртуальной машины, чтобы использовать их. |
Diff |
Указывает эфемерное размещение диска операционной системы для всех вычислительных узлов (виртуальных машин) в пуле. |
Diff |
Указывает временные параметры диска для диска операционной системы, используемого вычислительным узлом (vm). |
Disk |
Конфигурация шифрования дисков, примененная к вычислительным узлам в пуле. Конфигурация шифрования дисков не поддерживается в пуле Linux, созданном с помощью образа коллекции вычислений Azure. |
Disk |
Список целевых объектов дисков пакетной службы будет шифроваться на вычислительном узле. |
Dynamic |
Область динамического назначения виртуальной сети. |
Elevation |
Уровень повышения прав пользователя. |
Environment |
Переменная среды, устанавливаемая в процессе задачи. |
Error |
Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure. |
Http |
Пара "Имя-значение" заголовка HTTP |
Image |
Ссылка на образ Azure Virtual Machines Marketplace или образ коллекции вычислений Azure. Чтобы получить список всех ссылок на образы Azure Marketplace, проверенных пакетной службой Azure, см. операцию "Список поддерживаемых образов". |
Inbound |
Протокол конечной точки. |
Inbound |
Входящий пул NAT, который можно использовать для решения конкретных портов на вычислительных узлах во внешнем пуле пакетной службы. |
IPAddress |
Тип подготовки для общедоступных IP-адресов пула. |
Job |
Ограничения выполнения для задания. |
Job |
Указывает сведения о задаче диспетчера заданий. |
Job |
Конфигурация сети для задания. |
Job |
Задача подготовки заданий, выполняемая перед любыми задачами задания на любом заданном вычислительном узле. |
Job |
Задача выпуска задания для выполнения задания на любом вычислительном узле, где выполняется задание. |
Job |
Содержит сведения о заданиях, которые были и будут выполняться в рамках расписания заданий. |
Job |
Состояние расписания заданий. |
Job |
Статистика использования ресурсов для расписания заданий. |
Job |
Указывает сведения о заданиях, создаваемых по расписанию. |
Linux |
Свойства, используемые для создания учетной записи пользователя на вычислительном узле Linux. |
Login |
Режим входа для пользователя |
Managed |
|
Metadata |
Пара "имя-значение", связанная с ресурсом пакетной службы. |
Mount |
Файловая система для подключения на каждом узле. |
Network |
Конфигурация сети для пула. |
Network |
Правило группы безопасности сети для применения к входящей конечной точке. |
Network |
Действие, которое следует предпринять для указанного IP-адреса, диапазона подсети или тега. |
NFSMount |
Сведения, используемые для подключения к файловой системе NFS. |
Node |
Определяет, как пул взаимодействует со службой пакетной службы. |
Node |
Конфигурация размещения узлов для пула. |
Node |
Политика размещения для выделения узлов в пуле. |
On |
Действие пакетной службы должно выполняться, когда все задачи в задании находятся в состоянии завершения. |
On |
Действие пакетной службы должно выполняться при сбое любой задачи в задании. |
OSDisk |
Параметры диска операционной системы вычислительного узла (VM). |
Output |
Спецификация отправки файлов из вычислительного узла пакетной службы Azure в другое расположение после завершения выполнения процесса задачи пакетной службы. |
Output |
Указывает назначение отправки файлов в контейнере хранилища BLOB-объектов Azure. |
Output |
Назначение, в которое должен быть отправлен файл. |
Output |
Условия отправки выходного файла задачи или набора файлов. |
Output |
Сведения об операции отправки выходных файлов, включая условия отправки. |
Pool |
Конфигурация конечной точки для пула. |
Pool |
Указывает, как задание должно быть назначено пулу. |
Pool |
Минимальное время существования созданных автоматических пулов и назначение нескольких заданий в расписании пулам. |
Pool |
Спецификация создания нового пула. |
Public |
Конфигурация общедоступного IP-адреса конфигурации сети пула. |
Recent |
Сведения о последнем задании, выполняемом в рамках расписания заданий. |
Resource |
Один файл или несколько файлов, которые нужно скачать на вычислительный узел. |
Rolling |
Параметры конфигурации, используемые при выполнении последовательного обновления. |
Schedule |
Расписание, в соответствии с которым будут созданы задания. Все время фиксируются в формате UTC и не влияют на летнее время. |
Security |
Указывает тип шифрования управляемого диска. Он имеет значение VMGuestStateOnly для шифрования только большого двоичного объекта VMGuestState и NonPersistedTPM для сохранения состояния встроенного ПО в BLOB-объекте VMGuestState. примечание. Его можно задать только для конфиденциальных виртуальных машин и требуется при использовании конфиденциальных виртуальных машин. |
Security |
Задает параметры профиля безопасности для масштабируемого набора виртуальных машин или виртуальной машины. |
Security |
Указывает тип безопасности виртуальной машины. Для включения UefiSettings необходимо задать любое указанное значение. |
Service |
Указывает идентификатор ссылки на артефакт службы, используемый для задания одной версии образа для всех виртуальных машин в масштабируемом наборе при использовании последней версии образа. |
Start |
Задача, которая выполняется при присоединении узла к пулу в пакетной службе Azure или при перезагрузке или повторном переимыке вычислительного узла. |
Storage |
Тип учетной записи хранения для создания дисков данных или диска ОС. |
Task |
Ограничения выполнения для применения к задаче. |
Task |
Параметры контейнера для задачи. |
Task |
Указывает, как задачи должны распределяться по вычислительным узлам. |
Uefi |
Указывает параметры безопасности, такие как безопасная загрузка и vTPM, используемые при создании виртуальной машины. |
Upgrade |
Задает режим обновления до виртуальных машин в масштабируемом наборе. |
Upgrade |
Описывает политику обновления — автоматическую, ручную или перекатную. |
User |
Свойства, используемые для создания пользователя, используемого для выполнения задач на вычислительном узле пакетной службы Azure. |
User |
Определение удостоверения пользователя, в котором выполняется задача. |
Virtual |
Конфигурация вычислительных узлов в пуле на основе инфраструктуры виртуальных машин Azure. |
VMDisk |
Задает параметры профиля безопасности для управляемого диска. примечание. Его можно задать только для конфиденциальных виртуальных машин и требоваться при использовании конфиденциальных виртуальных машин. |
VMExtension |
Конфигурация расширений виртуальных машин. |
Windows |
Параметры операционной системы Windows для применения к виртуальной машине. |
Windows |
Свойства, используемые для создания учетной записи пользователя на вычислительном узле Windows. |
AccessScope
Ресурсы пакетной службы, к которым маркер предоставляет доступ.
Имя | Тип | Описание |
---|---|---|
job |
string |
Предоставляет доступ для выполнения всех операций с заданием, содержащим задачу. |
ApplicationPackageReference
Ссылка на пакет для развертывания на вычислительных узлах.
Имя | Тип | Описание |
---|---|---|
applicationId |
string |
Идентификатор развертываемого приложения. |
version |
string |
Версия приложения для развертывания. Если опущено, будет развернута версия по умолчанию. |
AuthenticationTokenSettings
Параметры маркера проверки подлинности, который задача может использовать для выполнения операций пакетной службы.
Имя | Тип | Описание |
---|---|---|
access |
Ресурсы пакетной службы, к которым маркер предоставляет доступ. |
AutomaticOSUpgradePolicy
Параметры конфигурации, используемые для автоматического обновления ОС.
Имя | Тип | Описание |
---|---|---|
disableAutomaticRollback |
boolean |
Следует ли отключить функцию отката образа ОС. |
enableAutomaticOSUpgrade |
boolean |
Указывает, следует ли автоматически применять обновления ОС к экземплярам масштабируемого набора в последовательном режиме, когда становится доступной более новая версия образа ОС. |
osRollingUpgradeDeferral |
boolean |
Отложить обновление ОС на телевизорах, если они выполняют задачи. |
useRollingUpgradePolicy |
boolean |
Указывает, следует ли использовать политику последовательного обновления во время автоматического обновления ОС. Автоматическое обновление ОС откатится к политике по умолчанию, если политика не определена в VMSS. |
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. Обратите внимание, что если область autoUser является пулом как для startTask, так и для задачи, этот сертификат также будет виден задаче. |
task |
string |
Сертификат должен быть видимым для учетных записей пользователей, в которых выполняются задачи задания. |
CIFSMountConfiguration
Сведения, используемые для подключения к файловой системе CIFS.
Имя | Тип | Описание |
---|---|---|
mountOptions |
string |
Дополнительные параметры командной строки для передачи команде подключения. |
password |
string |
Пароль, используемый для проверки подлинности в файловой системе CIFS. |
relativeMountPath |
string |
Относительный путь на вычислительном узле, где будет подключена файловая система. |
source |
string |
Универсальный код ресурса (URI) файловой системы для подключения. |
username |
string |
Пользователь, используемый для проверки подлинности в файловой системе CIFS. |
CloudJobSchedule
Расписание заданий, позволяющее повторяющимся заданиям, указывая время выполнения заданий и спецификацию, используемую для создания каждого задания.
Имя | Тип | Описание |
---|---|---|
creationTime |
string |
Время создания расписания заданий. |
displayName |
string |
Отображаемое имя расписания. |
eTag |
string |
ETag расписания заданий. |
executionInfo |
Сведения о заданиях, которые были и будут выполняться в рамках этого расписания. |
|
id |
string |
Строка, которая однозначно определяет расписание в учетной записи. |
jobSpecification |
Сведения о заданиях, которые необходимо создать в этом расписании. |
|
lastModified |
string |
Время последнего изменения расписания заданий. |
metadata |
Список пар "имя-значение", связанных с расписанием в виде метаданных. |
|
previousState |
Предыдущее состояние расписания заданий. |
|
previousStateTransitionTime |
string |
Время, в течение которого расписание заданий ввело свое предыдущее состояние. |
schedule |
Расписание, в соответствии с которым будут созданы задания. |
|
state |
Текущее состояние расписания заданий. |
|
stateTransitionTime |
string |
Время ввода расписания заданий в текущее состояние. |
stats |
Статистика использования ресурсов времени существования для расписания заданий. Статистика может быть недоступна сразу. Пакетная служба выполняет периодический свертки статистики. Типичная задержка составляет около 30 минут. |
|
url |
string |
URL-адрес расписания заданий. |
CloudJobScheduleListResult
Результат перечисления расписаний заданий в учетной записи.
Имя | Тип | Описание |
---|---|---|
odata.nextLink |
string |
URL-адрес для получения следующего набора результатов. |
value |
Список расписаний заданий. |
ComputeNodeFillType
Распределение задач между вычислительными узлами в пуле.
Имя | Тип | Описание |
---|---|---|
pack |
string |
Максимальное количество задач (taskSlotsPerNode) должно быть назначено каждому вычислительному узлу в пуле, прежде чем все задачи назначены следующему вычислительному узлу в пуле. |
spread |
string |
Задачи должны назначаться равномерно по всем вычислительным узлам в пуле. |
ComputeNodeIdentityReference
Ссылка на назначенное пользователем удостоверение, связанное с пулом пакетной службы, который будет использовать вычислительный узел.
Имя | Тип | Описание |
---|---|---|
resourceId |
string |
Идентификатор ресурса ARM назначенного пользователем удостоверения. |
ContainerConfiguration
Конфигурация пулов с поддержкой контейнера.
Имя | Тип | Описание |
---|---|---|
containerImageNames |
string[] |
Коллекция имен образов контейнера. |
containerRegistries |
Дополнительные частные реестры, из которых можно извлечь контейнеры. |
|
type |
Используемая технология контейнера. |
ContainerHostBatchBindMountEntry
Вход пути и режима подключения, который требуется подключить к контейнеру задач.
Имя | Тип | Описание |
---|---|---|
isReadOnly |
boolean |
Подключите этот исходный путь как режим только для чтения или нет. Значение по умолчанию равно false (режим чтения и записи). |
source |
Путь, подключенный к клиенту контейнера, можно выбрать. |
ContainerHostDataPath
Пути, которые будут подключены к контейнеру задачи контейнера.
Имя | Тип | Описание |
---|---|---|
Applications |
string |
Путь к приложениям. |
JobPrep |
string |
Путь задачи подготовки задания. |
Shared |
string |
Путь к задаче с несколькими экземплярами для совместного использования файлов. |
Startup |
string |
Путь к задаче запуска. |
Task |
string |
Путь к задаче. |
VfsMounts |
string |
Путь содержит все виртуальные файловые системы, подключенные на этом узле. |
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
Указывает временные параметры диска для диска операционной системы, используемого вычислительным узлом (vm).
Имя | Тип | Описание |
---|---|---|
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 Virtual Machines Marketplace или образ коллекции вычислений Azure. Чтобы получить список всех ссылок на образы Azure Marketplace, проверенных пакетной службой Azure, см. операцию "Список поддерживаемых образов".
Имя | Тип | Описание |
---|---|---|
communityGalleryImageId |
string |
Уникальный идентификатор образа коллекции сообщества |
exactVersion |
string |
Конкретная версия образа платформы или образа Marketplace, используемая для создания узла. Это поле только для чтения отличается от "версии" только в том случае, если значение, указанное для "версии", когда пул был создан, был "последняя". |
offer |
string |
Тип предложения образа Azure Virtual Machines Marketplace. |
publisher |
string |
Издатель образа Azure Virtual Machines Marketplace. |
sharedGalleryImageId |
string |
Уникальный идентификатор образа общей коллекции |
sku |
string |
Номер SKU образа Azure Virtual Machines Marketplace. |
version |
string |
Версия образа Azure Virtual Machines Marketplace. |
virtualMachineImageId |
string |
Идентификатор ресурса ARM образа коллекции вычислений Azure. Вычислительные узлы в пуле будут созданы с помощью этого идентификатора образа. Это форма /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} или /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName} для постоянного использования последней версии образа. |
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-адреса предоставляются пользователем и будут использоваться для подготовки вычислительных узлов. |
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
Конфигурация сети для задания.
Имя | Тип | Описание |
---|---|---|
skipWithdrawFromVNet |
boolean |
Следует ли удалять вычислительные узлы из виртуальной сети в DNC при завершении или удалении задания. |
subnetId |
string |
Идентификатор ресурса ARM подсети виртуальной сети, в которой вычислительные узлы, выполняющие задачи из задания, присоединяются в течение длительности задачи. |
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 |
Удостоверение пользователя, под которым выполняется задача выпуска задания. |
JobScheduleExecutionInformation
Содержит сведения о заданиях, которые были и будут выполняться в рамках расписания заданий.
Имя | Тип | Описание |
---|---|---|
endTime |
string |
Время окончания расписания. |
nextRunTime |
string |
В следующий раз, когда задание будет создано в рамках этого расписания. |
recentJob |
Сведения о последнем задании в рамках расписания заданий. |
JobScheduleState
Состояние расписания заданий.
Имя | Тип | Описание |
---|---|---|
active |
string |
Расписание заданий активно и будет создавать задания в соответствии с его расписанием. |
completed |
string |
Расписание заданий завершилось либо путем достижения времени окончания, либо путем явного завершения работы пользователя. |
deleting |
string |
Пользователь попросил удалить расписание заданий, но операция удаления по-прежнему выполняется. Планировщик не инициирует новые задания для этого расписания заданий и удаляет существующие задания и задачи в рамках расписания заданий, включая любое активное задание. Расписание заданий будет удалено при удалении всех заданий и задач в рамках расписания заданий. |
disabled |
string |
Пользователь отключил расписание заданий. Планировщик не будет инициировать новые задания в этом расписании, но все существующие активные задания будут продолжать выполняться. |
terminating |
string |
Расписание заданий не имеет больше работы или явно завершено пользователем, но операция завершения по-прежнему выполняется. Планировщик не инициирует новые задания для этого расписания заданий и не активен. |
JobScheduleStatistics
Статистика использования ресурсов для расписания заданий.
Имя | Тип | Описание |
---|---|---|
kernelCPUTime |
string |
Общее время ЦП режима ядра (суммировано во всех ядрах и всех вычислительных узлах), потребляемое всеми задачами во всех заданиях, созданных в соответствии с расписанием. |
lastUpdateTime |
string |
Время последнего обновления статистики. Все статистические данные ограничены диапазоном между startTime и lastUpdateTime. |
numFailedTasks |
integer |
Общее количество задач, завершающихся сбоем в заданном диапазоне времени в заданиях, созданных в соответствии с расписанием. Задача завершается ошибкой, если она исчерпает максимальное число повторных попыток, не возвращая код выхода 0. |
numSucceededTasks |
integer |
Общее количество задач успешно завершено в течение заданного диапазона времени в заданиях, созданных в соответствии с расписанием. Задача завершается успешно, если возвращает код выхода 0. |
numTaskRetries |
integer |
Общее количество повторных попыток в течение заданного диапазона времени для всех задач во всех заданиях, созданных в соответствии с расписанием. |
readIOGiB |
number |
Общее количество гибибайтов, считываемых с диска всеми задачами во всех заданиях, созданных в соответствии с расписанием. |
readIOps |
integer |
Общее количество операций чтения диска, выполненных всеми задачами во всех заданиях, созданных в соответствии с расписанием. |
startTime |
string |
Время начала диапазона времени, охватываемого статистикой. |
url |
string |
URL-адрес статистики. |
userCPUTime |
string |
Общее время ЦП в пользовательском режиме (суммировано во всех ядрах и всех вычислительных узлах), потребляемое всеми задачами во всех заданиях, созданных в соответствии с расписанием. |
waitTime |
string |
Общее время ожидания всех задач во всех заданиях, созданных в соответствии с расписанием. Время ожидания задачи определяется как истекшее время между созданием задачи и началом выполнения задачи. (Если задача извлекается из-за сбоев, время ожидания — это время последнего выполнения задачи.) |
wallClockTime |
string |
Общее время настенных часов всех задач во всех заданиях, созданных в соответствии с расписанием. |
writeIOGiB |
number |
Общее количество гибибайтов, записанных на диск всеми задачами во всех заданиях, созданных в соответствии с расписанием. |
writeIOps |
integer |
Общее количество операций записи диска, выполненных всеми задачами во всех заданиях, созданных в соответствии с расписанием. |
JobSpecification
Указывает сведения о заданиях, создаваемых по расписанию.
Имя | Тип | Default value | Описание |
---|---|---|---|
allowTaskPreemption |
boolean |
Могут ли задачи в этом задании быть предопределены другими заданиями с высоким приоритетом |
|
commonEnvironmentSettings |
Список общих параметров переменной среды. Эти переменные среды задаются для всех задач в заданиях, созданных в рамках этого расписания (включая диспетчер заданий, задачи подготовки заданий и выпуска заданий). |
||
constraints |
Ограничения выполнения для заданий, созданных в рамках этого расписания. |
||
displayName |
string |
Отображаемое имя заданий, созданных в рамках этого расписания. |
|
jobManagerTask |
Сведения о задаче диспетчера заданий, запускаемой при запуске задания в рамках этого расписания. |
||
jobPreparationTask |
Задача подготовки заданий для заданий, созданных в рамках этого расписания. |
||
jobReleaseTask |
Задача выпуска задания для заданий, созданных в рамках этого расписания. |
||
maxParallelTasks |
integer |
-1 |
Максимальное количество задач, которые могут выполняться параллельно для задания. |
metadata |
Список пар "имя-значение", связанных с каждым заданием, созданным в рамках этого расписания в качестве метаданных. |
||
networkConfiguration |
Конфигурация сети для задания. |
||
onAllTasksComplete |
Действие пакетной службы должно выполняться, когда все задачи в задании, созданном в рамках этого расписания, находятся в состоянии завершения. |
||
onTaskFailure |
Действие пакетной службы должно выполняться при сбое любой задачи в задании, созданном в рамках этого расписания. Задача считается неудачной, если она завершилась сбоем, если имеется ошибкаInfo. Параметр failureInfo устанавливается, если задача завершается с кодом выхода без нуля после исчерпания его количества повторных попыток или если возникла ошибка запуска задачи, например из-за ошибки загрузки файла ресурсов. |
||
poolInfo |
Пул, на котором служба пакетной службы выполняет задачи заданий, созданных в рамках этого расписания. |
||
priority |
integer |
Приоритет заданий, созданных в рамках этого расписания. |
|
usesTaskDependencies |
boolean |
Могут ли задачи в задании определять зависимости друг от друга. Значение по умолчанию — false. |
LinuxUserConfiguration
Свойства, используемые для создания учетной записи пользователя на вычислительном узле Linux.
Имя | Тип | Описание |
---|---|---|
gid |
integer |
Идентификатор группы для учетной записи пользователя. |
sshPrivateKey |
string |
Закрытый ключ SSH для учетной записи пользователя. |
uid |
integer |
Идентификатор пользователя учетной записи пользователя. |
LoginMode
Режим входа для пользователя
Имя | Тип | Описание |
---|---|---|
batch |
string |
Режим входа LOGON32_LOGON_BATCH Win32. Для длительных параллельных процессов рекомендуется использовать режим входа пакетной службы. |
interactive |
string |
Режим входа LOGON32_LOGON_INTERACTIVE Win32. UAC включен в пулах Windows. Если этот параметр используется с удостоверением пользователя с повышенными привилегиями в пуле Windows, сеанс пользователя не будет повышен, если приложение, выполняемое командной строкой задачи, всегда требует права администратора или всегда требует максимальной привилегии. |
ManagedDisk
Имя | Тип | Описание |
---|---|---|
securityProfile |
Задает параметры профиля безопасности для управляемого диска. |
|
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 в хранилище.регион и BatchNodeManagement. Теги службы {region}". |
default |
string |
Режим связи узла автоматически устанавливается пакетной службой. |
simplified |
string |
Узлы, использующие упрощенный режим связи, требуют исходящего TCP-подключения через порт 443 к пакетной службе BatchNodeManagement. Тег службы {region}". Открытые входящие порты не требуются. |
NodePlacementConfiguration
Конфигурация размещения узлов для пула.
Имя | Тип | Описание |
---|---|---|
policy |
Тип политики размещения узлов в пулах пакетной службы. |
NodePlacementPolicyType
Политика размещения для выделения узлов в пуле.
Имя | Тип | Описание |
---|---|---|
regional |
string |
Все узлы в пуле будут выделены в одном регионе. |
zonal |
string |
Узлы в пуле будут распределяться по разным зонам доступности с оптимальной балансировкой усилий. |
OnAllTasksComplete
Действие пакетной службы должно выполняться, когда все задачи в задании находятся в состоянии завершения.
Имя | Тип | Описание |
---|---|---|
noaction |
string |
Бездействовать. Задание остается активным, если не завершено или отключено другими средствами. |
terminatejob |
string |
Завершение задания. Значение "AllTasksComplete" имеет значение "AllTasksComplete". |
OnTaskFailure
Действие пакетной службы должно выполняться при сбое любой задачи в задании.
Имя | Тип | Описание |
---|---|---|
noaction |
string |
Бездействовать. Задание остается активным, если не завершено или отключено другими средствами. |
performexitoptionsjobaction |
string |
Выполните действие, связанное с условием выхода задачи в коллекции Task exitConditions. (Это может привести к тому, что действие не выполняется, если это то, что указывает задача.) |
OSDisk
Параметры диска операционной системы вычислительного узла (VM).
Имя | Тип | Описание |
---|---|---|
caching |
Указывает требования к кэшированию. Возможные значения: None, ReadOnly, ReadWrite. Значения по умолчанию: нет для хранилища уровня "Стандартный". ReadOnly для хранилища Premium. |
|
diskSizeGB |
integer |
Начальный размер диска в ГБ при создании нового диска ОС. |
ephemeralOSDiskSettings |
Указывает временные параметры диска для диска операционной системы, используемого вычислительным узлом (vm). |
|
managedDisk |
Параметры управляемого диска. |
|
writeAcceleratorEnabled |
boolean |
Указывает, следует ли включить или отключить записьAccelerator на диске. |
OutputFile
Спецификация отправки файлов из вычислительного узла пакетной службы Azure в другое расположение после завершения выполнения процесса задачи пакетной службы.
Имя | Тип | Описание |
---|---|---|
destination |
Назначение выходных файлов. |
|
filePattern |
string |
Шаблон, указывающий, какие файлы нужно отправить. |
uploadOptions |
Дополнительные параметры для операции отправки, включая условия выполнения отправки. |
OutputFileBlobContainerDestination
Указывает назначение отправки файлов в контейнере хранилища BLOB-объектов Azure.
Имя | Тип | Описание |
---|---|---|
containerUrl |
string |
URL-адрес контейнера в хранилище BLOB-объектов Azure, в который нужно отправить файлы. |
identityReference |
Ссылка на назначенное пользователем удостоверение, используемое для доступа к хранилищу BLOB-объектов Azure, заданному контейнеромUrl |
|
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 |
Пул существует в течение всего времени существования задания, к которому она выделена. Пакетная служба создает пул при создании задания. Если параметр job применяется к расписанию заданий, пакетная служба создает новый автоматический пул для каждого задания, созданного в расписании. |
jobschedule |
string |
Пул существует в течение времени существования расписания заданий. Пакетная служба создает пул при создании первого задания по расписанию. Этот параметр можно применить только к расписаниям заданий, а не к заданиям. |
PoolSpecification
Спецификация создания нового пула.
Имя | Тип | Описание |
---|---|---|
applicationPackageReferences |
Список пакетов, установленных на каждом вычислительном узле в пуле. |
|
autoScaleEvaluationInterval |
string |
Интервал времени, с помощью которого автоматически настраивается размер пула в соответствии с формулой автомасштабирования. |
autoScaleFormula |
string |
Формула для требуемого количества вычислительных узлов в пуле. |
certificateReferences |
Список сертификатов, которые необходимо установить на каждом вычислительном узле в пуле. Предупреждение. Это свойство устарело и будет удалено после февраля 2024 года. Вместо этого используйте расширения Azure KeyVault |
|
displayName |
string |
Отображаемое имя пула. |
enableAutoScale |
boolean |
Следует ли автоматически настраивать размер пула с течением времени. |
enableInterNodeCommunication |
boolean |
Разрешает ли пул прямой обмен данными между вычислительными узлами. |
metadata |
Список пар "имя-значение", связанных с пулом в качестве метаданных. |
|
mountConfiguration |
Список файловых систем для подключения на каждом узле в пуле. |
|
networkConfiguration |
Конфигурация сети для пула. |
|
resizeTimeout |
string |
Время ожидания выделения вычислительных узлов в пул. |
resourceTags |
object |
Указанные пользователем теги, связанные с пулом. |
startTask |
Задача, выполняемая на каждом вычислительном узле при присоединении к пулу. Задача выполняется при добавлении вычислительного узла в пул или при перезапуске вычислительного узла. |
|
targetDedicatedNodes |
integer |
Требуемое количество выделенных вычислительных узлов в пуле. |
targetLowPriorityNodes |
integer |
Требуемое количество точечных и низкоприоритетных вычислительных узлов в пуле. |
targetNodeCommunicationMode |
Требуемый режим связи узла для пула. |
|
taskSchedulingPolicy |
Распределение задач между вычислительными узлами в пуле. |
|
taskSlotsPerNode |
integer |
Количество слотов задач, которые можно использовать для выполнения параллельных задач на одном вычислительном узле в пуле. |
upgradePolicy |
Политика обновления пула. |
|
userAccounts |
Список учетных записей пользователей, создаваемых на каждом вычислительном узле в пуле. |
|
virtualMachineConfiguration |
Конфигурация виртуальной машины для пула. |
|
vmSize |
string |
Размер виртуальных машин в пуле. Все виртуальные машины в пуле имеют одинаковый размер. |
PublicIPAddressConfiguration
Конфигурация общедоступного IP-адреса конфигурации сети пула.
Имя | Тип | Описание |
---|---|---|
ipAddressIds |
string[] |
Список общедоступных IP-адресов, которые будет использоваться пакетной службой при подготовке вычислительных узлов. |
provision |
Тип подготовки для общедоступных IP-адресов пула. |
RecentJob
Сведения о последнем задании, выполняемом в рамках расписания заданий.
Имя | Тип | Описание |
---|---|---|
id |
string |
Идентификатор задания. |
url |
string |
URL-адрес задания. |
ResourceFile
Один файл или несколько файлов, которые нужно скачать на вычислительный узел.
Имя | Тип | Описание |
---|---|---|
autoStorageContainerName |
string |
Имя контейнера хранилища в учетной записи автоматического хранения. |
blobPrefix |
string |
Префикс большого двоичного объекта, используемый при скачивании BLOB-объектов из контейнера службы хранилища Azure. Будут загружены только большие двоичные объекты, имена которых начинаются с указанного префикса. |
fileMode |
string |
Атрибут режима разрешений файла в восьмимерном формате. |
filePath |
string |
Расположение на вычислительном узле, на который следует скачать файлы, относительно рабочего каталога задачи. |
httpUrl |
string |
URL-адрес скачиваемого файла. |
identityReference |
Ссылка на назначенное пользователем удостоверение для доступа к хранилищу BLOB-объектов Azure, заданному storageContainerUrl или httpUrl |
|
storageContainerUrl |
string |
URL-адрес контейнера BLOB-объектов в хранилище BLOB-объектов Azure. |
RollingUpgradePolicy
Параметры конфигурации, используемые при выполнении последовательного обновления.
Имя | Тип | Описание |
---|---|---|
enableCrossZoneUpgrade |
boolean |
Разрешить VMSS игнорировать границы AZ при создании пакетов обновления. Учитывайте домен обновления и maxBatchInstancePercent, чтобы определить размер пакета. Это поле может иметь значение true или false только при использовании NodePlacementConfiguration в качестве зонального. |
maxBatchInstancePercent |
integer |
Максимальный процент общих экземпляров виртуальных машин, которые будут обновляться одновременно путем последовательного обновления в одном пакете. Так как это максимальный, неработоспособные экземпляры в предыдущих или будущих пакетах могут привести к снижению процента экземпляров в пакете, чтобы обеспечить более высокую надежность. Значение этого поля должно составлять от 5 до 100 включительно. Если значение maxBatchInstancePercent и maxUnhealthyInstancePercent присваивается значением, значение maxBatchInstancePercent не должно превышать maxUnhealthyInstancePercent. |
maxUnhealthyInstancePercent |
integer |
Максимальный процент всех экземпляров виртуальных машин в масштабируемом наборе, которые могут быть одновременно неработоспособными, либо в результате обновления, либо путем обнаружения в неработоспособном состоянии проверки работоспособности виртуальной машины до завершения последовательного обновления. Это ограничение будет проверено перед запуском любого пакета. Значение этого поля должно составлять от 5 до 100 включительно. Если значение maxBatchInstancePercent и maxUnhealthyInstancePercent присваивается значением, значение maxBatchInstancePercent не должно превышать maxUnhealthyInstancePercent. |
maxUnhealthyUpgradedInstancePercent |
integer |
Максимальный процент обновленных экземпляров виртуальных машин, которые можно найти в неработоспособном состоянии. Эта проверка произойдет после обновления каждого пакета. Если этот процент когда-либо превышается, последовательное обновление прерывается. Значение этого поля должно быть от 0 до 100 включительно. |
pauseTimeBetweenBatches |
string |
Время ожидания между завершением обновления для всех виртуальных машин в одном пакете и запуском следующего пакета. Длительность времени должна быть указана в формате ISO 8601. |
prioritizeUnhealthyInstances |
boolean |
Обновите все неработоспособные экземпляры в масштабируемом наборе до всех здоровых экземпляров. |
rollbackFailedInstancesOnPolicyBreach |
boolean |
Откат неудачных экземпляров до предыдущей модели, если политика последовательного обновления нарушена. |
Schedule
Расписание, в соответствии с которым будут созданы задания. Все время фиксируются в формате UTC и не влияют на летнее время.
Имя | Тип | Описание |
---|---|---|
doNotRunAfter |
string |
Время, после которого задание не будет создано в рамках этого расписания заданий. Расписание перейдет к завершенному состоянию, как только этот крайний срок истек и в этом расписании задания нет активного задания. |
doNotRunUntil |
string |
Самое раннее время создания любого задания в рамках этого расписания заданий. |
recurrenceInterval |
string |
Интервал времени между временем начала двух последовательных заданий в рамках расписания заданий. Расписание заданий может иметь по крайней мере одно активное задание в любое время. |
startWindow |
string |
Интервал времени, начиная с момента создания расписания, в котором должно быть создано задание. |
SecurityEncryptionTypes
Указывает тип шифрования управляемого диска. Он имеет значение VMGuestStateOnly для шифрования только большого двоичного объекта VMGuestState и NonPersistedTPM для сохранения состояния встроенного ПО в BLOB-объекте VMGuestState. примечание. Его можно задать только для конфиденциальных виртуальных машин и требуется при использовании конфиденциальных виртуальных машин.
Имя | Тип | Описание |
---|---|---|
NonPersistedTPM |
string |
|
VMGuestStateOnly |
string |
SecurityProfile
Задает параметры профиля безопасности для масштабируемого набора виртуальных машин или виртуальной машины.
Имя | Тип | Описание |
---|---|---|
encryptionAtHost |
boolean |
Это свойство можно использовать пользователем в запросе, чтобы включить или отключить шифрование узла для виртуальной машины или масштабируемого набора виртуальных машин. Это позволит включить шифрование для всех дисков, включая диск Resource/Temp на самом узле. Дополнительные сведения о шифровании в требованиях к узлам см. в https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizes. |
securityType |
Указывает тип безопасности виртуальной машины. Для включения UefiSettings необходимо задать любое указанное значение. |
|
uefiSettings |
Указывает параметры безопасности, такие как безопасная загрузка и vTPM, используемые при создании виртуальной машины. |
SecurityTypes
Указывает тип безопасности виртуальной машины. Для включения UefiSettings необходимо задать любое указанное значение.
Имя | Тип | Описание |
---|---|---|
confidentialVM |
string |
Конфиденциальные вычисления Azure предлагают конфиденциальные виртуальные машины для клиентов с высокими требованиями к безопасности и конфиденциальности. Эти виртуальные машины обеспечивают надежную аппаратные границы, помогающие удовлетворить ваши потребности в безопасности. Конфиденциальные виртуальные машины можно использовать для миграции, не изменяя код, с помощью платформы, защищающей состояние виртуальной машины от чтения или изменения. |
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
Параметры контейнера для задачи.
Имя | Тип | Описание |
---|---|---|
containerHostBatchBindMounts |
Пути, которые необходимо подключить к задаче контейнера. |
|
containerRunOptions |
string |
Дополнительные параметры команды создания контейнера. |
imageName |
string |
Образ, используемый для создания контейнера, в котором будет выполняться задача. |
registry |
Частный реестр, содержащий образ контейнера. |
|
workingDirectory |
Расположение рабочего каталога задачи контейнера. |
TaskSchedulingPolicy
Указывает, как задачи должны распределяться по вычислительным узлам.
Имя | Тип | Описание |
---|---|---|
nodeFillType |
Распределение задач между вычислительными узлами в пуле. |
UefiSettings
Указывает параметры безопасности, такие как безопасная загрузка и vTPM, используемые при создании виртуальной машины.
Имя | Тип | Описание |
---|---|---|
secureBootEnabled |
boolean |
Указывает, следует ли включить безопасную загрузку на виртуальной машине. |
vTpmEnabled |
boolean |
Указывает, следует ли включить vTPM на виртуальной машине. |
UpgradeMode
Задает режим обновления до виртуальных машин в масштабируемом наборе.
Возможные значения:
вручную. Вы управляете приложением обновлений виртуальных машин в масштабируемом наборе. Это можно сделать с помощью действия manualUpgrade.
автоматическое. Все виртуальные машины в масштабируемом наборе автоматически обновляются одновременно.
Скользящей. Масштабируемый набор выполняет обновления в пакетах с необязательным временем приостановки между ними.
Имя | Тип | Описание |
---|---|---|
automatic |
string |
Все виртуальные машины в масштабируемом наборе автоматически обновляются одновременно. |
manual |
string |
Вы управляете применением обновлений для виртуальных машин в масштабируемом наборе. Это можно сделать с помощью действия manualUpgrade. |
rolling |
string |
Существующие экземпляры в масштабируемом наборе удаляются в пакетах для обновления. После завершения обновленного пакета экземпляры начнут принимать трафик снова, а следующий пакет начнется. Это продолжается до тех пор, пока все экземпляры не будут доставлены up-to-date. |
UpgradePolicy
Описывает политику обновления — автоматическую, ручную или перекатную.
Имя | Тип | Описание |
---|---|---|
automaticOSUpgradePolicy |
Параметры конфигурации, используемые для автоматического обновления ОС. |
|
mode |
Задает режим обновления до виртуальных машин в масштабируемом наборе. |
|
rollingUpgradePolicy |
Параметры конфигурации, используемые при выполнении последовательного обновления. |
UserAccount
Свойства, используемые для создания пользователя, используемого для выполнения задач на вычислительном узле пакетной службы Azure.
Имя | Тип | Описание |
---|---|---|
elevationLevel |
Уровень повышения прав учетной записи пользователя. |
|
linuxUserConfiguration |
Конфигурация пользователя для конкретной платформы Linux для учетной записи пользователя. |
|
name |
string |
Имя учетной записи пользователя. Имена могут содержать любые символы Юникода до максимальной длины 20. |
password |
string |
Пароль для учетной записи пользователя. |
windowsUserConfiguration |
Конфигурация пользователя windows для учетной записи пользователя. |
UserIdentity
Определение удостоверения пользователя, в котором выполняется задача.
Имя | Тип | Описание |
---|---|---|
autoUser |
Автоматический пользователь, под которым выполняется задача. |
|
username |
string |
Имя удостоверения пользователя, в котором выполняется задача. |
VirtualMachineConfiguration
Конфигурация вычислительных узлов в пуле на основе инфраструктуры виртуальных машин Azure.
Имя | Тип | Описание |
---|---|---|
containerConfiguration |
Конфигурация контейнера для пула. |
|
dataDisks |
Data |
Конфигурация дисков данных, подключенных к вычислительным узлам в пуле. |
diskEncryptionConfiguration |
Конфигурация шифрования дисков для пула. |
|
extensions |
Расширение виртуальной машины для пула. |
|
imageReference |
Ссылка на образ Marketplace виртуальных машин Azure или пользовательский образ виртуальной машины для использования. |
|
licenseType |
string |
Тип локальной лицензии, используемой при развертывании операционной системы. Windows_Server . Локальная лицензия предназначена для Windows Server. Windows_Client . Локальная лицензия предназначена для клиента Windows. |
nodeAgentSKUId |
string |
Номер SKU агента пакетного вычислительного узла для подготовки на вычислительных узлах в пуле. |
nodePlacementConfiguration |
Конфигурация размещения узлов для пула. |
|
osDisk |
Параметры диска операционной системы виртуальной машины. |
|
securityProfile |
Задает параметры профиля безопасности для масштабируемого набора виртуальных машин или виртуальной машины. |
|
serviceArtifactReference |
Указывает идентификатор ссылки на артефакт службы, используемый для задания одной версии образа для всех виртуальных машин в масштабируемом наборе при использовании последней версии образа. |
|
windowsConfiguration |
Параметры операционной системы Windows на виртуальной машине. |
VMDiskSecurityProfile
Задает параметры профиля безопасности для управляемого диска. примечание. Его можно задать только для конфиденциальных виртуальных машин и требоваться при использовании конфиденциальных виртуальных машин.
Имя | Тип | Описание |
---|---|---|
securityEncryptionType |
Указывает тип шифрования управляемого диска. Он имеет значение VMGuestStateOnly для шифрования только большого двоичного объекта VMGuestState и NonPersistedTPM для сохранения состояния встроенного ПО в BLOB-объекте VMGuestState. примечание. Его можно задать только для конфиденциальных виртуальных машин и требуется при использовании конфиденциальных виртуальных машин. |
VMExtension
Конфигурация расширений виртуальных машин.
Имя | Тип | Описание |
---|---|---|
autoUpgradeMinorVersion |
boolean |
Указывает, следует ли использовать более новую дополнительную версию, если она доступна во время развертывания. Однако после развертывания расширение не будет обновлять дополнительные версии без повторного развертывания, даже если это свойство не имеет значения true. |
enableAutomaticUpgrade |
boolean |
Указывает, следует ли автоматически обновлять расширение платформой, если доступна более новая версия расширения. |
name |
string |
Имя расширения виртуальной машины. |
protectedSettings |
object |
Расширение может содержать защищенные параметрыSettings или protectedSettingsFromKeyVault или не иметь защищенных параметров. |
provisionAfterExtensions |
string[] |
Коллекция имен расширений. |
publisher |
string |
Имя издателя обработчика расширений. |
settings |
object |
Форматированные общедоступные параметры JSON для расширения. |
type |
string |
Тип расширения. |
typeHandlerVersion |
string |
Версия обработчика скрипта. |
WindowsConfiguration
Параметры операционной системы Windows для применения к виртуальной машине.
Имя | Тип | Описание |
---|---|---|
enableAutomaticUpdates |
boolean |
Включена ли автоматическая установка обновлений на виртуальной машине. |
WindowsUserConfiguration
Свойства, используемые для создания учетной записи пользователя на вычислительном узле Windows.
Имя | Тип | Описание |
---|---|---|
loginMode |
Режим входа для пользователя |