Compartir a través de


Pool class

Clase que representa un grupo.

Constructores

Pool(BatchServiceClientContext)

Cree un grupo.

Métodos

add(PoolAddParameter, PoolAddOptionalParams)

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 accesibles para los ingenieros de soporte técnico de Microsoft.

add(PoolAddParameter, PoolAddOptionalParams, ServiceCallback<void>)
add(PoolAddParameter, ServiceCallback<void>)
deleteMethod(string, PoolDeleteMethodOptionalParams)

Al solicitar que se elimine un grupo, se producen las siguientes acciones: el estado del grupo se establece en eliminar; cualquier operación de cambio de tamaño en curso en el grupo se detiene; El servicio Batch comienza a cambiar el tamaño del grupo a cero nodos de proceso; las tareas que se ejecutan en nodos de proceso 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 requeue, debe llamar al tamaño del grupo explícitamente para reducir el tamaño del grupo a 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.

deleteMethod(string, PoolDeleteMethodOptionalParams, ServiceCallback<void>)
deleteMethod(string, ServiceCallback<void>)
disableAutoScale(string, PoolDisableAutoScaleOptionalParams)
disableAutoScale(string, PoolDisableAutoScaleOptionalParams, ServiceCallback<void>)
disableAutoScale(string, ServiceCallback<void>)
enableAutoScale(string, PoolEnableAutoScaleParameter, PoolEnableAutoScaleOptionalParams)

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 escalado automático 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 puede llamar a esta API para el mismo grupo más de una vez cada 30 segundos.

enableAutoScale(string, PoolEnableAutoScaleParameter, PoolEnableAutoScaleOptionalParams, ServiceCallback<void>)
enableAutoScale(string, PoolEnableAutoScaleParameter, ServiceCallback<void>)
evaluateAutoScale(string, string, PoolEvaluateAutoScaleOptionalParams)

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.

evaluateAutoScale(string, string, PoolEvaluateAutoScaleOptionalParams, ServiceCallback<AutoScaleRun>)
evaluateAutoScale(string, string, ServiceCallback<AutoScaleRun>)
exists(string, PoolExistsOptionalParams)

Obtiene las propiedades básicas de un grupo.

exists(string, PoolExistsOptionalParams, ServiceCallback<boolean>)
exists(string, ServiceCallback<boolean>)
get(string, PoolGetOptionalParams)

Obtiene información sobre el grupo especificado.

get(string, PoolGetOptionalParams, ServiceCallback<CloudPool>)
get(string, ServiceCallback<CloudPool>)
getAllLifetimeStatistics(PoolGetAllLifetimeStatisticsOptionalParams)

Las estadísticas se agregan en todos los grupos que han existido en la cuenta, desde la creación de la cuenta hasta la última hora de actualización de las estadísticas. 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.

getAllLifetimeStatistics(PoolGetAllLifetimeStatisticsOptionalParams, ServiceCallback<PoolStatistics>)
getAllLifetimeStatistics(ServiceCallback<PoolStatistics>)
list(PoolListOptionalParams)
list(PoolListOptionalParams, ServiceCallback<CloudPoolListResult>)
list(ServiceCallback<CloudPoolListResult>)
listNext(string, PoolListNextOptionalParams)
listNext(string, PoolListNextOptionalParams, ServiceCallback<CloudPoolListResult>)
listNext(string, ServiceCallback<CloudPoolListResult>)
listUsageMetrics(PoolListUsageMetricsOptionalParams)

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, incluida una 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.

listUsageMetrics(PoolListUsageMetricsOptionalParams, ServiceCallback<PoolListUsageMetricsResult>)
listUsageMetrics(ServiceCallback<PoolListUsageMetricsResult>)
listUsageMetricsNext(string, PoolListUsageMetricsNextOptionalParams)

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, incluida una 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.

listUsageMetricsNext(string, PoolListUsageMetricsNextOptionalParams, ServiceCallback<PoolListUsageMetricsResult>)
listUsageMetricsNext(string, ServiceCallback<PoolListUsageMetricsResult>)
patch(string, PoolPatchParameter, PoolPatchOptionalParams)

Esto solo reemplaza las propiedades del grupo especificadas en la solicitud. Por ejemplo, si el grupo tiene un startTask asociado a él y una solicitud no especifica un elemento StartTask, el grupo mantiene el StartTask existente.

