CloudPool Clase

Un grupo en el servicio Azure Batch.

Las variables solo se rellenan mediante el servidor y se omitirán al enviar una solicitud.

Herencia
CloudPool

Constructor

CloudPool(*, id: str = None, display_name: str = None, url: str = None, e_tag: str = None, last_modified=None, creation_time=None, state=None, state_transition_time=None, allocation_state=None, allocation_state_transition_time=None, vm_size: str = None, cloud_service_configuration=None, virtual_machine_configuration=None, resize_timeout=None, resize_errors=None, current_dedicated_nodes: int = None, current_low_priority_nodes: int = 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, auto_scale_run=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, stats=None, mount_configuration=None, identity=None, target_node_communication_mode=None, **kwargs)

Parámetros

id
str
Requerido

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 dentro de una cuenta que solo difieren 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.

url
str
Requerido
e_tag
str
Requerido

Se trata de una cadena opaca. Puede usarlo para detectar si el grupo ha cambiado entre solicitudes. En concreto, puede pasar la ETag al actualizar un grupo para especificar que los cambios deben surtir efecto solo si nadie más ha modificado el grupo mientras tanto.

last_modified
datetime
Requerido

Esta es la última vez en la que cambian los datos de nivel de grupo, como targetDedicatedNodes o enableAutoscale settings. No tiene en cuenta los cambios de nivel de nodo, como un estado de cambio de nodo de proceso.

creation_time
datetime
Requerido
state
str o PoolState
Requerido

Entre los valores posibles se incluyen: "activo", "eliminación"

state_transition_time
datetime
Requerido
allocation_state
str o AllocationState
Requerido

Entre los valores posibles se incluyen: "estable", "cambio de tamaño", "detención"

allocation_state_transition_time
datetime
Requerido
vm_size
str
Requerido

Para obtener información sobre los tamaños disponibles de las máquinas virtuales en grupos, consulte Elección de un tamaño de máquina virtual para nodos de proceso en un grupo de Azure Batch (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

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 es el tiempo de espera de la operación de cambio de tamaño más reciente. (El tamaño inicial cuando se crea el grupo cuenta como un cambio de tamaño). El valor predeterminado es 15 minutos.

resize_errors
list[ResizeError]
Requerido

Esta propiedad solo se establece si se produjeron uno o varios errores durante el último cambio de tamaño del grupo y solo cuando el valor allocationState del grupo es Estable.

current_dedicated_nodes
int
Requerido

Número de nodos de proceso dedicados actualmente en el grupo.

current_low_priority_nodes
int
Requerido

Número de nodos de proceso de prioridad baja o de acceso puntual actualmente en el grupo. Los nodos de proceso de prioridad baja o de acceso puntual que se han adelantado se incluyen en este recuento.

target_dedicated_nodes
int
Requerido

Número deseado de nodos de proceso dedicados en el grupo.

target_low_priority_nodes
int
Requerido

Número deseado de nodos de proceso de prioridad baja o de acceso puntual en el grupo.

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 solo se establece si el grupo se escala automáticamente, es decir, enableAutoScale es true.

auto_scale_evaluation_interval
<xref:timedelta>
Requerido

Esta propiedad solo se establece si el grupo se escala automáticamente, es decir, enableAutoScale es true.

auto_scale_run
AutoScaleRun
Requerido

Resultados y errores de la última ejecución de la fórmula de escalado automático. Esta propiedad solo se establece si el grupo se escala automáticamente, es decir, enableAutoScale es true.

enable_inter_node_communication
bool
Requerido

Si el grupo permite la comunicación directa entre nodos de proceso. Esto impone restricciones en las que se pueden asignar nodos de proceso al grupo. Especificar este valor puede reducir la posibilidad de asignar el número solicitado de nodos de ejecución en el grupo.

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.

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

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
stats
PoolStatistics
Requerido

Estadísticas de uso y uso de recursos para toda la duración del grupo. Esta propiedad solo se rellena si cloudPool se recuperó con una cláusula expand, incluido el atributo 'stats'; de lo contrario, es null. Es posible que las estadísticas no estén disponibles inmediatamente. El servicio Batch realiza una acumulación periódica de estadísticas. El retraso típico es de aproximadamente 30 minutos.

mount_configuration
list[MountConfiguration]
Requerido

Esto admite Azure Files, NFS, CIFS/SMB y Blobfuse.

identity
BatchPoolIdentity
Requerido

Identidad del grupo de Batch, si está configurada. Lista de identidades de usuario asociadas al grupo de Batch. Las referencias de clave de diccionario de identidades de usuario serán identificadores de recurso de ARM con el formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

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'

Variables

current_node_communication_mode
str o NodeCommunicationMode

Estado actual del modo de comunicación del grupo. 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

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

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