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


Пакетная служба Microsoft.BatchAccounts/pools 2021-01-01

Определение ресурсов Bicep

Тип ресурса batchAccounts/пулов можно развернуть с помощью операций, предназначенных для следующих операций:

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

Формат ресурса

Чтобы создать ресурс Microsoft.Batch/batchAccounts/pools, добавьте следующий Bicep в шаблон.

resource symbolicname 'Microsoft.Batch/batchAccounts/pools@2021-01-01' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  name: 'string'
  properties: {
    applicationLicenses: [
      'string'
    ]
    applicationPackages: [
      {
        id: 'string'
        version: 'string'
      }
    ]
    certificates: [
      {
        id: 'string'
        storeLocation: 'string'
        storeName: 'string'
        visibility: [
          'string'
        ]
      }
    ]
    deploymentConfiguration: {
      cloudServiceConfiguration: {
        osFamily: 'string'
        osVersion: 'string'
      }
      virtualMachineConfiguration: {
        containerConfiguration: {
          containerImageNames: [
            'string'
          ]
          containerRegistries: [
            {
              password: 'string'
              registryServer: 'string'
              username: 'string'
            }
          ]
          type: 'DockerCompatible'
        }
        dataDisks: [
          {
            caching: 'string'
            diskSizeGB: int
            lun: int
            storageAccountType: 'string'
          }
        ]
        diskEncryptionConfiguration: {
          targets: [
            'string'
          ]
        }
        extensions: [
          {
            autoUpgradeMinorVersion: bool
            name: 'string'
            protectedSettings: any(...)
            provisionAfterExtensions: [
              'string'
            ]
            publisher: 'string'
            settings: any(...)
            type: 'string'
            typeHandlerVersion: 'string'
          }
        ]
        imageReference: {
          id: 'string'
          offer: 'string'
          publisher: 'string'
          sku: 'string'
          version: 'string'
        }
        licenseType: 'string'
        nodeAgentSkuId: 'string'
        nodePlacementConfiguration: {
          policy: 'string'
        }
        windowsConfiguration: {
          enableAutomaticUpdates: bool
        }
      }
    }
    displayName: 'string'
    interNodeCommunication: 'string'
    metadata: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    mountConfiguration: [
      {
        azureBlobFileSystemConfiguration: {
          accountKey: 'string'
          accountName: 'string'
          blobfuseOptions: 'string'
          containerName: 'string'
          relativeMountPath: 'string'
          sasKey: 'string'
        }
        azureFileShareConfiguration: {
          accountKey: 'string'
          accountName: 'string'
          azureFileUrl: 'string'
          mountOptions: 'string'
          relativeMountPath: 'string'
        }
        cifsMountConfiguration: {
          mountOptions: 'string'
          password: 'string'
          relativeMountPath: 'string'
          source: 'string'
          username: 'string'
        }
        nfsMountConfiguration: {
          mountOptions: 'string'
          relativeMountPath: 'string'
          source: 'string'
        }
      }
    ]
    networkConfiguration: {
      endpointConfiguration: {
        inboundNatPools: [
          {
            backendPort: int
            frontendPortRangeEnd: int
            frontendPortRangeStart: int
            name: 'string'
            networkSecurityGroupRules: [
              {
                access: 'string'
                priority: int
                sourceAddressPrefix: 'string'
                sourcePortRanges: [
                  'string'
                ]
              }
            ]
            protocol: 'string'
          }
        ]
      }
      publicIPAddressConfiguration: {
        ipAddressIds: [
          'string'
        ]
        provision: 'string'
      }
      subnetId: 'string'
    }
    scaleSettings: {
      autoScale: {
        evaluationInterval: 'string'
        formula: 'string'
      }
      fixedScale: {
        nodeDeallocationOption: 'string'
        resizeTimeout: 'string'
        targetDedicatedNodes: int
        targetLowPriorityNodes: int
      }
    }
    startTask: {
      commandLine: 'string'
      containerSettings: {
        containerRunOptions: 'string'
        imageName: 'string'
        registry: {
          password: 'string'
          registryServer: 'string'
          username: 'string'
        }
        workingDirectory: 'string'
      }
      environmentSettings: [
        {
          name: 'string'
          value: 'string'
        }
      ]
      maxTaskRetryCount: int
      resourceFiles: [
        {
          autoStorageContainerName: 'string'
          blobPrefix: 'string'
          fileMode: 'string'
          filePath: 'string'
          httpUrl: 'string'
          storageContainerUrl: 'string'
        }
      ]
      userIdentity: {
        autoUser: {
          elevationLevel: 'string'
          scope: 'string'
        }
        userName: 'string'
      }
      waitForSuccess: bool
    }
    taskSchedulingPolicy: {
      nodeFillType: 'string'
    }
    taskSlotsPerNode: int
    userAccounts: [
      {
        elevationLevel: 'string'
        linuxUserConfiguration: {
          gid: int
          sshPrivateKey: 'string'
          uid: int
        }
        name: 'string'
        password: 'string'
        windowsUserConfiguration: {
          loginMode: 'string'
        }
      }
    ]
    vmSize: 'string'
  }
}

Значения свойств

Microsoft.Batch/batchAccounts/пулы

Имя Описание Ценность
тождество Тип удостоверения, используемого для пула пакетной службы. BatchPoolIdentity (Идентификация BatchPool)
имя Имя ресурса струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 64
Pattern = ^[a-zA-Z0-9_-]+$ (обязательно)
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса.

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

ApplicationPackageReference

Имя Описание Ценность
идентификатор Идентификатор устанавливаемого пакета приложения. Это должно находиться внутри той же учетной записи пакетной службы, что и пул. Это может быть ссылка на определенную версию или версию по умолчанию, если она существует. строка (обязательно)
Версия Если это опущено, и для этого приложения не указана версия по умолчанию, запрос завершается сбоем с кодом ошибки InvalidApplicationPackageReferences. Если вы вызываете REST API напрямую, код состояния HTTP равен 409. струна

АвтомасштабированиеSettings

Имя Описание Ценность
оценкаИнтервал Если опущено, значение по умолчанию — 15 минут (PT15M). струна
формула Формула для требуемого количества вычислительных узлов в пуле. строка (обязательно)

Спецификация AutoUserSpecification

Имя Описание Ценность
elevationLevel Значение по умолчанию — nonAdmin. "Администратор"
«Не-администратор»
размах Значением по умолчанию является пул. Если пул работает под управлением Windows, необходимо указать значение задачи, если требуется более строгая изоляция между задачами. Например, если задача мутирует реестр таким образом, что может повлиять на другие задачи, или если сертификаты были указаны в пуле, который не должен быть доступен обычными задачами, но должен быть доступен путем запуска задач. "Пул"
"Задача"

AzureBlobFileSystemConfiguration

Имя Описание Ценность
accountKey Это свойство является взаимоисключающим с sasKey, и его необходимо указать. струна
Имя аккаунта Имя учетной записи хранения Azure. строка (обязательно)
blobfuseOptions Это параметры "net use" в Windows и "подключение" в Linux. струна
имяКонтейнера Имя контейнера хранилища BLOB-объектов Azure. строка (обязательно)
relativeMountPath Все файловые системы подключены относительно каталога подключений пакетной службы, доступные с помощью переменной среды AZ_BATCH_NODE_MOUNTS_DIR. строка (обязательно)
sasKey Это свойство является взаимоисключающим с accountKey, и его необходимо указать. струна

Конфигурация AzureFileShare

Имя Описание Ценность
accountKey Ключ учетной записи хранения Azure. строка (обязательно)
Имя аккаунта Имя учетной записи хранения Azure. строка (обязательно)
azureFileUrl Это форма "https://{account}.file.core.windows.net/". строка (обязательно)
Варианты монтирования Это параметры "net use" в Windows и "подключение" в Linux. струна
relativeMountPath Все файловые системы подключены относительно каталога подключений пакетной службы, доступные с помощью переменной среды AZ_BATCH_NODE_MOUNTS_DIR. строка (обязательно)

BatchPoolIdentity (Идентификация BatchPool)

Имя Описание Ценность
тип Тип удостоверения, используемого для пула пакетной службы. "Нет"
UserAssigned (обязательно)
ИдентичностиНазначенныеПользователем Список удостоверений пользователей, связанных с пулом пакетной службы. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". BatchPoolIdentityUserAssignedIdentities

BatchPoolIdentityUserAssignedIdentities

Имя Описание Ценность

СертификатСсылка

Имя Описание Ценность
идентификатор Полный идентификатор сертификата для установки в пуле. Это должно находиться внутри той же учетной записи пакетной службы, что и пул. строка (обязательно)
Местоположение магазина Значение по умолчанию — currentUser. Это свойство применимо только для пулов, настроенных с узлами Windows (т. е. созданными с помощью cloudServiceConfiguration или virtualMachineConfiguration с помощью ссылки на образ Windows). Для вычислительных узлов Linux сертификаты хранятся в каталоге рабочих каталогов задач, а переменная среды AZ_BATCH_CERTIFICATES_DIR предоставляется задаче для запроса к этому расположению. Для сертификатов с видимостью remoteUser каталог "certs" создается в домашнем каталоге пользователя (например, /home/{user-name}/certs) и сертификаты помещаются в этот каталог. CurrentUser
LocalMachine
название магазина Это свойство применимо только для пулов, настроенных с узлами Windows (т. е. созданными с помощью cloudServiceConfiguration или virtualMachineConfiguration с помощью ссылки на образ Windows). Распространенные имена хранилищ: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, но любое пользовательское имя хранилища также можно использовать. Значением по умолчанию является My. струна
видимость Какие учетные записи пользователей на вычислительном узле должны иметь доступ к частным данным сертификата. Массив строк, содержащий любой из:
RemoteUser
StartTask
"Задача"

Конфигурация CifsMount

Имя Описание Ценность
Варианты монтирования Это параметры "net use" в Windows и "подключение" в Linux. струна
пароль Пароль, используемый для проверки подлинности в файловой системе CIFS. строка (обязательно)
relativeMountPath Все файловые системы подключены относительно каталога подключений пакетной службы, доступные с помощью переменной среды AZ_BATCH_NODE_MOUNTS_DIR. строка (обязательно)
источник Универсальный код ресурса (URI) файловой системы для подключения. строка (обязательно)
имя пользователя Пользователь, используемый для проверки подлинности в файловой системе CIFS. строка (обязательно)

CloudServiceConfiguration (Облачная службаКонфигурация)

Имя Описание Ценность
osFamily Возможные значения: 2 — семейство ОС 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). строка (обязательно)
Версия ОС Значение по умолчанию — *, указывающее последнюю версию операционной системы для указанного семейства ОС. струна

Компоненты81XseeSchemasBatchpoolidentityPropertiesUserassignedidentitiesAdditionalproperties

Имя Описание Ценность

ContainerConfiguration (Конфигурация контейнера)

Имя Описание Ценность
containerImageNames Это полная ссылка на изображение, как было бы указано для параметра docker pull. Образ будет получен из реестра Docker по умолчанию, если образ не является полным с альтернативным реестром. строка[]
containerRegistries Если какие-либо образы должны быть загружены из частного реестра, для которого требуются учетные данные, эти учетные данные должны быть предоставлены здесь. ContainerRegistry[]
тип Используемая технология контейнера. DockerCompatible (обязательный)

ContainerRegistry (ContainerRegistry)

Имя Описание Ценность
пароль Пароль для входа на сервер реестра. строка (обязательно)
сервер реестра Если опущено, значение по умолчанию — "docker.io". струна
имя пользователя Имя пользователя для входа на сервер реестра. строка (обязательно)

ДатаДиск

Имя Описание Ценность
Кэширование Значения:

none — режим кэширования для диска не включен.
readOnly — режим кэширования для диска доступен только для чтения.
readWrite — режим кэширования для диска считывается и записывается.

Значение по умолчанию для кэширования не имеет значения. Сведения о параметрах кэширования см. в статье https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.
"Нет"
"ReadOnly"
ReadWrite
Размер дискаГб Начальный размер диска в ГБ при создании нового диска данных. int (обязательно)
Лунь Луна используется для уникальной идентификации каждого диска данных. При подключении нескольких дисков каждый должен иметь отдельную луну. Значение должно быть от 0 до 63 включительно. int (обязательно)
Тип учетной записи хранилища Если опущено, значение по умолчанию — "Standard_LRS". Значения:

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

РазвертываниеКонфигурация

Имя Описание Ценность
CloudServiceConfiguration Это свойство и virtualMachineConfiguration являются взаимоисключающими, и необходимо указать одно из свойств. Это свойство нельзя указать, если учетная запись пакетной службы была создана с его свойством PoolAllocationMode с значением UserSubscription. CloudServiceConfiguration (Облачная службаКонфигурация)
virtualMachineConfiguration Это свойство и cloudServiceConfiguration являются взаимоисключающими, и необходимо указать одно из свойств. Конфигурация виртуальной машины

DiskEncryptionConfiguration (Настройка дискового шифрования)

Имя Описание Ценность
Цели В пуле Linux поддерживается только временныйdisk; В пуле Windows необходимо указать "OsDisk" и "TemporaryDisk". Массив строк, содержащий любой из:
OsDisk
"ВременныйDisk"

Окружающая средаНастройка

Имя Описание Ценность
имя Имя переменной среды. строка (обязательно)
ценность Значение переменной среды. струна

ФиксированныеScaleSettings

