Pool - Add

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

POST {batchUrl}/pools?api-version=2020-09-01.12.0
POST {batchUrl}/pools?timeout={timeout}&api-version=2020-09-01.12.0

Параметры URI

Name In Required Type Description
batchUrl
path True
  • string

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

api-version
query True
  • string

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

timeout
query
  • integer
int32

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

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

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

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

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

return-client-request-id
  • boolean

Должен ли сервер возвращать в ответе клиент-Request-ID.

ocp-date
  • string
date-time-rfc1123

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

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

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

Name Required Type Description
id True
  • string

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

vmSize True
  • string

Размер виртуальных машин в пуле. Все виртуальные машины в пуле имеют одинаковый размер.
Сведения о доступных размерах виртуальных машин для пулов облачных служб (пулов, созданных с помощью cloudServiceConfiguration) см. в статье размеры для облачных служб ( https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/) . Пакетная служба поддерживает все размеры виртуальных машин облачных служб, кроме Сверхмалый, A1V2 и A2V2. Сведения о доступных размерах ВИРТУАЛЬНЫХ машин для пулов с использованием образов из магазина виртуальных машин (пулы, созданные с помощью virtualMachineConfiguration) см. в статье размеры виртуальных машин (Linux) ( https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) или размеры виртуальных машин (Windows) () https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/) . Пакетная служба поддерживает все размеры виртуальных машин Azure, кроме STANDARD_A0 и хранилища класса Premium (STANDARD_GS, STANDARD_DS и STANDARD_DSV2 Series).

applicationLicenses
  • string[]

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

applicationPackageReferences

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

autoScaleEvaluationInterval
  • string

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

autoScaleFormula
  • string

Формула для требуемого числа вычисляемых узлов в пуле.
Это свойство не должно быть указано, если для enableAutoScale задано значение false. Он необходим, если для enableAutoScale задано значение true. Формула проверяется на допустимость до создания пула. Если формула недопустима, пакетная Служба отклоняет запрос с подробными сведениями об ошибке. Дополнительные сведения об указании этой формулы см. в разделе "автоматическое масштабирование вычисляемых узлов в пуле пакетной службы Azure" ( https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/) .

certificateReferences

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

cloudServiceConfiguration

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

displayName
  • string

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

enableAutoScale
  • boolean

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

enableInterNodeCommunication
  • boolean

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

metadata

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

mountConfiguration

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

networkConfiguration

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

resizeTimeout
  • string

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

startTask

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

targetDedicatedNodes
  • integer

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

targetLowPriorityNodes
  • integer

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

taskSchedulingPolicy

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

taskSlotsPerNode
  • integer

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

userAccounts

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

virtualMachineConfiguration

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

Ответы

Name Type Description
201 Created

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

Headers

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

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

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

azure_auth

Поток OAuth2 Azure Active Directory

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

Scopes

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

Authorization

Type: apiKey
In: header

Примеры

Add a CloudServiceConfiguration pool
Add a pool with mount drive specified
Add a VirtualMachineConfiguration pool
Add a VirtualMachineConfiguration pool with containers

Add a CloudServiceConfiguration pool

Sample Request

POST account.region.batch.azure.com/pools?api-version=2020-09-01.12.0
client-request-id: 00000000-0000-0000-0000-000000000000
ocp-date: Fri, 17 Feb 2017 00:00:00 GMT
{
  "id": "poolId",
  "vmSize": "small",
  "cloudServiceConfiguration": {
    "osFamily": "4"
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false,
  "enableInterNodeCommunication": true,
  "metadata": [
    {
      "name": "myproperty",
      "value": "myvalue"
    }
  ]
}

Sample Response

Add a pool with mount drive specified

Sample Request

POST account.region.batch.azure.com/pools?api-version=2020-09-01.12.0
client-request-id: 00000000-0000-0000-0000-000000000000
{
  "id": "pool2",
  "vmSize": "standard_a1",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "UbuntuServer",
      "sku": "16.04.0-LTS"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 16.04"
  },
  "mountConfiguration": [
    {
      "azureBlobFileSystemConfiguration": {
        "accountName": "accountName",
        "containerName": "blobContainerName",
        "accountKey": "accountKey",
        "relativeMountPath": "bfusepath"
      }
    },
    {
      "azureFileShareConfiguration": {
        "accountName": "accountName",
        "azureFileUrl": "https://myaccount.file.core.windows.net/fileshare",
        "accountKey": "accountKey",
        "relativeMountPath": "filesharepath",
        "mountOptions": "mount options ver=1.0"
      }
    },
    {
      "nfsMountConfiguration": {
        "source": "somesource nfs url",
        "relativeMountPath": "mountpath",
        "mountOptions": "mount options ver=1.0"
      }
    },
    {
      "cifsMountConfiguration": {
        "username": "accountName",
        "password": "password",
        "source": "//myaccount.file.core.windows.net/file",
        "relativeMountPath": "mountpath",
        "mountOptions": "mount options ver=1.0"
      }
    }
  ],
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false
}

