Модуль azure.azcollection.azure_rm_batchaccountpool — управление пулом учетных записей Azure Batch

ad_user

string

Имя пользователя Active Directory. Используйте при аутентификации с учетной записью пользователя Active Directory, а не с субъектом-службой.

adfs_authority_url

string

добавлено в azure.azcollection 0.0.1

URL-адрес центра сертификации Azure AD. Используйте при аутентификации с именем пользователя и паролем, если у вас есть собственный центр сертификации ADFS.

api_profile

string

добавлено в azure.azcollection 0.0.1

Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.

По умолчанию: "latest"

application_licenses

list / элементы=string

Список лицензий приложений должен быть подмножеством доступных лицензий приложений службы Batch.

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

application_packages

list / элементы=dictionary

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

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

Для любого пула можно указать не более 10 ссылок на пакеты приложений.

id

string / обязательный

Идентификатор устанавливаемого пакета приложения.

Он должен находиться в той же учетной записи Batch, что и пул.

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

version

string

Если это значение не указано и для приложения не задана версия по умолчанию, запрос завершится ошибкой с кодом InvalidApplicationPackageReferences.

При прямом вызове REST API код состояния HTTP равен 409.

auth_source

string

добавлено в azure.azcollection 0.0.1

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

Также можно задать с помощью переменной среды ANSIBLE_AZURE_AUTH_SOURCE.

Если задано значение auto (по умолчанию), приоритет следующий: параметры модуля -> env -> credential_file -> cli.

Если задано значение env, учетные данные будут считываться из переменных среды.

Если задано значение credential_file, профиль будет считываться из ~/.azure/credentials.

Если задано значение cli, учетные данные будут получены из профиля Azure CLI. Для указания идентификатора подписки, если их несколько, можно использовать subscription_id или переменную среды AZURE_SUBSCRIPTION_ID; в противном случае используется подписка az cli по умолчанию.

Если задано значение msi, компьютер-хост должен быть ресурсом Azure с включенным расширением MSI. Для указания идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, можно использовать subscription_id или переменную среды AZURE_SUBSCRIPTION_ID; в противном случае выбирается первая подписка.

Параметр msi добавлен в Ansible 2.6.

Варианты:

• "auto" ← (по умолчанию)
• "cli"
• "credential_file"
• "env"
• "msi"

batch_account_name

string / обязательный

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

cert_validation_mode

string

добавлено в azure.azcollection 0.0.1

Управляет проверкой сертификатов для конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав ignore. Также можно задать в профиле файла учетных данных или с помощью переменной среды AZURE_CERT_VALIDATION.

Варианты:

• "ignore"
• "validate"

certificates

list / элементы=dictionary

Для вычислительных узлов Windows служба Batch устанавливает сертификаты в указанное хранилище и расположение сертификатов.

Для вычислительных узлов Linux сертификаты хранятся в каталоге внутри рабочего каталога задачи, а задаче передается переменная среды AZ_BATCH_CERTIFICATES_DIR, позволяющая определить этот каталог.

Для сертификатов с видимостью ‘remoteUser’ в домашнем каталоге пользователя создается каталог ‘certs’, в который помещаются сертификаты.

id

string / обязательный

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

Он должен находиться в той же учетной записи Batch, что и пул.

store_location

string

Значение по умолчанию — CurrentUser.

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

Для вычислительных узлов Linux сертификаты хранятся в каталоге внутри рабочего каталога задачи, а задаче передается переменная среды AZ_BATCH_CERTIFICATES_DIR, позволяющая определить этот каталог.

Для сертификатов с видимостью ‘remoteUser’ в домашнем каталоге пользователя создается каталог ‘certs’, в который помещаются сертификаты.

Варианты:

• "CurrentUser" ← (по умолчанию)
• "LocalMachine"

store_name

string

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

Пул создан с помощью cloudServiceConfiguration или virtualMachineConfiguration с использованием ссылки на образ Windows.

Варианты:

• "My" ← (по умолчанию)
• "Root"
• "CA"
• "Trust"
• "Disallowed"
• "TrustedPeople"
• "TrustedPublisher"
• "AuthRoot"
• "AddressBook"

visibility

list / элементы=string

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

Варианты:

• "StartTask"
• "Task"
• "RemoteUser"