Имя Описание Ценность
nodeDeallocationOption Если опущено, значение по умолчанию — Requeue. "Requeue"
"СохранитьedData"
TaskCompletion
"Завершение"
resizeTimeout Значение по умолчанию — 15 минут. Значения времени ожидания используют формат ISO 8601. Например, используйте PT10M в течение 10 минут. Минимальное значение — 5 минут. Если указать значение менее 5 минут, служба пакетной службы отклоняет запрос с ошибкой; Если вы вызываете REST API напрямую, код состояния HTTP равен 400 (недопустимый запрос). струна
targetDedicatedNodes По крайней мере один из целевыхDedicatedNodes, необходимо задать targetLowPriorityNodes. инт
targetLowPriorityNodes По крайней мере один из целевыхDedicatedNodes, необходимо задать targetLowPriorityNodes. инт

Ссылка на изображение

Имя Описание Ценность
идентификатор Это свойство является взаимоисключающим с другими свойствами. Образ общей коллекции образов должен иметь реплики в том же регионе, что и учетная запись пакетной службы Azure. Сведения о параметрах брандмауэра для агента узла пакетной службы для взаимодействия с пакетной службой см. в статье /azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. струна
предлагать Например, UbuntuServer или WindowsServer. струна
издатель Например, Canonical или MicrosoftWindowsServer. струна
SKU Например, 18.04-LTS или 2019-Datacenter. струна
Версия Чтобы выбрать последнюю версию образа, можно указать значение "последняя". Если опущено, значение по умолчанию — "последняя". струна

Входящий NatPool (Входящий NatPool)

Имя Описание Ценность
серверный порт Это должно быть уникальным в пуле пакетной службы. Допустимые значения : от 1 до 65535, за исключением 22, 3389, 29876 и 29877, так как они зарезервированы. Если указаны зарезервированные значения, запрос завершается ошибкой с кодом состояния HTTP 400. int (обязательно)
frontendPortRangeEnd Допустимые значения варьируются от 1 до 65534, за исключением портов от 50000 до 55000, зарезервированных пакетной службой. Все диапазоны в пуле должны быть уникальными и не могут перекрываться. Если указаны зарезервированные или перекрывающиеся значения, запрос завершается ошибкой с кодом состояния HTTP 400. int (обязательно)
frontendPortRangeStart Допустимые значения варьируются от 1 до 65534, за исключением портов от 50000 до 55000, которые зарезервированы. Все диапазоны в пуле должны быть уникальными и не могут перекрываться. Если указаны зарезервированные или перекрывающиеся значения, запрос завершается ошибкой с кодом состояния HTTP 400. int (обязательно)
имя Имя должно быть уникальным в пуле пакетной службы, может содержать буквы, цифры, подчеркивания, периоды и дефисы. Имена должны начинаться с буквы или числа, заканчиваться буквой, числом или подчеркиванием и не может превышать 77 символов. Если указаны недопустимые значения, запрос завершается ошибкой с кодом состояния HTTP 400. строка (обязательно)
networkSecurityGroupRules Максимальное количество правил, которые можно указать во всех конечных точках в пуле пакетной службы, равно 25. Если правила группы безопасности сети не указаны, будет создано правило по умолчанию, чтобы разрешить входящий доступ к указанному внутреннему порту. Если максимальное число правил группы безопасности сети превышается, запрос завершается ошибкой с кодом состояния HTTP 400. Правило NetworkSecurityGroup[]
протокол Протокол конечной точки. "TCP"
UDP (обязательно)

LinuxUserConfiguration

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

МетаdataItem (МетаданныеItem)

Имя Описание Ценность
имя Имя элемента метаданных. строка (обязательно)
ценность Значение элемента метаданных. строка (обязательно)

МонтированиеКонфигурация

Имя Описание Ценность
azureBlobFileSystemConfiguration Это свойство является взаимоисключающим со всеми другими свойствами. AzureBlobFileSystemConfiguration
azureFileShareConfiguration Это свойство является взаимоисключающим со всеми другими свойствами. Конфигурация AzureFileShare
Конфигурация cifsMount Это свойство является взаимоисключающим со всеми другими свойствами. Конфигурация CifsMount
Конфигурация nfsMount Это свойство является взаимоисключающим со всеми другими свойствами. NFSMountConfiguration

Сетевая конфигурация

Имя Описание Ценность
конечная точкаКонфигурация Конфигурация конечной точки пула поддерживается только в пулах со свойством VirtualMachineConfiguration. PoolEndpointConfiguration (Конфигурация пулаEndpoint)
publicIPAddressConfiguration Это свойство поддерживается только в пулах с свойством virtualMachineConfiguration. PublicIPAddressConfiguration (ПубличныйIPAddressConfiguration)
SubnetId Виртуальная сеть должна находиться в том же регионе и подписке, что и учетная запись пакетной службы Azure. Указанная подсеть должна иметь достаточно свободных IP-адресов для размещения количества узлов в пуле. Если подсеть не имеет достаточно свободных IP-адресов, пул частично выделяет вычислительные узлы и возникнет ошибка изменения размера. Субъект-служба MicrosoftAzureBatch должна иметь роль "Участник классической виртуальной машины" Role-Based управление доступом (RBAC) для указанной виртуальной сети. Указанная подсеть должна разрешить обмен данными из пакетной службы Azure, чтобы иметь возможность планировать задачи на вычислительных узлах. Это можно проверить, проверьте, имеет ли указанная виртуальная сеть любые связанные группы безопасности сети (NSG). Если связь с вычислительными узлами в указанной подсети запрещена группой безопасности сети, служба пакетной службы установит состояние вычислительных узлов неиспользуемым. Если указанная виртуальная сеть имеет любые связанные группы безопасности сети (NSG), для входящего взаимодействия необходимо включить несколько зарезервированных системных портов. Для пулов, созданных с конфигурацией виртуальной машины, включите порты 29876 и 29877, а также порт 22 для Linux и порт 3389 для Windows. Для пулов, созданных с конфигурацией облачной службы, включите порты 10100, 20100 и 30100. Также включите исходящие подключения к службе хранилища Azure через порт 443. Для пулов cloudServiceConfiguration поддерживаются только классические виртуальные сети. Дополнительные сведения см. в статье /azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration струна

Правило NetworkSecurityGroupRule

Имя Описание Ценность
доступ Действие, которое следует предпринять для указанного IP-адреса, диапазона подсети или тега. "Разрешить"
"Запрет" (обязательно)
приоритет Приоритеты в пуле должны быть уникальными и оцениваются в порядке приоритета. Чем ниже число, тем выше приоритет. Например, правила можно указать с номерами заказов 150, 250 и 350. Правило с порядком 150 имеет приоритет над правилом, которое имеет порядок 250. Допустимые приоритеты — от 150 до 4096. Если указаны зарезервированные или повторяющиеся значения, запрос завершается ошибкой с кодом состояния HTTP 400. int (обязательно)
sourceAddressPrefix Допустимые значения — это один IP-адрес (например, 10.10.10.10), подсеть IP -адресов (т. е. 192.168.1.0/24), тег по умолчанию или * (для всех адресов). Если указаны другие значения, запрос завершается ошибкой с кодом состояния HTTP 400. строка (обязательно)
sourcePortRanges Допустимые значения: "*" (для всех портов 0 – 65535) или массивов портов или диапазонов портов (т. е. 100–200). Порты должны находиться в диапазоне от 0 до 65535, а диапазоны портов или порты не могут перекрываться. Если указаны другие значения, запрос завершается ошибкой с кодом состояния HTTP 400. Значение по умолчанию будет *. строка[]

NFSMountConfiguration

Имя Описание Ценность
Варианты монтирования Это параметры "net use" в Windows и "подключение" в Linux. струна
relativeMountPath Все файловые системы подключены относительно каталога подключений пакетной службы, доступные с помощью переменной среды AZ_BATCH_NODE_MOUNTS_DIR. строка (обязательно)
источник Универсальный код ресурса (URI) файловой системы для подключения. строка (обязательно)

NodePlacementConfiguration (Конфигурация NodePlacement)

Имя Описание Ценность
политика Политика выделения, используемая пакетной службой для подготовки узлов. Если оно не указано, пакетная служба будет использовать региональную политику. "Региональный"
"Зональный"

PoolEndpointConfiguration (Конфигурация пулаEndpoint)

Имя Описание Ценность
входящиеNatPools Максимальное количество входящих пулов NAT на пул пакетной службы составляет 5. Если максимальное число входящих пулов NAT превышается, запрос завершается ошибкой с кодом состояния HTTP 400. Это невозможно указать, если IPAddressProvisioningType — NoPublicIPAddresses. InboundNatPool[] (обязательно)

Свойства пула

