Pool - Add

Служба:

Batch Service

Версия API:

2024-07-01.20.0

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

POST {batchUrl}/pools?api-version=2024-07-01.20.0

С использованием необязательных параметров:

POST {batchUrl}/pools?timeout={timeout}&api-version=2024-07-01.20.0

Параметры URI

Имя	В	Обязательно	Тип	Описание
batchUrl	path	True	string	Базовый URL-адрес для всех запросов пакетной службы Azure.
api-version	query	True	string	Версия КЛИЕНТСКОго API.
timeout	query		integer int32	Максимальное время, которое сервер может тратить на обработку запроса в секундах. Значение по умолчанию — 30 секунд. Если значение больше 30, вместо этого будет использоваться значение по умолчанию.

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

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

Имя	Обязательно	Тип	Описание
client-request-id		string uuid	Удостоверение запроса, созданное вызывающим пользователем, в виде GUID без украшений, таких как фигурные скобки, например 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Должен ли сервер возвращать идентификатор client-request-id в ответе.
ocp-date		string date-time-rfc1123	Время выдачи запроса. Клиентские библиотеки обычно задают это в текущее время системных часов; задайте его явным образом, если вы вызываете REST API напрямую.

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

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

Имя	Обязательно	Тип	Описание
id	True	string	Строка, которая однозначно идентифицирует пул в учетной записи. Идентификатор может содержать любое сочетание буквенно-цифровых символов, включая дефисы и символы подчеркивания, и не может содержать более 64 символов. Идентификатор сохраняет регистр и не учитывает регистр (т. е. у вас могут не быть двух идентификаторов пула в учетной записи, которые отличаются только по регистру).
vmSize	True	string	Размер виртуальных машин в пуле. Все виртуальные машины в пуле имеют одинаковый размер. Сведения о доступных размерах виртуальных машин см. в статьях "Размеры виртуальных машин ( 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).
applicationPackageReferences		ApplicationPackageReference[]	Список пакетов, установленных на каждом вычислительном узле в пуле. При создании пула идентификатор приложения пакета должен быть полным (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Изменения ссылок на пакеты влияют на все новые узлы, присоединенные к пулу, но не влияют на вычислительные узлы, которые уже находятся в пуле, пока они не перезагрузятся или переимыслятся. В любом пуле имеется не более 10 ссылок на пакеты.
autoScaleEvaluationInterval		string	Интервал времени, с помощью которого автоматически настраивается размер пула в соответствии с формулой автомасштабирования. Значение по умолчанию — 15 минут. Минимальное и максимальное значение — 5 минут и 168 часов соответственно. Если указать значение менее 5 минут или больше 168 часов, служба пакетной службы возвращает ошибку; Если вы вызываете REST API напрямую, код состояния HTTP равен 400 (недопустимый запрос).
autoScaleFormula		string	Формула для требуемого количества вычислительных узлов в пуле. Это свойство не должно быть указано, если параметр enableAutoScale имеет значение false. Требуется, если параметр enableAutoScale имеет значение true. Формула проверяется на допустимость перед созданием пула. Если формула недопустима, служба пакетной службы отклоняет запрос с подробными сведениями об ошибке. Дополнительные сведения об указании этой формулы см. в статье "Автоматическое масштабирование вычислительных узлов в пуле пакетной службы Azure" (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/).
certificateReferences		CertificateReference[]	Список сертификатов, которые необходимо установить на каждом вычислительном узле в пуле. Для узлов Windows пакетная служба устанавливает сертификаты в указанное хранилище сертификатов и расположение. Для вычислительных узлов Linux сертификаты хранятся в каталоге рабочей папки задачи, а переменная среды AZ_BATCH_CERTIFICATES_DIR предоставляется задаче для запроса к этому расположению. Для сертификатов с видимостью remoteUser каталог "certs" создается в домашнем каталоге пользователя (например, /home/{user-name}/certs) и сертификаты помещаются в этот каталог. Предупреждение. Это свойство устарело и будет удалено после февраля 2024 года. Вместо этого используйте расширения Azure KeyVault .
displayName		string	Отображаемое имя пула. Отображаемое имя не должно быть уникальным и может содержать любые символы Юникода до максимальной длины 1024.
enableAutoScale		boolean	Следует ли автоматически настраивать размер пула с течением времени. Если значение false, необходимо указать по крайней мере один из targetDedicatedNodes и targetLowPriorityNodes. Если значение true, требуется свойство autoScaleFormula, а пул автоматически изменяет размер в соответствии с формулой. Значение по умолчанию — false.
enableInterNodeCommunication		boolean	Разрешает ли пул прямой обмен данными между вычислительными узлами. Включение обмена данными между узлами ограничивает максимальный размер пула из-за ограничений развертывания на вычислительных узлах пула. Это может привести к тому, что пул не достигает требуемого размера. Значение по умолчанию — false.
metadata		MetadataItem[]	Список пар "имя-значение", связанных с пулом в качестве метаданных. Пакетная служба не назначает никакое значение метаданным; он предназначен исключительно для использования пользовательского кода.
mountConfiguration		MountConfiguration[]	Подключите хранилище с помощью указанной файловой системы в течение всего времени существования пула. Подключите хранилище с помощью файловой системы Azure, NFS, CIFS или Blobfuse.
networkConfiguration		NetworkConfiguration	Конфигурация сети для пула. Конфигурация сети для пула.
resizeTimeout		string	Время ожидания выделения вычислительных узлов в пул. Это время ожидания применяется только к масштабированию вручную; Он не действует, если параметр enableAutoScale имеет значение true. Значение по умолчанию — 15 минут. Минимальное значение — 5 минут. Если указать значение менее 5 минут, пакетная служба возвращает ошибку; Если вы вызываете REST API напрямую, код состояния HTTP равен 400 (недопустимый запрос).
resourceTags		object	Указанные пользователем теги, связанные с пулом. Определяемые пользователем теги, связанные с пулом пакетной службы Azure. При указании эти теги распространяются на резервные ресурсы Azure, связанные с пулом. Это свойство можно указать только при создании учетной записи пакетной службы с свойством poolAllocationMode с значением UserSubscription.
startTask		StartTask	Задача, указанная для запуска на каждом вычислительном узле при присоединении к пулу. Задача выполняется при добавлении вычислительного узла в пул или при перезапуске вычислительного узла.
targetDedicatedNodes		integer	Требуемое количество выделенных вычислительных узлов в пуле. Это свойство не должно быть указано, если параметр enableAutoScale имеет значение true. Если параметр enableAutoScale имеет значение false, необходимо задать либо targetDedicatedNodes, targetLowPriorityNodes, либо оба.
targetLowPriorityNodes		integer	Требуемое количество точечных и низкоприоритетных вычислительных узлов в пуле. Это свойство не должно быть указано, если параметр enableAutoScale имеет значение true. Если параметр enableAutoScale имеет значение false, необходимо задать либо targetDedicatedNodes, targetLowPriorityNodes, либо оба.
targetNodeCommunicationMode		NodeCommunicationMode	Требуемый режим связи узла для пула. Если опущено, значение по умолчанию — Default.
taskSchedulingPolicy		TaskSchedulingPolicy	Распределение задач между вычислительными узлами в пуле. Если значение не указано, по умолчанию распространяется.
taskSlotsPerNode		integer	Количество слотов задач, которые можно использовать для выполнения параллельных задач на одном вычислительном узле в пуле. Значение по умолчанию — 1. Максимальное значение меньше 4 раза меньше числа ядер vmSize пула или 256.
upgradePolicy		UpgradePolicy	Политика обновления для пула. Описывает политику обновления — автоматическую, ручную или перекатную.
userAccounts		UserAccount[]	Список учетных записей пользователей, создаваемых на каждом вычислительном узле в пуле.
virtualMachineConfiguration		VirtualMachineConfiguration	Конфигурация виртуальной машины для пула. Это свойство должно быть указано.

Ответы

Имя	Тип	Описание
201 Created		Запрос к пакетной службе выполнен успешно. Заголовки client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Ошибка из пакетной службы.

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

azure_auth

Поток кода проверки подлинности Microsoft Entra OAuth 2.0

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

Области

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

Authorization

Тип: apiKey
В: header

Примеры

Add a pool with accelerated networking

Add a pool with mount drive specified

Add a pool with SecurityProfile

Add a pool with UpgradePolicy

Add a simple pool with resourceTags

Add a VirtualMachineConfiguration pool

Add a VirtualMachineConfiguration pool with containers

Add a VirtualMachineConfiguration pool with extensions

Add a VirtualMachineConfiguration pool with OS disk

Add a VirtualMachineConfiguration pool with ServiceArtifactReference

Add a pool with accelerated networking

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

HTTP

POST account.region.batch.azure.com/pools?api-version=2024-07-01.20.0



{
  "id": "mypool01",
  "vmSize": "Standard_D1_v2",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2016-datacenter-smalldisk",
      "version": "latest"
    },
    "nodeAgentSKUId": "batch.node.windows amd64"
  },
  "targetDedicatedNodes": 2,
  "networkConfiguration": {
    "enableAcceleratedNetworking": true
  }
}

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

