PoolOperations Clase
Operaciones poolOperations.
No debe crear instancias directamente de esta clase, sino crear una instancia de cliente que la creará automáticamente y la asociará como atributo.
- Herencia
-
builtins.objectPoolOperations
Constructor
PoolOperations(client, config, serializer, deserializer)Parámetros
- client
Cliente para solicitudes de servicio.
- config
Configuración del cliente de servicio.
- serializer
Serializador de modelo de objetos.
- deserializer
Deserializador de modelo de objetos.
Variables
- api_version
La versión de API que se usará para la solicitud. Valor constante: "2023-05-01.17.0".
Métodos
| add |
Agrega un grupo a la cuenta especificada. Al asignar nombres a grupos, evite incluir información confidencial, como nombres de usuario o nombres de proyecto secretos. Esta información puede aparecer en los registros de telemetría a los que pueden acceder los ingenieros de Soporte técnico de Microsoft. |
| delete |
Elimina un grupo de la cuenta especificada. Cuando se solicita que se elimine un grupo, se producen las siguientes acciones: el estado del grupo se establece en eliminar; se detiene cualquier operación de cambio de tamaño en curso en el grupo; el servicio Batch comienza a cambiar el tamaño del grupo a cero nodos de proceso; Todas las tareas que se ejecutan en nodos de ejecución existentes se finalizan y se vuelven a poner en cola (como si se hubiera solicitado una operación de grupo de cambio de tamaño con la opción de requeue predeterminada); por último, el grupo se quita del sistema. Dado que las tareas en ejecución se vuelven a poner en cola, el usuario puede volver a ejecutar estas tareas actualizando su trabajo para tener como destino un grupo diferente. A continuación, las tareas se pueden ejecutar en el nuevo grupo. Si desea invalidar el comportamiento de la puesta en cola, debe llamar al grupo de cambio de tamaño explícitamente para reducir el grupo a un tamaño cero antes de eliminar el grupo. Si llama a una API Update, Patch o Delete en un grupo en el estado de eliminación, se producirá un error con el código de estado HTTP 409 con el código de error PoolBeingDeleted. |
| disable_auto_scale |
Deshabilita el escalado automático de un grupo. |
| enable_auto_scale |
Habilita el escalado automático para un grupo. No se puede habilitar el escalado automático en un grupo si hay una operación de cambio de tamaño en curso en el grupo. Si el escalado automático del grupo está deshabilitado actualmente, debe especificar una fórmula de escalabilidad automática válida como parte de la solicitud. Si el escalado automático del grupo ya está habilitado, puede especificar una nueva fórmula de escalado automático o un nuevo intervalo de evaluación. No se puede llamar a esta API para el mismo grupo de más de una vez cada 30 segundos. |
| evaluate_auto_scale |
Obtiene el resultado de evaluar una fórmula de escalado automático en el grupo. Esta API es principalmente para validar una fórmula de escalado automático, ya que simplemente devuelve el resultado sin aplicar la fórmula al grupo. El grupo debe tener habilitado el escalado automático para evaluar una fórmula. |
| exists |
Obtiene las propiedades básicas de un grupo. |
| get |
Obtiene información sobre el grupo especificado. |
| list |
Enumera todos los grupos de la cuenta especificada. |
| list_usage_metrics |
Enumera las métricas de uso, agregadas por Grupo en intervalos de tiempo individuales, para la cuenta especificada. Si no especifica una cláusula de $filter, incluido un poolId, la respuesta incluye todos los grupos que existían en la cuenta en el intervalo de tiempo de los intervalos de agregación devueltos. Si no especifica una cláusula $filter que incluya un valor startTime o endTime, estos filtros tienen como valor predeterminado las horas de inicio y finalización del último intervalo de agregación disponible actualmente; es decir, solo se devuelve el último intervalo de agregación. |
| patch |
Novedades las propiedades del grupo especificado. Esto solo reemplaza las propiedades del grupo especificadas en la solicitud. Por ejemplo, si el grupo tiene un objeto StartTask asociado a él y una solicitud no especifica un elemento StartTask, el Grupo mantiene las StartTask existentes. |
| remove_nodes |
Quita los nodos de proceso del grupo especificado. Esta operación solo se puede ejecutar cuando el estado de asignación del grupo es estable. Cuando se ejecuta esta operación, el estado de asignación cambia de constante a cambio de tamaño. Cada solicitud puede quitar hasta 100 nodos. |
| resize |
Cambia el número de nodos de proceso asignados a un grupo. Solo puede cambiar el tamaño de un grupo cuando su estado de asignación es estable. Si el grupo ya cambia el tamaño, se produce un error en la solicitud con el código de estado 409. Al cambiar el tamaño de un grupo, el estado de asignación del grupo cambia de estable a cambio de tamaño. No se puede cambiar el tamaño de los grupos configurados para el escalado automático. Si intenta hacerlo, el servicio Batch devuelve un error 409. Si cambia el tamaño de un grupo hacia abajo, el servicio Batch elige los nodos de proceso que se van a quitar. Para quitar nodos de proceso específicos, use la API De eliminación de nodos de proceso en su lugar. |
| stop_resize |
Detiene una operación de cambio de tamaño en curso en el grupo. Esto no restaura el grupo a su estado anterior antes de la operación de cambio de tamaño: solo detiene los cambios adicionales que se realizan y el grupo mantiene su estado actual. Después de la detención, el grupo se estabiliza en el número de nodos de proceso en los que se encontraba cuando se realizó la operación de detención. Durante la operación de detención, el estado de asignación del grupo cambia primero a detener y luego a estable. Una operación de cambio de tamaño no debe ser una solicitud de grupo de cambio de tamaño explícita; Esta API también se puede usar para detener el tamaño inicial del grupo cuando se crea. |
| update_properties |
Novedades las propiedades del grupo especificado. Esto reemplaza completamente todas las propiedades actualizables del grupo. Por ejemplo, si el grupo tiene una clase StartTask asociada y si StartTask no se especifica con esta solicitud, el servicio Batch quitará el objeto StartTask existente. |
add
Agrega un grupo a la cuenta especificada.
Al asignar nombres a grupos, evite incluir información confidencial, como nombres de usuario o nombres de proyecto secretos. Esta información puede aparecer en los registros de telemetría a los que pueden acceder los ingenieros de Soporte técnico de Microsoft.
add(pool, pool_add_options=None, custom_headers=None, raw=False, **operation_config)Parámetros
- raw
- bool
devuelve la respuesta directa junto con la respuesta deserializada.
- operation_config
Invalidaciones de configuración de la operación.
Devoluciones
Ninguno o ClientRawResponse si raw=true
Tipo de valor devuelto
Excepciones
delete
Elimina un grupo de la cuenta especificada.
Cuando se solicita que se elimine un grupo, se producen las siguientes acciones: el estado del grupo se establece en eliminar; se detiene cualquier operación de cambio de tamaño en curso en el grupo; el servicio Batch comienza a cambiar el tamaño del grupo a cero nodos de proceso; Todas las tareas que se ejecutan en nodos de ejecución existentes se finalizan y se vuelven a poner en cola (como si se hubiera solicitado una operación de grupo de cambio de tamaño con la opción de requeue predeterminada); por último, el grupo se quita del sistema. Dado que las tareas en ejecución se vuelven a poner en cola, el usuario puede volver a ejecutar estas tareas actualizando su trabajo para tener como destino un grupo diferente. A continuación, las tareas se pueden ejecutar en el nuevo grupo. Si desea invalidar el comportamiento de la puesta en cola, debe llamar al grupo de cambio de tamaño explícitamente para reducir el grupo a un tamaño cero antes de eliminar el grupo. Si llama a una API Update, Patch o Delete en un grupo en el estado de eliminación, se producirá un error con el código de estado HTTP 409 con el código de error PoolBeingDeleted.
delete(pool_id, pool_delete_options=None, custom_headers=None, raw=False, **operation_config)Parámetros
- pool_delete_options
- PoolDeleteOptions
Parámetros adicionales para la operación
- raw
- bool
devuelve la respuesta directa junto con la respuesta deserializada.
- operation_config
Invalidaciones de configuración de la operación.
Devoluciones
Ninguno o ClientRawResponse si raw=true
Tipo de valor devuelto
Excepciones
disable_auto_scale
Deshabilita el escalado automático de un grupo.
disable_auto_scale(pool_id, pool_disable_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)Parámetros
- pool_id
- str
Identificador del grupo en el que se va a deshabilitar el escalado automático.
- pool_disable_auto_scale_options
- PoolDisableAutoScaleOptions
Parámetros adicionales para la operación
- raw
- bool
devuelve la respuesta directa junto con la respuesta deserializada.
- operation_config
Invalidaciones de configuración de la operación.
Devoluciones
Ninguno o ClientRawResponse si raw=true
Tipo de valor devuelto
Excepciones
enable_auto_scale
Habilita el escalado automático para un grupo.
No se puede habilitar el escalado automático en un grupo si hay una operación de cambio de tamaño en curso en el grupo. Si el escalado automático del grupo está deshabilitado actualmente, debe especificar una fórmula de escalabilidad automática válida como parte de la solicitud. Si el escalado automático del grupo ya está habilitado, puede especificar una nueva fórmula de escalado automático o un nuevo intervalo de evaluación. No se puede llamar a esta API para el mismo grupo de más de una vez cada 30 segundos.
enable_auto_scale(pool_id, auto_scale_formula=None, auto_scale_evaluation_interval=None, pool_enable_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)Parámetros
- auto_scale_formula
- str
La fórmula se comprueba si hay validez antes de que se aplique al 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/en-us/documentation/articles/batch-automatic-scaling).
- auto_scale_evaluation_interval
- <xref:timedelta>
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 rechaza la solicitud con un error de valor de propiedad no válido; Si llama directamente a la API REST, el código de estado HTTP es 400 (solicitud incorrecta). Si especifica un nuevo intervalo, se detendrá la programación de evaluación de escalabilidad automática existente y se iniciará una nueva programación de evaluación de escalado automático, con su hora de inicio siendo la hora a la que se emitió esta solicitud.
- pool_enable_auto_scale_options
- PoolEnableAutoScaleOptions
Parámetros adicionales para la operación
- raw
- bool
devuelve la respuesta directa junto con la respuesta deserializada.
- operation_config
Invalidaciones de configuración de la operación.
Devoluciones
Ninguno o ClientRawResponse si raw=true
Tipo de valor devuelto
Excepciones
evaluate_auto_scale
Obtiene el resultado de evaluar una fórmula de escalado automático en el grupo.
Esta API es principalmente para validar una fórmula de escalado automático, ya que simplemente devuelve el resultado sin aplicar la fórmula al grupo. El grupo debe tener habilitado el escalado automático para evaluar una fórmula.
evaluate_auto_scale(pool_id, auto_scale_formula, pool_evaluate_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)Parámetros
- pool_id
- str
Identificador del grupo en el que se va a evaluar la fórmula de escalado automático.
- auto_scale_formula
- str
La fórmula se valida y sus resultados se calculan, pero no se aplica al grupo. Para aplicar la fórmula al grupo, "Habilitar el escalado automático en un grupo". 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/en-us/documentation/articles/batch-automatic-scaling).
- pool_evaluate_auto_scale_options
- PoolEvaluateAutoScaleOptions
Parámetros adicionales para la operación
- raw
- bool
devuelve la respuesta directa junto con la respuesta deserializada.
- operation_config
Invalidaciones de configuración de la operación.
Devoluciones
AutoScaleRun o ClientRawResponse si raw=true
Tipo de valor devuelto
Excepciones
exists
Obtiene las propiedades básicas de un grupo.
exists(pool_id, pool_exists_options=None, custom_headers=None, raw=False, **operation_config)Parámetros
- pool_exists_options
- PoolExistsOptions
Parámetros adicionales para la operación
- raw
- bool
devuelve la respuesta directa junto con la respuesta deserializada.
- operation_config
Invalidaciones de configuración de la operación.
Devoluciones
bool o ClientRawResponse si raw=true
Tipo de valor devuelto
Excepciones
get
Obtiene información sobre el grupo especificado.
get(pool_id, pool_get_options=None, custom_headers=None, raw=False, **operation_config)Parámetros
- raw
- bool
devuelve la respuesta directa junto con la respuesta deserializada.
- operation_config
Invalidaciones de configuración de la operación.
Devoluciones
CloudPool o ClientRawResponse si raw=true
Tipo de valor devuelto
Excepciones
list
Enumera todos los grupos de la cuenta especificada.
list(pool_list_options=None, custom_headers=None, raw=False, **operation_config)Parámetros
- pool_list_options
- PoolListOptions
Parámetros adicionales para la operación
- raw
- bool
devuelve la respuesta directa junto con la respuesta deserializada.
- operation_config
Invalidaciones de configuración de la operación.
Devoluciones
Iterador como una instancia de CloudPool
Tipo de valor devuelto
Excepciones
list_usage_metrics
Enumera las métricas de uso, agregadas por Grupo en intervalos de tiempo individuales, para la cuenta especificada.
Si no especifica una cláusula de $filter, incluido un poolId, la respuesta incluye todos los grupos que existían en la cuenta en el intervalo de tiempo de los intervalos de agregación devueltos. Si no especifica una cláusula $filter que incluya un valor startTime o endTime, estos filtros tienen como valor predeterminado las horas de inicio y finalización del último intervalo de agregación disponible actualmente; es decir, solo se devuelve el último intervalo de agregación.
list_usage_metrics(pool_list_usage_metrics_options=None, custom_headers=None, raw=False, **operation_config)Parámetros
- pool_list_usage_metrics_options
- PoolListUsageMetricsOptions
Parámetros adicionales para la operación
- raw
- bool
devuelve la respuesta directa junto con la respuesta deserializada.
- operation_config
Invalidaciones de configuración de la operación.
Devoluciones
Iterador como una instancia de PoolUsageMetrics
Tipo de valor devuelto
Excepciones
patch
Novedades las propiedades del grupo especificado.
Esto solo reemplaza las propiedades del grupo especificadas en la solicitud. Por ejemplo, si el grupo tiene un objeto StartTask asociado a él y una solicitud no especifica un elemento StartTask, el Grupo mantiene las StartTask existentes.
patch(pool_id, pool_patch_parameter, pool_patch_options=None, custom_headers=None, raw=False, **operation_config)Parámetros
- pool_patch_options
- PoolPatchOptions
Parámetros adicionales para la operación
- raw
- bool
devuelve la respuesta directa junto con la respuesta deserializada.
- operation_config
Invalidaciones de configuración de la operación.
Devoluciones
Ninguno o ClientRawResponse si raw=true
Tipo de valor devuelto
Excepciones
remove_nodes
Quita los nodos de proceso del grupo especificado.
Esta operación solo se puede ejecutar cuando el estado de asignación del grupo es estable. Cuando se ejecuta esta operación, el estado de asignación cambia de constante a cambio de tamaño. Cada solicitud puede quitar hasta 100 nodos.
remove_nodes(pool_id, node_remove_parameter, pool_remove_nodes_options=None, custom_headers=None, raw=False, **operation_config)Parámetros
- pool_remove_nodes_options
- PoolRemoveNodesOptions
Parámetros adicionales para la operación
- raw
- bool
devuelve la respuesta directa junto con la respuesta deserializada.
- operation_config
Invalidaciones de configuración de la operación.
Devoluciones
Ninguno o ClientRawResponse si raw=true
Tipo de valor devuelto
Excepciones
resize
Cambia el número de nodos de proceso asignados a un grupo.
Solo puede cambiar el tamaño de un grupo cuando su estado de asignación es estable. Si el grupo ya cambia el tamaño, se produce un error en la solicitud con el código de estado 409. Al cambiar el tamaño de un grupo, el estado de asignación del grupo cambia de estable a cambio de tamaño. No se puede cambiar el tamaño de los grupos configurados para el escalado automático. Si intenta hacerlo, el servicio Batch devuelve un error 409. Si cambia el tamaño de un grupo hacia abajo, el servicio Batch elige los nodos de proceso que se van a quitar. Para quitar nodos de proceso específicos, use la API De eliminación de nodos de proceso en su lugar.
resize(pool_id, pool_resize_parameter, pool_resize_options=None, custom_headers=None, raw=False, **operation_config)Parámetros
- pool_resize_options
- PoolResizeOptions
Parámetros adicionales para la operación
- raw
- bool
devuelve la respuesta directa junto con la respuesta deserializada.
- operation_config
Invalidaciones de configuración de la operación.
Devoluciones
Ninguno o ClientRawResponse si raw=true
Tipo de valor devuelto
Excepciones
stop_resize
Detiene una operación de cambio de tamaño en curso en el grupo.
Esto no restaura el grupo a su estado anterior antes de la operación de cambio de tamaño: solo detiene los cambios adicionales que se realizan y el grupo mantiene su estado actual. Después de la detención, el grupo se estabiliza en el número de nodos de proceso en los que se encontraba cuando se realizó la operación de detención. Durante la operación de detención, el estado de asignación del grupo cambia primero a detener y luego a estable. Una operación de cambio de tamaño no debe ser una solicitud de grupo de cambio de tamaño explícita; Esta API también se puede usar para detener el tamaño inicial del grupo cuando se crea.
stop_resize(pool_id, pool_stop_resize_options=None, custom_headers=None, raw=False, **operation_config)Parámetros
- pool_stop_resize_options
- PoolStopResizeOptions
Parámetros adicionales para la operación
- raw
- bool
devuelve la respuesta directa junto con la respuesta deserializada.
- operation_config
Invalidaciones de configuración de la operación.
Devoluciones
Ninguno o ClientRawResponse si raw=true
Tipo de valor devuelto
Excepciones
update_properties
Novedades las propiedades del grupo especificado.
Esto reemplaza completamente todas las propiedades actualizables del grupo. Por ejemplo, si el grupo tiene una clase StartTask asociada y si StartTask no se especifica con esta solicitud, el servicio Batch quitará el objeto StartTask existente.
update_properties(pool_id, pool_update_properties_parameter, pool_update_properties_options=None, custom_headers=None, raw=False, **operation_config)Parámetros
- pool_update_properties_parameter
- PoolUpdatePropertiesParameter
Parámetros de la solicitud.
- pool_update_properties_options
- PoolUpdatePropertiesOptions
Parámetros adicionales para la operación
- raw
- bool
devuelve la respuesta directa junto con la respuesta deserializada.
- operation_config
Invalidaciones de configuración de la operación.
Devoluciones
Ninguno o ClientRawResponse si raw=true
Tipo de valor devuelto
Excepciones
Atributos
models
models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\batch\\models\\__init__.py'>
Azure SDK for Python