Имя Описание Ценность
applicationLicenses Список лицензий приложений должен быть подмножеством доступных лицензий приложения пакетной службы. Если запрашивается лицензия, которая не поддерживается, создание пула завершится ошибкой. строка[]
пакеты приложений Изменения ссылок на пакеты приложений влияют на все новые вычислительные узлы, присоединенные к пулу, но не влияют на вычислительные узлы, которые уже находятся в пуле, пока они не перезагрузятся или переимыслятся. В любом пуле имеется не более 10 ссылок на пакеты приложений. Ссылка на ApplicationPackage[]
Сертификаты Для вычислительных узлов Windows служба пакетной службы устанавливает сертификаты в указанное хранилище сертификатов и расположение. Для вычислительных узлов Linux сертификаты хранятся в каталоге рабочих каталогов задач, а переменная среды AZ_BATCH_CERTIFICATES_DIR предоставляется задаче для запроса к этому расположению. Для сертификатов с видимостью remoteUser каталог "certs" создается в домашнем каталоге пользователя (например, /home/{user-name}/certs) и сертификаты помещаются в этот каталог. Справка о сертификате[]
deploymentConfiguration Использование CloudServiceConfiguration указывает, что узлы должны создаваться с помощью облачных служб Azure (PaaS), а VirtualMachineConfiguration использует виртуальные машины Azure (IaaS). РазвертываниеКонфигурация
отображаемое имя Отображаемое имя не должно быть уникальным и может содержать любые символы Юникода до максимальной длины 1024. струна
interNodeCommunication Это накладывает ограничения на назначение узлов пулу. Включение этого значения может снизить вероятность выделения запрошенного количества узлов в пуле. Если этот параметр не указан, значение по умолчанию имеет значение "Отключено". "Отключено"
"Включено"
метаданные Пакетная служба не назначает никакое значение метаданным; он предназначен исключительно для использования пользовательского кода. МетаданныеItem[]
mountConfiguration Это поддерживает файлы Azure, NFS, CIFS/SMB и Blobfuse. Конфигурация монтирования[]
networkConfiguration Конфигурация сети для пула. Конфигурация сети
параметры масштабирования Определяет требуемый размер пула. Это может быть "фиксированный масштаб", где указан запрошенный целевой идентификаторNodes или "автомасштабирование", определяющий формулу, которая периодически переоценится. Если это свойство не указано, пул будет иметь фиксированный масштаб с 0 targetDedicatedNodes. ScaleSettings (МасштабНастройки)
начатьЗадачу В операции PATCH (update) это свойство можно задать для пустого объекта, чтобы удалить начальную задачу из пула. СтартЗадача
taskSchedulingPolicy Если значение не указано, по умолчанию распространяется. TaskSchedulingPolicy
taskSlotsPerNode Значение по умолчанию — 1. Максимальное значение меньше 4 раза меньше числа ядер vmSize пула или 256. инт
userAccounts Список учетных записей пользователей, создаваемых на каждом узле в пуле. Учетная запись пользователя[]
vmSize Сведения о доступных размерах виртуальных машин для пулов облачных служб (пулы, созданные с помощью cloudServiceConfiguration), см. в разделе "Размеры облачных служб" (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Пакетная служба поддерживает все размеры виртуальных машин облачных служб, кроме ExtraSmall. Сведения о доступных размерах виртуальных машин для пулов с помощью образов из Marketplace виртуальных машин (пулы, созданные с помощью 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). струна

PublicIPAddressConfiguration (ПубличныйIPAddressConfiguration)

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

РесурсФайл

Имя Описание Ценность
autoStorageContainerName Свойства autoStorageContainerName, storageContainerUrl и httpUrl являются взаимоисключающими, и один из них должен быть указан. струна
BLOBPrefix Свойство допустимо, только если используется autoStorageContainerName или storageContainerUrl. Этот префикс может быть частичным именем файла или подкаталогом. Если префикс не указан, все файлы в контейнере будут скачаны. струна
Режим файла Это свойство применяется только к файлам, скачанным на вычислительные узлы Linux. Он будет игнорироваться, если он указан для resourceFile, который будет скачан на узел Windows. Если это свойство не указано для узла Linux, к файлу применяется значение по умолчанию 0770. струна
путь к файлу Если задано свойство httpUrl, файлPath является обязательным и описывает путь, в который будет скачан файл, включая имя файла. В противном случае, если задано свойство autoStorageContainerName или storageContainerUrl, filePath является необязательным и является каталогом для скачивания файлов. В случае, когда filePath используется в качестве каталога, любая структура каталогов, уже связанная с входными данными, будет сохранена в полном объеме и добавлена в указанный каталог filePath. Указанный относительный путь не может выйти из рабочего каталога задачи (например, с помощью '.'). струна
httpUrl (httpUrl) Свойства autoStorageContainerName, storageContainerUrl и httpUrl являются взаимоисключающими, и один из них должен быть указан. Если URL-адрес — хранилище BLOB-объектов Azure, он должен быть доступен для чтения с помощью анонимного доступа; То есть пакетная служба не предоставляет учетные данные при скачивании большого двоичного объекта. Существует два способа получить такой URL-адрес для большого двоичного объекта в хранилище Azure: включить подписанный URL-адрес (SAS), предоставляющий разрешения на чтение большого двоичного объекта, или задать ACL для большого двоичного объекта или его контейнера, чтобы разрешить общедоступный доступ. струна
storageContainerUrl Свойства autoStorageContainerName, storageContainerUrl и httpUrl являются взаимоисключающими, и один из них должен быть указан. Этот URL-адрес должен быть доступен для чтения и списка с помощью анонимного доступа; То есть пакетная служба не предоставляет учетные данные при скачивании большого двоичного объекта. Существует два способа получить такой URL-адрес для большого двоичного объекта в хранилище Azure: включить подписанный URL-адрес (SAS), предоставляющий разрешения на чтение и список для большого двоичного объекта, или задать ACL для большого двоичного объекта или его контейнера, чтобы разрешить общедоступный доступ. струна

Настройки масштабирования

Имя Описание Ценность
автомасштабирование Это свойство и фиксированное масштабирование являются взаимоисключающими, и необходимо указать одно из свойств. АвтомасштабированиеSettings
fixedScale Это свойство и автомасштабирование являются взаимоисключающими, и необходимо указать одно из свойств. ФиксированныеScaleSettings

СтартЗадача

Имя Описание Ценность
командная строка Командная строка не выполняется под оболочкой и поэтому не может воспользоваться преимуществами функций оболочки, таких как расширение переменной среды. Если вы хотите воспользоваться такими функциями, необходимо вызвать оболочку в командной строке, например с помощью cmd /c MyCommand в Windows или "/bin/sh -c MyCommand" в Linux. Требуется, если указаны другие свойства startTask. струна
Настройки контейнера При указании все каталоги рекурсивно под AZ_BATCH_NODE_ROOT_DIR (корнем каталогов пакетной службы Azure на узле) сопоставляются с контейнером, все переменные среды задач сопоставляются с контейнером, а командная строка задачи выполняется в контейнере. TaskContainerSettings (ЗадачиКонтейнерНастройки)
средаНастройки Список параметров переменной среды для начальной задачи. Окружающая средаНастройка[]
maxTaskRetryCount Пакетная служба повторяет задачу, если его код выхода не является ненулевой. Обратите внимание, что это значение специально управляет числом повторных попыток. Пакетная служба попытается выполнить задачу один раз, а затем повторите попытку до этого ограничения. Например, если максимальное число повторных попыток равно 3, пакетная служба пытается выполнить задачу до 4 раз (одна начальная попытка и 3 повторные попытки). Если максимальное число повторных попыток равно 0, пакетная служба не повторяет задачу. Если максимальное число повторных попыток равно -1, пакетная служба повторяет задачу без ограничения. инт
Файлы ресурсов Список файлов, которые служба пакетной службы скачивает на вычислительный узел перед выполнением командной строки. РесурсФайл[]
userIdentity Если этот параметр не указан, задача выполняется как пользователь, не являющийся администратором, уникальным для задачи. Идентификация пользователя
waitForSuccess Если значение true и задача запуска завершается сбоем на вычислительном узле, пакетная служба повторяет задачу запуска до максимального количества повторных попыток (maxTaskRetryCount). Если задача по-прежнему не выполнена успешно после всех повторных попыток, служба пакетной службы помечает вычислительный узел неиспользуемым и не запланирует задачи. Это условие можно обнаружить с помощью состояния узла и подробных сведений об ошибке планирования. Если значение false, служба пакетной службы не ожидает завершения начальной задачи. В этом случае другие задачи могут запускаться на вычислительном узле, пока задача запуска по-прежнему выполняется; и даже если задача запуска завершается сбоем, новые задачи будут продолжать планироваться на узле. Значение по умолчанию — true. булевая переменная (bool)

TaskContainerSettings (ЗадачиКонтейнерНастройки)

Имя Описание Ценность
containerRunOptions Эти дополнительные параметры предоставляются в качестве аргументов в команду docker create, а также те, которые управляются пакетной службой. струна
названиеИзображения Это полная ссылка на изображение, как было бы указано для параметра docker pull. Если тег не указан как часть имени изображения, тег ":latest" используется в качестве значения по умолчанию. строка (обязательно)
регистратура Этот параметр может быть опущен, если он уже был предоставлен при создании пула. ContainerRegistry (ContainerRegistry)
workingDirectory Флаг, указывающий, где находится рабочий каталог задачи контейнера. Значение по умолчанию — taskWorkingDirectory. ContainerImageDefault
TaskWorkingDirectory

TaskSchedulingPolicy

Имя Описание Ценность
nodeFillType Порядок распределения задач между вычислительными узлами. "Pack"
"Распространение" (обязательно)

Учетная запись пользователя

Имя Описание Ценность
elevationLevel nonAdmin — автоматический пользователь является стандартным пользователем без повышенного доступа. администратор . Автоматический пользователь является пользователем с повышенным доступом и работает с полными разрешениями администратора. Значение по умолчанию — nonAdmin. "Администратор"
«Не-администратор»
linuxUserConfiguration Это свойство игнорируется, если указано в пуле Windows. Если это не указано, пользователь создается с параметрами по умолчанию. LinuxUserConfiguration
имя Имя учетной записи пользователя. строка (обязательно)
пароль Пароль для учетной записи пользователя. строка (обязательно)
windowsUserConfiguration Это свойство можно указать только в том случае, если пользователь находится в пуле Windows. Если он не указан и в пуле Windows, пользователь создается с параметрами по умолчанию. WindowsUserConfiguration

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

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

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

Имя Описание Ценность
Конфигурация контейнера Если задано, программа установки выполняется на каждом узле в пуле, чтобы разрешить выполнение задач в контейнерах. Все обычные задачи и задачи диспетчера заданий, выполняемые в этом пуле, должны указывать свойство containerSettings, а все остальные задачи могут указывать его. ContainerConfiguration (Конфигурация контейнера)
Диски данных Это свойство должно быть указано, если вычислительные узлы в пуле должны иметь пустые диски данных, подключенные к ним. Диск данных[]
diskEncryptionConfiguration При указании шифрование выполняется на каждом узле в пуле во время подготовки узлов. DiskEncryptionConfiguration (Настройка дискового шифрования)
Расширения При указании расширения, упомянутые в этой конфигурации, будут установлены на каждом узле. VMExtension[]
ImageReference Ссылка на образ Виртуальной машины Azure Marketplace или ресурс образа Azure настраиваемой виртуальной машины. Чтобы получить список всех образовReference, проверенных пакетной службой Azure, см. операцию "Список поддерживаемых номеров SKU агента узлов". ImageReference (обязательно)
тип лицензии Это относится только к образам, содержащим операционную систему Windows, и следует использовать только при удержании допустимых локальных лицензий для узлов, которые будут развернуты. Если не указано, скидка на лицензирование в локальной среде не применяется. Значения:

Windows_Server . Локальная лицензия предназначена для Windows Server.
Windows_Client . Локальная лицензия предназначена для клиента Windows.
струна
nodeAgentSkuId Агент узла пакетной службы — это программа, которая выполняется на каждом узле в пуле и предоставляет интерфейс управления между узлом и пакетной службой. Существуют различные реализации агента узла, известного как номера SKU для разных операционных систем. Необходимо указать номер SKU агента узла, соответствующий выбранной ссылке на изображение. Чтобы получить список поддерживаемых номеров SKU агента узлов вместе со списком проверенных ссылок на образы, см. в разделе "Список поддерживаемых SKU агента узлов". строка (обязательно)
nodePlacementConfiguration Эта конфигурация будет указывать правила по тому, как узлы в пуле будут физически выделены. NodePlacementConfiguration (Конфигурация NodePlacement)
windowsКонфигурация Это свойство не должно быть указано, если imageReference указывает образ ОС Linux. WindowsКонфигурация

VMExtension

Имя Описание Ценность
автоматическое обновление минорной версии Указывает, следует ли использовать более новую дополнительную версию, если она доступна во время развертывания. Однако после развертывания расширение не будет обновлять дополнительные версии без повторного развертывания, даже если это свойство не имеет значения true. булевая переменная (bool)
имя Имя расширения виртуальной машины. строка (обязательно)
защищенныеНастройки Расширение может содержать защищенные параметрыSettings или protectedSettingsFromKeyVault или не иметь защищенных параметров. любой
provisionAfterExtensions Коллекция имен расширений, после которой необходимо подготовить это расширение. строка[]
издатель Имя издателя обработчика расширений. строка (обязательно)
Параметры Форматированные общедоступные параметры JSON для расширения. любой
тип Тип расширений. строка (обязательно)
версияТипаОбработчика Версия обработчика скрипта. струна

WindowsКонфигурация

Имя Описание Ценность
enableAutomaticUpdates Если опущено, значение по умолчанию имеет значение true. булевая переменная (bool)

WindowsUserConfiguration

Имя Описание Ценность
loginMode Задает режим входа для пользователя. Значением по умолчанию для пулов VirtualMachineConfiguration является интерактивный режим, а для пулов CloudServiceConfiguration используется пакетный режим. Пакетная служба
"Интерактивный"

Примеры использования

Примеры быстрого запуска Azure

Следующие шаблоны быстрого запуска Azure содержат примеры Bicep для развертывания этого типа ресурса.

Bicep-файл Описание
пул пакетной службы Azure без общедоступных IP-адресов Этот шаблон создает упрощенный пул обмена данными с узлами пакетной службы Azure без общедоступных IP-адресов.

Определение ресурса шаблона ARM

Тип ресурса batchAccounts/пулов можно развернуть с помощью операций, предназначенных для следующих операций:

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

Формат ресурса

Чтобы создать ресурс Microsoft.Batch/batchAccounts/pools, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.Batch/batchAccounts/pools",
  "apiVersion": "2021-01-01",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "properties": {
    "applicationLicenses": [ "string" ],
    "applicationPackages": [
      {
        "id": "string",
        "version": "string"
      }
    ],
    "certificates": [
      {
        "id": "string",
        "storeLocation": "string",
        "storeName": "string",
        "visibility": [ "string" ]
      }
    ],
    "deploymentConfiguration": {
      "cloudServiceConfiguration": {
        "osFamily": "string",
        "osVersion": "string"
      },
      "virtualMachineConfiguration": {
        "containerConfiguration": {
          "containerImageNames": [ "string" ],
          "containerRegistries": [
            {
              "password": "string",
              "registryServer": "string",
              "username": "string"
            }
          ],
          "type": "DockerCompatible"
        },
        "dataDisks": [
          {
            "caching": "string",
            "diskSizeGB": "int",
            "lun": "int",
            "storageAccountType": "string"
          }
        ],
        "diskEncryptionConfiguration": {
          "targets": [ "string" ]
        },
        "extensions": [
          {
            "autoUpgradeMinorVersion": "bool",
            "name": "string",
            "protectedSettings": {},
            "provisionAfterExtensions": [ "string" ],
            "publisher": "string",
            "settings": {},
            "type": "string",
            "typeHandlerVersion": "string"
          }
        ],
        "imageReference": {
          "id": "string",
          "offer": "string",
          "publisher": "string",
          "sku": "string",
          "version": "string"
        },
        "licenseType": "string",
        "nodeAgentSkuId": "string",
        "nodePlacementConfiguration": {
          "policy": "string"
        },
        "windowsConfiguration": {
          "enableAutomaticUpdates": "bool"
        }
      }
    },
    "displayName": "string",
    "interNodeCommunication": "string",
    "metadata": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "mountConfiguration": [
      {
        "azureBlobFileSystemConfiguration": {
          "accountKey": "string",
          "accountName": "string",
          "blobfuseOptions": "string",
          "containerName": "string",
          "relativeMountPath": "string",
          "sasKey": "string"
        },
        "azureFileShareConfiguration": {
          "accountKey": "string",
          "accountName": "string",
          "azureFileUrl": "string",
          "mountOptions": "string",
          "relativeMountPath": "string"
        },
        "cifsMountConfiguration": {
          "mountOptions": "string",
          "password": "string",
          "relativeMountPath": "string",
          "source": "string",
          "username": "string"
        },
        "nfsMountConfiguration": {
          "mountOptions": "string",
          "relativeMountPath": "string",
          "source": "string"
        }
      }
    ],
    "networkConfiguration": {
      "endpointConfiguration": {
        "inboundNatPools": [
          {
            "backendPort": "int",
            "frontendPortRangeEnd": "int",
            "frontendPortRangeStart": "int",
            "name": "string",
            "networkSecurityGroupRules": [
              {
                "access": "string",
                "priority": "int",
                "sourceAddressPrefix": "string",
                "sourcePortRanges": [ "string" ]
              }
            ],
            "protocol": "string"
          }
        ]
      },
      "publicIPAddressConfiguration": {
        "ipAddressIds": [ "string" ],
        "provision": "string"
      },
      "subnetId": "string"
    },
    "scaleSettings": {
      "autoScale": {
        "evaluationInterval": "string",
        "formula": "string"
      },
      "fixedScale": {
        "nodeDeallocationOption": "string",
        "resizeTimeout": "string",
        "targetDedicatedNodes": "int",
        "targetLowPriorityNodes": "int"
      }
    },
    "startTask": {
      "commandLine": "string",
      "containerSettings": {
        "containerRunOptions": "string",
        "imageName": "string",
        "registry": {
          "password": "string",
          "registryServer": "string",
          "username": "string"
        },
        "workingDirectory": "string"
      },
      "environmentSettings": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "maxTaskRetryCount": "int",
      "resourceFiles": [
        {
          "autoStorageContainerName": "string",
          "blobPrefix": "string",
          "fileMode": "string",
          "filePath": "string",
          "httpUrl": "string",
          "storageContainerUrl": "string"
        }
      ],
      "userIdentity": {
        "autoUser": {
          "elevationLevel": "string",
          "scope": "string"
        },
        "userName": "string"
      },
      "waitForSuccess": "bool"
    },
    "taskSchedulingPolicy": {
      "nodeFillType": "string"
    },
    "taskSlotsPerNode": "int",
    "userAccounts": [
      {
        "elevationLevel": "string",
        "linuxUserConfiguration": {
          "gid": "int",
          "sshPrivateKey": "string",
          "uid": "int"
        },
        "name": "string",
        "password": "string",
        "windowsUserConfiguration": {
          "loginMode": "string"
        }
      }
    ],
    "vmSize": "string"
  }
}