Код состояния:

201

Add a pool with mount drive specified

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

HTTP

POST account.region.batch.azure.com/pools?api-version=2024-07-01.20.0


{
  "id": "pool2",
  "vmSize": "standard_a1",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "UbuntuServer",
      "sku": "20_04-lts"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04"
  },
  "mountConfiguration": [
    {
      "azureBlobFileSystemConfiguration": {
        "accountName": "accountName",
        "containerName": "blobContainerName",
        "accountKey": "accountKey",
        "relativeMountPath": "bfusepath"
      }
    },
    {
      "azureFileShareConfiguration": {
        "accountName": "accountName",
        "azureFileUrl": "https://myaccount.file.core.windows.net/fileshare",
        "accountKey": "accountKey",
        "relativeMountPath": "filesharepath",
        "mountOptions": "mount options ver=1.0"
      }
    },
    {
      "nfsMountConfiguration": {
        "source": "somesource nfs url",
        "relativeMountPath": "mountpath",
        "mountOptions": "mount options ver=1.0"
      }
    },
    {
      "cifsMountConfiguration": {
        "username": "accountName",
        "password": "password",
        "source": "//myaccount.file.core.windows.net/file",
        "relativeMountPath": "mountpath",
        "mountOptions": "mount options ver=1.0"
      }
    }
  ],
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false
}

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

Код состояния:

201

Add a pool with SecurityProfile

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

HTTP

POST account.region.batch.azure.com/pools?api-version=2024-07-01.20.0



{
  "id": "mypool001",
  "vmSize": "STANDARD_DC2s_V2",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "UbuntuServer",
      "sku": "18_04-lts-gen2",
      "version": "latest"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 18.04",
    "securityProfile": {
      "securityType": "trustedLaunch",
      "encryptionAtHost": true,
      "uefiSettings": {
        "secureBootEnabled": false,
        "vTpmEnabled": null
      }
    }
  },
  "targetDedicatedNodes": 1
}

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

Код состояния:

201

Add a pool with UpgradePolicy

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

HTTP

POST account.region.batch.azure.com/pools?api-version=2024-07-01.20.0



{
  "id": "mypool001",
  "vmSize": "Standard_A1_v2",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2016-datacenter-smalldisk",
      "version": "latest"
    },
    "windowsConfiguration": {
      "enableAutomaticUpdates": false
    },
    "nodePlacementConfiguration": {
      "policy": "zonal"
    },
    "nodeAgentSKUId": "batch.node.windows amd64"
  },
  "targetDedicatedNodes": 2,
  "upgradePolicy": {
    "mode": "automatic",
    "automaticOSUpgradePolicy": {
      "disableAutomaticRollback": true,
      "enableAutomaticOSUpgrade": true,
      "useRollingUpgradePolicy": true,
      "osRollingUpgradeDeferral": true
    },
    "rollingUpgradePolicy": {
      "enableCrossZoneUpgrade": true,
      "maxBatchInstancePercent": 20,
      "maxUnhealthyInstancePercent": 20,
      "maxUnhealthyUpgradedInstancePercent": 20,
      "pauseTimeBetweenBatches": "PT0S",
      "prioritizeUnhealthyInstances": false,
      "rollbackFailedInstancesOnPolicyBreach": false
    }
  }
}

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

Код состояния:

201

Add a simple pool with resourceTags

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

HTTP

POST account.region.batch.azure.com/pools?api-version=2024-07-01.20.0



{
  "id": "mypool001",
  "vmSize": "STANDARD_DC2s_V2",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "UbuntuServer",
      "sku": "18_04-lts-gen2",
      "version": "latest"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 18.04"
  },
  "targetDedicatedNodes": 1,
  "resourceTags": {
    "TagName1": "TagValue1",
    "TagName2": "TagValue2"
  }
}

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

Код состояния:

201

Add a VirtualMachineConfiguration pool

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

HTTP

POST account.region.batch.azure.com/pools?api-version=2024-07-01.20.0



{
  "id": "pool2",
  "vmSize": "standard_a1",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "sku": "20_04-lts"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04"
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false,
  "enableInterNodeCommunication": true,
  "metadata": [
    {
      "name": "myproperty",
      "value": "myvalue"
    }
  ]
}

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

Код состояния:

201

Add a VirtualMachineConfiguration pool with containers

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

HTTP

POST account.region.batch.azure.com/pools?api-version=2024-07-01.20.0



{
  "id": "pool2",
  "vmSize": "standard_a1",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "sku": "120_04-lts"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04",
    "containerConfiguration": {
      "type": "dockerCompatible",
      "containerImageNames": [
        "busybox"
      ]
    }
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false
}

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

Код состояния:

201

Add a VirtualMachineConfiguration pool with extensions

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

HTTP

POST account.region.batch.azure.com/pools?api-version=2024-07-01.20.0



{
  "id": "pool2",
  "vmSize": "standard_a1",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "sku": "20_04-lts"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04",
    "extensions": [
      {
        "name": "batchextension1",
        "type": "KeyVaultForLinux",
        "publisher": "Microsoft.Azure.KeyVault",
        "typeHandlerVersion": "2.0",
        "autoUpgradeMinorVersion": true,
        "enableAutomaticUpgrade": true,
        "settings": "{\"secretsManagementSettingsKey\":\"secretsManagementSettingsValue\",\"authenticationSettingsKey\":\"authenticationSettingsValue\"}"
      }
    ]
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false,
  "enableInterNodeCommunication": true,
  "metadata": [
    {
      "name": "myproperty",
      "value": "myvalue"
    }
  ],
  "targetNodeCommunicationMode": "simplified"
}

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

Код состояния:

201

Add a VirtualMachineConfiguration pool with OS disk

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

HTTP

POST account.region.batch.azure.com/pools?api-version=2024-07-01.20.0



{
  "id": "mypool001",
  "vmSize": "standard_d2s_v3",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "sku": "20_04-lts"
    },
    "osDisk": {
      "diskSizeGB": 100,
      "managedDisk": {
        "storageAccountType": "standardssd_lrs"
      },
      "caching": "readwrite",
      "ephemeralOSDiskSettings": {
        "placement": "CacheDisk"
      }
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04"
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 1,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 1,
  "enableAutoScale": false
}

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

Код состояния:

201

Add a VirtualMachineConfiguration pool with ServiceArtifactReference

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

HTTP

POST account.region.batch.azure.com/pools?api-version=2024-07-01.20.0



{
  "id": "mypool002",
  "vmSize": "Standard_A1_v2",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2016-datacenter-smalldisk",
      "version": "latest"
    },
    "windowsConfiguration": {
      "enableAutomaticUpdates": false
    },
    "serviceArtifactReference": {
      "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile"
    },
    "nodeAgentSKUId": "batch.node.windows amd64"
  },
  "targetDedicatedNodes": 2,
  "upgradePolicy": {
    "mode": "automatic",
    "automaticOSUpgradePolicy": {
      "enableAutomaticOSUpgrade": true
    }
  }
}

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

Код состояния:

201

Определения

