PoolAddParameter Clase

Un grupo en el servicio Azure Batch que se va a agregar.

Todos los parámetros necesarios deben rellenarse para enviarlos a Azure.

Herencia

Model

PoolAddParameter

Constructor

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)

Parámetros

id

str

Requerido

Necesario. El identificador puede contener cualquier combinación de caracteres alfanuméricos, incluidos guiones y caracteres de subrayado, y no puede contener más de 64 caracteres. El identificador se conserva entre mayúsculas y minúsculas y no distingue mayúsculas de minúsculas (es decir, es posible que no tenga dos identificadores de grupo dentro de una cuenta que solo difiere por mayúsculas y minúsculas).

display_name

str

Requerido

El nombre para mostrar no debe ser único y puede contener cualquier carácter Unicode hasta una longitud máxima de 1024.

vm_size

str

Requerido

Necesario. Para obtener información sobre los tamaños disponibles de las máquinas virtuales para grupos de Cloud Services (grupos creados con cloudServiceConfiguration), consulte Tamaños de Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch admite todos los tamaños de máquina virtual Cloud Services excepto ExtraSmall, A1V2 y A2V2. Para obtener información sobre los tamaños de máquina virtual disponibles para grupos que usan imágenes de Virtual Machines Marketplace (grupos creados con virtualMachineConfiguration), consulte Tamaños de Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) o Tamaños para Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch admite todos los tamaños de máquina virtual de Azure excepto STANDARD_A0 y aquellos con premium Storage (STANDARD_GS, STANDARD_DS y serie STANDARD_DSV2).

cloud_service_configuration

CloudServiceConfiguration

Requerido

Configuración del servicio en la nube para el grupo. Esta propiedad y virtualMachineConfiguration son mutuamente excluyentes y se debe especificar una de las propiedades. Esta propiedad no se puede especificar si la cuenta de Batch se creó con su propiedad poolAllocationMode establecida en "UserSubscription".

virtual_machine_configuration

VirtualMachineConfiguration

Requerido

Configuración de la máquina virtual para el grupo. Esta propiedad y cloudServiceConfiguration son mutuamente excluyentes y se debe especificar una de las propiedades.

resize_timeout

<xref:timedelta>

Requerido

Este tiempo de espera solo se aplica al escalado manual; no tiene ningún efecto cuando enableAutoScale se establece en true. El valor predeterminado es 15 minutos. El valor mínimo es de 5 minutos. Si especifica un valor inferior a 5 minutos, el servicio Batch devuelve un error; Si llama directamente a la API REST, el código de estado HTTP es 400 (solicitud incorrecta).

target_dedicated_nodes

int

Requerido

Número deseado de nodos de proceso dedicados en el grupo. Esta propiedad no se debe especificar si enableAutoScale está establecido en true. Si enableAutoScale está establecido en false, debe establecer targetDedicatedNodes, targetLowPriorityNodes o ambos.

target_low_priority_nodes

int

Requerido

Número deseado de nodos de proceso de prioridad baja o de acceso puntual en el grupo. Esta propiedad no se debe especificar si enableAutoScale está establecido en true. Si enableAutoScale está establecido en false, debe establecer targetDedicatedNodes, targetLowPriorityNodes o ambos.

enable_auto_scale

bool

Requerido

Si el tamaño del grupo se debe ajustar automáticamente con el tiempo. Si es false, se debe especificar al menos uno de targetDedicatedNodes y targetLowPriorityNodes. Si es true, se requiere la propiedad autoScaleFormula y el grupo cambia automáticamente el tamaño según la fórmula. El valor predeterminado es false.

auto_scale_formula

str

Requerido

Esta propiedad no se debe especificar si enableAutoScale está establecido en false. Es necesario si enableAutoScale está establecido en true. La fórmula se comprueba si hay validez antes de crear el grupo. Si la fórmula no es válida, el servicio Batch rechaza la solicitud con información de error detallada. Para obtener más información sobre cómo especificar esta fórmula, consulte "Escalado automático de nodos de proceso en un grupo de Azure Batch" (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/).

auto_scale_evaluation_interval

<xref:timedelta>

Requerido

El valor predeterminado es 15 minutos. El valor mínimo y máximo son 5 minutos y 168 horas respectivamente. Si especifica un valor inferior a 5 minutos o superior a 168 horas, el servicio Batch devuelve un error; Si llama directamente a la API REST, el código de estado HTTP es 400 (solicitud incorrecta).

enable_inter_node_communication

bool

Requerido

Si el grupo permite la comunicación directa entre nodos de proceso. La habilitación de la comunicación entre nodos limita el tamaño máximo del grupo debido a las restricciones de implementación en los nodos de proceso del grupo. Esto puede dar lugar a que el grupo no alcance su tamaño deseado. El valor predeterminado es false.

network_configuration

NetworkConfiguration

Requerido

Configuración de red del grupo.

start_task

StartTask

Requerido

Tarea especificada para ejecutarse en cada nodo de ejecución a medida que se une al grupo. La tarea se ejecuta cuando se agrega el nodo de ejecución al grupo o cuando se reinicia el nodo de ejecución.

certificate_references

list[CertificateReference]

Requerido

En el caso de los nodos de Windows, el servicio Batch instala los certificados en el almacén de certificados y la ubicación especificados. En el caso de los nodos de ejecución de Linux, los certificados se almacenan en un directorio dentro del directorio de trabajo de la tarea y se proporciona una variable de entorno AZ_BATCH_CERTIFICATES_DIR a la tarea para consultar esta ubicación. En el caso de los certificados con visibilidad de "remoteUser", se crea un directorio "certs" en el directorio principal del usuario (por ejemplo, /home/{user-name}/certs) y los certificados se colocan en ese directorio. Advertencia: esta propiedad está en desuso y se quitará después de febrero de 2024. Use la extensión Azure KeyVault en su lugar.