Значения свойств

Microsoft.Batch/batchAccounts/пулы

Имя Описание Ценность
apiVersion Версия API '2021-01-01'
тождество Тип удостоверения, используемого для пула пакетной службы. BatchPoolIdentity (Идентификация BatchPool)
имя Имя ресурса струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 64
Pattern = ^[a-zA-Z0-9_-]+$ (обязательно)
свойства Свойства, связанные с пулом. Свойства пула
тип Тип ресурса "Microsoft.Batch/batchAccounts/pools"

ApplicationPackageReference

Имя Описание Ценность
идентификатор Идентификатор устанавливаемого пакета приложения. Это должно находиться внутри той же учетной записи пакетной службы, что и пул. Это может быть ссылка на определенную версию или версию по умолчанию, если она существует. строка (обязательно)
Версия Если это опущено, и для этого приложения не указана версия по умолчанию, запрос завершается сбоем с кодом ошибки InvalidApplicationPackageReferences. Если вы вызываете REST API напрямую, код состояния HTTP равен 409. струна

АвтомасштабированиеSettings

Имя Описание Ценность
оценкаИнтервал Если опущено, значение по умолчанию — 15 минут (PT15M). струна
формула Формула для требуемого количества вычислительных узлов в пуле. строка (обязательно)

Спецификация AutoUserSpecification

Имя Описание Ценность
elevationLevel Значение по умолчанию — nonAdmin. "Администратор"
«Не-администратор»
размах Значением по умолчанию является пул. Если пул работает под управлением Windows, необходимо указать значение задачи, если требуется более строгая изоляция между задачами. Например, если задача мутирует реестр таким образом, что может повлиять на другие задачи, или если сертификаты были указаны в пуле, который не должен быть доступен обычными задачами, но должен быть доступен путем запуска задач. "Пул"
"Задача"

AzureBlobFileSystemConfiguration

Имя Описание Ценность
accountKey Это свойство является взаимоисключающим с sasKey, и его необходимо указать. струна
Имя аккаунта Имя учетной записи хранения Azure. строка (обязательно)
blobfuseOptions Это параметры "net use" в Windows и "подключение" в Linux. струна
имяКонтейнера Имя контейнера хранилища BLOB-объектов Azure. строка (обязательно)
relativeMountPath Все файловые системы подключены относительно каталога подключений пакетной службы, доступные с помощью переменной среды AZ_BATCH_NODE_MOUNTS_DIR. строка (обязательно)
sasKey Это свойство является взаимоисключающим с accountKey, и его необходимо указать. струна

Конфигурация AzureFileShare

Имя Описание Ценность
accountKey Ключ учетной записи хранения Azure. строка (обязательно)
Имя аккаунта Имя учетной записи хранения Azure. строка (обязательно)
azureFileUrl Это форма "https://{account}.file.core.windows.net/". строка (обязательно)
Варианты монтирования Это параметры "net use" в Windows и "подключение" в Linux. струна
relativeMountPath Все файловые системы подключены относительно каталога подключений пакетной службы, доступные с помощью переменной среды AZ_BATCH_NODE_MOUNTS_DIR. строка (обязательно)

BatchPoolIdentity (Идентификация BatchPool)

Имя Описание Ценность
тип Тип удостоверения, используемого для пула пакетной службы. "Нет"
UserAssigned (обязательно)
ИдентичностиНазначенныеПользователем Список удостоверений пользователей, связанных с пулом пакетной службы. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". BatchPoolIdentityUserAssignedIdentities

BatchPoolIdentityUserAssignedIdentities

Имя Описание Ценность

СертификатСсылка

Имя Описание Ценность
идентификатор Полный идентификатор сертификата для установки в пуле. Это должно находиться внутри той же учетной записи пакетной службы, что и пул. строка (обязательно)
Местоположение магазина Значение по умолчанию — currentUser. Это свойство применимо только для пулов, настроенных с узлами Windows (т. е. созданными с помощью cloudServiceConfiguration или virtualMachineConfiguration с помощью ссылки на образ Windows). Для вычислительных узлов Linux сертификаты хранятся в каталоге рабочих каталогов задач, а переменная среды AZ_BATCH_CERTIFICATES_DIR предоставляется задаче для запроса к этому расположению. Для сертификатов с видимостью remoteUser каталог "certs" создается в домашнем каталоге пользователя (например, /home/{user-name}/certs) и сертификаты помещаются в этот каталог. CurrentUser
LocalMachine
название магазина Это свойство применимо только для пулов, настроенных с узлами Windows (т. е. созданными с помощью cloudServiceConfiguration или virtualMachineConfiguration с помощью ссылки на образ Windows). Распространенные имена хранилищ: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, но любое пользовательское имя хранилища также можно использовать. Значением по умолчанию является My. струна
видимость Какие учетные записи пользователей на вычислительном узле должны иметь доступ к частным данным сертификата. Массив строк, содержащий любой из:
RemoteUser
StartTask
"Задача"

Конфигурация CifsMount

Имя Описание Ценность
Варианты монтирования Это параметры "net use" в Windows и "подключение" в Linux. струна
пароль Пароль, используемый для проверки подлинности в файловой системе CIFS. строка (обязательно)
relativeMountPath Все файловые системы подключены относительно каталога подключений пакетной службы, доступные с помощью переменной среды AZ_BATCH_NODE_MOUNTS_DIR. строка (обязательно)
источник Универсальный код ресурса (URI) файловой системы для подключения. строка (обязательно)
имя пользователя Пользователь, используемый для проверки подлинности в файловой системе CIFS. строка (обязательно)

CloudServiceConfiguration (Облачная службаКонфигурация)

Имя Описание Ценность
osFamily Возможные значения: 2 — семейство ОС 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). строка (обязательно)
Версия ОС Значение по умолчанию — *, указывающее последнюю версию операционной системы для указанного семейства ОС. струна

Компоненты81XseeSchemasBatchpoolidentityPropertiesUserassignedidentitiesAdditionalproperties

Имя Описание Ценность

ContainerConfiguration (Конфигурация контейнера)

Имя Описание Ценность
containerImageNames Это полная ссылка на изображение, как было бы указано для параметра docker pull. Образ будет получен из реестра Docker по умолчанию, если образ не является полным с альтернативным реестром. строка[]
containerRegistries Если какие-либо образы должны быть загружены из частного реестра, для которого требуются учетные данные, эти учетные данные должны быть предоставлены здесь. ContainerRegistry[]
тип Используемая технология контейнера. DockerCompatible (обязательный)

ContainerRegistry (ContainerRegistry)

Имя Описание Ценность
пароль Пароль для входа на сервер реестра. строка (обязательно)
сервер реестра Если опущено, значение по умолчанию — "docker.io". струна
имя пользователя Имя пользователя для входа на сервер реестра. строка (обязательно)

ДатаДиск

Имя Описание Ценность
Кэширование Значения:

none — режим кэширования для диска не включен.
readOnly — режим кэширования для диска доступен только для чтения.
readWrite — режим кэширования для диска считывается и записывается.

Значение по умолчанию для кэширования не имеет значения. Сведения о параметрах кэширования см. в статье https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.
"Нет"
"ReadOnly"
ReadWrite
Размер дискаГб Начальный размер диска в ГБ при создании нового диска данных. int (обязательно)
Лунь Луна используется для уникальной идентификации каждого диска данных. При подключении нескольких дисков каждый должен иметь отдельную луну. Значение должно быть от 0 до 63 включительно. int (обязательно)
Тип учетной записи хранилища Если опущено, значение по умолчанию — "Standard_LRS". Значения:

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

РазвертываниеКонфигурация

Имя Описание Ценность
CloudServiceConfiguration Это свойство и virtualMachineConfiguration являются взаимоисключающими, и необходимо указать одно из свойств. Это свойство нельзя указать, если учетная запись пакетной службы была создана с его свойством PoolAllocationMode с значением UserSubscription. CloudServiceConfiguration (Облачная службаКонфигурация)
virtualMachineConfiguration Это свойство и cloudServiceConfiguration являются взаимоисключающими, и необходимо указать одно из свойств. Конфигурация виртуальной машины

DiskEncryptionConfiguration (Настройка дискового шифрования)

Имя Описание Ценность
Цели В пуле Linux поддерживается только временныйdisk; В пуле Windows необходимо указать "OsDisk" и "TemporaryDisk". Массив строк, содержащий любой из:
OsDisk
"ВременныйDisk"

Окружающая средаНастройка

Имя Описание Ценность
имя Имя переменной среды. строка (обязательно)
ценность Значение переменной среды. струна

ФиксированныеScaleSettings

Имя Описание Ценность
nodeDeallocationOption Если опущено, значение по умолчанию — Requeue. "Requeue"
"СохранитьedData"
TaskCompletion
"Завершение"
resizeTimeout Значение по умолчанию — 15 минут. Значения времени ожидания используют формат ISO 8601. Например, используйте PT10M в течение 10 минут. Минимальное значение — 5 минут. Если указать значение менее 5 минут, служба пакетной службы отклоняет запрос с ошибкой; Если вы вызываете REST API напрямую, код состояния HTTP равен 400 (недопустимый запрос). струна
targetDedicatedNodes По крайней мере один из целевыхDedicatedNodes, необходимо задать targetLowPriorityNodes. инт
targetLowPriorityNodes По крайней мере один из целевыхDedicatedNodes, необходимо задать targetLowPriorityNodes. инт

Ссылка на изображение

Имя Описание Ценность
идентификатор Это свойство является взаимоисключающим с другими свойствами. Образ общей коллекции образов должен иметь реплики в том же регионе, что и учетная запись пакетной службы Azure. Сведения о параметрах брандмауэра для агента узла пакетной службы для взаимодействия с пакетной службой см. в статье /azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. струна
предлагать Например, UbuntuServer или WindowsServer. струна
издатель Например, Canonical или MicrosoftWindowsServer. струна
SKU Например, 18.04-LTS или 2019-Datacenter. струна
Версия Чтобы выбрать последнюю версию образа, можно указать значение "последняя". Если опущено, значение по умолчанию — "последняя". струна

Входящий NatPool (Входящий NatPool)

Имя Описание Ценность
серверный порт Это должно быть уникальным в пуле пакетной службы. Допустимые значения : от 1 до 65535, за исключением 22, 3389, 29876 и 29877, так как они зарезервированы. Если указаны зарезервированные значения, запрос завершается ошибкой с кодом состояния HTTP 400. int (обязательно)
frontendPortRangeEnd Допустимые значения варьируются от 1 до 65534, за исключением портов от 50000 до 55000, зарезервированных пакетной службой. Все диапазоны в пуле должны быть уникальными и не могут перекрываться. Если указаны зарезервированные или перекрывающиеся значения, запрос завершается ошибкой с кодом состояния HTTP 400. int (обязательно)
frontendPortRangeStart Допустимые значения варьируются от 1 до 65534, за исключением портов от 50000 до 55000, которые зарезервированы. Все диапазоны в пуле должны быть уникальными и не могут перекрываться. Если указаны зарезервированные или перекрывающиеся значения, запрос завершается ошибкой с кодом состояния HTTP 400. int (обязательно)
имя Имя должно быть уникальным в пуле пакетной службы, может содержать буквы, цифры, подчеркивания, периоды и дефисы. Имена должны начинаться с буквы или числа, заканчиваться буквой, числом или подчеркиванием и не может превышать 77 символов. Если указаны недопустимые значения, запрос завершается ошибкой с кодом состояния HTTP 400. строка (обязательно)
networkSecurityGroupRules Максимальное количество правил, которые можно указать во всех конечных точках в пуле пакетной службы, равно 25. Если правила группы безопасности сети не указаны, будет создано правило по умолчанию, чтобы разрешить входящий доступ к указанному внутреннему порту. Если максимальное число правил группы безопасности сети превышается, запрос завершается ошибкой с кодом состояния HTTP 400. Правило NetworkSecurityGroup[]
протокол Протокол конечной точки. "TCP"
UDP (обязательно)

LinuxUserConfiguration

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

МетаdataItem (МетаданныеItem)

Имя Описание Ценность
имя Имя элемента метаданных. строка (обязательно)
ценность Значение элемента метаданных. строка (обязательно)

МонтированиеКонфигурация

Имя Описание Ценность
azureBlobFileSystemConfiguration Это свойство является взаимоисключающим со всеми другими свойствами. AzureBlobFileSystemConfiguration
azureFileShareConfiguration Это свойство является взаимоисключающим со всеми другими свойствами. Конфигурация AzureFileShare
Конфигурация cifsMount Это свойство является взаимоисключающим со всеми другими свойствами. Конфигурация CifsMount
Конфигурация nfsMount Это свойство является взаимоисключающим со всеми другими свойствами. NFSMountConfiguration

Сетевая конфигурация