Имя	Описание
ApplicationPackageReference	Ссылка на пакет для развертывания на вычислительных узлах.
AutomaticOSUpgradePolicy	Параметры конфигурации, используемые для автоматического обновления ОС.
AutoUserScope	Область для автоматического пользователя
AutoUserSpecification	Задает параметры для автоматического пользователя, выполняющего задачу в пакетной службе.
AzureBlobFileSystemConfiguration	Сведения, используемые для подключения к контейнеру службы хранилища Azure с помощью Blobfuse.
AzureFileShareConfiguration	Сведения, используемые для подключения к общей папке Azure.
BatchError	Ответ об ошибке, полученный из пакетной службы Azure.
BatchErrorDetail	Элемент дополнительных сведений, включенных в ответ на ошибку пакетной службы Azure.
CachingType	Тип кэширования для диска.
CertificateReference	Ссылка на сертификат, который необходимо установить на вычислительных узлах в пуле.
CertificateStoreLocation	Расположение хранилища сертификатов на вычислительном узле, в который необходимо установить сертификат.
CertificateVisibility	Какие учетные записи пользователей на вычислительном узле должны иметь доступ к частным данным сертификата.
CIFSMountConfiguration	Сведения, используемые для подключения к файловой системе CIFS.
ComputeNodeFillType	Распределение задач между вычислительными узлами в пуле.
ComputeNodeIdentityReference	Ссылка на назначенное пользователем удостоверение, связанное с пулом пакетной службы, который будет использовать вычислительный узел.
ContainerConfiguration	Конфигурация пулов с поддержкой контейнера.
ContainerHostBatchBindMountEntry	Вход пути и режима подключения, который требуется подключить к контейнеру задач.
ContainerHostDataPath	Пути, которые будут подключены к контейнеру задачи контейнера.
ContainerRegistry	Частный реестр контейнеров.
ContainerType	Используемая технология контейнера.
ContainerWorkingDirectory	Расположение рабочего каталога задачи контейнера.
DataDisk	Параметры, которые будут использоваться дисками данных, связанными с вычислительными узлами в пуле. При использовании подключенных дисков данных необходимо подключить и отформатировать диски из виртуальной машины, чтобы использовать их.
DiffDiskPlacement	Указывает эфемерное размещение диска операционной системы для всех вычислительных узлов (виртуальных машин) в пуле.
DiffDiskSettings	Указывает временные параметры диска для диска операционной системы, используемого вычислительным узлом (vm).
DiskEncryptionConfiguration	Конфигурация шифрования дисков, примененная к вычислительным узлам в пуле. Конфигурация шифрования дисков не поддерживается в пуле Linux, созданном с помощью образа коллекции вычислений Azure.
DiskEncryptionTarget	Список целевых объектов дисков пакетной службы будет шифроваться на вычислительном узле.
DynamicVNetAssignmentScope	Область динамического назначения виртуальной сети.
ElevationLevel	Уровень повышения прав пользователя.
EnvironmentSetting	Переменная среды, устанавливаемая в процессе задачи.
ErrorMessage	Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure.
ImageReference	Ссылка на образ Azure Virtual Machines Marketplace или образ коллекции вычислений Azure. Чтобы получить список всех ссылок на образы Azure Marketplace, проверенных пакетной службой Azure, см. операцию "Список поддерживаемых образов".
InboundEndpointProtocol	Протокол конечной точки.
InboundNATPool	Входящий пул NAT, который можно использовать для решения конкретных портов на вычислительных узлах во внешнем пуле пакетной службы.
IPAddressProvisioningType	Тип подготовки для общедоступных IP-адресов пула.
LinuxUserConfiguration	Свойства, используемые для создания учетной записи пользователя на вычислительном узле Linux.
LoginMode	Режим входа для пользователя
ManagedDisk
MetadataItem	Пара "имя-значение", связанная с ресурсом пакетной службы.
MountConfiguration	Файловая система для подключения на каждом узле.
NetworkConfiguration	Конфигурация сети для пула.
NetworkSecurityGroupRule	Правило группы безопасности сети для применения к входящей конечной точке.
NetworkSecurityGroupRuleAccess	Действие, которое следует предпринять для указанного IP-адреса, диапазона подсети или тега.
NFSMountConfiguration	Сведения, используемые для подключения к файловой системе NFS.
NodeCommunicationMode	Определяет, как пул взаимодействует со службой пакетной службы.
NodePlacementConfiguration	Конфигурация размещения узлов для пула.
NodePlacementPolicyType	Политика размещения для выделения узлов в пуле.
OSDisk	Параметры диска операционной системы вычислительного узла (VM).
PoolAddParameter	Пул в службе пакетной службы Azure для добавления.
PoolEndpointConfiguration	Конфигурация конечной точки для пула.
PublicIPAddressConfiguration	Конфигурация общедоступного IP-адреса конфигурации сети пула.
ResourceFile	Один файл или несколько файлов, которые нужно скачать на вычислительный узел.
RollingUpgradePolicy	Параметры конфигурации, используемые при выполнении последовательного обновления.
SecurityEncryptionTypes	Указывает тип шифрования управляемого диска. Он имеет значение VMGuestStateOnly для шифрования только большого двоичного объекта VMGuestState и NonPersistedTPM для сохранения состояния встроенного ПО в BLOB-объекте VMGuestState. примечание. Его можно задать только для конфиденциальных виртуальных машин и требуется при использовании конфиденциальных виртуальных машин.
SecurityProfile	Задает параметры профиля безопасности для масштабируемого набора виртуальных машин или виртуальной машины.
SecurityTypes	Указывает тип безопасности виртуальной машины. Для включения UefiSettings необходимо задать любое указанное значение.
ServiceArtifactReference	Указывает идентификатор ссылки на артефакт службы, используемый для задания одной версии образа для всех виртуальных машин в масштабируемом наборе при использовании последней версии образа.
StartTask	Задача, которая выполняется при присоединении узла к пулу в пакетной службе Azure или при перезагрузке или повторном переимыке вычислительного узла.
StorageAccountType	Тип учетной записи хранения для создания дисков данных или диска ОС.
TaskContainerSettings	Параметры контейнера для задачи.
TaskSchedulingPolicy	Указывает, как задачи должны распределяться по вычислительным узлам.
UefiSettings	Указывает параметры безопасности, такие как безопасная загрузка и vTPM, используемые при создании виртуальной машины.
UpgradeMode	Задает режим обновления до виртуальных машин в масштабируемом наборе. Возможные значения: вручную. Вы управляете приложением обновлений виртуальных машин в масштабируемом наборе. Это можно сделать с помощью действия manualUpgrade. автоматическое. Все виртуальные машины в масштабируемом наборе автоматически обновляются одновременно. Скользящей. Масштабируемый набор выполняет обновления в пакетах с необязательным временем приостановки между ними.
UpgradePolicy	Описывает политику обновления — автоматическую, ручную или перекатную.
UserAccount	Свойства, используемые для создания пользователя, используемого для выполнения задач на вычислительном узле пакетной службы Azure.
UserIdentity	Определение удостоверения пользователя, в котором выполняется задача.
VirtualMachineConfiguration	Конфигурация вычислительных узлов в пуле на основе инфраструктуры виртуальных машин Azure.
VMDiskSecurityProfile	Задает параметры профиля безопасности для управляемого диска. примечание. Его можно задать только для конфиденциальных виртуальных машин и требоваться при использовании конфиденциальных виртуальных машин.
VMExtension	Конфигурация расширений виртуальных машин.
WindowsConfiguration	Параметры операционной системы Windows для применения к виртуальной машине.
WindowsUserConfiguration	Свойства, используемые для создания учетной записи пользователя на вычислительном узле Windows.

ApplicationPackageReference

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

Имя	Тип	Описание
applicationId	string	Идентификатор развертываемого приложения. При создании пула идентификатор приложения пакета должен быть полным (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).
version	string	Версия приложения для развертывания. Если опущено, будет развернута версия по умолчанию. Если это опущено в пуле, и для этого приложения версия по умолчанию не указана, запрос завершается ошибкой с кодом error InvalidApplicationPackageReferences и кодом состояния HTTP 409. Если это опущено в задаче, и для этого приложения версия по умолчанию не указана, задача завершается ошибкой предварительной обработки.

AutomaticOSUpgradePolicy

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

Имя	Тип	Описание
disableAutomaticRollback	boolean	Следует ли отключить функцию отката образа ОС.
enableAutomaticOSUpgrade	boolean	Указывает, следует ли автоматически применять обновления ОС к экземплярам масштабируемого набора в последовательном режиме, когда становится доступной более новая версия образа ОС. Если для пулов windows задано значение true, WindowsConfiguration.enableAutomaticUpdates не может быть задано значение true.
osRollingUpgradeDeferral	boolean	Отложить обновление ОС на телевизорах, если они выполняют задачи.
useRollingUpgradePolicy	boolean	Указывает, следует ли использовать политику последовательного обновления во время автоматического обновления ОС. Автоматическое обновление ОС откатится к политике по умолчанию, если политика не определена в VMSS.

AutoUserScope

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

Имя	Тип	Описание
pool	string	Указывает, что задача выполняется в качестве общей учетной записи автоматического пользователя, созданной на каждом вычислительном узле в пуле.
task	string	Указывает, что служба должна создать нового пользователя для задачи.

AutoUserSpecification

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