Sample Response

Add a VirtualMachineConfiguration pool

Sample Request

POST account.region.batch.azure.com/pools?api-version=2020-09-01.12.0
client-request-id: 00000000-0000-0000-0000-000000000000
ocp-date: Fri, 17 Feb 2017 00:00:00 GMT
{
  "id": "pool2",
  "vmSize": "standard_a1",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "UbuntuServer",
      "sku": "16.04.0-LTS"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 16.04"
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false,
  "enableInterNodeCommunication": true,
  "metadata": [
    {
      "name": "myproperty",
      "value": "myvalue"
    }
  ]
}

Sample Response

Add a VirtualMachineConfiguration pool with containers

Sample Request

POST account.region.batch.azure.com/pools?api-version=2020-09-01.12.0
client-request-id: 00000000-0000-0000-0000-000000000000
ocp-date: Fri, 17 Feb 2017 00:00:00 GMT
{
  "id": "pool2",
  "vmSize": "standard_a1",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "UbuntuServer",
      "sku": "16.04.0-LTS"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 16.04",
    "containerConfiguration": {
      "type": "dockerCompatible",
      "containerImageNames": [
        "busybox"
      ]
    }
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false
}

Sample Response

Определения

ApplicationPackageReference

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

AutoUserScope

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

AutoUserSpecification

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

AzureBlobFileSystemConfiguration

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

AzureFileShareConfiguration

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

BatchError

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

BatchErrorDetail

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

CachingType

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

CertificateReference

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

CertificateStoreLocation

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

CIFSMountConfiguration

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

CloudServiceConfiguration

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

ComputeNodeFillType

Как задачи распределяются между различными узлами в пуле.

ContainerConfiguration

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

ContainerRegistry

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

ContainerType

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

ContainerWorkingDirectory

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

DataDisk

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

DiskEncryptionConfiguration

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

DynamicVNetAssignmentScope

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

ElevationLevel

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

EnvironmentSetting

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

ErrorMessage

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

ImageReference

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

InboundEndpointProtocol

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

InboundNATPool

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

IPAddressProvisioningType

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

LinuxUserConfiguration

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

LoginMode

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

MetadataItem

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

MountConfiguration

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

NetworkConfiguration

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

NetworkSecurityGroupRule

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

NetworkSecurityGroupRuleAccess

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

NFSMountConfiguration

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

PoolAddParameter

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

PoolEndpointConfiguration

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

PublicIPAddressConfiguration

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

ResourceFile

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

StartTask

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

StorageAccountType

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

TaskContainerSettings

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

TaskSchedulingPolicy

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

UserAccount

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

UserIdentity

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

VirtualMachineConfiguration

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

WindowsConfiguration

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

WindowsUserConfiguration

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

ApplicationPackageReference

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

Name Type Description
applicationId
  • string

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

version
  • string

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

AutoUserScope

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

Name Type Description
pool
  • string

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

task
  • string

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

AutoUserSpecification

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

Name Type Description
elevationLevel

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

scope

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

AzureBlobFileSystemConfiguration

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

Name Type Description
accountKey
  • string

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

accountName
  • string

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

blobfuseOptions
  • string

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

containerName
  • string

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

relativeMountPath
  • string

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

sasKey
  • string

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

AzureFileShareConfiguration

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

Name Type Description
accountKey
  • string

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

accountName
  • string

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

azureFileUrl
  • string

URL-адрес службы файлов Azure.
Это форма «HTTPS://{Account}. File. Core. Windows. NET/».

mountOptions
  • string

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

relativeMountPath
  • string

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

BatchError

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

Name Type Description
code
  • string

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

message

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

values

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

BatchErrorDetail

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

Name Type Description
key
  • string

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

value
  • string

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

CachingType

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

Name Type Description
none
  • string

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