Имя Описание Ценность
конечная точкаКонфигурация Конфигурация конечной точки пула поддерживается только в пулах со свойством VirtualMachineConfiguration. PoolEndpointConfiguration (Конфигурация пулаEndpoint)
publicIPAddressConfiguration Это свойство поддерживается только в пулах с свойством virtualMachineConfiguration. PublicIPAddressConfiguration (ПубличныйIPAddressConfiguration)
SubnetId Виртуальная сеть должна находиться в том же регионе и подписке, что и учетная запись пакетной службы Azure. Указанная подсеть должна иметь достаточно свободных IP-адресов для размещения количества узлов в пуле. Если подсеть не имеет достаточно свободных IP-адресов, пул частично выделяет вычислительные узлы и возникнет ошибка изменения размера. Субъект-служба MicrosoftAzureBatch должна иметь роль "Участник классической виртуальной машины" Role-Based управление доступом (RBAC) для указанной виртуальной сети. Указанная подсеть должна разрешить обмен данными из пакетной службы Azure, чтобы иметь возможность планировать задачи на вычислительных узлах. Это можно проверить, проверьте, имеет ли указанная виртуальная сеть любые связанные группы безопасности сети (NSG). Если связь с вычислительными узлами в указанной подсети запрещена группой безопасности сети, служба пакетной службы установит состояние вычислительных узлов неиспользуемым. Если указанная виртуальная сеть имеет любые связанные группы безопасности сети (NSG), для входящего взаимодействия необходимо включить несколько зарезервированных системных портов. Для пулов, созданных с конфигурацией виртуальной машины, включите порты 29876 и 29877, а также порт 22 для Linux и порт 3389 для Windows. Для пулов, созданных с конфигурацией облачной службы, включите порты 10100, 20100 и 30100. Также включите исходящие подключения к службе хранилища Azure через порт 443. Для пулов cloudServiceConfiguration поддерживаются только классические виртуальные сети. Дополнительные сведения см. в статье /azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration струна

Правило NetworkSecurityGroupRule

Имя Описание Ценность
доступ Действие, которое следует предпринять для указанного IP-адреса, диапазона подсети или тега. "Разрешить"
"Запрет" (обязательно)
приоритет Приоритеты в пуле должны быть уникальными и оцениваются в порядке приоритета. Чем ниже число, тем выше приоритет. Например, правила можно указать с номерами заказов 150, 250 и 350. Правило с порядком 150 имеет приоритет над правилом, которое имеет порядок 250. Допустимые приоритеты — от 150 до 4096. Если указаны зарезервированные или повторяющиеся значения, запрос завершается ошибкой с кодом состояния HTTP 400. int (обязательно)
sourceAddressPrefix Допустимые значения — это один IP-адрес (например, 10.10.10.10), подсеть IP -адресов (т. е. 192.168.1.0/24), тег по умолчанию или * (для всех адресов). Если указаны другие значения, запрос завершается ошибкой с кодом состояния HTTP 400. строка (обязательно)
sourcePortRanges Допустимые значения: "*" (для всех портов 0 – 65535) или массивов портов или диапазонов портов (т. е. 100–200). Порты должны находиться в диапазоне от 0 до 65535, а диапазоны портов или порты не могут перекрываться. Если указаны другие значения, запрос завершается ошибкой с кодом состояния HTTP 400. Значение по умолчанию будет *. строка[]

NFSMountConfiguration

Имя Описание Ценность
Варианты монтирования Это параметры "net use" в Windows и "подключение" в Linux. струна
relativeMountPath Все файловые системы подключены относительно каталога подключений пакетной службы, доступные с помощью переменной среды AZ_BATCH_NODE_MOUNTS_DIR. строка (обязательно)
источник Универсальный код ресурса (URI) файловой системы для подключения. строка (обязательно)

NodePlacementConfiguration (Конфигурация NodePlacement)

Имя Описание Ценность
политика Политика выделения, используемая пакетной службой для подготовки узлов. Если оно не указано, пакетная служба будет использовать региональную политику. "Региональный"
"Зональный"

PoolEndpointConfiguration (Конфигурация пулаEndpoint)

Имя Описание Ценность
входящиеNatPools Максимальное количество входящих пулов NAT на пул пакетной службы составляет 5. Если максимальное число входящих пулов NAT превышается, запрос завершается ошибкой с кодом состояния HTTP 400. Это невозможно указать, если IPAddressProvisioningType — NoPublicIPAddresses. InboundNatPool[] (обязательно)

Свойства пула