Имя	Тип	Описание
elevationLevel	ElevationLevel	Уровень повышения прав автоматического пользователя. Значение по умолчанию — nonAdmin.
scope	AutoUserScope	Область для автоматического пользователя Значение по умолчанию — пул. Если пул работает под управлением Windows, необходимо указать значение задачи, если требуется более строгая изоляция между задачами. Например, если задача изменяет реестр таким образом, что может повлиять на другие задачи или сертификаты были указаны в пуле, который не должен быть доступен обычными задачами, но должен быть доступен startTasks.

AzureBlobFileSystemConfiguration

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

Имя	Тип	Описание
accountKey	string	Ключ учетной записи хранения Azure. Это свойство является взаимоисключающим как с sasKey, так и с удостоверением; необходимо указать именно один.
accountName	string	Имя учетной записи хранения Azure.
blobfuseOptions	string	Дополнительные параметры командной строки для передачи команде подключения. Это параметры "net use" в Windows и "подключение" в Linux.
containerName	string	Имя контейнера хранилища BLOB-объектов Azure.
identityReference	ComputeNodeIdentityReference	Ссылка на назначенное пользователем удостоверение для доступа к containerName Это свойство является взаимоисключающим как с accountKey, так и sasKey; необходимо указать именно один.
relativeMountPath	string	Относительный путь на вычислительном узле, где будет подключена файловая система. Все файловые системы подключены относительно каталога подключений пакетной службы, доступные с помощью переменной среды AZ_BATCH_NODE_MOUNTS_DIR.
sasKey	string	Маркер SAS службы хранилища Azure. Это свойство является взаимоисключающим как с accountKey, так и с удостоверением; необходимо указать именно один.

AzureFileShareConfiguration

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

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

BatchError

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

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования.
message	ErrorMessage	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.
values	BatchErrorDetail[]	Коллекция пар "ключ-значение", содержащая дополнительные сведения об ошибке.

BatchErrorDetail

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

Имя	Тип	Описание
key	string	Идентификатор, указывающий значение свойства Value.
value	string	Дополнительные сведения, включенные в ответ на ошибку.

CachingType

Тип кэширования для диска.

Имя	Тип	Описание
none	string	Режим кэширования для диска не включен.
readonly	string	Режим кэширования для диска доступен только для чтения.
readwrite	string	Режим кэширования для диска считывается и записывается.

CertificateReference

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

Имя	Тип	Описание
storeLocation	CertificateStoreLocation	Расположение хранилища сертификатов на вычислительном узле, в который необходимо установить сертификат. Значение по умолчанию — currentuser. Это свойство применимо только для пулов, настроенных с помощью вычислительных узлов Windows. Для вычислительных узлов Linux сертификаты хранятся в каталоге рабочей папки задачи, а переменная среды AZ_BATCH_CERTIFICATES_DIR предоставляется задаче для запроса к этому расположению. Для сертификатов с видимостью remoteUser каталог "certs" создается в домашнем каталоге пользователя (например, /home/{user-name}/certs) и сертификаты помещаются в этот каталог.
storeName	string	Имя хранилища сертификатов на вычислительном узле, в который необходимо установить сертификат. Это свойство применимо только для пулов, настроенных с помощью вычислительных узлов Windows. Распространенные имена хранилищ: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, но любое пользовательское имя хранилища также можно использовать. Значением по умолчанию является My.
thumbprint	string	Отпечаток сертификата.
thumbprintAlgorithm	string	Алгоритм, с которым связан отпечаток. Это должно быть sha1.
visibility	CertificateVisibility[]	Какие учетные записи пользователей на вычислительном узле должны иметь доступ к частным данным сертификата. В этой коллекции можно указать несколько видимостей. По умолчанию используется все учетные записи.

CertificateStoreLocation

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

Имя	Тип	Описание
currentuser	string	Сертификаты должны быть установлены в хранилище сертификатов CurrentUser.
localmachine	string	Сертификаты должны быть установлены в хранилище сертификатов LocalMachine.

CertificateVisibility

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

Имя	Тип	Описание
remoteuser	string	Сертификат должен отображаться для учетных записей пользователей, в которых пользователи удаленно обращаются к вычислительному узлу.
starttask	string	Сертификат должен быть видимым для учетной записи пользователя, в которой выполняется StartTask. Обратите внимание, что если область autoUser является пулом как для startTask, так и для задачи, этот сертификат также будет виден задаче.
task	string	Сертификат должен быть видимым для учетных записей пользователей, в которых выполняются задачи задания.

CIFSMountConfiguration

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

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

ComputeNodeFillType

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

Имя	Тип	Описание
pack	string	Максимальное количество задач (taskSlotsPerNode) должно быть назначено каждому вычислительному узлу в пуле, прежде чем все задачи назначены следующему вычислительному узлу в пуле.
spread	string	Задачи должны назначаться равномерно по всем вычислительным узлам в пуле.

ComputeNodeIdentityReference

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

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

ContainerConfiguration

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

Имя	Тип	Описание
containerImageNames	string[]	Коллекция имен образов контейнера. Это полная ссылка на изображение, как было бы указано в параметре docker pull. Образ будет получен из реестра Docker по умолчанию, если образ не является полным с альтернативным реестром.
containerRegistries	ContainerRegistry[]	Дополнительные частные реестры, из которых можно извлечь контейнеры. Если изображения должны быть загружены из частного реестра, для которого требуются учетные данные, эти учетные данные должны быть предоставлены здесь.
type	ContainerType	Используемая технология контейнера.

ContainerHostBatchBindMountEntry

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

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

ContainerHostDataPath

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

Имя	Тип	Описание
Applications	string	Путь к приложениям.
JobPrep	string	Путь задачи подготовки задания.
Shared	string	Путь к задаче с несколькими экземплярами для совместного использования файлов.
Startup	string	Путь к задаче запуска.
Task	string	Путь к задаче.
VfsMounts	string	Путь содержит все виртуальные файловые системы, подключенные на этом узле.

ContainerRegistry

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

Имя	Тип	Описание
identityReference	ComputeNodeIdentityReference	Ссылка на назначенное пользователем удостоверение для доступа к реестру контейнеров Azure вместо имени пользователя и пароля. Ссылка на назначенное пользователем удостоверение, связанное с пулом пакетной службы, который будет использовать вычислительный узел.
password	string	Пароль для входа на сервер реестра.
registryServer	string	URL-адрес реестра. Если опущено, значение по умолчанию — "docker.io".
username	string	Имя пользователя для входа на сервер реестра.

ContainerType

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

Имя	Тип	Описание
criCompatible	string	Технология на основе CRI будет использоваться для запуска контейнеров.
dockerCompatible	string	Для запуска контейнеров будет использоваться технология совместимого контейнера Docker.

ContainerWorkingDirectory

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

Имя	Тип	Описание
containerImageDefault	string	Используйте рабочий каталог, определенный в образе контейнера. Убедитесь, что этот каталог не будет содержать файлы ресурсов, скачанные пакетной службой.
taskWorkingDirectory	string	Используйте стандартный рабочий каталог задачи пакетной службы, который будет содержать файлы ресурсов задач, заполненные пакетной службой.

DataDisk

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

Имя	Тип	Описание
caching	CachingType	Тип кэширования для дисков данных. Значение по умолчанию для кэширования — readwrite. Сведения о параметрах кэширования см. в статье https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.
diskSizeGB	integer	Начальный размер диска в гигабайтах.
lun	integer	Номер логического блока. Луна используется для уникальной идентификации каждого диска данных. При подключении нескольких дисков каждый должен иметь отдельную луну. Значение должно быть от 0 до 63 включительно.
storageAccountType	StorageAccountType	Тип учетной записи хранения, используемый для диска данных. Если опущено, значение по умолчанию — "standard_lrs".

DiffDiskPlacement

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

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

DiffDiskSettings

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

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

DiskEncryptionConfiguration

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

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

DiskEncryptionTarget

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

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

DynamicVNetAssignmentScope

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

Имя	Тип	Описание
job	string	Динамическое назначение виртуальной сети выполняется для каждого задания.
none	string	Динамическое назначение виртуальной сети не включено.

ElevationLevel

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

Имя	Тип	Описание
admin	string	Пользователь является пользователем с повышенными правами доступа и работает с полными разрешениями администратора.
nonadmin	string	Пользователь является стандартным пользователем без повышенного доступа.

EnvironmentSetting

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

Имя	Тип	Описание
name	string	Имя переменной среды.
value	string	Значение переменной среды.