readonly
  • string

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

readwrite
  • string

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

CertificateReference

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

Name Type Description
storeLocation

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

storeName
  • string

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

thumbprint
  • string

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

thumbprintAlgorithm
  • string

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

visibility
  • string[]

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

CertificateStoreLocation

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

Name Type Description
currentuser
  • string

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

localmachine
  • string

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

CIFSMountConfiguration

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

Name Type Description
mountOptions
  • string

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

password
  • string

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

relativeMountPath
  • string

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

source
  • string

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

username
  • string

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

CloudServiceConfiguration

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

Name Type Description
osFamily
  • string

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

osVersion
  • string

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

ComputeNodeFillType

Как задачи распределяются между различными узлами в пуле.

Name Type Description
pack
  • string

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

spread
  • string

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

ContainerConfiguration

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

Name Type Description
containerImageNames
  • string[]

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

containerRegistries

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

type

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

ContainerRegistry

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

Name Type Description
password
  • string

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

registryServer
  • string

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

username
  • string

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

ContainerType

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

Name Type Description
dockerCompatible
  • string

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

ContainerWorkingDirectory

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

Name Type Description
containerImageDefault
  • string

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

taskWorkingDirectory
  • string

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

DataDisk

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

Name Type Description
caching

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

diskSizeGB
  • integer

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

lun
  • integer

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

storageAccountType

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

DiskEncryptionConfiguration

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

Name Type Description
targets
  • string[]

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

DynamicVNetAssignmentScope

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

Name Type Description
job
  • string

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

none
  • string

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

ElevationLevel

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

Name Type Description
admin
  • string

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

nonadmin
  • string

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

EnvironmentSetting

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

Name Type Description
name
  • string

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

value
  • string

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

ErrorMessage

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

Name Type Description
lang
  • string

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

value
  • string

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

ImageReference

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

Name Type Description
offer
  • string

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

publisher
  • string

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

sku
  • string

Номер SKU образа Marketplace для виртуальных машин Azure.
Например, 18,04-LTS или 2019-Datacenter.

version
  • string

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

virtualMachineImageId
  • string

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

InboundEndpointProtocol

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

Name Type Description
tcp
  • string

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

udp
  • string

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

InboundNATPool

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

Name Type Description
backendPort
  • integer

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

frontendPortRangeEnd
  • integer

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

frontendPortRangeStart
  • integer

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

name
  • string

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

networkSecurityGroupRules

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

protocol

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

IPAddressProvisioningType

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

Name Type Description
batchmanaged
  • string

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

nopublicipaddresses
  • string

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

usermanaged
  • string

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

LinuxUserConfiguration

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

Name Type Description
gid
  • integer

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

sshPrivateKey
  • string

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

uid
  • integer

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

LoginMode

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

Name Type Description
batch
  • string

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

interactive
  • string

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

MetadataItem

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

Name Type Description
name
  • string

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

value
  • string

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

MountConfiguration

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

Name Type Description
azureBlobFileSystemConfiguration

Контейнер службы хранилища Azure для подключения с использованием ПРЕДОХРАНИТЕЛя BLOB-объекта на каждом узле.
Это свойство является взаимоисключающим со всеми другими свойствами.

azureFileShareConfiguration

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

cifsMountConfiguration

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

nfsMountConfiguration

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

NetworkConfiguration

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

Name Type Description
dynamicVNetAssignmentScope

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

endpointConfiguration

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

publicIPAddressConfiguration

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

subnetId
  • string

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

NetworkSecurityGroupRule

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

Name Type Description
access

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

priority
  • integer

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

sourceAddressPrefix
  • string

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

sourcePortRanges
  • string[]

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

NetworkSecurityGroupRuleAccess

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

Name Type Description
allow
  • string

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

deny
  • string

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

NFSMountConfiguration

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

Name Type Description
mountOptions
  • string

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

relativeMountPath
  • string

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

source
  • string

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

PoolAddParameter

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

Name Type Description
applicationLicenses
  • string[]

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

applicationPackageReferences

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

autoScaleEvaluationInterval
  • string

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

autoScaleFormula
  • string

Формула для требуемого числа вычисляемых узлов в пуле.
Это свойство не должно быть указано, если для enableAutoScale задано значение false. Он необходим, если для enableAutoScale задано значение true. Формула проверяется на допустимость до создания пула. Если формула недопустима, пакетная Служба отклоняет запрос с подробными сведениями об ошибке. Дополнительные сведения об указании этой формулы см. в разделе "автоматическое масштабирование вычисляемых узлов в пуле пакетной службы Azure" ( https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/) .