Имя Описание Ценность
applicationLicenses Список лицензий приложений должен быть подмножеством доступных лицензий приложения пакетной службы. Если запрашивается лицензия, которая не поддерживается, создание пула завершится ошибкой. строка[]
пакеты приложений Изменения ссылок на пакеты приложений влияют на все новые вычислительные узлы, присоединенные к пулу, но не влияют на вычислительные узлы, которые уже находятся в пуле, пока они не перезагрузятся или переимыслятся. В любом пуле имеется не более 10 ссылок на пакеты приложений. Ссылка на ApplicationPackage[]
Сертификаты Для вычислительных узлов Windows служба пакетной службы устанавливает сертификаты в указанное хранилище сертификатов и расположение. Для вычислительных узлов Linux сертификаты хранятся в каталоге рабочих каталогов задач, а переменная среды AZ_BATCH_CERTIFICATES_DIR предоставляется задаче для запроса к этому расположению. Для сертификатов с видимостью remoteUser каталог "certs" создается в домашнем каталоге пользователя (например, /home/{user-name}/certs) и сертификаты помещаются в этот каталог. Справка о сертификате[]
deploymentConfiguration Использование CloudServiceConfiguration указывает, что узлы должны создаваться с помощью облачных служб Azure (PaaS), а VirtualMachineConfiguration использует виртуальные машины Azure (IaaS). РазвертываниеКонфигурация
отображаемое имя Отображаемое имя не должно быть уникальным и может содержать любые символы Юникода до максимальной длины 1024. струна
interNodeCommunication Это накладывает ограничения на назначение узлов пулу. Включение этого значения может снизить вероятность выделения запрошенного количества узлов в пуле. Если этот параметр не указан, значение по умолчанию имеет значение "Отключено". "Отключено"
"Включено"
метаданные Пакетная служба не назначает никакое значение метаданным; он предназначен исключительно для использования пользовательского кода. МетаданныеItem[]
mountConfiguration Это поддерживает файлы Azure, NFS, CIFS/SMB и Blobfuse. Конфигурация монтирования[]
networkConfiguration Конфигурация сети для пула. Конфигурация сети
параметры масштабирования Определяет требуемый размер пула. Это может быть "фиксированный масштаб", где указан запрошенный целевой идентификаторNodes или "автомасштабирование", определяющий формулу, которая периодически переоценится. Если это свойство не указано, пул будет иметь фиксированный масштаб с 0 targetDedicatedNodes. ScaleSettings (МасштабНастройки)
начатьЗадачу В операции PATCH (update) это свойство можно задать для пустого объекта, чтобы удалить начальную задачу из пула. СтартЗадача
taskSchedulingPolicy Если значение не указано, по умолчанию распространяется. TaskSchedulingPolicy
taskSlotsPerNode Значение по умолчанию — 1. Максимальное значение меньше 4 раза меньше числа ядер vmSize пула или 256. инт
userAccounts Список учетных записей пользователей, создаваемых на каждом узле в пуле. Учетная запись пользователя[]
vmSize Сведения о доступных размерах виртуальных машин для пулов облачных служб (пулы, созданные с помощью cloudServiceConfiguration), см. в разделе "Размеры облачных служб" (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Пакетная служба поддерживает все размеры виртуальных машин облачных служб, кроме ExtraSmall. Сведения о доступных размерах виртуальных машин для пулов с помощью образов из Marketplace виртуальных машин (пулы, созданные с помощью 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). струна

PublicIPAddressConfiguration (ПубличныйIPAddressConfiguration)

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

РесурсФайл

Имя Описание Ценность
autoStorageContainerName Свойства autoStorageContainerName, storageContainerUrl и httpUrl являются взаимоисключающими, и один из них должен быть указан. струна
BLOBPrefix Свойство допустимо, только если используется autoStorageContainerName или storageContainerUrl. Этот префикс может быть частичным именем файла или подкаталогом. Если префикс не указан, все файлы в контейнере будут скачаны. струна
Режим файла Это свойство применяется только к файлам, скачанным на вычислительные узлы Linux. Он будет игнорироваться, если он указан для resourceFile, который будет скачан на узел Windows. Если это свойство не указано для узла Linux, к файлу применяется значение по умолчанию 0770. струна
путь к файлу Если задано свойство httpUrl, файлPath является обязательным и описывает путь, в который будет скачан файл, включая имя файла. В противном случае, если задано свойство autoStorageContainerName или storageContainerUrl, filePath является необязательным и является каталогом для скачивания файлов. В случае, когда filePath используется в качестве каталога, любая структура каталогов, уже связанная с входными данными, будет сохранена в полном объеме и добавлена в указанный каталог filePath. Указанный относительный путь не может выйти из рабочего каталога задачи (например, с помощью '.'). струна
httpUrl (httpUrl) Свойства autoStorageContainerName, storageContainerUrl и httpUrl являются взаимоисключающими, и один из них должен быть указан. Если URL-адрес — хранилище BLOB-объектов Azure, он должен быть доступен для чтения с помощью анонимного доступа; То есть пакетная служба не предоставляет учетные данные при скачивании большого двоичного объекта. Существует два способа получить такой URL-адрес для большого двоичного объекта в хранилище Azure: включить подписанный URL-адрес (SAS), предоставляющий разрешения на чтение большого двоичного объекта, или задать ACL для большого двоичного объекта или его контейнера, чтобы разрешить общедоступный доступ. струна
storageContainerUrl Свойства autoStorageContainerName, storageContainerUrl и httpUrl являются взаимоисключающими, и один из них должен быть указан. Этот URL-адрес должен быть доступен для чтения и списка с помощью анонимного доступа; То есть пакетная служба не предоставляет учетные данные при скачивании большого двоичного объекта. Существует два способа получить такой URL-адрес для большого двоичного объекта в хранилище Azure: включить подписанный URL-адрес (SAS), предоставляющий разрешения на чтение и список для большого двоичного объекта, или задать ACL для большого двоичного объекта или его контейнера, чтобы разрешить общедоступный доступ. струна

Настройки масштабирования

Имя Описание Ценность
автомасштабирование Это свойство и фиксированное масштабирование являются взаимоисключающими, и необходимо указать одно из свойств. АвтомасштабированиеSettings
fixedScale Это свойство и автомасштабирование являются взаимоисключающими, и необходимо указать одно из свойств. ФиксированныеScaleSettings

СтартЗадача

Имя Описание Ценность
командная строка Командная строка не выполняется под оболочкой и поэтому не может воспользоваться преимуществами функций оболочки, таких как расширение переменной среды. Если вы хотите воспользоваться такими функциями, необходимо вызвать оболочку в командной строке, например с помощью cmd /c MyCommand в Windows или "/bin/sh -c MyCommand" в Linux. Требуется, если указаны другие свойства startTask. струна
Настройки контейнера При указании все каталоги рекурсивно под AZ_BATCH_NODE_ROOT_DIR (корнем каталогов пакетной службы Azure на узле) сопоставляются с контейнером, все переменные среды задач сопоставляются с контейнером, а командная строка задачи выполняется в контейнере. TaskContainerSettings (ЗадачиКонтейнерНастройки)
средаНастройки Список параметров переменной среды для начальной задачи. Окружающая средаНастройка[]
maxTaskRetryCount Пакетная служба повторяет задачу, если его код выхода не является ненулевой. Обратите внимание, что это значение специально управляет числом повторных попыток. Пакетная служба попытается выполнить задачу один раз, а затем повторите попытку до этого ограничения. Например, если максимальное число повторных попыток равно 3, пакетная служба пытается выполнить задачу до 4 раз (одна начальная попытка и 3 повторные попытки). Если максимальное число повторных попыток равно 0, пакетная служба не повторяет задачу. Если максимальное число повторных попыток равно -1, пакетная служба повторяет задачу без ограничения. инт
Файлы ресурсов Список файлов, которые служба пакетной службы скачивает на вычислительный узел перед выполнением командной строки. РесурсФайл[]
userIdentity Если этот параметр не указан, задача выполняется как пользователь, не являющийся администратором, уникальным для задачи. Идентификация пользователя
waitForSuccess Если значение true и задача запуска завершается сбоем на вычислительном узле, пакетная служба повторяет задачу запуска до максимального количества повторных попыток (maxTaskRetryCount). Если задача по-прежнему не выполнена успешно после всех повторных попыток, служба пакетной службы помечает вычислительный узел неиспользуемым и не запланирует задачи. Это условие можно обнаружить с помощью состояния узла и подробных сведений об ошибке планирования. Если значение false, служба пакетной службы не ожидает завершения начальной задачи. В этом случае другие задачи могут запускаться на вычислительном узле, пока задача запуска по-прежнему выполняется; и даже если задача запуска завершается сбоем, новые задачи будут продолжать планироваться на узле. Значение по умолчанию — true. булевая переменная (bool)

TaskContainerSettings (ЗадачиКонтейнерНастройки)

Имя Описание Ценность
containerRunOptions Эти дополнительные параметры предоставляются в качестве аргументов в команду docker create, а также те, которые управляются пакетной службой. струна
названиеИзображения Это полная ссылка на изображение, как было бы указано для параметра docker pull. Если тег не указан как часть имени изображения, тег ":latest" используется в качестве значения по умолчанию. строка (обязательно)
регистратура Этот параметр может быть опущен, если он уже был предоставлен при создании пула. ContainerRegistry (ContainerRegistry)
workingDirectory Флаг, указывающий, где находится рабочий каталог задачи контейнера. Значение по умолчанию — taskWorkingDirectory. ContainerImageDefault
TaskWorkingDirectory

TaskSchedulingPolicy

Имя Описание Ценность
nodeFillType Порядок распределения задач между вычислительными узлами. "Pack"
"Распространение" (обязательно)

Учетная запись пользователя

Имя Описание Ценность
elevationLevel nonAdmin — автоматический пользователь является стандартным пользователем без повышенного доступа. администратор . Автоматический пользователь является пользователем с повышенным доступом и работает с полными разрешениями администратора. Значение по умолчанию — nonAdmin. "Администратор"
«Не-администратор»
linuxUserConfiguration Это свойство игнорируется, если указано в пуле Windows. Если это не указано, пользователь создается с параметрами по умолчанию. LinuxUserConfiguration
имя Имя учетной записи пользователя. строка (обязательно)
пароль Пароль для учетной записи пользователя. строка (обязательно)
windowsUserConfiguration Это свойство можно указать только в том случае, если пользователь находится в пуле Windows. Если он не указан и в пуле Windows, пользователь создается с параметрами по умолчанию. WindowsUserConfiguration

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

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

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

Имя Описание Ценность
Конфигурация контейнера Если задано, программа установки выполняется на каждом узле в пуле, чтобы разрешить выполнение задач в контейнерах. Все обычные задачи и задачи диспетчера заданий, выполняемые в этом пуле, должны указывать свойство containerSettings, а все остальные задачи могут указывать его. ContainerConfiguration (Конфигурация контейнера)
Диски данных Это свойство должно быть указано, если вычислительные узлы в пуле должны иметь пустые диски данных, подключенные к ним. Диск данных[]
diskEncryptionConfiguration При указании шифрование выполняется на каждом узле в пуле во время подготовки узлов. DiskEncryptionConfiguration (Настройка дискового шифрования)
Расширения При указании расширения, упомянутые в этой конфигурации, будут установлены на каждом узле. VMExtension[]
ImageReference Ссылка на образ Виртуальной машины Azure Marketplace или ресурс образа Azure настраиваемой виртуальной машины. Чтобы получить список всех образовReference, проверенных пакетной службой Azure, см. операцию "Список поддерживаемых номеров SKU агента узлов". ImageReference (обязательно)
тип лицензии Это относится только к образам, содержащим операционную систему Windows, и следует использовать только при удержании допустимых локальных лицензий для узлов, которые будут развернуты. Если не указано, скидка на лицензирование в локальной среде не применяется. Значения:

Windows_Server . Локальная лицензия предназначена для Windows Server.
Windows_Client . Локальная лицензия предназначена для клиента Windows.
струна
nodeAgentSkuId Агент узла пакетной службы — это программа, которая выполняется на каждом узле в пуле и предоставляет интерфейс управления между узлом и пакетной службой. Существуют различные реализации агента узла, известного как номера SKU для разных операционных систем. Необходимо указать номер SKU агента узла, соответствующий выбранной ссылке на изображение. Чтобы получить список поддерживаемых номеров SKU агента узлов вместе со списком проверенных ссылок на образы, см. в разделе "Список поддерживаемых SKU агента узлов". строка (обязательно)
nodePlacementConfiguration Эта конфигурация будет указывать правила по тому, как узлы в пуле будут физически выделены. NodePlacementConfiguration (Конфигурация NodePlacement)
windowsКонфигурация Это свойство не должно быть указано, если imageReference указывает образ ОС Linux. WindowsКонфигурация

VMExtension

Имя Описание Ценность
автоматическое обновление минорной версии Указывает, следует ли использовать более новую дополнительную версию, если она доступна во время развертывания. Однако после развертывания расширение не будет обновлять дополнительные версии без повторного развертывания, даже если это свойство не имеет значения true. булевая переменная (bool)
имя Имя расширения виртуальной машины. строка (обязательно)
защищенныеНастройки Расширение может содержать защищенные параметрыSettings или protectedSettingsFromKeyVault или не иметь защищенных параметров. любой
provisionAfterExtensions Коллекция имен расширений, после которой необходимо подготовить это расширение. строка[]
издатель Имя издателя обработчика расширений. строка (обязательно)
Параметры Форматированные общедоступные параметры JSON для расширения. любой
тип Тип расширений. строка (обязательно)
версияТипаОбработчика Версия обработчика скрипта. струна

WindowsКонфигурация

Имя Описание Ценность
enableAutomaticUpdates Если опущено, значение по умолчанию имеет значение true. булевая переменная (bool)

WindowsUserConfiguration

Имя Описание Ценность
loginMode Задает режим входа для пользователя. Значением по умолчанию для пулов VirtualMachineConfiguration является интерактивный режим, а для пулов CloudServiceConfiguration используется пакетный режим. Пакетная служба
"Интерактивный"

Примеры использования

Шаблоны быстрого запуска Azure

Следующие шаблоны быстрого запуска Azure развернуть этот тип ресурса.

Шаблон Описание
пул пакетной службы Azure без общедоступных IP-адресов

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

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса batchAccounts/пулов можно развернуть с помощью операций, предназначенных для следующих операций:

  • групп ресурсов

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

Формат ресурса

Чтобы создать ресурс Microsoft.Batch/batchAccounts/pools, добавьте следующий объект Terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Batch/batchAccounts/pools@2021-01-01"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  body = {
    properties = {
      applicationLicenses = [
        "string"
      ]
      applicationPackages = [
        {
          id = "string"
          version = "string"
        }
      ]
      certificates = [
        {
          id = "string"
          storeLocation = "string"
          storeName = "string"
          visibility = [
            "string"
          ]
        }
      ]
      deploymentConfiguration = {
        cloudServiceConfiguration = {
          osFamily = "string"
          osVersion = "string"
        }
        virtualMachineConfiguration = {
          containerConfiguration = {
            containerImageNames = [
              "string"
            ]
            containerRegistries = [
              {
                password = "string"
                registryServer = "string"
                username = "string"
              }
            ]
            type = "DockerCompatible"
          }
          dataDisks = [
            {
              caching = "string"
              diskSizeGB = int
              lun = int
              storageAccountType = "string"
            }
          ]
          diskEncryptionConfiguration = {
            targets = [
              "string"
            ]
          }
          extensions = [
            {
              autoUpgradeMinorVersion = bool
              name = "string"
              protectedSettings = ?
              provisionAfterExtensions = [
                "string"
              ]
              publisher = "string"
              settings = ?
              type = "string"
              typeHandlerVersion = "string"
            }
          ]
          imageReference = {
            id = "string"
            offer = "string"
            publisher = "string"
            sku = "string"
            version = "string"
          }
          licenseType = "string"
          nodeAgentSkuId = "string"
          nodePlacementConfiguration = {
            policy = "string"
          }
          windowsConfiguration = {
            enableAutomaticUpdates = bool
          }
        }
      }
      displayName = "string"
      interNodeCommunication = "string"
      metadata = [
        {
          name = "string"
          value = "string"
        }
      ]
      mountConfiguration = [
        {
          azureBlobFileSystemConfiguration = {
            accountKey = "string"
            accountName = "string"
            blobfuseOptions = "string"
            containerName = "string"
            relativeMountPath = "string"
            sasKey = "string"
          }
          azureFileShareConfiguration = {
            accountKey = "string"
            accountName = "string"
            azureFileUrl = "string"
            mountOptions = "string"
            relativeMountPath = "string"
          }
          cifsMountConfiguration = {
            mountOptions = "string"
            password = "string"
            relativeMountPath = "string"
            source = "string"
            username = "string"
          }
          nfsMountConfiguration = {
            mountOptions = "string"
            relativeMountPath = "string"
            source = "string"
          }
        }
      ]
      networkConfiguration = {
        endpointConfiguration = {
          inboundNatPools = [
            {
              backendPort = int
              frontendPortRangeEnd = int
              frontendPortRangeStart = int
              name = "string"
              networkSecurityGroupRules = [
                {
                  access = "string"
                  priority = int
                  sourceAddressPrefix = "string"
                  sourcePortRanges = [
                    "string"
                  ]
                }
              ]
              protocol = "string"
            }
          ]
        }
        publicIPAddressConfiguration = {
          ipAddressIds = [
            "string"
          ]
          provision = "string"
        }
        subnetId = "string"
      }
      scaleSettings = {
        autoScale = {
          evaluationInterval = "string"
          formula = "string"
        }
        fixedScale = {
          nodeDeallocationOption = "string"
          resizeTimeout = "string"
          targetDedicatedNodes = int
          targetLowPriorityNodes = int
        }
      }
      startTask = {
        commandLine = "string"
        containerSettings = {
          containerRunOptions = "string"
          imageName = "string"
          registry = {
            password = "string"
            registryServer = "string"
            username = "string"
          }
          workingDirectory = "string"
        }
        environmentSettings = [
          {
            name = "string"
            value = "string"
          }
        ]
        maxTaskRetryCount = int
        resourceFiles = [
          {
            autoStorageContainerName = "string"
            blobPrefix = "string"
            fileMode = "string"
            filePath = "string"
            httpUrl = "string"
            storageContainerUrl = "string"
          }
        ]
        userIdentity = {
          autoUser = {
            elevationLevel = "string"
            scope = "string"
          }
          userName = "string"
        }
        waitForSuccess = bool
      }
      taskSchedulingPolicy = {
        nodeFillType = "string"
      }
      taskSlotsPerNode = int
      userAccounts = [
        {
          elevationLevel = "string"
          linuxUserConfiguration = {
            gid = int
            sshPrivateKey = "string"
            uid = int
          }
          name = "string"
          password = "string"
          windowsUserConfiguration = {
            loginMode = "string"
          }
        }
      ]
      vmSize = "string"
    }
  }
}

Значения свойств

Microsoft.Batch/batchAccounts/пулы

Имя Описание Ценность
тождество Тип удостоверения, используемого для пула пакетной службы. BatchPoolIdentity (Идентификация BatchPool)
имя Имя ресурса струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 64
Pattern = ^[a-zA-Z0-9_-]+$ (обязательно)
идентификатор_родителя Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: batchAccounts
свойства Свойства, связанные с пулом. Свойства пула
тип Тип ресурса "Microsoft.Batch/batchAccounts/pools@2021-01-01"

ApplicationPackageReference

Имя Описание Ценность
идентификатор Идентификатор устанавливаемого пакета приложения. Это должно находиться внутри той же учетной записи пакетной службы, что и пул. Это может быть ссылка на определенную версию или версию по умолчанию, если она существует. строка (обязательно)
Версия Если это опущено, и для этого приложения не указана версия по умолчанию, запрос завершается сбоем с кодом ошибки InvalidApplicationPackageReferences. Если вы вызываете REST API напрямую, код состояния HTTP равен 409. струна

АвтомасштабированиеSettings

Имя Описание Ценность
оценкаИнтервал Если опущено, значение по умолчанию — 15 минут (PT15M). струна
формула Формула для требуемого количества вычислительных узлов в пуле. строка (обязательно)

Спецификация AutoUserSpecification

Имя Описание Ценность
elevationLevel Значение по умолчанию — nonAdmin. "Администратор"
«Не-администратор»
размах Значением по умолчанию является пул. Если пул работает под управлением Windows, необходимо указать значение задачи, если требуется более строгая изоляция между задачами. Например, если задача мутирует реестр таким образом, что может повлиять на другие задачи, или если сертификаты были указаны в пуле, который не должен быть доступен обычными задачами, но должен быть доступен путем запуска задач. "Пул"
"Задача"

AzureBlobFileSystemConfiguration

Имя Описание Ценность
accountKey Это свойство является взаимоисключающим с sasKey, и его необходимо указать. струна
Имя аккаунта Имя учетной записи хранения Azure. строка (обязательно)
blobfuseOptions Это параметры "net use" в Windows и "подключение" в Linux. струна
имяКонтейнера Имя контейнера хранилища BLOB-объектов Azure. строка (обязательно)
relativeMountPath Все файловые системы подключены относительно каталога подключений пакетной службы, доступные с помощью переменной среды AZ_BATCH_NODE_MOUNTS_DIR. строка (обязательно)
sasKey Это свойство является взаимоисключающим с accountKey, и его необходимо указать. струна

Конфигурация AzureFileShare

Имя Описание Ценность
accountKey Ключ учетной записи хранения Azure. строка (обязательно)
Имя аккаунта Имя учетной записи хранения Azure. строка (обязательно)
azureFileUrl Это форма "https://{account}.file.core.windows.net/". строка (обязательно)
Варианты монтирования Это параметры "net use" в Windows и "подключение" в Linux. струна
relativeMountPath Все файловые системы подключены относительно каталога подключений пакетной службы, доступные с помощью переменной среды AZ_BATCH_NODE_MOUNTS_DIR. строка (обязательно)

BatchPoolIdentity (Идентификация BatchPool)

Имя Описание Ценность
тип Тип удостоверения, используемого для пула пакетной службы. "Нет"
UserAssigned (обязательно)
ИдентичностиНазначенныеПользователем Список удостоверений пользователей, связанных с пулом пакетной службы. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". BatchPoolIdentityUserAssignedIdentities

BatchPoolIdentityUserAssignedIdentities

Имя Описание Ценность

СертификатСсылка