ErrorMessage

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

Имя	Тип	Описание
lang	string	Языковой код сообщения об ошибке
value	string	Текст сообщения.

ImageReference

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

Имя	Тип	Описание
communityGalleryImageId	string	Уникальный идентификатор образа коллекции сообщества Это свойство является взаимоисключающим с другими свойствами и может быть получено из вызова GET коллекции сообщества.
exactVersion	string	Конкретная версия образа платформы или образа Marketplace, используемая для создания узла. Это поле только для чтения отличается от "версии" только в том случае, если значение, указанное для "версии", когда пул был создан, был "последняя".
offer	string	Тип предложения образа Azure Virtual Machines Marketplace. Например, UbuntuServer или WindowsServer.
publisher	string	Издатель образа Azure Virtual Machines Marketplace. Например, Canonical или MicrosoftWindowsServer.
sharedGalleryImageId	string	Уникальный идентификатор образа общей коллекции Это свойство является взаимоисключающим с другими свойствами и может быть получено из вызова GET образа общей коллекции.
sku	string	Номер SKU образа Azure Virtual Machines Marketplace. Например, 18.04-LTS или 2019-Datacenter.
version	string	Версия образа Azure Virtual Machines Marketplace. Чтобы выбрать последнюю версию образа, можно указать значение "последняя". Если опущено, значение по умолчанию — "последняя".
virtualMachineImageId	string	Идентификатор ресурса ARM образа коллекции вычислений Azure. Вычислительные узлы в пуле будут созданы с помощью этого идентификатора образа. Это форма /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} или /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName} для постоянного использования последней версии образа. Это свойство является взаимоисключающим с другими свойствами ImageReference. Образ коллекции вычислений Azure должен иметь реплики в том же регионе и должен находиться в той же подписке, что и учетная запись пакетной службы Azure. Если версия образа не указана в imageId, будет использоваться последняя версия. Сведения о параметрах брандмауэра для агента пакетного вычислительного узла для взаимодействия со службой пакетной службы см. в https://docs.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

InboundEndpointProtocol

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

Имя	Тип	Описание
tcp	string	Используйте TCP для конечной точки.
udp	string	Используйте UDP для конечной точки.

InboundNATPool

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

Имя	Тип	Описание
backendPort	integer	Номер порта на вычислительном узле. Это должно быть уникальным в пуле пакетной службы. Допустимые значения : от 1 до 65535, за исключением 22, 3389, 29876 и 29877, так как они зарезервированы. Если указаны зарезервированные значения, запрос завершается ошибкой с кодом состояния HTTP 400.
frontendPortRangeEnd	integer	Последний номер порта в диапазоне внешних портов, которые будут использоваться для предоставления входящего доступа к внутреннему порту на отдельных вычислительных узлах. Допустимые значения варьируются от 1 до 65534, за исключением портов от 50000 до 55000, зарезервированных пакетной службой. Все диапазоны в пуле должны быть уникальными и не могут перекрываться. Каждый диапазон должен содержать не менее 40 портов. Если указаны зарезервированные или перекрывающиеся значения, запрос завершается ошибкой с кодом состояния HTTP 400.
frontendPortRangeStart	integer	Первый номер порта в диапазоне внешних портов, которые будут использоваться для предоставления входящего доступа к внутреннему порту на отдельных вычислительных узлах. Допустимые значения варьируются от 1 до 65534, за исключением портов от 50000 до 55000, которые зарезервированы. Все диапазоны в пуле должны быть уникальными и не могут перекрываться. Каждый диапазон должен содержать не менее 40 портов. Если указаны зарезервированные или перекрывающиеся значения, запрос завершается ошибкой с кодом состояния HTTP 400.
name	string	Имя конечной точки. Имя должно быть уникальным в пуле пакетной службы, может содержать буквы, цифры, подчеркивания, периоды и дефисы. Имена должны начинаться с буквы или числа, заканчиваться буквой, числом или подчеркиванием и не может превышать 77 символов. Если указаны недопустимые значения, запрос завершается ошибкой с кодом состояния HTTP 400.
networkSecurityGroupRules	NetworkSecurityGroupRule[]	Список правил группы безопасности сети, которые будут применены к конечной точке. Максимальное количество правил, которые можно указать во всех конечных точках в пуле пакетной службы, равно 25. Если правила группы безопасности сети не указаны, будет создано правило по умолчанию, чтобы разрешить входящий доступ к указанному внутреннему порту. Если максимальное число правил группы безопасности сети превышается, запрос завершается ошибкой с кодом состояния HTTP 400.
protocol	InboundEndpointProtocol	Протокол конечной точки.

IPAddressProvisioningType

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

Имя	Тип	Описание
batchmanaged	string	Общедоступный IP-адрес будет создан и управляется пакетной службой. В зависимости от размера пула может быть несколько общедоступных IP-адресов.
nopublicipaddresses	string	Общедоступный IP-адрес не будет создан.
usermanaged	string	Общедоступные IP-адреса предоставляются пользователем и будут использоваться для подготовки вычислительных узлов.

LinuxUserConfiguration

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

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

LoginMode

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

Имя	Тип	Описание
batch	string	Режим входа LOGON32_LOGON_BATCH Win32. Для длительных параллельных процессов рекомендуется использовать режим входа пакетной службы.
interactive	string	Режим входа LOGON32_LOGON_INTERACTIVE Win32. UAC включен в пулах Windows. Если этот параметр используется с удостоверением пользователя с повышенными привилегиями в пуле Windows, сеанс пользователя не будет повышен, если приложение, выполняемое командной строкой задачи, всегда требует права администратора или всегда требует максимальной привилегии.

ManagedDisk

Имя	Тип	Описание
securityProfile	VMDiskSecurityProfile	Задает параметры профиля безопасности для управляемого диска. Задает параметры профиля безопасности для управляемого диска. примечание. Его можно задать только для конфиденциальных виртуальных машин и требоваться при использовании конфиденциальных виртуальных машин.
storageAccountType	StorageAccountType	Тип учетной записи хранения для управляемого диска.

MetadataItem

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

Имя	Тип	Описание
name	string	Имя элемента метаданных.
value	string	Значение элемента метаданных.

MountConfiguration

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

Имя	Тип	Описание
azureBlobFileSystemConfiguration	AzureBlobFileSystemConfiguration	Контейнер службы хранилища Azure для подключения с помощью FUSE BLOB-объектов на каждом узле. Это свойство является взаимоисключающим со всеми другими свойствами.
azureFileShareConfiguration	AzureFileShareConfiguration	Общая папка Azure для подключения к каждому узлу. Это свойство является взаимоисключающим со всеми другими свойствами.
cifsMountConfiguration	CIFSMountConfiguration	Файловая система CIFS/SMB для подключения на каждом узле. Это свойство является взаимоисключающим со всеми другими свойствами.
nfsMountConfiguration	NFSMountConfiguration	Файловая система NFS для подключения на каждом узле. Это свойство является взаимоисключающим со всеми другими свойствами.

NetworkConfiguration

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

Имя	Тип	Описание
dynamicVNetAssignmentScope	DynamicVNetAssignmentScope	Область динамического назначения виртуальной сети.
enableAcceleratedNetworking	boolean	Следует ли включить ускоренную сеть в этом пуле. Ускорение сети обеспечивает виртуализацию одно корневых операций ввода-вывода (SR-IOV) к виртуальной машине, что может привести к повышению производительности сети. Дополнительные сведения см. в статье https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview.
endpointConfiguration	PoolEndpointConfiguration	Конфигурация конечных точек на вычислительных узлах в пуле пакетной службы.
publicIPAddressConfiguration	PublicIPAddressConfiguration	Конфигурация public IPAddress для вычислительных узлов в пуле пакетной службы. Конфигурация общедоступного IP-адреса конфигурации сети пула.
subnetId	string	Идентификатор ресурса ARM подсети виртуальной сети, к которой присоединяются вычислительные узлы пула. Это форма /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}}. Виртуальная сеть должна находиться в том же регионе и подписке, что и учетная запись пакетной службы Azure. Указанная подсеть должна иметь достаточно свободных IP-адресов для размещения количества вычислительных узлов в пуле. Если подсеть не имеет достаточно свободных IP-адресов, пул частично выделяет узлы и возникнет ошибка изменения размера. Субъект-служба MicrosoftAzureBatch должна иметь роль "Участник классической виртуальной машины" Role-Based управление доступом (RBAC) для указанной виртуальной сети. Указанная подсеть должна разрешить обмен данными из пакетной службы Azure, чтобы иметь возможность планировать задачи на узлах. Это можно проверить, проверьте, имеет ли указанная виртуальная сеть любые связанные группы безопасности сети (NSG). Если связь с узлами в указанной подсети запрещена группой безопасности сети, служба пакетной службы установит состояние вычислительных узлов неиспользуемым. Поддерживаются только виртуальные сети ARM (Microsoft.Network/virtualNetworks). Если указанная виртуальная сеть имеет любые связанные группы безопасности сети (NSG), для входящего взаимодействия необходимо включить несколько зарезервированных системных портов. Включите порты 29876 и 29877, а также порт 22 для Linux и порт 3389 для Windows. Также включите исходящие подключения к службе хранилища Azure через порт 443. Дополнительные сведения см. в статье https://docs.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

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

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