client_id

string

Идентификатор клиента Azure. Используйте при аутентификации с субъектом-службой или управляемым удостоверением (msi).

Также можно задать с помощью переменной среды AZURE_CLIENT_ID.

cloud_environment

string

добавлено в azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, — имя среды (определенное в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (обязательно для Azure Stack). Также можно задать в профиле файла учетных данных или с помощью переменной среды AZURE_CLOUD_ENVIRONMENT.

По умолчанию: "AzureCloud"

deployment_configuration

dictionary

Использование CloudServiceConfiguration указывает, что узлы следует создавать с помощью Azure Cloud Services (PaaS).

Использование VirtualMachineConfiguration означает использование виртуальных машин Azure (IaaS).

cloud_service_configuration

dictionary

Это свойство и virtualMachineConfiguration являются взаимоисключающими; необходимо указать одно из них.

Это свойство нельзя указать, если для учетной записи Batch при создании свойству poolAllocationMode было задано значение ‘UserSubscription’.

os_family

string

os_family=2 соответствует Windows Server 2008 R2 SP1.

os_family=3 соответствует Windows Server 2012.

os_family=4 соответствует Windows Server 2012 R2.

os_family=5 соответствует Windows Server 2016.

os_family=6 соответствует Windows Server 2019.

По умолчанию: "*"

os_version

string

Значение по умолчанию — *; оно указывает последнюю версию операционной системы для указанного семейства ОС.

virtual_machine_configuration

dictionary

Это свойство и cloudServiceConfiguration являются взаимоисключающими; необходимо указать одно из них.

container_configuration

dictionary

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

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

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

container_image_names

list / элементы=string

Это полная ссылка на образ, такая же, как указывается для команды “docker pull”.

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

container_registries

list / элементы=dictionary

Если образы необходимо загрузить из закрытого реестра, требующего учетные данные, их следует указать здесь.

identity_reference

dictionary

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

resource_id

string

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

password

string

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

registry_server

string

Если значение не указано, используется значение по умолчанию docker.io.

По умолчанию: "docker.io"

user_name

string

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

type

string / обязательный

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

Варианты:

• "DockerCompatible"
• "CriCompatible"

data_disks

list / элементы=dictionary

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

caching

string

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

Варианты:

• "None"
• "ReadOnly"
• "ReadWrite"

disk_size_gb

integer / обязательный

Начальный размер диска в ГБ при создании нового диска данных.

lun

integer / обязательный

LUN используется для уникальной идентификации каждого диска данных.

При подключении нескольких дисков у каждого должен быть уникальный LUN.

Значение должно находиться в диапазоне от 0 до 63 включительно.

storage_account_type

string

Тип диска данных.

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

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

Варианты:

• "Standard_LRS" ← (по умолчанию)
• "Premium_LRS"
• "StandardSSD_LRS"

disk_encryption_configuration

dictionary

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

targets

list / элементы=string

В пуле Linux поддерживается только TemporaryDisk.

В пуле Windows необходимо указать OsDisk и TemporaryDisk.

Варианты:

• "TemporaryDisk"
• "OsDisk"

extensions

list / элементы=dictionary

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

auto_upgrade_minor_version

boolean

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

После развертывания расширение не будет обновляться до новых дополнительных версий без повторного развертывания, даже если для этого свойства задано значение true.

Варианты:

• false
• true

enable_automatic_upgrade

boolean

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

Варианты:

• false
• true

name

string / обязательный

Имя расширения виртуальной машины.

protected_settings

json

Расширение может содержать protectedSettings, protectedSettingsFromKeyVault или вообще не содержать защищенных параметров.

provision_after_extensions

list / elements=string

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

publisher

string / обязательно

Имя издателя обработчика расширения.

settings

json

Общедоступные параметры расширения в формате JSON.

type

string / обязательно

Тип расширений.

type_handler_version

string

Версия обработчика скриптов.

image_reference

dictionary / обязательно

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

Чтобы получить список всех imageReferences, проверенных Azure Batch, см. операцию «List supported node agent SKUs».

id

string

Это свойство нельзя использовать одновременно с другими свойствами.

Образ Azure Compute Gallery должен иметь реплики в том же регионе, что и учетная запись Azure Batch.

Пример: '/subscriptions/{sub_Id}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}.

offer

string

Например, UbuntuServer или WindowsServer.

publisher

string

Например, Canonical или MicrosoftWindowsServer.

sku

string

Например, 18.04-LTS или 2022-datacenter.

version

string

Чтобы выбрать последнюю версию образа, можно указать значение «latest».

Если параметр не указан, используется значение по умолчанию latest.

license_type

string

Применимо только к образам с операционной системой Windows.

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

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

Windows_Client, локальная лицензия предназначена для Windows Client.

node_agent_sku_id

string / обязательно

Агент узла Batch — это программа, работающая на каждом узле пула.

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

Для разных операционных систем существуют различные реализации агента узла, называемые SKU.

Необходимо указать SKU агента узла, соответствующий выбранной ссылке на образ.

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

node_placement_configuration

dictionary

Эта конфигурация задает правила размещения узлов в пуле при их подготовке.

policy

string

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

Если не указана, Batch использует региональную политику.

Допустимые значения:

• "Regional"
• "Zonal"

os_disk

dictionary

Содержит параметры конфигурации временного диска ОС.

caching

string

Тип кэширования, включаемого для диска.

Допустимые значения:

• "None"
• "ReadOnly"
• "ReadWrite"

disk_size_gb

integer

Начальный размер диска в ГБ при создании нового диска ОС.

ephemeral_os_disk_settings

dictionary

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

placement

string

Это свойство позволяет пользователю указать в запросе расположение операционной системы.

managed_disk

dictionary

Конфигурация диска данных.

storage_account_type

string

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

Допустимые значения:

• "Standard_LRS"
• "Premium_LRS"
• "StandardSSD_LRS"

write_accelerator_enabled

boolean

Указывает, следует ли включить или отключить Write Accelerator для диска.

Допустимые значения:

• false
• true

security_profile

dictionary

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

encryption_at_host

boolean

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

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

Допустимые значения:

• false
• true

security_type

string

Задает SecurityType виртуальной машины.

Чтобы включить UefiSettings, необходимо установить любое из указанных значений.

По умолчанию: "trustedLaunch"

uefi_settings

dictionary

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

secure_boot_enabled

boolean

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

Допустимые значения:

• false
• true

v_tpm_enabled

boolean

Указывает, следует ли включить vTPM на виртуальной машине.

Допустимые значения:

• false
• true

service_artifact_reference

dictionary

Идентификатор ссылки на артефакт службы.

Например, /subscriptions/{subId}/resourceGroups/{testRG}/providers/Microsoft.Compute/galleries /{gName}/serviceArtifacts/{ArtName}/vmArtifactsProfiles/{ProfilesName}.

id

string

Идентификатор ссылки на артефакт службы для vmArtifactsProfiles.

windows_configuration

dictionary

Это свойство не следует указывать, если в imageReference задан образ ОС Linux.

enable_automatic_updates

boolean

Если параметр не указан, используется значение по умолчанию true.

Допустимые значения:

• false
• true ← (по умолчанию)

disable_instance_discovery

boolean

добавлено в azure.azcollection 2.3.0

Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Если задать значение true, обнаружение экземпляров и проверка центра авторизации будут полностью отключены. Эта возможность предназначена для сценариев, в которых невозможно получить доступ к конечной точке метаданных, например в частных облаках или Azure Stack. При обнаружении экземпляров метаданные центра авторизации извлекаются с https://login.microsoft.com/ для проверки центра авторизации. Если задать значение **True**, проверка центра авторизации отключается. Поэтому крайне важно убедиться, что настроенный узел центра авторизации является действительным и заслуживающим доверия.

Задается через профиль файла учетных данных или переменную среды AZURE_DISABLE_INSTANCE_DISCOVERY.

Допустимые значения:

• false ← (по умолчанию)
• true

display_name

string

Отображаемое имя пула.

identity

dictionary

Тип удостоверения, используемого для пула Batch.

Если удостоверение пула обновляется при обновлении существующего пула.

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

type

string / обязательно

Тип удостоверения, используемого для пула Batch.

Допустимые значения:

• "None"
• "UserAssigned"

user_assigned_identities

dictionary

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

Ключом является идентификатор удостоверения, а значение содержит «principal_id» и «client_id».

inter_node_communication

string

Этот параметр ограничивает набор узлов, которые могут быть назначены пулу.

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

Если параметр не указан, по умолчанию используется значение Disabled.

Допустимые значения:

• "Enabled"
• "Disabled"

is_disable_auto_scale

boolean

Отключает ли автоматическое масштабирование пула.

Допустимые значения:

• false ← (по умолчанию)
• true

is_stop_resize

boolean

Останавливает ли выполняющуюся операцию изменения размера пула.

Допустимые значения:

• false ← (по умолчанию)
• true

log_mode

string

Родительский аргумент.

log_path

string

Родительский аргумент.

metadata

list / elements=dictionary

Служба Batch не придает этим метаданным никакого значения; они предназначены исключительно для использования в пользовательском коде.

name

string / обязательно

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

value

string / обязательно

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

mount_configuration

list / elements=dictionary

Поддерживаются Azure Files, NFS, CIFS/SMB и Blobfuse.

azure_blob_file_system_configuration

dictionary

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

Это свойство нельзя использовать одновременно с другими свойствами.

account_key

string

Это свойство нельзя использовать одновременно с sasKey и identity; необходимо указать ровно одно из них.

account_name

string / обязательно

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

blobfuse_options

string

В Windows доступны параметры net use, а в Linux — параметры mount.

Допустимые значения:

• "net use"
• "mount"

container_name

string / обязательно

Имя контейнера Azure Blob Storage.

identity_reference

dictionary

Это свойство взаимоисключающее с accountKey и sasKey; необходимо указать ровно одно из них.

resource_id

string

Идентификатор ресурса ARM назначенного пользователю удостоверения.

relative_mount_path

string / обязательно

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

sas_key

string

Это свойство взаимоисключающее с accountKey и identity; необходимо указать ровно одно из них.

azure_file_share_configuration

dictionary

Конфигурация общей папки Azure Files.

Это свойство взаимоисключающее со всеми остальными свойствами.

account_key

string / обязательно

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

account_name

string / обязательно

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

azure_file_url

string / обязательно

Значение должно иметь вид «https://{account}.file.core.windows.net/».

mount_options

string

Это параметры net use в Windows и параметры mount в Linux.

Варианты:

• "net use"
• "mount"

relative_mount_path

string / обязательно

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

cifs_mount_configuration

dictionary

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

Это свойство взаимоисключающее со всеми остальными свойствами.

mount_options

string

Это параметры net use в Windows и параметры mount в Linux.

Варианты:

• "net use"
• "mount"

password

string / обязательно

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

relative_mount_path

string / обязательно

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

source

string / обязательно

URI монтируемой файловой системы.

user_name

string / обязательно

Имя пользователя для аутентификации в файловой системе CIFS.

nfs_mount_configuration

dictionary

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

Это свойство взаимоисключающее со всеми остальными свойствами.

mount_options

string

Это параметры net use в Windows и параметры mount в Linux.

Варианты:

• "net use"
• "mount"

relative_mount_path

string / обязательно

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

source

string / обязательно

URI монтируемой файловой системы.

name

string / обязательно

Имя пула учетных записей Batch.

network_configuration

dictionary

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

dynamic_vnet_assignment_scope

string

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

Варианты:

• "none"
• "job"

enable_accelerated_networking

boolean

Ускоренная сеть включает виртуализацию ввода-вывода с одним корнем (SR-IOV) для виртуальной машины.

Это может повысить производительность сети.

Варианты:

• false
• true

endpoint_configuration

dictionary

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

inbound_nat_pools

list / elements=dictionary

Максимальное число пулов входящего NAT для одного пула Batch — 5.

Если превышено максимальное число пулов входящего NAT, запрос завершается с кодом состояния HTTP 400.

backend_port

integer / обязательно

Это значение должно быть уникальным в пределах пула Batch.

Допустимые значения — от 1 до 65535, кроме 22.

frontend_port_range_end

integer / обязательно

Допустимые значения — от 1 до 65534, кроме портов от 50000 до 55000, зарезервированных службой Batch.

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

frontend_port_range_start

integer / обязательно

Допустимые значения находятся в диапазоне от 1 до 65534, кроме пересекающихся портов

Если указаны зарезервированные или пересекающиеся значения, запрос завершается с кодом состояния HTTP 400.

name

string / обязательно

Имя должно быть уникальным в пределах пула Batch.

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

network_security_group_rules

list / elements=dictionary

Максимальное число правил, которые можно указать для всех конечных точек пула Batch, — 25.

Если правила группы безопасности сети не указаны,

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

access

string / обязательно

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

Варианты:

• "Allow"
• "Deny"

priority

integer / обязательно

Приоритеты в пределах пула должны быть уникальными; правила обрабатываются в порядке приоритета

source_address_prefix

string

Допустимое значение — один IP-адрес (например, 10.10.10.10).

Допустимое значение — один IP-адрес.

source_port_ranges

list / elements=string

Допустимые значения — «*» (для всех портов 0–65535) или массивы портов либо диапазонов портов (например, 100-200).

protocol

string / обязательно

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

Варианты:

• "UDP"
• "TCP"

public_ip_address_configuration

dictionary

Это свойство поддерживается только для пулов со свойством virtualMachineConfiguration.

ip_address_ids

list / elements=string

Указанное здесь число IP-адресов ограничивает максимальный размер пула: для каждого общедоступного IP-адреса можно выделить 100 выделенных узлов или 100 узлов Spot/с низким приоритетом.

provision

string

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

Варианты:

• "BatchManaged" ← (по умолчанию)
• "UserManaged"
• "NoPublicIPAddresses"

subnet_id

string

Виртуальная сеть должна находиться в том же регионе и подписке, что и учетная запись Azure Batch.

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

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

oidc_token

string

добавлено в azure.azcollection 3.17.0

Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Этот токен обменивается с Azure AD с использованием федеративного удостоверения OIDC.

Полезно в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC.

Также можно задать через переменную среды AZURE_FEDERATED_TOKEN.

oidc_token_file_path

path

добавлено в azure.azcollection 3.17.0

Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Файл должен содержать только необработанный токен.

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

Также можно задать через переменную среды AZURE_FEDERATED_TOKEN_FILE.

password

string

Пароль пользователя Active Directory. Используется при аутентификации от имени пользователя Active Directory, а не субъекта-службы.

profile

string

Профиль безопасности из файла ~/.azure/credentials.

resource_group

string / обязательно

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

resource_tags

dictionary

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

При указании эти теги распространяются на связанные с пулом базовые ресурсы Azure.

Это свойство можно указать только в том случае, если учетная запись Batch создана со свойством poolAllocationMode, установленным в значение ‘UserSubscription’.

scale_settings

dictionary

Определяет требуемый размер пула.

Можно задать ‘fixedScale’, указав целевое значение targetDedicatedNodes, либо ‘autoScale’, определяющее формулу, которая периодически пересчитывается.

Если это свойство не указано, пул будет иметь фиксированный масштаб с targetDedicatedNodes, равным 0.

auto_scale

dictionary

Это свойство и fixedScale взаимоисключающие; необходимо указать одно из них.

evaluation_interval

string

Если не указано, используется значение по умолчанию — 15 минут (PT15M).

По умолчанию: "P15M"

formula

string / обязательно

Формула для вычисления требуемого числа вычислительных узлов в пуле.

fixed_scale

dictionary

Это свойство и autoScale взаимоисключающие; необходимо указать одно из них.

node_deallocation_option

string

Если параметр не указан, используется значение по умолчанию Requeue.

Варианты:

• "Requeue"
• "Terminate"
• "TaskCompletion"
• "RetainedData"

resize_timeout

string

Значение по умолчанию — 15 минут P15M.

Значения времени ожидания указываются в формате ISO 8601. Например, для 10 минут используйте PT10M.

Минимальное значение — 5 минут.

Если указать значение меньше 5 минут, служба Batch отклонит запрос с ошибкой.

По умолчанию: "P15M"

target_dedicated_nodes

integer

Необходимо задать хотя бы один из параметров targetDedicatedNodes и targetLowPriorityNodes.

target_low_priority_nodes

integer

Необходимо задать хотя бы один из параметров targetDedicatedNodes и targetLowPriorityNodes.

secret

string

Секрет клиента Azure. Используется при аутентификации с помощью субъекта-службы.

start_task

dictionary

При выполнении операции PATCH (обновления) для удаления задачи запуска из пула этому свойству можно присвоить пустой объект.

command_line

string

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

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

Обязателен, если заданы другие свойства startTask.

container_settings

dictionary

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

container_run_options

string

Эти дополнительные параметры передаются в качестве аргументов команде ‘docker create’ помимо параметров, задаваемых службой Batch.

image_name

string

Полная ссылка на образ, как при указании в команде «docker pull».

Если в имени образа не указан тег, по умолчанию используется тег «:latest».

registry

dictionary

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

identity_reference

dictionary

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

resource_id

string

Идентификатор ресурса ARM назначенного пользователю удостоверения.

password

string

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

registry_server

string

Если параметр не указан, по умолчанию используется «docker.io».

По умолчанию: "docker.io"

user_name

string

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

working_directory

string

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

Варианты:

• "TaskWorkingDirectory"
• "ContainerImageDefault"

environment_settings

list / elements=dictionary

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

name

string / обязательный

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

value

string

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

max_task_retry_count

integer

Служба Batch повторяет задачу, если ее код завершения не равен нулю.

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

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

По умолчанию: 0

resource_files

list / elements=dictionary

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

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

auto_storage_container_name

string

Свойства autoStorageContainerName, storageContainerUrl и httpUrl являются взаимоисключающими; необходимо указать одно из них.

blob_prefix

string

Это свойство допустимо только при использовании autoStorageContainerName или storageContainerUrl.

Префиксом может быть часть имени файла или подкаталог.

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

file_mode

string

Это свойство применяется только к файлам, загружаемым на вычислительные узлы Linux.

Если оно указано для resourceFile, загружаемого на узел Windows, оно будет проигнорировано.

Если это свойство не задано для узла Linux, для файла применяется значение по умолчанию 0770.

file_path

string

Если указано свойство httpUrl, параметр filePath обязателен и задает путь, по которому будет загружен файл, включая имя файла.

Если указано свойство autoStorageContainerName или storageContainerUrl, параметр filePath является необязательным и задает каталог для загрузки файлов.

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

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

http_url

string

Свойства autoStorageContainerName, storageContainerUrl и httpUrl являются взаимоисключающими; необходимо указать одно из них.

Если URL-адрес указывает на хранилище BLOB-объектов Azure, он должен быть доступен для чтения с вычислительных узлов.

Получить такой URL-адрес для BLOB-объекта в хранилище Azure можно тремя способами.

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

identity_reference

dictionary

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

resource_id

string

Идентификатор ресурса ARM назначенного пользователю удостоверения.

storage_container_url

string

Свойства autoStorageContainerName, storageContainerUrl и httpUrl являются взаимоисключающими; необходимо указать одно из них.

Этот URL-адрес должен быть доступен для чтения и просмотра списка объектов с вычислительных узлов.

Получить такой URL-адрес для контейнера в хранилище Azure можно тремя способами.

Включить подписанный URL-адрес общего доступа (SAS), предоставляющий разрешения на чтение и просмотр списка объектов в контейнере; использовать управляемое удостоверение с разрешениями на чтение и просмотр списка объектов; либо настроить ACL контейнера для предоставления общего доступа.

user_identity

dictionary

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

auto_user

dictionary

Конфигурация autouser для удостоверения пользователя задачи.

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

elevation_level

string

Уровень привилегий автоматического пользователя.

Варианты:

• "NonAdmin" ← (по умолчанию)
• "Admin"

scope

string

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

Значение по умолчанию — Pool.

Если в пуле используется Windows и требуется более строгая изоляция задач, укажите значение Task.

Варианты:

• "Task"
• "Pool" ← (по умолчанию)

user_name

string

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

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

wait_for_success

boolean

Если значение равно true и задача запуска завершается с ошибкой на вычислительном узле,

служба Batch повторяет задачу запуска до достижения максимального количества повторных попыток (maxTaskRetryCount).

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

Это состояние можно определить по состоянию узла и сведениям об ошибке планирования.

Если значение равно false, служба Batch не будет ждать завершения задачи запуска.

Варианты:

• false
• true

state

string

Задать требуемое состояние пула учетной записи Batch.

Используйте present для создания или обновления пула учетной записи Batch и absent для его удаления.

Варианты:

• "present" ← (по умолчанию)
• "absent"

subscription_id

string

Идентификатор вашей подписки Azure.

target_node_communication_mode

string

Если параметр не указан, используется значение по умолчанию Default.

Варианты:

• "Default" ← (по умолчанию)
• "Classic"
• "Simplified"

task_scheduling_policy

dictionary

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

node_fill_type

string

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

Варианты:

• "Spread"
• "Pack"

task_slots_per_node

integer

Значение по умолчанию — 1.

Максимальное значение — меньшее из следующих чисел: 4-кратное количество ядер vmSize пула или 256.

По умолчанию: 1

tenant

string

Идентификатор клиента Azure. Используется при аутентификации с помощью субъекта-службы.

thumbprint

string

добавлено в azure.azcollection 1.14.0

Отпечаток закрытого ключа, указанного в x509_certificate_path.

Используется при аутентификации с помощью субъекта-службы.

Обязателен, если задан параметр x509_certificate_path.

upgrade_policy

dictionary

Описывает политику обновления.

automatic_os_upgrade_policy

dictionary

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

disable_automatic_rollback

boolean

Следует ли отключить функцию отката образа ОС.

Варианты:

• false
• true

enable_automatic_os_upgrade

boolean

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

Варианты:

• false
• true

os_rolling_upgrade_deferral

boolean

Откладывать обновления ОС на TVM, если на них выполняются задачи.

Варианты:

• false
• true

use_rolling_upgrade_policy

boolean

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

Если для VMSS не задана политика, при автоматическом обновлении ОС будет использоваться политика по умолчанию.

Варианты:

• false
• true

mode

string / обязательный

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

Варианты:

• "automatic"
• "manual"
• "rolling"

rolling_upgrade_policy

dictionary

Это свойство поддерживается только для пулов со свойством virtualMachineConfiguration.

enable_cross_zone_upgrade

boolean

Разрешить VMSS игнорировать границы зон при формировании пакетов обновления.

Размер пакета определяется с учетом домена обновления и maxBatchInstancePercent.

Если это поле не задано, Azure Batch не будет устанавливать для него значение по умолчанию.

Значение enableCrossZoneUpgrade созданного VirtualMachineScaleSet будет определяться конфигурацией по умолчанию VirtualMachineScaleSet.

Это поле можно установить в значение true или false только при использовании NodePlacementConfiguration со значением Zonal.

Варианты:

• false
• true

max_batch_instance_percent

integer

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

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

Значение этого поля должно быть в диапазоне от 5 до 100 включительно.

Если для maxBatchInstancePercent и maxUnhealthyInstancePercent заданы значения, значение maxBatchInstancePercent не должно превышать maxUnhealthyInstancePercent.

max_unhealthy_instance_percent

integer

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

Это ограничение проверяется перед началом каждого пакета.

Если для maxBatchInstancePercent и maxUnhealthyInstancePercent заданы значения, значение maxBatchInstancePercent не должно превышать maxUnhealthyInstancePercent.

max_unhealthy_upgraded_instance_percent

integer

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

Эта проверка выполняется после обновления каждого пакета.

Если этот процент будет превышен, последовательное обновление будет прервано.

Значение этого поля должно быть в диапазоне от 0 до 100 включительно.

pause_time_between_batches

string

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

Продолжительность времени следует указывать в формате ISO 8601.

prioritize_unhealthy_instances

boolean

Обновить все неработоспособные экземпляры в масштабируемом наборе до обновления любых работоспособных экземпляров.

Варианты:

• false
• true

rollback_failed_instances_on_policy_breach

boolean

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

Варианты:

• false
• true

user_accounts

list / elements=dictionary

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

elevation_level

string

NonAdmin — обычный пользователь без повышенных прав доступа.

Admin — пользователь с повышенными правами доступа, имеющий полные права администратора.

Варианты:

• "NonAdmin" ← (по умолчанию)
• "Admin"

linux_user_configuration

dictionary

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

gid

integer

Свойства uid и gid необходимо указывать вместе либо не указывать вовсе.

Если значение не указано, gid выбирает операционная система.

ssh_private_key

string

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

Закрытый ключ используется для автоматической настройки аутентификации SSH на основе асимметричных ключей между узлами пула Linux, если свойство enableInterNodeCommunication пула имеет значение true.

Для этого пара ключей помещается в каталог .ssh пользователя.

Если значение не указано, аутентификация SSH без пароля между узлами не настраивается (каталог .ssh пользователя не изменяется).

uid

integer

Свойства uid и gid необходимо указывать вместе либо не указывать вовсе.

Если значение не указано, uid выбирает операционная система.

name

string / обязательный

Имя учетной записи пользователя. Имя может содержать любые символы Unicode и иметь длину не более 20 символов.

password

string / обязательный

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

windows_user_configuration

dictionary

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

login_mode

string

Указывает режим входа для пользователя.

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

Варианты:

• "Batch"
• "Interactive"

vm_size

string

Сведения о доступных размерах виртуальных машин для пулов Cloud Services.

Batch поддерживает все размеры виртуальных машин Cloud Services, кроме ExtraSmall, A1V2 и A2V2.

Batch поддерживает все размеры виртуальных машин Azure, кроме STANDARD_A0 и размеров с хранилищем Premium (серии STANDARD_GS, STANDARD_DS и STANDARD_DSV2).

x509_certificate_path

path

добавлено в azure.azcollection 1.14.0

Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы.

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

Используется при аутентификации с помощью субъекта-службы.

state

dictionary

Содержит сведения о пуле в учетной записи Batch.

Возвращается: всегда

Пример: {"allocation_state": "Steady", "allocation_state_transition_time": "2024-11-05T08:58:16.803138Z", "batch_account_name": "fredbatch02", "creation_time": "2024-11-05T08:58:15.399345Z", "current_dedicated_nodes": 0, "current_low_priority_nodes": 0, "deployment_configuration": {"virtual_machine_configuration": {"image_reference": {"offer": "ubuntu-hpc", "publisher": "microsoft-dsvm", "sku": "2204", "version": "latest"}, "node_agent_sku_id": "batch.node.ubuntu 22.04", "node_placement_configuration": {"policy": "Regional"}, "os_disk": {"caching": "None", "managed_disk": {"storage_account_type": "Premium_LRS"}}}}, "etag": "0x8DCFD77FC345CFE", "id": "/subscriptions/xxx-xxx/resourceGroups/testRG/providers/Microsoft.Batch/batchAccounts/batch01/pools/pool01", "inter_node_communication": "Disabled", "last_modified": "2024-11-05T08:58:15.399347Z", "name": "poolfredbatch02--002", "network_configuration": {"dynamic_vnet_assignment_scope": "None", "enable_accelerated_networking": false, "endpoint_configuration": {"inbound_nat_pools": [{"backend_port": 33, "frontend_port_range_end": 49999, "frontend_port_range_start": 1, "name": "nat02", "protocol": "UDP"}]}, "public_ip_address_configuration": {"provision": "BatchManaged"}, "subnet_id": "/subscriptions/xxx-xxx/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet01/subnets/default"}, "provisioning_state": "Succeeded", "provisioning_state_transition_time": "2024-11-05T08:58:15.399345Z", "resize_operation_status": {"node_deallocation_option": "Requeue", "resize_timeout": "PT15M", "start_time": "2024-11-05T08:58:15.399317Z", "target_dedicated_nodes": 0}, "resource_group": "v-xisuRG06", "scale_settings": {"fixed_scale": {"resize_timeout": "PT15M", "target_dedicated_nodes": 0, "target_low_priority_nodes": 0}}, "target_node_communication_mode": "Default", "task_scheduling_policy": {"node_fill_type": "Pack"}, "task_slots_per_node": 1, "type": "Microsoft.Batch/batchAccounts/pools", "upgrade_policy": {"automatic_os_upgrade_policy": {"disable_automatic_rollback": false, "enable_automatic_os_upgrade": false, "os_rolling_upgrade_deferral": false, "use_rolling_upgrade_policy": false}, "mode": "Manual", "rolling_upgrade_policy": {"max_batch_instance_percent": 20, "max_unhealthy_instance_percent": 20, "max_unhealthy_upgraded_instance_percent": 20, "pause_time_between_batches": "P0D", "rollback_failed_instances_on_policy_breach": false}}, "vm_size": "STANDARD_D2S_V3"}