patch(string, PoolPatchParameter, PoolPatchOptionalParams, ServiceCallback<void>)
patch(string, PoolPatchParameter, ServiceCallback<void>)
removeNodes(string, NodeRemoveParameter, PoolRemoveNodesOptionalParams)

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.

removeNodes(string, NodeRemoveParameter, PoolRemoveNodesOptionalParams, ServiceCallback<void>)
removeNodes(string, NodeRemoveParameter, ServiceCallback<void>)
resize(string, PoolResizeParameter, PoolResizeOptionalParams)

Solo puede cambiar el tamaño de un grupo cuando su estado de asignación sea 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 constante 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 qué nodos de proceso se van a quitar. Para quitar nodos de proceso específicos, use la API de quitar nodos de proceso en su lugar.

resize(string, PoolResizeParameter, PoolResizeOptionalParams, ServiceCallback<void>)
resize(string, PoolResizeParameter, ServiceCallback<void>)
stopResize(string, PoolStopResizeOptionalParams)

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 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, a continuación, a constante. 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.

stopResize(string, PoolStopResizeOptionalParams, ServiceCallback<void>)
stopResize(string, ServiceCallback<void>)
updateProperties(string, PoolUpdatePropertiesParameter, PoolUpdatePropertiesOptionalParams)

Esto reemplaza por completo todas las propiedades actualizables del grupo. Por ejemplo, si el grupo tiene un StartTask asociado a él y si StartTask no se especifica con esta solicitud, el servicio Batch quitará el startTask existente.

updateProperties(string, PoolUpdatePropertiesParameter, PoolUpdatePropertiesOptionalParams, ServiceCallback<void>)
updateProperties(string, PoolUpdatePropertiesParameter, ServiceCallback<void>)

Detalles del constructor

Pool(BatchServiceClientContext)

Cree un grupo.

new Pool(client: BatchServiceClientContext)

Parámetros

client
BatchServiceClientContext

Referencia al cliente de servicio.

Detalles del método

add(PoolAddParameter, PoolAddOptionalParams)

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 accesibles para los ingenieros de soporte técnico de Microsoft.

function add(pool: PoolAddParameter, options?: PoolAddOptionalParams): Promise<PoolAddResponse>

Parámetros

pool
PoolAddParameter

Grupo que se va a agregar.

options
PoolAddOptionalParams

Los parámetros opcionales

Devoluciones

Promise<PoolAddResponse>

Modelos de promesas.PoolAddResponse<>

add(PoolAddParameter, PoolAddOptionalParams, ServiceCallback<void>)

function add(pool: PoolAddParameter, options: PoolAddOptionalParams, callback: ServiceCallback<void>)

Parámetros

pool
PoolAddParameter

Grupo que se va a agregar.

options
PoolAddOptionalParams

Los parámetros opcionales

callback

ServiceCallback<void>

Devolución de llamada

add(PoolAddParameter, ServiceCallback<void>)

function add(pool: PoolAddParameter, callback: ServiceCallback<void>)

Parámetros

pool
PoolAddParameter

Grupo que se va a agregar.

callback

ServiceCallback<void>

Devolución de llamada

deleteMethod(string, PoolDeleteMethodOptionalParams)

Al solicitar que se elimine un grupo, se producen las siguientes acciones: el estado del grupo se establece en eliminar; cualquier operación de cambio de tamaño en curso en el grupo se detiene; El servicio Batch comienza a cambiar el tamaño del grupo a cero nodos de proceso; las tareas que se ejecutan en nodos de proceso 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 requeue, debe llamar al tamaño del grupo explícitamente para reducir el tamaño del grupo a 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.

function deleteMethod(poolId: string, options?: PoolDeleteMethodOptionalParams): Promise<PoolDeleteResponse>

Parámetros

poolId

string

Identificador del grupo que se va a eliminar.

options
PoolDeleteMethodOptionalParams

Los parámetros opcionales

Devoluciones

Promise<Models.PoolDeleteResponse>

deleteMethod(string, PoolDeleteMethodOptionalParams, ServiceCallback<void>)

function deleteMethod(poolId: string, options: PoolDeleteMethodOptionalParams, callback: ServiceCallback<void>)

Parámetros

poolId

string

Identificador del grupo que se va a eliminar.

options
PoolDeleteMethodOptionalParams

Los parámetros opcionales

callback

ServiceCallback<void>