NetworkSecurityGroupRuleAccess

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

Имя	Тип	Описание
allow	string	Разрешить доступ.
deny	string	Запретить доступ.

NFSMountConfiguration

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

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

NodeCommunicationMode

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

Имя	Тип	Описание
classic	string	Для узлов, использующих классический режим связи, требуется входящий TCP-обмен данными через порты 29876 и 29877 из пакета BatchNodeManagement. Тег службы {region}" и исходящий TCP-обмен данными через порт 443 в хранилище.регион и BatchNodeManagement. Теги службы {region}".
default	string	Режим связи узла автоматически устанавливается пакетной службой.
simplified	string	Узлы, использующие упрощенный режим связи, требуют исходящего TCP-подключения через порт 443 к пакетной службе BatchNodeManagement. Тег службы {region}". Открытые входящие порты не требуются.

NodePlacementConfiguration

Конфигурация размещения узлов для пула.

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

NodePlacementPolicyType

Политика размещения для выделения узлов в пуле.

Имя	Тип	Описание
regional	string	Все узлы в пуле будут выделены в одном регионе.
zonal	string	Узлы в пуле будут распределяться по разным зонам доступности с оптимальной балансировкой усилий.

OSDisk

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

Имя	Тип	Описание
caching	CachingType	Указывает требования к кэшированию. Возможные значения: None, ReadOnly, ReadWrite. Значения по умолчанию: нет для хранилища уровня "Стандартный". ReadOnly для хранилища Premium. Значение по умолчанию для кэширования не имеет значения. Сведения о параметрах кэширования см. в статье https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.
diskSizeGB	integer	Начальный размер диска в ГБ при создании нового диска ОС.
ephemeralOSDiskSettings	DiffDiskSettings	Указывает временные параметры диска для диска операционной системы, используемого вычислительным узлом (vm).
managedDisk	ManagedDisk	Параметры управляемого диска.
writeAcceleratorEnabled	boolean	Указывает, следует ли включить или отключить записьAccelerator на диске.

PoolAddParameter

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