Имя Описание Ценность
идентификатор Полный идентификатор сертификата для установки в пуле. Это должно находиться внутри той же учетной записи пакетной службы, что и пул. строка (обязательно)
Местоположение магазина Значение по умолчанию — currentUser. Это свойство применимо только для пулов, настроенных с узлами Windows (т. е. созданными с помощью cloudServiceConfiguration или virtualMachineConfiguration с помощью ссылки на образ Windows). Для вычислительных узлов Linux сертификаты хранятся в каталоге рабочих каталогов задач, а переменная среды AZ_BATCH_CERTIFICATES_DIR предоставляется задаче для запроса к этому расположению. Для сертификатов с видимостью remoteUser каталог "certs" создается в домашнем каталоге пользователя (например, /home/{user-name}/certs) и сертификаты помещаются в этот каталог. CurrentUser
LocalMachine
название магазина Это свойство применимо только для пулов, настроенных с узлами Windows (т. е. созданными с помощью cloudServiceConfiguration или virtualMachineConfiguration с помощью ссылки на образ Windows). Распространенные имена хранилищ: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, но любое пользовательское имя хранилища также можно использовать. Значением по умолчанию является My. струна
видимость Какие учетные записи пользователей на вычислительном узле должны иметь доступ к частным данным сертификата. Массив строк, содержащий любой из:
RemoteUser
StartTask
"Задача"

Конфигурация CifsMount

Имя Описание Ценность
Варианты монтирования Это параметры "net use" в Windows и "подключение" в Linux. струна
пароль Пароль, используемый для проверки подлинности в файловой системе CIFS. строка (обязательно)
relativeMountPath Все файловые системы подключены относительно каталога подключений пакетной службы, доступные с помощью переменной среды AZ_BATCH_NODE_MOUNTS_DIR. строка (обязательно)
источник Универсальный код ресурса (URI) файловой системы для подключения. строка (обязательно)
имя пользователя Пользователь, используемый для проверки подлинности в файловой системе CIFS. строка (обязательно)

CloudServiceConfiguration (Облачная службаКонфигурация)

Имя Описание Ценность
osFamily Возможные значения: 2 — семейство ОС 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). строка (обязательно)
Версия ОС Значение по умолчанию — *, указывающее последнюю версию операционной системы для указанного семейства ОС. струна

Компоненты81XseeSchemasBatchpoolidentityPropertiesUserassignedidentitiesAdditionalproperties

Имя Описание Ценность

ContainerConfiguration (Конфигурация контейнера)

Имя Описание Ценность
containerImageNames Это полная ссылка на изображение, как было бы указано для параметра docker pull. Образ будет получен из реестра Docker по умолчанию, если образ не является полным с альтернативным реестром. строка[]
containerRegistries Если какие-либо образы должны быть загружены из частного реестра, для которого требуются учетные данные, эти учетные данные должны быть предоставлены здесь. ContainerRegistry[]
тип Используемая технология контейнера. DockerCompatible (обязательный)

ContainerRegistry (ContainerRegistry)

Имя Описание Ценность
пароль Пароль для входа на сервер реестра. строка (обязательно)
сервер реестра Если опущено, значение по умолчанию — "docker.io". струна
имя пользователя Имя пользователя для входа на сервер реестра. строка (обязательно)

ДатаДиск

Имя Описание Ценность
Кэширование Значения:

none — режим кэширования для диска не включен.
readOnly — режим кэширования для диска доступен только для чтения.
readWrite — режим кэширования для диска считывается и записывается.

Значение по умолчанию для кэширования не имеет значения. Сведения о параметрах кэширования см. в статье https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.
"Нет"
"ReadOnly"
ReadWrite
Размер дискаГб Начальный размер диска в ГБ при создании нового диска данных. int (обязательно)
Лунь Луна используется для уникальной идентификации каждого диска данных. При подключении нескольких дисков каждый должен иметь отдельную луну. Значение должно быть от 0 до 63 включительно. int (обязательно)
Тип учетной записи хранилища Если опущено, значение по умолчанию — "Standard_LRS". Значения:

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

РазвертываниеКонфигурация

Имя Описание Ценность
CloudServiceConfiguration Это свойство и virtualMachineConfiguration являются взаимоисключающими, и необходимо указать одно из свойств. Это свойство нельзя указать, если учетная запись пакетной службы была создана с его свойством PoolAllocationMode с значением UserSubscription. CloudServiceConfiguration (Облачная службаКонфигурация)
virtualMachineConfiguration Это свойство и cloudServiceConfiguration являются взаимоисключающими, и необходимо указать одно из свойств. Конфигурация виртуальной машины

DiskEncryptionConfiguration (Настройка дискового шифрования)

Имя Описание Ценность
Цели В пуле Linux поддерживается только временныйdisk; В пуле Windows необходимо указать "OsDisk" и "TemporaryDisk". Массив строк, содержащий любой из:
OsDisk
"ВременныйDisk"

Окружающая средаНастройка

Имя Описание Ценность
имя Имя переменной среды. строка (обязательно)
ценность Значение переменной среды. струна

ФиксированныеScaleSettings

Имя Описание Ценность
nodeDeallocationOption Если опущено, значение по умолчанию — Requeue. "Requeue"
"СохранитьedData"
TaskCompletion
"Завершение"
resizeTimeout Значение по умолчанию — 15 минут. Значения времени ожидания используют формат ISO 8601. Например, используйте PT10M в течение 10 минут. Минимальное значение — 5 минут. Если указать значение менее 5 минут, служба пакетной службы отклоняет запрос с ошибкой; Если вы вызываете REST API напрямую, код состояния HTTP равен 400 (недопустимый запрос). струна
targetDedicatedNodes По крайней мере один из целевыхDedicatedNodes, необходимо задать targetLowPriorityNodes. инт
targetLowPriorityNodes По крайней мере один из целевыхDedicatedNodes, необходимо задать targetLowPriorityNodes. инт

Ссылка на изображение

Имя Описание Ценность
идентификатор Это свойство является взаимоисключающим с другими свойствами. Образ общей коллекции образов должен иметь реплики в том же регионе, что и учетная запись пакетной службы Azure. Сведения о параметрах брандмауэра для агента узла пакетной службы для взаимодействия с пакетной службой см. в статье /azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. струна
предлагать Например, UbuntuServer или WindowsServer. струна
издатель Например, Canonical или MicrosoftWindowsServer. струна
SKU Например, 18.04-LTS или 2019-Datacenter. струна
Версия Чтобы выбрать последнюю версию образа, можно указать значение "последняя". Если опущено, значение по умолчанию — "последняя". струна

Входящий NatPool (Входящий NatPool)

Имя Описание Ценность
серверный порт Это должно быть уникальным в пуле пакетной службы. Допустимые значения : от 1 до 65535, за исключением 22, 3389, 29876 и 29877, так как они зарезервированы. Если указаны зарезервированные значения, запрос завершается ошибкой с кодом состояния HTTP 400. int (обязательно)
frontendPortRangeEnd Допустимые значения варьируются от 1 до 65534, за исключением портов от 50000 до 55000, зарезервированных пакетной службой. Все диапазоны в пуле должны быть уникальными и не могут перекрываться. Если указаны зарезервированные или перекрывающиеся значения, запрос завершается ошибкой с кодом состояния HTTP 400. int (обязательно)
frontendPortRangeStart Допустимые значения варьируются от 1 до 65534, за исключением портов от 50000 до 55000, которые зарезервированы. Все диапазоны в пуле должны быть уникальными и не могут перекрываться. Если указаны зарезервированные или перекрывающиеся значения, запрос завершается ошибкой с кодом состояния HTTP 400. int (обязательно)
имя Имя должно быть уникальным в пуле пакетной службы, может содержать буквы, цифры, подчеркивания, периоды и дефисы. Имена должны начинаться с буквы или числа, заканчиваться буквой, числом или подчеркиванием и не может превышать 77 символов. Если указаны недопустимые значения, запрос завершается ошибкой с кодом состояния HTTP 400. строка (обязательно)
networkSecurityGroupRules Максимальное количество правил, которые можно указать во всех конечных точках в пуле пакетной службы, равно 25. Если правила группы безопасности сети не указаны, будет создано правило по умолчанию, чтобы разрешить входящий доступ к указанному внутреннему порту. Если максимальное число правил группы безопасности сети превышается, запрос завершается ошибкой с кодом состояния HTTP 400. Правило NetworkSecurityGroup[]
протокол Протокол конечной точки. "TCP"
UDP (обязательно)

LinuxUserConfiguration

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

МетаdataItem (МетаданныеItem)

Имя Описание Ценность
имя Имя элемента метаданных. строка (обязательно)
ценность Значение элемента метаданных. строка (обязательно)

МонтированиеКонфигурация

Имя Описание Ценность
azureBlobFileSystemConfiguration Это свойство является взаимоисключающим со всеми другими свойствами. AzureBlobFileSystemConfiguration
azureFileShareConfiguration Это свойство является взаимоисключающим со всеми другими свойствами. Конфигурация AzureFileShare
Конфигурация cifsMount Это свойство является взаимоисключающим со всеми другими свойствами. Конфигурация CifsMount
Конфигурация nfsMount Это свойство является взаимоисключающим со всеми другими свойствами. NFSMountConfiguration

Сетевая конфигурация

Имя Описание Ценность
конечная точкаКонфигурация Конфигурация конечной точки пула поддерживается только в пулах со свойством VirtualMachineConfiguration. PoolEndpointConfiguration (Конфигурация пулаEndpoint)
publicIPAddressConfiguration Это свойство поддерживается только в пулах с свойством virtualMachineConfiguration. PublicIPAddressConfiguration (ПубличныйIPAddressConfiguration)
SubnetId Виртуальная сеть должна находиться в том же регионе и подписке, что и учетная запись пакетной службы Azure. Указанная подсеть должна иметь достаточно свободных IP-адресов для размещения количества узлов в пуле. Если подсеть не имеет достаточно свободных IP-адресов, пул частично выделяет вычислительные узлы и возникнет ошибка изменения размера. Субъект-служба MicrosoftAzureBatch должна иметь роль "Участник классической виртуальной машины" Role-Based управление доступом (RBAC) для указанной виртуальной сети. Указанная подсеть должна разрешить обмен данными из пакетной службы Azure, чтобы иметь возможность планировать задачи на вычислительных узлах. Это можно проверить, проверьте, имеет ли указанная виртуальная сеть любые связанные группы безопасности сети (NSG). Если связь с вычислительными узлами в указанной подсети запрещена группой безопасности сети, служба пакетной службы установит состояние вычислительных узлов неиспользуемым. Если указанная виртуальная сеть имеет любые связанные группы безопасности сети (NSG), для входящего взаимодействия необходимо включить несколько зарезервированных системных портов. Для пулов, созданных с конфигурацией виртуальной машины, включите порты 29876 и 29877, а также порт 22 для Linux и порт 3389 для Windows. Для пулов, созданных с конфигурацией облачной службы, включите порты 10100, 20100 и 30100. Также включите исходящие подключения к службе хранилища Azure через порт 443. Для пулов cloudServiceConfiguration поддерживаются только классические виртуальные сети. Дополнительные сведения см. в статье /azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration струна

Правило NetworkSecurityGroupRule

Имя Описание Ценность
доступ Действие, которое следует предпринять для указанного IP-адреса, диапазона подсети или тега. "Разрешить"
"Запрет" (обязательно)
приоритет Приоритеты в пуле должны быть уникальными и оцениваются в порядке приоритета. Чем ниже число, тем выше приоритет. Например, правила можно указать с номерами заказов 150, 250 и 350. Правило с порядком 150 имеет приоритет над правилом, которое имеет порядок 250. Допустимые приоритеты — от 150 до 4096. Если указаны зарезервированные или повторяющиеся значения, запрос завершается ошибкой с кодом состояния HTTP 400. int (обязательно)
sourceAddressPrefix Допустимые значения — это один IP-адрес (например, 10.10.10.10), подсеть IP -адресов (т. е. 192.168.1.0/24), тег по умолчанию или * (для всех адресов). Если указаны другие значения, запрос завершается ошибкой с кодом состояния HTTP 400. строка (обязательно)
sourcePortRanges Допустимые значения: "*" (для всех портов 0 – 65535) или массивов портов или диапазонов портов (т. е. 100–200). Порты должны находиться в диапазоне от 0 до 65535, а диапазоны портов или порты не могут перекрываться. Если указаны другие значения, запрос завершается ошибкой с кодом состояния HTTP 400. Значение по умолчанию будет *. строка[]

NFSMountConfiguration

Имя Описание Ценность
Варианты монтирования Это параметры "net use" в Windows и "подключение" в Linux. струна
relativeMountPath Все файловые системы подключены относительно каталога подключений пакетной службы, доступные с помощью переменной среды AZ_BATCH_NODE_MOUNTS_DIR. строка (обязательно)
источник Универсальный код ресурса (URI) файловой системы для подключения. строка (обязательно)

NodePlacementConfiguration (Конфигурация NodePlacement)

Имя Описание Ценность
политика Политика выделения, используемая пакетной службой для подготовки узлов. Если оно не указано, пакетная служба будет использовать региональную политику. "Региональный"
"Зональный"

PoolEndpointConfiguration (Конфигурация пулаEndpoint)

Имя Описание Ценность
входящиеNatPools Максимальное количество входящих пулов NAT на пул пакетной службы составляет 5. Если максимальное число входящих пулов NAT превышается, запрос завершается ошибкой с кодом состояния HTTP 400. Это невозможно указать, если IPAddressProvisioningType — NoPublicIPAddresses. InboundNatPool[] (обязательно)

Свойства пула