Devolución de llamada

deleteMethod(string, ServiceCallback<void>)

function deleteMethod(poolId: string, callback: ServiceCallback<void>)

Parámetros

poolId

string

Identificador del grupo que se va a eliminar.

callback

ServiceCallback<void>

Devolución de llamada

disableAutoScale(string, PoolDisableAutoScaleOptionalParams)

function disableAutoScale(poolId: string, options?: PoolDisableAutoScaleOptionalParams): Promise<PoolDisableAutoScaleResponse>

Parámetros

poolId

string

Identificador del grupo en el que se va a deshabilitar el escalado automático.

options
PoolDisableAutoScaleOptionalParams

Los parámetros opcionales

Devoluciones

Promise<Models.PoolDisableAutoScaleResponse>

disableAutoScale(string, PoolDisableAutoScaleOptionalParams, ServiceCallback<void>)

function disableAutoScale(poolId: string, options: PoolDisableAutoScaleOptionalParams, callback: ServiceCallback<void>)

Parámetros

poolId

string

Identificador del grupo en el que se va a deshabilitar el escalado automático.

options
PoolDisableAutoScaleOptionalParams

Los parámetros opcionales

callback

ServiceCallback<void>

Devolución de llamada

disableAutoScale(string, ServiceCallback<void>)

function disableAutoScale(poolId: string, callback: ServiceCallback<void>)

Parámetros

poolId

string

Identificador del grupo en el que se va a deshabilitar el escalado automático.

callback

ServiceCallback<void>

Devolución de llamada

enableAutoScale(string, PoolEnableAutoScaleParameter, PoolEnableAutoScaleOptionalParams)

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 escalado automático 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 puede llamar a esta API para el mismo grupo más de una vez cada 30 segundos.

function enableAutoScale(poolId: string, poolEnableAutoScaleParameter: PoolEnableAutoScaleParameter, options?: PoolEnableAutoScaleOptionalParams): Promise<PoolEnableAutoScaleResponse>

Parámetros

poolId

string

Identificador del grupo en el que se va a habilitar el escalado automático.

poolEnableAutoScaleParameter
PoolEnableAutoScaleParameter

Parámetros de la solicitud.

options
PoolEnableAutoScaleOptionalParams

Los parámetros opcionales

Devoluciones

Promise<Models.PoolEnableAutoScaleResponse>

enableAutoScale(string, PoolEnableAutoScaleParameter, PoolEnableAutoScaleOptionalParams, ServiceCallback<void>)

function enableAutoScale(poolId: string, poolEnableAutoScaleParameter: PoolEnableAutoScaleParameter, options: PoolEnableAutoScaleOptionalParams, callback: ServiceCallback<void>)

Parámetros

poolId

string

Identificador del grupo en el que se va a habilitar el escalado automático.

poolEnableAutoScaleParameter
PoolEnableAutoScaleParameter

Parámetros de la solicitud.

options
PoolEnableAutoScaleOptionalParams

Los parámetros opcionales

callback

ServiceCallback<void>

Devolución de llamada

enableAutoScale(string, PoolEnableAutoScaleParameter, ServiceCallback<void>)

function enableAutoScale(poolId: string, poolEnableAutoScaleParameter: PoolEnableAutoScaleParameter, callback: ServiceCallback<void>)

Parámetros

poolId

string

Identificador del grupo en el que se va a habilitar el escalado automático.

poolEnableAutoScaleParameter
PoolEnableAutoScaleParameter

Parámetros de la solicitud.

callback

ServiceCallback<void>

Devolución de llamada

evaluateAutoScale(string, string, PoolEvaluateAutoScaleOptionalParams)

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.

function evaluateAutoScale(poolId: string, autoScaleFormula: string, options?: PoolEvaluateAutoScaleOptionalParams): Promise<PoolEvaluateAutoScaleResponse>

Parámetros

poolId

string

Identificador del grupo en el que se va a evaluar la fórmula de escalado automático.

autoScaleFormula

string

Fórmula para el número deseado de nodos de proceso en el grupo. 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 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).

options
PoolEvaluateAutoScaleOptionalParams

Los parámetros opcionales

Devoluciones

Promise<Models.PoolEvaluateAutoScaleResponse>

evaluateAutoScale(string, string, PoolEvaluateAutoScaleOptionalParams, ServiceCallback<AutoScaleRun>)