certificateReferences

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

cloudServiceConfiguration

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

displayName
  • string

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

enableAutoScale
  • boolean

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

enableInterNodeCommunication
  • boolean

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

id
  • string

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

metadata

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

mountConfiguration

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

networkConfiguration

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

resizeTimeout
  • string

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

startTask

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

targetDedicatedNodes
  • integer

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

targetLowPriorityNodes
  • integer

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

taskSchedulingPolicy

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

taskSlotsPerNode
  • integer

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

userAccounts

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

virtualMachineConfiguration

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

vmSize
  • string

Размер виртуальных машин в пуле. Все виртуальные машины в пуле имеют одинаковый размер.
Сведения о доступных размерах виртуальных машин для пулов облачных служб (пулов, созданных с помощью cloudServiceConfiguration) см. в статье размеры для облачных служб ( https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/) . Пакетная служба поддерживает все размеры виртуальных машин облачных служб, кроме Сверхмалый, A1V2 и A2V2. Сведения о доступных размерах ВИРТУАЛЬНЫХ машин для пулов с использованием образов из магазина виртуальных машин (пулы, созданные с помощью virtualMachineConfiguration) см. в статье размеры виртуальных машин (Linux) ( https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) или размеры виртуальных машин (Windows) () https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/) . Пакетная служба поддерживает все размеры виртуальных машин Azure, кроме STANDARD_A0 и хранилища класса Premium (STANDARD_GS, STANDARD_DS и STANDARD_DSV2 Series).

PoolEndpointConfiguration

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

Name Type Description
inboundNATPools

Список пулов NAT для входящего трафика, которые могут использоваться для адресации определенных портов на отдельном кластерном узле извне.
Максимальное количество входящих пулов NAT на пул пакетной службы — 5. Если превышено максимальное число пулов NAT для входящего трафика, запрос завершается ошибкой с кодом состояния HTTP 400. Невозможно указать этот параметр, если Ипаддресспровисионингтипе имеет значение НопублиЦипаддрессес.

PublicIPAddressConfiguration

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

Name Type Description
ipAddressIds
  • string[]

Список общедоступных IP-адресов, которые Пакетная служба будет использовать при подготовке вычислений-узлов.
Указанное здесь количество IP-адресов ограничивает максимальный размер выделенных узлов пула (100) или узлов с низким приоритетом 100, которые можно выделить для каждого общедоступного IP-адреса. Например, для пула, требующего 250 выделенных виртуальных машин, потребуется по крайней мере 3 общедоступных IP-адресов. Каждый элемент этой коллекции имеет вид:/Субскриптионс/{субскриптион}/ресаурцеграупс/{грауп}/провидерс/Микрософт.Нетворк/публиЦипаддрессес/{ИП}.

provision

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

ResourceFile

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

Name Type Description
autoStorageContainerName
  • string

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

blobPrefix
  • string

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

fileMode
  • string

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

filePath
  • string

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

httpUrl
  • string

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

storageContainerUrl
  • string

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

StartTask

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

Name Type Description
commandLine
  • string

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

containerSettings

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

environmentSettings

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

maxTaskRetryCount
  • integer

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

resourceFiles

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

userIdentity

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

waitForSuccess
  • boolean

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

StorageAccountType

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

Name Type Description
premium_lrs
  • string

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

standard_lrs
  • string

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

TaskContainerSettings

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

Name Type Description
containerRunOptions
  • string

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

imageName
  • string

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

registry

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

workingDirectory

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

TaskSchedulingPolicy

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

Name Type Description
nodeFillType

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

UserAccount

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

Name Type Description
elevationLevel

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

linuxUserConfiguration

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

name
  • string

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

password
  • string

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

windowsUserConfiguration

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

UserIdentity

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

Name Type Description
autoUser

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

username
  • string

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

VirtualMachineConfiguration

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

Name Type Description
containerConfiguration

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

dataDisks

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

diskEncryptionConfiguration

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

imageReference

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

licenseType
  • string

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

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

nodeAgentSKUId
  • string

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

windowsConfiguration

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

WindowsConfiguration

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

Name Type Description
enableAutomaticUpdates
  • boolean

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

WindowsUserConfiguration

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

Name Type Description
loginMode

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