Имя	Тип	Описание
applicationPackageReferences	ApplicationPackageReference[]	Список пакетов, установленных на каждом вычислительном узле в пуле. При создании пула идентификатор приложения пакета должен быть полным (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Изменения ссылок на пакеты влияют на все новые узлы, присоединенные к пулу, но не влияют на вычислительные узлы, которые уже находятся в пуле, пока они не перезагрузятся или переимыслятся. В любом пуле имеется не более 10 ссылок на пакеты.
autoScaleEvaluationInterval	string	Интервал времени, с помощью которого автоматически настраивается размер пула в соответствии с формулой автомасштабирования. Значение по умолчанию — 15 минут. Минимальное и максимальное значение — 5 минут и 168 часов соответственно. Если указать значение менее 5 минут или больше 168 часов, служба пакетной службы возвращает ошибку; Если вы вызываете REST API напрямую, код состояния HTTP равен 400 (недопустимый запрос).
autoScaleFormula	string	Формула для требуемого количества вычислительных узлов в пуле. Это свойство не должно быть указано, если параметр enableAutoScale имеет значение false. Требуется, если параметр enableAutoScale имеет значение true. Формула проверяется на допустимость перед созданием пула. Если формула недопустима, служба пакетной службы отклоняет запрос с подробными сведениями об ошибке. Дополнительные сведения об указании этой формулы см. в статье "Автоматическое масштабирование вычислительных узлов в пуле пакетной службы Azure" (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/).
certificateReferences	CertificateReference[]	Список сертификатов, которые необходимо установить на каждом вычислительном узле в пуле. Для узлов Windows пакетная служба устанавливает сертификаты в указанное хранилище сертификатов и расположение. Для вычислительных узлов Linux сертификаты хранятся в каталоге рабочей папки задачи, а переменная среды AZ_BATCH_CERTIFICATES_DIR предоставляется задаче для запроса к этому расположению. Для сертификатов с видимостью remoteUser каталог "certs" создается в домашнем каталоге пользователя (например, /home/{user-name}/certs) и сертификаты помещаются в этот каталог. Предупреждение. Это свойство устарело и будет удалено после февраля 2024 года. Вместо этого используйте расширения Azure KeyVault .
displayName	string	Отображаемое имя пула. Отображаемое имя не должно быть уникальным и может содержать любые символы Юникода до максимальной длины 1024.
enableAutoScale	boolean	Следует ли автоматически настраивать размер пула с течением времени. Если значение false, необходимо указать по крайней мере один из targetDedicatedNodes и targetLowPriorityNodes. Если значение true, требуется свойство autoScaleFormula, а пул автоматически изменяет размер в соответствии с формулой. Значение по умолчанию — false.
enableInterNodeCommunication	boolean	Разрешает ли пул прямой обмен данными между вычислительными узлами. Включение обмена данными между узлами ограничивает максимальный размер пула из-за ограничений развертывания на вычислительных узлах пула. Это может привести к тому, что пул не достигает требуемого размера. Значение по умолчанию — false.
id	string	Строка, которая однозначно идентифицирует пул в учетной записи. Идентификатор может содержать любое сочетание буквенно-цифровых символов, включая дефисы и символы подчеркивания, и не может содержать более 64 символов. Идентификатор сохраняет регистр и не учитывает регистр (т. е. у вас могут не быть двух идентификаторов пула в учетной записи, которые отличаются только по регистру).
metadata	MetadataItem[]	Список пар "имя-значение", связанных с пулом в качестве метаданных. Пакетная служба не назначает никакое значение метаданным; он предназначен исключительно для использования пользовательского кода.
mountConfiguration	MountConfiguration[]	Подключите хранилище с помощью указанной файловой системы в течение всего времени существования пула. Подключите хранилище с помощью файловой системы Azure, NFS, CIFS или Blobfuse.
networkConfiguration	NetworkConfiguration	Конфигурация сети для пула. Конфигурация сети для пула.
resizeTimeout	string	Время ожидания выделения вычислительных узлов в пул. Это время ожидания применяется только к масштабированию вручную; Он не действует, если параметр enableAutoScale имеет значение true. Значение по умолчанию — 15 минут. Минимальное значение — 5 минут. Если указать значение менее 5 минут, пакетная служба возвращает ошибку; Если вы вызываете REST API напрямую, код состояния HTTP равен 400 (недопустимый запрос).
resourceTags	object	Указанные пользователем теги, связанные с пулом. Определяемые пользователем теги, связанные с пулом пакетной службы Azure. При указании эти теги распространяются на резервные ресурсы Azure, связанные с пулом. Это свойство можно указать только при создании учетной записи пакетной службы с свойством poolAllocationMode с значением UserSubscription.
startTask	StartTask	Задача, указанная для запуска на каждом вычислительном узле при присоединении к пулу. Задача выполняется при добавлении вычислительного узла в пул или при перезапуске вычислительного узла.
targetDedicatedNodes	integer	Требуемое количество выделенных вычислительных узлов в пуле. Это свойство не должно быть указано, если параметр enableAutoScale имеет значение true. Если параметр enableAutoScale имеет значение false, необходимо задать либо targetDedicatedNodes, targetLowPriorityNodes, либо оба.
targetLowPriorityNodes	integer	Требуемое количество точечных и низкоприоритетных вычислительных узлов в пуле. Это свойство не должно быть указано, если параметр enableAutoScale имеет значение true. Если параметр enableAutoScale имеет значение false, необходимо задать либо targetDedicatedNodes, targetLowPriorityNodes, либо оба.
targetNodeCommunicationMode	NodeCommunicationMode	Требуемый режим связи узла для пула. Если опущено, значение по умолчанию — Default.
taskSchedulingPolicy	TaskSchedulingPolicy	Распределение задач между вычислительными узлами в пуле. Если значение не указано, по умолчанию распространяется.
taskSlotsPerNode	integer	Количество слотов задач, которые можно использовать для выполнения параллельных задач на одном вычислительном узле в пуле. Значение по умолчанию — 1. Максимальное значение меньше 4 раза меньше числа ядер vmSize пула или 256.
upgradePolicy	UpgradePolicy	Политика обновления для пула. Описывает политику обновления — автоматическую, ручную или перекатную.
userAccounts	UserAccount[]	Список учетных записей пользователей, создаваемых на каждом вычислительном узле в пуле.
virtualMachineConfiguration	VirtualMachineConfiguration	Конфигурация виртуальной машины для пула. Это свойство должно быть указано.
vmSize	string	Размер виртуальных машин в пуле. Все виртуальные машины в пуле имеют одинаковый размер. Сведения о доступных размерах виртуальных машин см. в статьях "Размеры виртуальных машин ( 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).

PoolEndpointConfiguration

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

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

PublicIPAddressConfiguration

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

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

ResourceFile

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

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

RollingUpgradePolicy

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

Имя	Тип	Описание
enableCrossZoneUpgrade	boolean	Разрешить VMSS игнорировать границы AZ при создании пакетов обновления. Учитывайте домен обновления и maxBatchInstancePercent, чтобы определить размер пакета. Это поле может иметь значение true или false только при использовании NodePlacementConfiguration в качестве зонального.
maxBatchInstancePercent	integer	Максимальный процент общих экземпляров виртуальных машин, которые будут обновляться одновременно путем последовательного обновления в одном пакете. Так как это максимальный, неработоспособные экземпляры в предыдущих или будущих пакетах могут привести к снижению процента экземпляров в пакете, чтобы обеспечить более высокую надежность. Значение этого поля должно составлять от 5 до 100 включительно. Если значение maxBatchInstancePercent и maxUnhealthyInstancePercent присваивается значением, значение maxBatchInstancePercent не должно превышать maxUnhealthyInstancePercent.
maxUnhealthyInstancePercent	integer	Максимальный процент всех экземпляров виртуальных машин в масштабируемом наборе, которые могут быть одновременно неработоспособными, либо в результате обновления, либо путем обнаружения в неработоспособном состоянии проверки работоспособности виртуальной машины до завершения последовательного обновления. Это ограничение будет проверено перед запуском любого пакета. Значение этого поля должно составлять от 5 до 100 включительно. Если значение maxBatchInstancePercent и maxUnhealthyInstancePercent присваивается значением, значение maxBatchInstancePercent не должно превышать maxUnhealthyInstancePercent.
maxUnhealthyUpgradedInstancePercent	integer	Максимальный процент обновленных экземпляров виртуальных машин, которые можно найти в неработоспособном состоянии. Эта проверка произойдет после обновления каждого пакета. Если этот процент когда-либо превышается, последовательное обновление прерывается. Значение этого поля должно быть от 0 до 100 включительно.
pauseTimeBetweenBatches	string	Время ожидания между завершением обновления для всех виртуальных машин в одном пакете и запуском следующего пакета. Длительность времени должна быть указана в формате ISO 8601.
prioritizeUnhealthyInstances	boolean	Обновите все неработоспособные экземпляры в масштабируемом наборе до всех здоровых экземпляров.
rollbackFailedInstancesOnPolicyBreach	boolean	Откат неудачных экземпляров до предыдущей модели, если политика последовательного обновления нарушена.

SecurityEncryptionTypes

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

Имя	Тип	Описание
NonPersistedTPM	string
VMGuestStateOnly	string

SecurityProfile

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

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

SecurityTypes

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

Имя	Тип	Описание
confidentialVM	string	Конфиденциальные вычисления Azure предлагают конфиденциальные виртуальные машины для клиентов с высокими требованиями к безопасности и конфиденциальности. Эти виртуальные машины обеспечивают надежную аппаратные границы, помогающие удовлетворить ваши потребности в безопасности. Конфиденциальные виртуальные машины можно использовать для миграции, не изменяя код, с помощью платформы, защищающей состояние виртуальной машины от чтения или изменения.
trustedLaunch	string	Доверенный запуск защищает от расширенных и постоянных методов атак.

ServiceArtifactReference

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

Имя	Тип	Описание
id	string	Идентификатор ссылки на артефакт службы ServiceArtifactReference Идентификатор ссылки на артефакт службы в виде /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

StartTask

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

Имя	Тип	Описание
commandLine	string	Командная строка StartTask. Командная строка не выполняется под оболочкой и поэтому не может воспользоваться преимуществами функций оболочки, таких как расширение переменной среды. Если вы хотите воспользоваться такими функциями, необходимо вызвать оболочку в командной строке, например с помощью cmd /c MyCommand в Windows или "/bin/sh -c MyCommand" в Linux. Если командная строка ссылается на пути к файлам, она должна использовать относительный путь (относительно рабочего каталога задачи) или использовать указанную пакетную переменную среды (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables).
containerSettings	TaskContainerSettings	Параметры контейнера, в котором выполняется StartTask. При указании все каталоги рекурсивно под AZ_BATCH_NODE_ROOT_DIR (корневой каталог пакетной службы Azure на узле) сопоставляются с контейнером, все переменные среды задач сопоставляются с контейнером, а командная строка задачи выполняется в контейнере. Файлы, созданные в контейнере за пределами AZ_BATCH_NODE_ROOT_DIR, могут не отражаться на диске узла, что означает, что API пакетного файла не смогут получить доступ к этим файлам.
environmentSettings	EnvironmentSetting[]	Список параметров переменной среды для StartTask.
maxTaskRetryCount	integer	Максимальное количество повторных попыток задачи. Пакетная служба повторяет задачу, если его код выхода не является ненулевой. Обратите внимание, что это значение специально управляет числом повторных попыток. Пакетная служба попытается выполнить задачу один раз, а затем повторите попытку до этого ограничения. Например, если максимальное число повторных попыток равно 3, пакет пытается выполнить задачу до 4 раз (одна начальная попытка и 3 повторные попытки). Если максимальное число повторных попыток равно 0, пакетная служба не повторяет задачу. Если максимальное число повторных попыток равно -1, пакетная служба повторяет задачу без ограничения, однако это не рекомендуется для начальной задачи или любой задачи. Значение по умолчанию равно 0 (без повторных попыток).
resourceFiles	ResourceFile[]	Список файлов, которые служба пакетной службы скачивает на вычислительный узел перед выполнением командной строки. Существует максимальный размер списка файлов ресурсов. При превышении максимального размера запрос завершится ошибкой, и код ошибки ответа будет RequestEntityTooLarge. В этом случае коллекция ResourceFiles должна быть уменьшена. Это можно сделать с помощью .zip файлов, пакетов приложений или контейнеров Docker. Файлы, перечисленные в этом элементе, находятся в рабочем каталоге задачи.
userIdentity	UserIdentity	Удостоверение пользователя, под которым запускается StartTask. Если опущен, задача выполняется как пользователь, отличный от администрирования, уникальным для задачи.
waitForSuccess	boolean	Следует ли пакетной службе ждать успешного завершения startTask (т. е. выйти с кодом выхода 0) перед планированием любых задач на вычислительном узле. Если значение true и startTask завершается сбоем на узле, пакетная служба повторяет запускTask до максимального количества повторных попыток (maxTaskRetryCount). Если задача по-прежнему не выполнена успешно после всех повторных попыток, служба пакетной службы помечает узел неиспользуемой и не будет планировать задачи. Это условие можно обнаружить с помощью сведений о состоянии вычислительного узла и сведения о сбоях. Если значение false, служба пакетной службы не будет ожидать завершения запускаTask. В этом случае другие задачи могут запускаться на вычислительном узле во время запуска StartTask; и даже если сбой StartTask, новые задачи будут продолжать планироваться на вычислительном узле. Значение по умолчанию — true.

StorageAccountType

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

Имя	Тип	Описание
premium_lrs	string	Диск данных или диск ОС должен использовать локально избыточное хранилище класса Premium.
standard_lrs	string	Диск данных или диск ОС должен использовать стандартное локально избыточное хранилище.
standardssd_lrs	string	Диск данных или диск ОС должен использовать локально избыточное хранилище SSD уровня "Стандартный".

TaskContainerSettings

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

Имя	Тип	Описание
containerHostBatchBindMounts	ContainerHostBatchBindMountEntry[]	Пути, которые необходимо подключить к задаче контейнера. Если этот массив имеет значение NULL или отсутствует, задача контейнера будет подключать весь временный диск диска в окнах (или AZ_BATCH_NODE_ROOT_DIR в Linux). Он не будет подключать пути к данным в контейнер, если этот массив задан как пустой.
containerRunOptions	string	Дополнительные параметры команды создания контейнера. Эти дополнительные параметры предоставляются в качестве аргументов в команду docker create, а также те, которые управляются пакетной службой.
imageName	string	Образ, используемый для создания контейнера, в котором будет выполняться задача. Это полная ссылка на изображение, как было бы указано в параметре docker pull. Если тег не указан как часть имени изображения, тег ":latest" используется в качестве значения по умолчанию.
registry	ContainerRegistry	Частный реестр, содержащий образ контейнера. Этот параметр может быть опущен, если он уже предоставлен при создании пула.
workingDirectory	ContainerWorkingDirectory	Расположение рабочего каталога задачи контейнера. Значение по умолчанию — taskWorkingDirectory.

TaskSchedulingPolicy

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

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

UefiSettings

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

Имя	Тип	Описание
secureBootEnabled	boolean	Указывает, следует ли включить безопасную загрузку на виртуальной машине.
vTpmEnabled	boolean	Указывает, следует ли включить vTPM на виртуальной машине.

UpgradeMode

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

Возможные значения:

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

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

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

Имя	Тип	Описание
automatic	string	Все виртуальные машины в масштабируемом наборе автоматически обновляются одновременно.
manual	string	Вы управляете применением обновлений для виртуальных машин в масштабируемом наборе. Это можно сделать с помощью действия manualUpgrade.
rolling	string	Существующие экземпляры в масштабируемом наборе удаляются в пакетах для обновления. После завершения обновленного пакета экземпляры начнут принимать трафик снова, а следующий пакет начнется. Это продолжается до тех пор, пока все экземпляры не будут доставлены up-to-date.

UpgradePolicy

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

Имя	Тип	Описание
automaticOSUpgradePolicy	AutomaticOSUpgradePolicy	Параметры конфигурации, используемые для автоматического обновления ОС. Параметры конфигурации, используемые для автоматического обновления ОС.
mode	UpgradeMode	Задает режим обновления до виртуальных машин в масштабируемом наборе. Возможные значения: вручную. Вы управляете приложением обновлений виртуальных машин в масштабируемом наборе. Это можно сделать с помощью действия manualUpgrade. автоматическое. Все виртуальные машины в масштабируемом наборе автоматически обновляются одновременно. Скользящей. Масштабируемый набор выполняет обновления в пакетах с необязательным временем приостановки между ними.
rollingUpgradePolicy	RollingUpgradePolicy	Параметры конфигурации, используемые при выполнении последовательного обновления. Параметры конфигурации, используемые при выполнении последовательного обновления.

UserAccount

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

Имя	Тип	Описание
elevationLevel	ElevationLevel	Уровень повышения прав учетной записи пользователя. Значение по умолчанию — nonAdmin.
linuxUserConfiguration	LinuxUserConfiguration	Конфигурация пользователя для конкретной платформы Linux для учетной записи пользователя. Это свойство игнорируется, если указано в пуле Windows. Если это не указано, пользователь создается с параметрами по умолчанию.
name	string	Имя учетной записи пользователя. Имена могут содержать любые символы Юникода до максимальной длины 20.
password	string	Пароль для учетной записи пользователя.
windowsUserConfiguration	WindowsUserConfiguration	Конфигурация пользователя windows для учетной записи пользователя. Это свойство можно указать только в том случае, если пользователь находится в пуле Windows. Если он не указан и в пуле Windows, пользователь создается с параметрами по умолчанию.

UserIdentity

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

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

VirtualMachineConfiguration

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

Имя	Тип	Описание
containerConfiguration	ContainerConfiguration	Конфигурация контейнера для пула. Если задано, настройка выполняется на каждом вычислительном узле в пуле, чтобы разрешить задачам выполняться в контейнерах. Все обычные задачи и задачи диспетчера заданий, выполняемые в этом пуле, должны указывать свойство containerSettings, а все остальные задачи могут указывать его.
dataDisks	DataDisk[]	Конфигурация дисков данных, подключенных к вычислительным узлам в пуле. Это свойство должно быть указано, если вычислительные узлы в пуле должны иметь пустые диски данных, подключенные к ним. Это невозможно обновить. Каждый вычислительный узел получает свой собственный диск (диск не является общим файлом). Существующие диски не могут быть присоединены, каждый подключенный диск пуст. При удалении вычислительного узла из пула диск и все данные, связанные с ним, также удаляются. Диск не отформатирован после подключения, его необходимо отформатировать перед использованием. Дополнительные сведения см. в https://docs.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux и https://docs.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine.
diskEncryptionConfiguration	DiskEncryptionConfiguration	Конфигурация шифрования дисков для пула. При указании шифрование выполняется на каждом узле в пуле во время подготовки узлов.
extensions	VMExtension[]	Расширение виртуальной машины для пула. При указании расширения, упомянутые в этой конфигурации, будут установлены на каждом узле.
imageReference	ImageReference	Ссылка на образ Marketplace виртуальных машин Azure или пользовательский образ виртуальной машины для использования.
licenseType	string	Тип локальной лицензии, используемой при развертывании операционной системы. Это относится только к образам, содержащим операционную систему Windows, и следует использовать только при наличии допустимых локальных лицензий для вычислительных узлов, которые будут развернуты. Если не указано, скидка на лицензирование в локальной среде не применяется. Значения: Windows_Server . Локальная лицензия предназначена для Windows Server. Windows_Client . Локальная лицензия предназначена для клиента Windows.
nodeAgentSKUId	string	Номер SKU агента пакетного вычислительного узла для подготовки на вычислительных узлах в пуле. Агент пакетного вычислительного узла — это программа, которая выполняется на каждом вычислительном узле в пуле, а также предоставляет интерфейс управления между вычислительным узлом и пакетной службой. Существуют различные реализации агента вычислительного узла, известного как номера SKU для разных операционных систем. Необходимо указать номер SKU агента вычислительного узла, соответствующий выбранной ссылке на изображение. Чтобы получить список поддерживаемых номеров SKU агента вычислительных узлов вместе со списком проверенных ссылок на образы, см. в разделе "Список поддерживаемых номеров SKU агента вычислительных узлов".
nodePlacementConfiguration	NodePlacementConfiguration	Конфигурация размещения узлов для пула. Эта конфигурация будет указывать правила по тому, как узлы в пуле будут физически выделены.
osDisk	OSDisk	Параметры диска операционной системы виртуальной машины.
securityProfile	SecurityProfile	Задает параметры профиля безопасности для масштабируемого набора виртуальных машин или виртуальной машины. Задает параметры профиля безопасности для масштабируемого набора виртуальных машин или виртуальной машины.
serviceArtifactReference	ServiceArtifactReference	Указывает идентификатор ссылки на артефакт службы, используемый для задания одной версии образа для всех виртуальных машин в масштабируемом наборе при использовании последней версии образа. Идентификатор ссылки на артефакт службы в виде /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}
windowsConfiguration	WindowsConfiguration	Параметры операционной системы Windows на виртуальной машине. Это свойство не должно быть указано, если свойство imageReference указывает образ ОС Linux.

VMDiskSecurityProfile

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

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

VMExtension

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

Имя	Тип	Описание
autoUpgradeMinorVersion	boolean	Указывает, следует ли использовать более новую дополнительную версию, если она доступна во время развертывания. Однако после развертывания расширение не будет обновлять дополнительные версии без повторного развертывания, даже если это свойство не имеет значения true.
enableAutomaticUpgrade	boolean	Указывает, следует ли автоматически обновлять расширение платформой, если доступна более новая версия расширения.
name	string	Имя расширения виртуальной машины.
protectedSettings	object	Расширение может содержать защищенные параметрыSettings или protectedSettingsFromKeyVault или не иметь защищенных параметров.
provisionAfterExtensions	string[]	Коллекция имен расширений. Коллекция имен расширений, после которой необходимо подготовить это расширение.
publisher	string	Имя издателя обработчика расширений.
settings	object	Форматированные общедоступные параметры JSON для расширения.
type	string	Тип расширения.
typeHandlerVersion	string	Версия обработчика скрипта.

WindowsConfiguration

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

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

WindowsUserConfiguration

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

Имя	Тип	Описание
loginMode	LoginMode	Режим входа для пользователя Значение по умолчанию — batch.