function evaluateAutoScale(poolId: string, autoScaleFormula: string, options: PoolEvaluateAutoScaleOptionalParams, callback: ServiceCallback<AutoScaleRun>)

Parámetros

poolId

string

Identificador del grupo en el que se va a evaluar la fórmula de escalado automático.

autoScaleFormula

string

Fórmula para el número deseado de nodos de proceso en el grupo. 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 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).

options
PoolEvaluateAutoScaleOptionalParams

Los parámetros opcionales

callback

ServiceCallback<AutoScaleRun>

Devolución de llamada

evaluateAutoScale(string, string, ServiceCallback<AutoScaleRun>)

function evaluateAutoScale(poolId: string, autoScaleFormula: string, callback: ServiceCallback<AutoScaleRun>)

Parámetros

poolId

string

Identificador del grupo en el que se va a evaluar la fórmula de escalado automático.

autoScaleFormula

string

Fórmula para el número deseado de nodos de proceso en el grupo. 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 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).

callback

ServiceCallback<AutoScaleRun>

Devolución de llamada

exists(string, PoolExistsOptionalParams)

Obtiene las propiedades básicas de un grupo.

function exists(poolId: string, options?: PoolExistsOptionalParams): Promise<PoolExistsResponse>

Parámetros

poolId

string

Identificador del grupo que se va a obtener.

options
PoolExistsOptionalParams

Los parámetros opcionales

Devoluciones

Modelos de promesas.PoolExistsResponse<>

exists(string, PoolExistsOptionalParams, ServiceCallback<boolean>)

function exists(poolId: string, options: PoolExistsOptionalParams, callback: ServiceCallback<boolean>)

Parámetros

poolId

string

Identificador del grupo que se va a obtener.

options
PoolExistsOptionalParams

Los parámetros opcionales

callback

ServiceCallback<boolean>

Devolución de llamada

exists(string, ServiceCallback<boolean>)

function exists(poolId: string, callback: ServiceCallback<boolean>)

Parámetros

poolId

string

Identificador del grupo que se va a obtener.

callback

ServiceCallback<boolean>

Devolución de llamada

get(string, PoolGetOptionalParams)

Obtiene información sobre el grupo especificado.

function get(poolId: string, options?: PoolGetOptionalParams): Promise<PoolGetResponse>

Parámetros

poolId

string

Identificador del grupo que se va a obtener.

options
PoolGetOptionalParams

Los parámetros opcionales

Devoluciones

Promise<PoolGetResponse>

< Promise>Models.PoolGetResponse

get(string, PoolGetOptionalParams, ServiceCallback<CloudPool>)

function get(poolId: string, options: PoolGetOptionalParams, callback: ServiceCallback<CloudPool>)

Parámetros

poolId

string

Identificador del grupo que se va a obtener.

options
PoolGetOptionalParams

Los parámetros opcionales

callback

ServiceCallback<CloudPool>

Devolución de llamada

get(string, ServiceCallback<CloudPool>)

function get(poolId: string, callback: ServiceCallback<CloudPool>)

Parámetros

poolId

string

Identificador del grupo que se va a obtener.

callback

ServiceCallback<CloudPool>

Devolución de llamada

getAllLifetimeStatistics(PoolGetAllLifetimeStatisticsOptionalParams)

Las estadísticas se agregan en todos los grupos que han existido en la cuenta, desde la creación de la cuenta hasta la última hora de actualización de las estadísticas. 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.

function getAllLifetimeStatistics(options?: PoolGetAllLifetimeStatisticsOptionalParams): Promise<PoolGetAllLifetimeStatisticsResponse>

Parámetros

options
PoolGetAllLifetimeStatisticsOptionalParams

Los parámetros opcionales

Devoluciones

Promise<Models.PoolGetAllLifetimeStatisticsResponse>

getAllLifetimeStatistics(PoolGetAllLifetimeStatisticsOptionalParams, ServiceCallback<PoolStatistics>)

function getAllLifetimeStatistics(options: PoolGetAllLifetimeStatisticsOptionalParams, callback: ServiceCallback<PoolStatistics>)

Parámetros

options
PoolGetAllLifetimeStatisticsOptionalParams

Los parámetros opcionales

callback

ServiceCallback<PoolStatistics>

Devolución de llamada

getAllLifetimeStatistics(ServiceCallback<PoolStatistics>)