Имя Описание Ценность
applicationLicenses Список лицензий приложений должен быть подмножеством доступных лицензий приложения пакетной службы. Если запрашивается лицензия, которая не поддерживается, создание пула завершится ошибкой. строка[]
пакеты приложений Изменения ссылок на пакеты приложений влияют на все новые вычислительные узлы, присоединенные к пулу, но не влияют на вычислительные узлы, которые уже находятся в пуле, пока они не перезагрузятся или переимыслятся. В любом пуле имеется не более 10 ссылок на пакеты приложений. Ссылка на ApplicationPackage[]
Сертификаты Для вычислительных узлов Windows служба пакетной службы устанавливает сертификаты в указанное хранилище сертификатов и расположение. Для вычислительных узлов Linux сертификаты хранятся в каталоге рабочих каталогов задач, а переменная среды AZ_BATCH_CERTIFICATES_DIR предоставляется задаче для запроса к этому расположению. Для сертификатов с видимостью remoteUser каталог "certs" создается в домашнем каталоге пользователя (например, /home/{user-name}/certs) и сертификаты помещаются в этот каталог. Справка о сертификате[]
deploymentConfiguration Использование CloudServiceConfiguration указывает, что узлы должны создаваться с помощью облачных служб Azure (PaaS), а VirtualMachineConfiguration использует виртуальные машины Azure (IaaS). РазвертываниеКонфигурация
отображаемое имя Отображаемое имя не должно быть уникальным и может содержать любые символы Юникода до максимальной длины 1024. струна
interNodeCommunication Это накладывает ограничения на назначение узлов пулу. Включение этого значения может снизить вероятность выделения запрошенного количества узлов в пуле. Если этот параметр не указан, значение по умолчанию имеет значение "Отключено". "Отключено"
"Включено"
метаданные Пакетная служба не назначает никакое значение метаданным; он предназначен исключительно для использования пользовательского кода. МетаданныеItem[]
mountConfiguration Это поддерживает файлы Azure, NFS, CIFS/SMB и Blobfuse. Конфигурация монтирования[]
networkConfiguration Конфигурация сети для пула. Конфигурация сети
параметры масштабирования Определяет требуемый размер пула. Это может быть "фиксированный масштаб", где указан запрошенный целевой идентификаторNodes или "автомасштабирование", определяющий формулу, которая периодически переоценится. Если это свойство не указано, пул будет иметь фиксированный масштаб с 0 targetDedicatedNodes. ScaleSettings (МасштабНастройки)
начатьЗадачу В операции PATCH (update) это свойство можно задать для пустого объекта, чтобы удалить начальную задачу из пула. СтартЗадача
taskSchedulingPolicy Если значение не указано, по умолчанию распространяется. TaskSchedulingPolicy
taskSlotsPerNode Значение по умолчанию — 1. Максимальное значение меньше 4 раза меньше числа ядер vmSize пула или 256. инт
userAccounts Список учетных записей пользователей, создаваемых на каждом узле в пуле. Учетная запись пользователя[]
vmSize Сведения о доступных размерах виртуальных машин для пулов облачных служб (пулы, созданные с помощью cloudServiceConfiguration), см. в разделе "Размеры облачных служб" (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Пакетная служба поддерживает все размеры виртуальных машин облачных служб, кроме ExtraSmall. Сведения о доступных размерах виртуальных машин для пулов с помощью образов из Marketplace виртуальных машин (пулы, созданные с помощью 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). струна

PublicIPAddressConfiguration (ПубличныйIPAddressConfiguration)

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

РесурсФайл

Имя Описание Ценность
autoStorageContainerName Свойства autoStorageContainerName, storageContainerUrl и httpUrl являются взаимоисключающими, и один из них должен быть указан. струна
BLOBPrefix Свойство допустимо, только если используется autoStorageContainerName или storageContainerUrl. Этот префикс может быть частичным именем файла или подкаталогом. Если префикс не указан, все файлы в контейнере будут скачаны. струна
Режим файла Это свойство применяется только к файлам, скачанным на вычислительные узлы Linux. Он будет игнорироваться, если он указан для resourceFile, который будет скачан на узел Windows. Если это свойство не указано для узла Linux, к файлу применяется значение по умолчанию 0770. струна
путь к файлу Если задано свойство httpUrl, файлPath является обязательным и описывает путь, в который будет скачан файл, включая имя файла. В противном случае, если задано свойство autoStorageContainerName или storageContainerUrl, filePath является необязательным и является каталогом для скачивания файлов. В случае, когда filePath используется в качестве каталога, любая структура каталогов, уже связанная с входными данными, будет сохранена в полном объеме и добавлена в указанный каталог filePath. Указанный относительный путь не может выйти из рабочего каталога задачи (например, с помощью '.'). струна
httpUrl (httpUrl) Свойства autoStorageContainerName, storageContainerUrl и httpUrl являются взаимоисключающими, и один из них должен быть указан. Если URL-адрес — хранилище BLOB-объектов Azure, он должен быть доступен для чтения с помощью анонимного доступа; То есть пакетная служба не предоставляет учетные данные при скачивании большого двоичного объекта. Существует два способа получить такой URL-адрес для большого двоичного объекта в хранилище Azure: включить подписанный URL-адрес (SAS), предоставляющий разрешения на чтение большого двоичного объекта, или задать ACL для большого двоичного объекта или его контейнера, чтобы разрешить общедоступный доступ. струна
storageContainerUrl Свойства autoStorageContainerName, storageContainerUrl и httpUrl являются взаимоисключающими, и один из них должен быть указан. Этот URL-адрес должен быть доступен для чтения и списка с помощью анонимного доступа; То есть пакетная служба не предоставляет учетные данные при скачивании большого двоичного объекта. Существует два способа получить такой URL-адрес для большого двоичного объекта в хранилище Azure: включить подписанный URL-адрес (SAS), предоставляющий разрешения на чтение и список для большого двоичного объекта, или задать ACL для большого двоичного объекта или его контейнера, чтобы разрешить общедоступный доступ. струна

Настройки масштабирования

Имя Описание Ценность
автомасштабирование Это свойство и фиксированное масштабирование являются взаимоисключающими, и необходимо указать одно из свойств. АвтомасштабированиеSettings
fixedScale Это свойство и автомасштабирование являются взаимоисключающими, и необходимо указать одно из свойств. ФиксированныеScaleSettings

СтартЗадача

Имя Описание Ценность
командная строка Командная строка не выполняется под оболочкой и поэтому не может воспользоваться преимуществами функций оболочки, таких как расширение переменной среды. Если вы хотите воспользоваться такими функциями, необходимо вызвать оболочку в командной строке, например с помощью cmd /c MyCommand в Windows или "/bin/sh -c MyCommand" в Linux. Требуется, если указаны другие свойства startTask. струна
Настройки контейнера При указании все каталоги рекурсивно под AZ_BATCH_NODE_ROOT_DIR (корнем каталогов пакетной службы Azure на узле) сопоставляются с контейнером, все переменные среды задач сопоставляются с контейнером, а командная строка задачи выполняется в контейнере. TaskContainerSettings (ЗадачиКонтейнерНастройки)
средаНастройки Список параметров переменной среды для начальной задачи. Окружающая средаНастройка[]
maxTaskRetryCount Пакетная служба повторяет задачу, если его код выхода не является ненулевой. Обратите внимание, что это значение специально управляет числом повторных попыток. Пакетная служба попытается выполнить задачу один раз, а затем повторите попытку до этого ограничения. Например, если максимальное число повторных попыток равно 3, пакетная служба пытается выполнить задачу до 4 раз (одна начальная попытка и 3 повторные попытки). Если максимальное число повторных попыток равно 0, пакетная служба не повторяет задачу. Если максимальное число повторных попыток равно -1, пакетная служба повторяет задачу без ограничения. инт
Файлы ресурсов Список файлов, которые служба пакетной службы скачивает на вычислительный узел перед выполнением командной строки. РесурсФайл[]
userIdentity Если этот параметр не указан, задача выполняется как пользователь, не являющийся администратором, уникальным для задачи. Идентификация пользователя
waitForSuccess Если значение true и задача запуска завершается сбоем на вычислительном узле, пакетная служба повторяет задачу запуска до максимального количества повторных попыток (maxTaskRetryCount). Если задача по-прежнему не выполнена успешно после всех повторных попыток, служба пакетной службы помечает вычислительный узел неиспользуемым и не запланирует задачи. Это условие можно обнаружить с помощью состояния узла и подробных сведений об ошибке планирования. Если значение false, служба пакетной службы не ожидает завершения начальной задачи. В этом случае другие задачи могут запускаться на вычислительном узле, пока задача запуска по-прежнему выполняется; и даже если задача запуска завершается сбоем, новые задачи будут продолжать планироваться на узле. Значение по умолчанию — true. булевая переменная (bool)

TaskContainerSettings (ЗадачиКонтейнерНастройки)

Имя Описание Ценность
containerRunOptions Эти дополнительные параметры предоставляются в качестве аргументов в команду docker create, а также те, которые управляются пакетной службой. струна
названиеИзображения Это полная ссылка на изображение, как было бы указано для параметра docker pull. Если тег не указан как часть имени изображения, тег ":latest" используется в качестве значения по умолчанию. строка (обязательно)
регистратура Этот параметр может быть опущен, если он уже был предоставлен при создании пула. ContainerRegistry (ContainerRegistry)
workingDirectory Флаг, указывающий, где находится рабочий каталог задачи контейнера. Значение по умолчанию — taskWorkingDirectory. ContainerImageDefault
TaskWorkingDirectory

TaskSchedulingPolicy

Имя Описание Ценность
nodeFillType Порядок распределения задач между вычислительными узлами. "Pack"
"Распространение" (обязательно)

Учетная запись пользователя

Имя Описание Ценность
elevationLevel nonAdmin — автоматический пользователь является стандартным пользователем без повышенного доступа. администратор . Автоматический пользователь является пользователем с повышенным доступом и работает с полными разрешениями администратора. Значение по умолчанию — nonAdmin. "Администратор"
«Не-администратор»
linuxUserConfiguration Это свойство игнорируется, если указано в пуле Windows. Если это не указано, пользователь создается с параметрами по умолчанию. LinuxUserConfiguration
имя Имя учетной записи пользователя. строка (обязательно)
пароль Пароль для учетной записи пользователя. строка (обязательно)
windowsUserConfiguration Это свойство можно указать только в том случае, если пользователь находится в пуле Windows. Если он не указан и в пуле Windows, пользователь создается с параметрами по умолчанию. WindowsUserConfiguration

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

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

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

Имя Описание Ценность
Конфигурация контейнера Если задано, программа установки выполняется на каждом узле в пуле, чтобы разрешить выполнение задач в контейнерах. Все обычные задачи и задачи диспетчера заданий, выполняемые в этом пуле, должны указывать свойство containerSettings, а все остальные задачи могут указывать его. ContainerConfiguration (Конфигурация контейнера)
Диски данных Это свойство должно быть указано, если вычислительные узлы в пуле должны иметь пустые диски данных, подключенные к ним. Диск данных[]
diskEncryptionConfiguration При указании шифрование выполняется на каждом узле в пуле во время подготовки узлов. DiskEncryptionConfiguration (Настройка дискового шифрования)
Расширения При указании расширения, упомянутые в этой конфигурации, будут установлены на каждом узле. VMExtension[]
ImageReference Ссылка на образ Виртуальной машины Azure Marketplace или ресурс образа Azure настраиваемой виртуальной машины. Чтобы получить список всех образовReference, проверенных пакетной службой Azure, см. операцию "Список поддерживаемых номеров SKU агента узлов". ImageReference (обязательно)
тип лицензии Это относится только к образам, содержащим операционную систему Windows, и следует использовать только при удержании допустимых локальных лицензий для узлов, которые будут развернуты. Если не указано, скидка на лицензирование в локальной среде не применяется. Значения:

Windows_Server . Локальная лицензия предназначена для Windows Server.
Windows_Client . Локальная лицензия предназначена для клиента Windows.
струна
nodeAgentSkuId Агент узла пакетной службы — это программа, которая выполняется на каждом узле в пуле и предоставляет интерфейс управления между узлом и пакетной службой. Существуют различные реализации агента узла, известного как номера SKU для разных операционных систем. Необходимо указать номер SKU агента узла, соответствующий выбранной ссылке на изображение. Чтобы получить список поддерживаемых номеров SKU агента узлов вместе со списком проверенных ссылок на образы, см. в разделе "Список поддерживаемых SKU агента узлов". строка (обязательно)
nodePlacementConfiguration Эта конфигурация будет указывать правила по тому, как узлы в пуле будут физически выделены. NodePlacementConfiguration (Конфигурация NodePlacement)
windowsКонфигурация Это свойство не должно быть указано, если imageReference указывает образ ОС Linux. WindowsКонфигурация

VMExtension

Имя Описание Ценность
автоматическое обновление минорной версии Указывает, следует ли использовать более новую дополнительную версию, если она доступна во время развертывания. Однако после развертывания расширение не будет обновлять дополнительные версии без повторного развертывания, даже если это свойство не имеет значения true. булевая переменная (bool)
имя Имя расширения виртуальной машины. строка (обязательно)
защищенныеНастройки Расширение может содержать защищенные параметрыSettings или protectedSettingsFromKeyVault или не иметь защищенных параметров. любой
provisionAfterExtensions Коллекция имен расширений, после которой необходимо подготовить это расширение. строка[]
издатель Имя издателя обработчика расширений. строка (обязательно)
Параметры Форматированные общедоступные параметры JSON для расширения. любой
тип Тип расширений. строка (обязательно)
версияТипаОбработчика Версия обработчика скрипта. струна

WindowsКонфигурация

Имя Описание Ценность
enableAutomaticUpdates Если опущено, значение по умолчанию имеет значение true. булевая переменная (bool)

WindowsUserConfiguration

Имя Описание Ценность
loginMode Задает режим входа для пользователя. Значением по умолчанию для пулов VirtualMachineConfiguration является интерактивный режим, а для пулов CloudServiceConfiguration используется пакетный режим. Пакетная служба
"Интерактивный"