PoolAddParameter Класс

  • Ссылка

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

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

Наследование
Model
PoolAddParameter

Конструктор

PoolAddParameter(*, id: str, vm_size: str, display_name: str = None, cloud_service_configuration=None, virtual_machine_configuration=None, resize_timeout=None, target_dedicated_nodes: int = None, target_low_priority_nodes: int = None, enable_auto_scale: bool = None, auto_scale_formula: str = None, auto_scale_evaluation_interval=None, enable_inter_node_communication: bool = None, network_configuration=None, start_task=None, certificate_references=None, application_package_references=None, application_licenses=None, task_slots_per_node: int = None, task_scheduling_policy=None, user_accounts=None, metadata=None, mount_configuration=None, target_node_communication_mode=None, **kwargs)

Параметры

id
str
Обязательно

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

display_name
str
Обязательно

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

vm_size
str
Обязательно

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

cloud_service_configuration
CloudServiceConfiguration
Обязательно

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

virtual_machine_configuration
VirtualMachineConfiguration
Обязательно

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

resize_timeout
<xref:timedelta>
Обязательно

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

target_dedicated_nodes
int
Обязательно

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

target_low_priority_nodes
int
Обязательно

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

enable_auto_scale
bool
Обязательно

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

auto_scale_formula
str
Обязательно

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

auto_scale_evaluation_interval
<xref:timedelta>
Обязательно

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

enable_inter_node_communication
bool
Обязательно

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

network_configuration
NetworkConfiguration
Обязательно

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

start_task
StartTask
Обязательно

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

certificate_references
list[CertificateReference]
Обязательно

Для узлов Windows пакетная служба устанавливает сертификаты в указанное хранилище сертификатов и расположение. Для вычислительных узлов Linux сертификаты хранятся в каталоге в рабочем каталоге Задачи, а переменная среды AZ_BATCH_CERTIFICATES_DIR предоставляется задаче для запроса этого расположения. Для сертификатов с видимостью remoteUser каталог certs создается в домашнем каталоге пользователя (например, /home/{имя_пользователя}/certs), а сертификаты помещаются в этот каталог. Предупреждение. Это свойство устарело и будет удалено после февраля 2024 г. Вместо этого используйте расширение Azure KeyVault .

application_package_references
list[ApplicationPackageReference]
Обязательно

При создании пула идентификатор приложения пакета должен быть полным (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Изменения ссылок на пакеты влияют на все новые узлы, присоединенные к пулу, но не влияют на вычислительные узлы, которые уже находятся в пуле, пока они не будут перезагружены или перезагружены. В любом пуле имеется не более 10 ссылок на пакеты.

application_licenses
list[str]
Обязательно

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

task_slots_per_node
int
Обязательно

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

task_scheduling_policy
TaskSchedulingPolicy
Обязательно

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

user_accounts
list[UserAccount]
Обязательно
metadata
list[MetadataItem]
Обязательно

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

mount_configuration
list[MountConfiguration]
Обязательно

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

target_node_communication_mode
str или NodeCommunicationMode
Обязательно

Требуемый режим связи узла для пула. Если этот параметр опущен, значение по умолчанию — Default. Возможные значения: default, classic, simplified

Методы

as_dict

Возвращает словарь, который может иметь значение JSONify с помощью json.dump.

Дополнительное использование может использовать обратный вызов в качестве параметра:

Ключ — это имя атрибута, используемого в Python. Attr_desc — это диктовка метаданных. В настоящее время содержит "тип" с типом msrest и "key" с ключом в кодировке RestAPI. Значение — это текущее значение в этом объекте.

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

См. три примера в этом файле:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Если требуется xml-сериализация, можно передать kwargs is_xml=True.
deserialize

Синтаксический анализ str с помощью синтаксиса RestAPI и возврат модели.
enable_additional_properties_sending
from_dict

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

По умолчанию рекомендуется использовать средства извлечения ключей (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor и last_rest_key_case_insensitive_extractor).
is_xml_model
serialize

Возвращает json, который будет отправлен в Azure из этой модели.

Это псевдоним для as_dict(full_restapi_key_transformer, keep_readonly=False).

Если требуется xml-сериализация, можно передать kwargs is_xml=True.
validate

Рекурсивная проверка этой модели и возврат списка ValidationError.

as_dict

Возвращает словарь, который может иметь значение JSONify с помощью json.dump.

Дополнительное использование может использовать обратный вызов в качестве параметра:

Ключ — это имя атрибута, используемого в Python. Attr_desc — это диктовка метаданных. В настоящее время содержит "тип" с типом msrest и "key" с ключом в кодировке RestAPI. Значение — это текущее значение в этом объекте.

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

См. три примера в этом файле:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Если требуется xml-сериализация, можно передать kwargs is_xml=True.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Параметры

key_transformer
<xref:function>

Функция преобразователя ключей.

keep_readonly
значение по умолчанию: True

Возвращаемое значение

Объект, совместимый с JSON для дикта

Возвращаемый тип

dict

deserialize

Синтаксический анализ str с помощью синтаксиса RestAPI и возврат модели.

deserialize(data, content_type=None)

Параметры

data
str
Обязательно

Строка, использующий структуру RestAPI. JSON по умолчанию.

content_type
str
значение по умолчанию: None

JSON по умолчанию задайте значение application/xml if XML.

Возвращаемое значение

Экземпляр этой модели

Исключения

DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending()

from_dict

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

По умолчанию рекомендуется использовать средства извлечения ключей (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor и last_rest_key_case_insensitive_extractor).

from_dict(data, key_extractors=None, content_type=None)

Параметры

data
dict
Обязательно

Словарь, использующий структуру RestAPI

content_type
str
значение по умолчанию: None

JSON по умолчанию задайте значение application/xml if XML.

key_extractors
значение по умолчанию: None

Возвращаемое значение

Экземпляр этой модели

Исключения

DeserializationError if something went wrong

is_xml_model 

is_xml_model()

serialize

Возвращает json, который будет отправлен в Azure из этой модели.

Это псевдоним для as_dict(full_restapi_key_transformer, keep_readonly=False).

Если требуется xml-сериализация, можно передать kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Параметры

keep_readonly
bool
значение по умолчанию: False

Если вы хотите сериализовать атрибуты только для чтения

Возвращаемое значение

Объект, совместимый с JSON для дикта

Возвращаемый тип

dict

validate

Рекурсивная проверка этой модели и возврат списка ValidationError.

validate()

Возвращаемое значение

Список ошибок проверки

Возвращаемый тип

list