function getAllLifetimeStatistics(callback: ServiceCallback<PoolStatistics>)

Parámetros

callback

ServiceCallback<PoolStatistics>

Devolución de llamada

list(PoolListOptionalParams)

function list(options?: PoolListOptionalParams): Promise<PoolListResponse>

Parámetros

options
PoolListOptionalParams

Los parámetros opcionales

Devoluciones

Promise<PoolListResponse>

< Promise>Models.PoolListResponse

list(PoolListOptionalParams, ServiceCallback<CloudPoolListResult>)

function list(options: PoolListOptionalParams, callback: ServiceCallback<CloudPoolListResult>)

Parámetros

options
PoolListOptionalParams

Los parámetros opcionales

callback

ServiceCallback<CloudPoolListResult>

Devolución de llamada

list(ServiceCallback<CloudPoolListResult>)

function list(callback: ServiceCallback<CloudPoolListResult>)

Parámetros

callback

ServiceCallback<CloudPoolListResult>

Devolución de llamada

listNext(string, PoolListNextOptionalParams)

function listNext(nextPageLink: string, options?: PoolListNextOptionalParams): Promise<PoolListResponse>

Parámetros

nextPageLink

string

NextLink de la llamada correcta anterior a la operación List.

options
PoolListNextOptionalParams

Los parámetros opcionales

Devoluciones

Promise<PoolListResponse>

< Promise>Models.PoolListResponse

listNext(string, PoolListNextOptionalParams, ServiceCallback<CloudPoolListResult>)

function listNext(nextPageLink: string, options: PoolListNextOptionalParams, callback: ServiceCallback<CloudPoolListResult>)

Parámetros

nextPageLink

string

NextLink de la llamada correcta anterior a la operación List.

options
PoolListNextOptionalParams

Los parámetros opcionales

callback

ServiceCallback<CloudPoolListResult>

Devolución de llamada

listNext(string, ServiceCallback<CloudPoolListResult>)

function listNext(nextPageLink: string, callback: ServiceCallback<CloudPoolListResult>)

Parámetros

nextPageLink

string

NextLink de la llamada correcta anterior a la operación List.

callback

ServiceCallback<CloudPoolListResult>

Devolución de llamada

listUsageMetrics(PoolListUsageMetricsOptionalParams)

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, incluida una 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.

function listUsageMetrics(options?: PoolListUsageMetricsOptionalParams): Promise<PoolListUsageMetricsResponse>

Parámetros

options
PoolListUsageMetricsOptionalParams

Los parámetros opcionales

Devoluciones

Promise<Models.PoolListUsageMetricsResponse>

listUsageMetrics(PoolListUsageMetricsOptionalParams, ServiceCallback<PoolListUsageMetricsResult>)

function listUsageMetrics(options: PoolListUsageMetricsOptionalParams, callback: ServiceCallback<PoolListUsageMetricsResult>)

Parámetros

options
PoolListUsageMetricsOptionalParams

Los parámetros opcionales

callback

ServiceCallback<PoolListUsageMetricsResult>

Devolución de llamada

listUsageMetrics(ServiceCallback<PoolListUsageMetricsResult>)

function listUsageMetrics(callback: ServiceCallback<PoolListUsageMetricsResult>)

Parámetros

callback

ServiceCallback<PoolListUsageMetricsResult>

Devolución de llamada

listUsageMetricsNext(string, PoolListUsageMetricsNextOptionalParams)

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, incluida una 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.

function listUsageMetricsNext(nextPageLink: string, options?: PoolListUsageMetricsNextOptionalParams): Promise<PoolListUsageMetricsResponse>

Parámetros

nextPageLink

string

NextLink de la llamada correcta anterior a la operación List.

options
PoolListUsageMetricsNextOptionalParams

Los parámetros opcionales

Devoluciones

Promise<Models.PoolListUsageMetricsResponse>

listUsageMetricsNext(string, PoolListUsageMetricsNextOptionalParams, ServiceCallback<PoolListUsageMetricsResult>)

function listUsageMetricsNext(nextPageLink: string, options: PoolListUsageMetricsNextOptionalParams, callback: ServiceCallback<PoolListUsageMetricsResult>)

Parámetros

nextPageLink

string

NextLink de la llamada correcta anterior a la operación List.

options
PoolListUsageMetricsNextOptionalParams

Los parámetros opcionales