application_package_references

list[ApplicationPackageReference]

Requerido

Al crear un grupo, el identificador de aplicación del paquete debe ser completo (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Los cambios en las referencias de paquete afectan a todos los nodos nuevos que se unen al grupo, pero no afectan a los nodos de proceso que ya están en el grupo hasta que se reinician o se vuelven a crear una imagen inicial. Hay un máximo de 10 referencias de paquete en cualquier grupo determinado.

application_licenses

list[str]

Requerido

La lista de licencias de aplicación debe ser un subconjunto de licencias de aplicaciones de servicio de Batch disponibles. Si se solicita una licencia que no se admite, se producirá un error en la creación del grupo.

task_slots_per_node

int

Requerido

El número de ranuras de tareas que pueden usarse para ejecutar tareas simultáneas en un solo nodo de ejecución en el grupo. El valor predeterminado es 1. El valor máximo es el menor de 4 veces el número de núcleos de vmSize del grupo o 256.

task_scheduling_policy

TaskSchedulingPolicy

Requerido

Cómo se distribuyen las tareas entre nodos de proceso en un grupo. Si no se especifica, el valor predeterminado se distribuye.

user_accounts

list[UserAccount]

Requerido

metadata

list[MetadataItem]

Requerido

El servicio Batch no asigna ningún significado a los metadatos; es únicamente para el uso del código de usuario.

mount_configuration

list[MountConfiguration]

Requerido

Monte el almacenamiento mediante el uso compartido de archivos de Azure, NFS, CIFS o blobfuse basado en el sistema de archivos.

target_node_communication_mode

str o NodeCommunicationMode

Requerido

Modo de comunicación de nodo deseado para el grupo. Si se omite, el valor predeterminado es Default. Entre los valores posibles se incluyen: 'default', 'classic', 'simplified'

Métodos

as_dict	Devuelve un dict que puede ser JSONify mediante json.dump. El uso avanzado podría usar opcionalmente una devolución de llamada como parámetro: Key es el nombre de atributo que se usa en Python. Attr_desc es un dict de metadatos. Actualmente contiene 'type' con el tipo msrest y 'key' con la clave codificada restAPI. Value es el valor actual de este objeto. La cadena devuelta se usará para serializar la clave. Si el tipo de valor devuelto es una lista, se considera dict de resultados jerárquicos. Consulte los tres ejemplos de este archivo: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Si desea serialización XML, puede pasar los kwargs is_xml=True.
deserialize	Analice una cadena mediante la sintaxis restAPI y devuelva un modelo.
enable_additional_properties_sending
from_dict	Analizar un dict mediante un extractor de claves dado devuelve un modelo. De forma predeterminada, considere la posibilidad de extractores de claves (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor y last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Devuelve el JSON que se enviaría a Azure desde este modelo. Se trata de un alias para as_dict(full_restapi_key_transformer, keep_readonly=False). Si desea serialización XML, puede pasar los kwargs is_xml=True.
validate	Valide este modelo de forma recursiva y devuelva una lista de ValidationError.

as_dict

Devuelve un dict que puede ser JSONify mediante json.dump.

El uso avanzado podría usar opcionalmente una devolución de llamada como parámetro:

Key es el nombre de atributo que se usa en Python. Attr_desc es un dict de metadatos. Actualmente contiene 'type' con el tipo msrest y 'key' con la clave codificada restAPI. Value es el valor actual de este objeto.

La cadena devuelta se usará para serializar la clave. Si el tipo de valor devuelto es una lista, se considera dict de resultados jerárquicos.

Consulte los tres ejemplos de este archivo:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Si desea serialización XML, puede pasar los kwargs is_xml=True.

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

Parámetros

key_transformer

<xref:function>

Una función de transformador de teclas.

keep_readonly

valor predeterminado: True

Devoluciones

Un objeto compatible con JSON dict

Tipo de valor devuelto

dict

deserialize

Analice una cadena mediante la sintaxis restAPI y devuelva un modelo.

deserialize(data, content_type=None)

Parámetros

data

str

Requerido

Una cadena de datos mediante la estructura restAPI. JSON de forma predeterminada.

content_type

str

valor predeterminado: None

JSON de forma predeterminada, establezca application/xml si XML.

Devoluciones

Una instancia de este modelo

Excepciones

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Analizar un dict mediante un extractor de claves dado devuelve un modelo.

De forma predeterminada, considere la posibilidad de extractores de claves (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor y last_rest_key_case_insensitive_extractor)

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

Parámetros

data

dict

Requerido

Un dict mediante la estructura restAPI

content_type

str

valor predeterminado: None

JSON de forma predeterminada, establezca application/xml si XML.

key_extractors

valor predeterminado: None

Devoluciones

Una instancia de este modelo

Excepciones

DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

Devuelve el JSON que se enviaría a Azure desde este modelo.

Se trata de un alias para as_dict(full_restapi_key_transformer, keep_readonly=False).

Si desea serialización XML, puede pasar los kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parámetros

keep_readonly

bool

valor predeterminado: False

Si desea serializar los atributos de solo lectura

Devoluciones

Un objeto compatible con JSON dict

Tipo de valor devuelto

dict

validate

Valide este modelo de forma recursiva y devuelva una lista de ValidationError.

validate()

Devoluciones

Una lista de errores de validación

Tipo de valor devuelto

list