callback

ServiceCallback<PoolListUsageMetricsResult>

Devolución de llamada

listUsageMetricsNext(string, ServiceCallback<PoolListUsageMetricsResult>)

function listUsageMetricsNext(nextPageLink: string, callback: ServiceCallback<PoolListUsageMetricsResult>)

Parámetros

nextPageLink

string

NextLink de la llamada correcta anterior a la operación List.

callback

ServiceCallback<PoolListUsageMetricsResult>

Devolución de llamada

patch(string, PoolPatchParameter, PoolPatchOptionalParams)

Esto solo reemplaza las propiedades del grupo especificadas en la solicitud. Por ejemplo, si el grupo tiene un startTask asociado a él y una solicitud no especifica un elemento StartTask, el grupo mantiene el StartTask existente.

function patch(poolId: string, poolPatchParameter: PoolPatchParameter, options?: PoolPatchOptionalParams): Promise<PoolPatchResponse>

Parámetros

poolId

string

Identificador del grupo que se va a actualizar.

poolPatchParameter
PoolPatchParameter

Parámetros de la solicitud.

options
PoolPatchOptionalParams

Los parámetros opcionales

Devoluciones

< Promise>Models.PoolPatchResponse

patch(string, PoolPatchParameter, PoolPatchOptionalParams, ServiceCallback<void>)

function patch(poolId: string, poolPatchParameter: PoolPatchParameter, options: PoolPatchOptionalParams, callback: ServiceCallback<void>)

Parámetros

poolId

string

Identificador del grupo que se va a actualizar.

poolPatchParameter
PoolPatchParameter

Parámetros de la solicitud.

options
PoolPatchOptionalParams

Los parámetros opcionales

callback

ServiceCallback<void>

Devolución de llamada

patch(string, PoolPatchParameter, ServiceCallback<void>)

function patch(poolId: string, poolPatchParameter: PoolPatchParameter, callback: ServiceCallback<void>)

Parámetros

poolId

string

Identificador del grupo que se va a actualizar.

poolPatchParameter
PoolPatchParameter

Parámetros de la solicitud.

callback

ServiceCallback<void>

Devolución de llamada

removeNodes(string, NodeRemoveParameter, PoolRemoveNodesOptionalParams)

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.

function removeNodes(poolId: string, nodeRemoveParameter: NodeRemoveParameter, options?: PoolRemoveNodesOptionalParams): Promise<PoolRemoveNodesResponse>

Parámetros

poolId

string

Identificador del grupo del que desea quitar nodos de proceso.

nodeRemoveParameter
NodeRemoveParameter

Parámetros de la solicitud.

options
PoolRemoveNodesOptionalParams

Los parámetros opcionales

Devoluciones

Promise<Models.PoolRemoveNodesResponse>

removeNodes(string, NodeRemoveParameter, PoolRemoveNodesOptionalParams, ServiceCallback<void>)

function removeNodes(poolId: string, nodeRemoveParameter: NodeRemoveParameter, options: PoolRemoveNodesOptionalParams, callback: ServiceCallback<void>)

Parámetros

poolId

string

Identificador del grupo del que desea quitar nodos de proceso.

nodeRemoveParameter
NodeRemoveParameter

Parámetros de la solicitud.

options
PoolRemoveNodesOptionalParams

Los parámetros opcionales

callback

ServiceCallback<void>

Devolución de llamada

removeNodes(string, NodeRemoveParameter, ServiceCallback<void>)

function removeNodes(poolId: string, nodeRemoveParameter: NodeRemoveParameter, callback: ServiceCallback<void>)

Parámetros

poolId

string

Identificador del grupo del que desea quitar nodos de proceso.

nodeRemoveParameter
NodeRemoveParameter

Parámetros de la solicitud.

callback

ServiceCallback<void>

Devolución de llamada

resize(string, PoolResizeParameter, PoolResizeOptionalParams)

Solo puede cambiar el tamaño de un grupo cuando su estado de asignación sea 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 constante 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 qué nodos de proceso se van a quitar. Para quitar nodos de proceso específicos, use la API de quitar nodos de proceso en su lugar.

function resize(poolId: string, poolResizeParameter: PoolResizeParameter, options?: PoolResizeOptionalParams): Promise<PoolResizeResponse>

Parámetros

poolId

string

Identificador del grupo que se va a cambiar de tamaño.

poolResizeParameter
PoolResizeParameter

Parámetros de la solicitud.

options
PoolResizeOptionalParams

Los parámetros opcionales

Devoluciones

Modelos de promesas.PoolResizeResponse<>

resize(string, PoolResizeParameter, PoolResizeOptionalParams, ServiceCallback<void>)

function resize(poolId: string, poolResizeParameter: PoolResizeParameter, options: PoolResizeOptionalParams, callback: ServiceCallback<void>)

Parámetros

poolId

string

Identificador del grupo que se va a cambiar de tamaño.

poolResizeParameter
PoolResizeParameter

Parámetros de la solicitud.

options
PoolResizeOptionalParams

Los parámetros opcionales

callback

ServiceCallback<void>

Devolución de llamada

resize(string, PoolResizeParameter, ServiceCallback<void>)

function resize(poolId: string, poolResizeParameter: PoolResizeParameter, callback: ServiceCallback<void>)

Parámetros

poolId

string

Identificador del grupo que se va a cambiar de tamaño.

poolResizeParameter
PoolResizeParameter

Parámetros de la solicitud.

callback

ServiceCallback<void>

Devolución de llamada

stopResize(string, PoolStopResizeOptionalParams)

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 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, a continuación, a constante. 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.

function stopResize(poolId: string, options?: PoolStopResizeOptionalParams): Promise<PoolStopResizeResponse>

Parámetros

poolId

string

Identificador del grupo cuyo cambio de tamaño desea detener.

options
PoolStopResizeOptionalParams

Los parámetros opcionales

Devoluciones

Promise<Models.PoolStopResizeResponse>

stopResize(string, PoolStopResizeOptionalParams, ServiceCallback<void>)

function stopResize(poolId: string, options: PoolStopResizeOptionalParams, callback: ServiceCallback<void>)

Parámetros

poolId

string

Identificador del grupo cuyo cambio de tamaño desea detener.

options
PoolStopResizeOptionalParams

Los parámetros opcionales

callback

ServiceCallback<void>

Devolución de llamada

stopResize(string, ServiceCallback<void>)

function stopResize(poolId: string, callback: ServiceCallback<void>)

Parámetros

poolId

string

Identificador del grupo cuyo cambio de tamaño desea detener.

callback

ServiceCallback<void>

Devolución de llamada

updateProperties(string, PoolUpdatePropertiesParameter, PoolUpdatePropertiesOptionalParams)

Esto reemplaza por completo todas las propiedades actualizables del grupo. Por ejemplo, si el grupo tiene un StartTask asociado a él y si StartTask no se especifica con esta solicitud, el servicio Batch quitará el startTask existente.

function updateProperties(poolId: string, poolUpdatePropertiesParameter: PoolUpdatePropertiesParameter, options?: PoolUpdatePropertiesOptionalParams): Promise<PoolUpdatePropertiesResponse>

Parámetros

poolId

string

Identificador del grupo que se va a actualizar.

poolUpdatePropertiesParameter
PoolUpdatePropertiesParameter

Parámetros de la solicitud.

options
PoolUpdatePropertiesOptionalParams

Los parámetros opcionales

Devoluciones

Promise<Models.PoolUpdatePropertiesResponse>

updateProperties(string, PoolUpdatePropertiesParameter, PoolUpdatePropertiesOptionalParams, ServiceCallback<void>)

function updateProperties(poolId: string, poolUpdatePropertiesParameter: PoolUpdatePropertiesParameter, options: PoolUpdatePropertiesOptionalParams, callback: ServiceCallback<void>)

Parámetros

poolId

string

Identificador del grupo que se va a actualizar.

poolUpdatePropertiesParameter
PoolUpdatePropertiesParameter

Parámetros de la solicitud.

options
PoolUpdatePropertiesOptionalParams

Los parámetros opcionales

callback

ServiceCallback<void>

Devolución de llamada

updateProperties(string, PoolUpdatePropertiesParameter, ServiceCallback<void>)

function updateProperties(poolId: string, poolUpdatePropertiesParameter: PoolUpdatePropertiesParameter, callback: ServiceCallback<void>)

Parámetros

poolId

string

Identificador del grupo que se va a actualizar.

poolUpdatePropertiesParameter
PoolUpdatePropertiesParameter

Parámetros de la solicitud.

callback

ServiceCallback<void>

Devolución de llamada