BatchClient class

Clase cliente para acceder al servicio batch de Azure.

Constructores

BatchClient(string, TokenCredential | AzureNamedKeyCredential, BatchClientOptionalParams)

Métodos

createJob(BatchJobCreateOptions, CreateJobOptionalParams)	El servicio por lotes permite dos formas de controlar el trabajo realizado como parte de un trabajo. En el primer enfoque, el usuario especifica una tarea de Gestor de Trabajos. El servicio por lotes lanza esta tarea cuando está lista para iniciar el trabajo. La tarea del Gestor de Trabajos controla todas las demás tareas que se ejecutan bajo este trabajo, utilizando las APIs de tareas. En el segundo enfoque, el usuario controla directamente la ejecución de tareas bajo un trabajo activo, utilizando las APIs de tareas. También ten en cuenta: al nombrar los puestos, evita incluir información sensible como nombres de usuario o nombres secretos de proyectos. Esta información puede aparecer en registros de telemetría accesibles para los ingenieros de Soporte técnico de Microsoft.
createJobSchedule(BatchJobScheduleCreateOptions, CreateJobScheduleOptionalParams)	Crea un Horario de Trabajo para la Cuenta especificada.
createNodeUser(string, string, BatchNodeUserCreateOptions, CreateNodeUserOptionalParams)	Puedes añadir una cuenta de usuario a un Nodo de Cómputo solo cuando esté en estado inactivo o en funcionamiento. Antes de poder iniciar sesión remotamente en un Nodo de Cómputo, debes configurar puertos de acceso para SSH y RDP. Para obtener más información, consulte: https://learn.microsoft.com/azure/batch/pool-endpoint-configuration
createPool(BatchPoolCreateOptions, CreatePoolOptionalParams)	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 registros de telemetría accesibles para los ingenieros de Soporte técnico de Microsoft.
createTask(string, BatchTaskCreateOptions, CreateTaskOptionalParams)	La vida máxima de una tarea desde la suma hasta la finalización es de 180 días. Si una tarea no se completa en los 180 días posteriores a su añadido, será terminada por el servicio por lotes y dejada en el estado en el que estaba en ese momento.
createTaskCollection(string, BatchTaskGroup, CreateTaskCollectionOptionalParams)	Ten en cuenta que cada tarea debe tener un ID único. El servicio por lotes no puede devolver los resultados de cada tarea en el mismo orden en que se enviaron en esta solicitud. Si el servidor expira o la conexión se cierra durante la solicitud, la solicitud puede haberse procesado parcial o totalmente, o no haberse procesado en absoluto. En tales casos, el usuario debe volver a emitir la solicitud. Ten en cuenta que corresponde al usuario gestionar correctamente los fallos al volver a emitir una solicitud. Por ejemplo, deberías usar los mismos IDs de tarea durante un reintento para que, si la operación anterior tuvo éxito, el reintento no genere tareas adicionales inesperadamente. Si la respuesta contiene alguna Tareas que no se haya añadido, un cliente puede intentar de nuevo la solicitud. En un reintento, es más eficiente volver a enviar solo las Tareas que no se sumaron y omitir las Tareas que se añadieron con éxito en el primer intento. La vida máxima de una tarea desde la suma hasta la finalización es de 180 días. Si una tarea no se completa en los 180 días posteriores a su añadido, será terminada por el servicio por lotes y dejada en el estado en el que estaba en ese momento.
deallocateNode(string, string, DeallocateNodeOptionalParams)	Solo puede desasignar un nodo de proceso si está en estado inactivo o en ejecución.
deleteJob(string, DeleteJobOptionalParams)	Eliminar un trabajo también elimina todas las tareas que forman parte de ese trabajo, así como todas las estadísticas del puesto. Esto también anula el periodo de retención de los datos de la Tarea; es decir, si el Trabajo contiene Tareas que aún se conservan en los Nodos de Cómputo, los servicios por lotes eliminan los directorios de trabajo de esas Tareas y todo su contenido. Cuando se recibe una solicitud de Trabajo de Eliminación, el servicio Batch establece el Trabajo en estado de eliminación. Todas las operaciones de actualización en un trabajo que esté en estado de eliminación fallarán con el código de estado 409 (Conflicto), con información adicional indicando que el trabajo está siendo eliminado.
deleteJobSchedule(string, DeleteJobScheduleOptionalParams)	Al eliminar una programación de trabajos, esto también elimina todos los trabajos y tareas de esa programación. Cuando se eliminan las tareas, también se eliminan todos los archivos de sus directorios de trabajo en los nodos de proceso (se omite el período de retención). Las estadísticas de programación de trabajos ya no son accesibles una vez eliminada la programación de trabajos, aunque todavía se cuentan para las estadísticas de duración de la cuenta.
deleteNodeFile(string, string, string, DeleteNodeFileOptionalParams)	Elimina el archivo especificado del nodo de proceso.
deleteNodeUser(string, string, string, DeleteNodeUserOptionalParams)	Puede eliminar una cuenta de usuario en un nodo de proceso solo cuando se encuentra en estado inactivo o en ejecución. Antes de poder iniciar sesión remotamente en un Nodo de Cómputo, debes configurar puertos de acceso para SSH y RDP. Para obtener más información, consulte: https://learn.microsoft.com/azure/batch/pool-endpoint-configuration
deletePool(string, DeletePoolOptionalParams)	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.
deleteTask(string, string, DeleteTaskOptionalParams)	Cuando se elimina una tarea, todos los archivos de su directorio en el nodo de proceso donde se ejecutó también se eliminan (independientemente del tiempo de retención). En el caso de las tareas de varias instancias, la operación eliminar tarea se aplica sincrónicamente a la tarea principal; Las subtareas y sus archivos se eliminan de forma asincrónica en segundo plano.
deleteTaskFile(string, string, string, DeleteTaskFileOptionalParams)	Elimina el archivo de tarea especificado del nodo de proceso donde se ejecutó la tarea.
disableJob(string, BatchJobDisableOptions, DisableJobOptionalParams)	El Servicio de Lotes mueve inmediatamente el Trabajo al estado de desactivación. A continuación, el lote utiliza el parámetro disableTasks para determinar qué hacer con las Tareas del Trabajo que se están ejecutando actualmente. El Trabajo permanece en estado de desactivación hasta que se completa la operación de desactivación y todas las Tareas se han gestionado según la opción de desactivaciónTareas (disableTasks); el Trabajo pasa entonces al estado de discapacidad. No se inician nuevas tareas bajo el Trabajo hasta que vuelve a estar activo. Si intentas desactivar un Trabajo que esté en cualquier estado distinto a activo, deshabilitado o deshabilitado, la solicitud falla con el código de estado 409.
disableJobSchedule(string, DisableJobScheduleOptionalParams)	No se creará ningún nuevo trabajo hasta que se vuelva a habilitar la programación de trabajos.
disableNodeScheduling(string, string, DisableNodeSchedulingOptionalParams)	Solo puedes desactivar la planificación de tareas en un nodo de cómputo si su estado actual de programación está activado.
disablePoolAutoScale(string, DisablePoolAutoScaleOptionalParams)	Deshabilita el escalado automático de un grupo.
enableJob(string, EnableJobOptionalParams)	Cuando llamas a esta API, el servicio por lotes establece un Trabajo deshabilitado en el estado habilitador. Una vez completada esta operación, el trabajo pasa al estado activo y la programación de nuevas tareas bajo el puesto se reanuda. El servicio por lotes no permite que una tarea permanezca en estado activo más de 180 días. Por lo tanto, si activas un Trabajo que contiene Tareas activas añadidas hace más de 180 días, esas Tareas no se ejecutarán.
enableJobSchedule(string, EnableJobScheduleOptionalParams)	Habilita una programación de trabajos.
enableNodeScheduling(string, string, EnableNodeSchedulingOptionalParams)	Puedes activar la planificación de tareas en un nodo de cómputo solo si su estado actual de programación está deshabilitado
enablePoolAutoScale(string, BatchPoolEnableAutoScaleOptions, EnablePoolAutoScaleOptionalParams)	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.
evaluatePoolAutoScale(string, BatchPoolEvaluateAutoScaleOptions, EvaluatePoolAutoScaleOptionalParams)	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.
getApplication(string, GetApplicationOptionalParams)	Esta operación solo devuelve las Aplicaciones y versiones disponibles para su uso en Nodos de Cómputo; es decir, que puede usarse en una referencia de paquete. Para información de administrador sobre aplicaciones y versiones que aún no están disponibles para Compute Nodes, utilice el portal de Azure o la API del Azure Resource Manager.
getJob(string, GetJobOptionalParams)	Obtiene información sobre el puesto especificado.
getJobSchedule(string, GetJobScheduleOptionalParams)	Obtiene información sobre el horario de trabajo especificado.
getJobTaskCounts(string, GetJobTaskCountsOptionalParams)	Los recuentos de tareas proporcionan un recuento de las tareas por estado activo, en ejecución o completado de la tarea, y un recuento de tareas que se realizaron correctamente o con errores. Las tareas del estado de preparación se cuentan como en ejecución. Tenga en cuenta que es posible que los números devueltos no siempre estén actualizados. Si necesita recuentos exactos de tareas, use una consulta de lista.
getNode(string, string, GetNodeOptionalParams)	Obtiene información sobre el nodo de proceso especificado.
getNodeExtension(string, string, string, GetNodeExtensionOptionalParams)	Obtiene información sobre la Extensión de Nodo de Cómputo especificada.
getNodeFile(string, string, string, GetNodeFileOptionalParams)	Devuelve el contenido del archivo de Nodo de Cómputo especificado.
getNodeFileProperties(string, string, string, GetNodeFilePropertiesOptionalParams)	Obtiene las propiedades del archivo de nodo de proceso especificado.
getNodeRemoteLoginSettings(string, string, GetNodeRemoteLoginSettingsOptionalParams)	Antes de poder iniciar sesión remotamente en un Nodo de Computación usando la configuración remota de inicio de sesión, debes crear una cuenta de usuario en el Nodo de Computación y configurar los puertos de acceso para SSH y RDP. Para obtener más información, consulte: https://learn.microsoft.com/azure/batch/pool-endpoint-configuration
getPool(string, GetPoolOptionalParams)	Obtiene información sobre el grupo especificado.
getTask(string, string, GetTaskOptionalParams)	Para tareas multiinstancia, información como affinityId, executionInfo y nodeInfo se refiere a la tarea principal. Utiliza la API de subtareas de lista para obtener información sobre subtareas.
getTaskFile(string, string, string, GetTaskFileOptionalParams)	Devuelve el contenido del archivo de tarea especificado.
getTaskFileProperties(string, string, string, GetTaskFilePropertiesOptionalParams)	Obtiene las propiedades del archivo task especificado.
jobScheduleExists(string, JobScheduleExistsOptionalParams)	Comprueba que exista el Horario de Trabajo especificado.
listApplications(ListApplicationsOptionalParams)	Esta operación solo devuelve las Aplicaciones y versiones disponibles para su uso en Nodos de Cómputo; es decir, que puede usarse en una referencia de paquete. Para información de administrador sobre aplicaciones y versiones que aún no están disponibles para Compute Nodes, utilice el portal Azure o la API Azure Resource Manager.
listJobPreparationAndReleaseTaskStatus(string, ListJobPreparationAndReleaseTaskStatusOptionalParams)	Esta API devuelve el estado de la tarea de preparación y liberación de trabajos en todos los nodos de proceso que han ejecutado la tarea Preparación del trabajo o Liberación de trabajos. Esto incluye nodos de proceso que se han quitado del grupo. Si esta API se invoca en un trabajo que no tiene ninguna tarea de preparación o liberación de trabajos, el servicio Batch devuelve el código de estado HTTP 409 (conflicto) con un código de error de JobPreparationTaskNotSpecified.
listJobs(ListJobsOptionalParams)	Lista todos los trabajos en la cuenta especificada.
listJobSchedules(ListJobSchedulesOptionalParams)	Lista todos los horarios de trabajo en la cuenta especificada.
listJobsFromSchedule(string, ListJobsFromScheduleOptionalParams)	Lista los trabajos que se han creado bajo el calendario de trabajos especificado.
listNodeExtensions(string, string, ListNodeExtensionsOptionalParams)	Lista las extensiones de los nodos de cómputo en el conjunto especificado.
listNodeFiles(string, string, ListNodeFilesOptionalParams)	Enumera todos los archivos de los directorios de tareas en el nodo de proceso especificado.
listNodes(string, ListNodesOptionalParams)	Enumera los nodos de proceso del grupo especificado.
listPoolNodeCounts(ListPoolNodeCountsOptionalParams)	Obtiene el número de nodos de proceso en cada estado, agrupados por grupo. Tenga en cuenta que es posible que los números devueltos no siempre estén actualizados. Si necesita recuentos exactos de nodos, use una consulta de lista.
listPools(ListPoolsOptionalParams)	Enumera todos los grupos de la cuenta especificada.
listPoolUsageMetrics(ListPoolUsageMetricsOptionalParams)	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.
listSubTasks(string, string, ListSubTasksOptionalParams)	Si la tarea no es una tarea de varias instancias, devuelve una colección vacía.
listSupportedImages(ListSupportedImagesOptionalParams)	Enumera todas las imágenes de máquina virtual compatibles con el servicio Azure Batch.
listTaskFiles(string, string, ListTaskFilesOptionalParams)	Enumera los archivos del directorio de una tarea en su nodo de proceso.
listTasks(string, ListTasksOptionalParams)	Para tareas multiinstancia, información como affinityId, executionInfo y nodeInfo se refiere a la tarea principal. Utiliza la API de subtareas de lista para obtener información sobre subtareas.
poolExists(string, PoolExistsOptionalParams)	Obtiene propiedades básicas de un Pool.
reactivateTask(string, string, ReactivateTaskOptionalParams)	La reactivación hace que una tarea sea apta para reintentarse de nuevo hasta su recuento máximo de reintentos. El estado de la tarea se cambia a activo. Dado que la tarea ya no está en el estado completado, cualquier código de salida o información de error anterior ya no está disponible después de la reactivación. Cada vez que se reactiva una tarea, su recuento de reintentos se restablece a 0. Se producirá un error en la reactivación de las tareas que no se hayan completado o que se hayan completado correctamente (con un código de salida de 0). Además, se producirá un error si el trabajo se ha completado (o está finalizando o eliminando).
rebootNode(string, string, RebootNodeOptionalParams)	Solo puede reiniciar un nodo de proceso si está en estado inactivo o en ejecución.
reimageNode(string, string, ReimageNodeOptionalParams)	Puede reinstalar el sistema operativo en un nodo de proceso solo si está en estado inactivo o en ejecución. Esta API solo puede invocarse en pools creados con la propiedad de configuración de servicios en la nube.
removeNodes(string, BatchNodeRemoveOptions, RemoveNodesOptionalParams)	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.
replaceJob(string, BatchJob, ReplaceJobOptionalParams)	Esto reemplaza completamente todas las propiedades actualizables del Job. Por ejemplo, si el Trabajo tiene restricciones asociadas y si no se especifica restricción con esta solicitud, entonces el servicio por lotes eliminará las restricciones existentes.
replaceJobSchedule(string, BatchJobSchedule, ReplaceJobScheduleOptionalParams)	Esto reemplaza completamente todas las propiedades actualizables del Horario de Trabajos. Por ejemplo, si la propiedad de horario no se especifica con esta solicitud, el servicio por lotes eliminará el horario existente. Los cambios en un calendario de trabajos solo afectan a los trabajos creados por el horario después de que se haya realizado la actualización; los trabajos que actualmente están en funcionamiento no se ven afectados.
replaceNodeUser(string, string, string, BatchNodeUserUpdateOptions, ReplaceNodeUserOptionalParams)	Esta operación reemplaza todas las propiedades actualizables de la Cuenta. Por ejemplo, si el elemento expiryTime no se especifica, el valor actual se reemplaza por el valor por defecto, no se deja sin modificar. Puedes actualizar una cuenta de usuario en un Nodo de Cómputo solo cuando esté en estado inactivo o en funcionamiento.
replacePoolProperties(string, BatchPoolReplaceOptions, ReplacePoolPropertiesOptionalParams)	Esto reemplaza completamente todas las propiedades actualizables de la piscina. Por ejemplo, si el Pool tiene asociado un StartTask y si StartTask no está especificado con esta solicitud, entonces el servicio Batch eliminará el StartTask existente.
replaceTask(string, string, BatchTask, ReplaceTaskOptionalParams)	Actualiza las propiedades de la tarea especificada.
resizePool(string, BatchPoolResizeOptions, ResizePoolOptionalParams)	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.
startNode(string, string, StartNodeOptionalParams)	Solo puedes iniciar un Nodo de Cómputo si ha sido dislocato.
stopPoolResize(string, StopPoolResizeOptionalParams)	Esto no restaura el Pool a su estado anterior anterior a la operación de redimensionamiento: solo impide que se realicen más cambios, y el Pool mantiene su estado actual. Tras detenerse, el Pool se estabiliza en el número de Nodos de Cómputo en el que se encontraba cuando se realizó la operación de parada. Durante la operación de parada, el estado de asignación del pool cambia primero a parada y luego a estable. Una operación de redimensionamiento no tiene por qué ser una solicitud explícita de Pool de redimensionamiento; esta API también puede usarse para detener el tamaño inicial del Pool cuando se crea.
terminateJob(string, TerminateJobOptionalParams)	Cuando se recibe una solicitud de Terminar Trabajo, el servicio por lotes establece el Trabajo en el estado de terminación. El servicio por lotes termina entonces cualquier tarea en ejecución asociada al trabajo y ejecuta las tareas de liberación de trabajos necesarias. Luego el Trabajo pasa al estado completado. Si hay alguna Tareas en el Trabajo en estado activo, permanecerán en estado activo. Una vez terminado un trabajo, no se pueden añadir nuevas tareas y no se programarán las tareas activas restantes.
terminateJobSchedule(string, TerminateJobScheduleOptionalParams)	Finaliza una programación de trabajo.
terminateTask(string, string, TerminateTaskOptionalParams)	Cuando se ha terminado la tarea, se mueve al estado completado. Para las tareas de varias instancias, la operación finalizar tarea se aplica sincrónicamente a la tarea principal; Las subtareas se finalizan de forma asincrónica en segundo plano.
updateJob(string, BatchJobUpdateOptions, UpdateJobOptionalParams)	Esto reemplaza solo las propiedades del Trabajo especificadas en la solicitud. Por ejemplo, si el Trabajo tiene restricciones y una petición no especifica el elemento restricción, entonces el Trabajo mantiene las restricciones existentes.
updateJobSchedule(string, BatchJobScheduleUpdateOptions, UpdateJobScheduleOptionalParams)	Esto reemplaza solo las propiedades de Horario de Trabajo especificadas en la solicitud. Por ejemplo, si la propiedad de horario no se especifica con esta solicitud, entonces el servicio por lotes mantendrá el horario existente. Los cambios en un calendario de trabajos solo afectan a los trabajos creados por el horario después de que se haya realizado la actualización; los trabajos que actualmente están en funcionamiento no se ven afectados.
updatePool(string, BatchPoolUpdateOptions, UpdatePoolOptionalParams)	Esto solo reemplaza las propiedades del Pool especificadas en la solicitud. Por ejemplo, si el Pool tiene asociado un StartTask y una solicitud no especifica un elemento StartTask, entonces el Pool mantiene el StartTask existente.
uploadNodeLogs(string, string, UploadBatchServiceLogsOptions, UploadNodeLogsOptionalParams)	Esto es para recopilar archivos de registro de servicios Azure Batch de forma automatizada desde Compute Nodes si estás experimentando un error y quieres escalar a soporte de Azure. Los archivos de registro del servicio Azure Batch deben compartirse con Soporte técnico de Azure para ayudar a depurar problemas con el servicio Batch.

BatchClient(string, TokenCredential | AzureNamedKeyCredential, BatchClientOptionalParams)

new BatchClient(endpointParam: string, credential: TokenCredential | AzureNamedKeyCredential, options?: BatchClientOptionalParams)

Parámetros

endpointParam: string

credential: TokenCredential | AzureNamedKeyCredential

options: BatchClientOptionalParams

createJob(BatchJobCreateOptions, CreateJobOptionalParams)

El servicio por lotes permite dos formas de controlar el trabajo realizado como parte de un trabajo. En el primer enfoque, el usuario especifica una tarea de Gestor de Trabajos. El servicio por lotes lanza esta tarea cuando está lista para iniciar el trabajo. La tarea del Gestor de Trabajos controla todas las demás tareas que se ejecutan bajo este trabajo, utilizando las APIs de tareas. En el segundo enfoque, el usuario controla directamente la ejecución de tareas bajo un trabajo activo, utilizando las APIs de tareas. También ten en cuenta: al nombrar los puestos, evita incluir información sensible como nombres de usuario o nombres secretos de proyectos. Esta información puede aparecer en registros de telemetría accesibles para los ingenieros de Soporte técnico de Microsoft.

function createJob(job: BatchJobCreateOptions, options?: CreateJobOptionalParams): Promise<void>

Parámetros

job: BatchJobCreateOptions

options: CreateJobOptionalParams

Devoluciones

Promise<void>

createJobSchedule(BatchJobScheduleCreateOptions, CreateJobScheduleOptionalParams)

Crea un Horario de Trabajo para la Cuenta especificada.

function createJobSchedule(jobSchedule: BatchJobScheduleCreateOptions, options?: CreateJobScheduleOptionalParams): Promise<void>

Parámetros

jobSchedule: BatchJobScheduleCreateOptions

options: CreateJobScheduleOptionalParams

Devoluciones

Promise<void>

createNodeUser(string, string, BatchNodeUserCreateOptions, CreateNodeUserOptionalParams)

Puedes añadir una cuenta de usuario a un Nodo de Cómputo solo cuando esté en estado inactivo o en funcionamiento. Antes de poder iniciar sesión remotamente en un Nodo de Cómputo, debes configurar puertos de acceso para SSH y RDP. Para obtener más información, consulte: https://learn.microsoft.com/azure/batch/pool-endpoint-configuration

function createNodeUser(poolId: string, nodeId: string, user: BatchNodeUserCreateOptions, options?: CreateNodeUserOptionalParams): Promise<void>

Parámetros

poolId: string

nodeId: string

user: BatchNodeUserCreateOptions

options: CreateNodeUserOptionalParams

Devoluciones

Promise<void>

createPool(BatchPoolCreateOptions, CreatePoolOptionalParams)

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 registros de telemetría accesibles para los ingenieros de Soporte técnico de Microsoft.

function createPool(pool: BatchPoolCreateOptions, options?: CreatePoolOptionalParams): Promise<void>

Parámetros

pool: BatchPoolCreateOptions

options: CreatePoolOptionalParams

Devoluciones

Promise<void>

createTask(string, BatchTaskCreateOptions, CreateTaskOptionalParams)

La vida máxima de una tarea desde la suma hasta la finalización es de 180 días. Si una tarea no se completa en los 180 días posteriores a su añadido, será terminada por el servicio por lotes y dejada en el estado en el que estaba en ese momento.

function createTask(jobId: string, task: BatchTaskCreateOptions, options?: CreateTaskOptionalParams): Promise<void>

Parámetros

jobId: string

task: BatchTaskCreateOptions

options: CreateTaskOptionalParams

Devoluciones

Promise<void>

createTaskCollection(string, BatchTaskGroup, CreateTaskCollectionOptionalParams)

Ten en cuenta que cada tarea debe tener un ID único. El servicio por lotes no puede devolver los resultados de cada tarea en el mismo orden en que se enviaron en esta solicitud. Si el servidor expira o la conexión se cierra durante la solicitud, la solicitud puede haberse procesado parcial o totalmente, o no haberse procesado en absoluto. En tales casos, el usuario debe volver a emitir la solicitud. Ten en cuenta que corresponde al usuario gestionar correctamente los fallos al volver a emitir una solicitud. Por ejemplo, deberías usar los mismos IDs de tarea durante un reintento para que, si la operación anterior tuvo éxito, el reintento no genere tareas adicionales inesperadamente. Si la respuesta contiene alguna Tareas que no se haya añadido, un cliente puede intentar de nuevo la solicitud. En un reintento, es más eficiente volver a enviar solo las Tareas que no se sumaron y omitir las Tareas que se añadieron con éxito en el primer intento. La vida máxima de una tarea desde la suma hasta la finalización es de 180 días. Si una tarea no se completa en los 180 días posteriores a su añadido, será terminada por el servicio por lotes y dejada en el estado en el que estaba en ese momento.

function createTaskCollection(jobId: string, taskCollection: BatchTaskGroup, options?: CreateTaskCollectionOptionalParams): Promise<BatchCreateTaskCollectionResult>

Parámetros

jobId: string

taskCollection: BatchTaskGroup

options: CreateTaskCollectionOptionalParams

Devoluciones

Promise<BatchCreateTaskCollectionResult>

deallocateNode(string, string, DeallocateNodeOptionalParams)

Solo puede desasignar un nodo de proceso si está en estado inactivo o en ejecución.

function deallocateNode(poolId: string, nodeId: string, options?: DeallocateNodeOptionalParams): PollerLike<OperationState<void>, void>

Parámetros

poolId: string

nodeId: string

options: DeallocateNodeOptionalParams

Devoluciones

PollerLike<OperationState<void>, void>

deleteJob(string, DeleteJobOptionalParams)

Eliminar un trabajo también elimina todas las tareas que forman parte de ese trabajo, así como todas las estadísticas del puesto. Esto también anula el periodo de retención de los datos de la Tarea; es decir, si el Trabajo contiene Tareas que aún se conservan en los Nodos de Cómputo, los servicios por lotes eliminan los directorios de trabajo de esas Tareas y todo su contenido. Cuando se recibe una solicitud de Trabajo de Eliminación, el servicio Batch establece el Trabajo en estado de eliminación. Todas las operaciones de actualización en un trabajo que esté en estado de eliminación fallarán con el código de estado 409 (Conflicto), con información adicional indicando que el trabajo está siendo eliminado.

function deleteJob(jobId: string, options?: DeleteJobOptionalParams): PollerLike<OperationState<void>, void>

Parámetros

jobId: string

options: DeleteJobOptionalParams

Devoluciones

PollerLike<OperationState<void>, void>

deleteJobSchedule(string, DeleteJobScheduleOptionalParams)

Al eliminar una programación de trabajos, esto también elimina todos los trabajos y tareas de esa programación. Cuando se eliminan las tareas, también se eliminan todos los archivos de sus directorios de trabajo en los nodos de proceso (se omite el período de retención). Las estadísticas de programación de trabajos ya no son accesibles una vez eliminada la programación de trabajos, aunque todavía se cuentan para las estadísticas de duración de la cuenta.

function deleteJobSchedule(jobScheduleId: string, options?: DeleteJobScheduleOptionalParams): PollerLike<OperationState<void>, void>

Parámetros

jobScheduleId: string

options: DeleteJobScheduleOptionalParams

Devoluciones

PollerLike<OperationState<void>, void>

deleteNodeFile(string, string, string, DeleteNodeFileOptionalParams)

Elimina el archivo especificado del nodo de proceso.

function deleteNodeFile(poolId: string, nodeId: string, filePath: string, options?: DeleteNodeFileOptionalParams): Promise<void>

Parámetros

poolId: string

nodeId: string

filePath: string

options: DeleteNodeFileOptionalParams

Devoluciones

Promise<void>

deleteNodeUser(string, string, string, DeleteNodeUserOptionalParams)

Puede eliminar una cuenta de usuario en un nodo de proceso solo cuando se encuentra en estado inactivo o en ejecución. Antes de poder iniciar sesión remotamente en un Nodo de Cómputo, debes configurar puertos de acceso para SSH y RDP. Para obtener más información, consulte: https://learn.microsoft.com/azure/batch/pool-endpoint-configuration

function deleteNodeUser(poolId: string, nodeId: string, userName: string, options?: DeleteNodeUserOptionalParams): Promise<void>

Parámetros

poolId: string

nodeId: string

userName: string

options: DeleteNodeUserOptionalParams

Devoluciones

Promise<void>

deletePool(string, DeletePoolOptionalParams)

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 deletePool(poolId: string, options?: DeletePoolOptionalParams): PollerLike<OperationState<void>, void>

Parámetros

poolId: string

options: DeletePoolOptionalParams

Devoluciones

PollerLike<OperationState<void>, void>

deleteTask(string, string, DeleteTaskOptionalParams)

Cuando se elimina una tarea, todos los archivos de su directorio en el nodo de proceso donde se ejecutó también se eliminan (independientemente del tiempo de retención). En el caso de las tareas de varias instancias, la operación eliminar tarea se aplica sincrónicamente a la tarea principal; Las subtareas y sus archivos se eliminan de forma asincrónica en segundo plano.

function deleteTask(jobId: string, taskId: string, options?: DeleteTaskOptionalParams): Promise<void>

Parámetros

jobId: string

taskId: string

options: DeleteTaskOptionalParams

Devoluciones

Promise<void>

deleteTaskFile(string, string, string, DeleteTaskFileOptionalParams)

Elimina el archivo de tarea especificado del nodo de proceso donde se ejecutó la tarea.

function deleteTaskFile(jobId: string, taskId: string, filePath: string, options?: DeleteTaskFileOptionalParams): Promise<void>

Parámetros

jobId: string

taskId: string

filePath: string

options: DeleteTaskFileOptionalParams

Devoluciones

Promise<void>

disableJob(string, BatchJobDisableOptions, DisableJobOptionalParams)

El Servicio de Lotes mueve inmediatamente el Trabajo al estado de desactivación. A continuación, el lote utiliza el parámetro disableTasks para determinar qué hacer con las Tareas del Trabajo que se están ejecutando actualmente. El Trabajo permanece en estado de desactivación hasta que se completa la operación de desactivación y todas las Tareas se han gestionado según la opción de desactivaciónTareas (disableTasks); el Trabajo pasa entonces al estado de discapacidad. No se inician nuevas tareas bajo el Trabajo hasta que vuelve a estar activo. Si intentas desactivar un Trabajo que esté en cualquier estado distinto a activo, deshabilitado o deshabilitado, la solicitud falla con el código de estado 409.

function disableJob(jobId: string, disableOptions: BatchJobDisableOptions, options?: DisableJobOptionalParams): PollerLike<OperationState<void>, void>

Parámetros

jobId: string

disableOptions: BatchJobDisableOptions

options: DisableJobOptionalParams

Devoluciones

PollerLike<OperationState<void>, void>

disableJobSchedule(string, DisableJobScheduleOptionalParams)

No se creará ningún nuevo trabajo hasta que se vuelva a habilitar la programación de trabajos.

function disableJobSchedule(jobScheduleId: string, options?: DisableJobScheduleOptionalParams): Promise<void>

Parámetros

jobScheduleId: string

options: DisableJobScheduleOptionalParams

Devoluciones

Promise<void>

disableNodeScheduling(string, string, DisableNodeSchedulingOptionalParams)

Solo puedes desactivar la planificación de tareas en un nodo de cómputo si su estado actual de programación está activado.

function disableNodeScheduling(poolId: string, nodeId: string, options?: DisableNodeSchedulingOptionalParams): Promise<void>

Parámetros

poolId: string

nodeId: string

options: DisableNodeSchedulingOptionalParams

Devoluciones

Promise<void>

disablePoolAutoScale(string, DisablePoolAutoScaleOptionalParams)

Deshabilita el escalado automático de un grupo.

function disablePoolAutoScale(poolId: string, options?: DisablePoolAutoScaleOptionalParams): Promise<void>

Parámetros

poolId: string

options: DisablePoolAutoScaleOptionalParams

Devoluciones

Promise<void>

enableJob(string, EnableJobOptionalParams)

Cuando llamas a esta API, el servicio por lotes establece un Trabajo deshabilitado en el estado habilitador. Una vez completada esta operación, el trabajo pasa al estado activo y la programación de nuevas tareas bajo el puesto se reanuda. El servicio por lotes no permite que una tarea permanezca en estado activo más de 180 días. Por lo tanto, si activas un Trabajo que contiene Tareas activas añadidas hace más de 180 días, esas Tareas no se ejecutarán.

function enableJob(jobId: string, options?: EnableJobOptionalParams): PollerLike<OperationState<void>, void>

Parámetros

jobId: string

options: EnableJobOptionalParams

Devoluciones

PollerLike<OperationState<void>, void>

enableJobSchedule(string, EnableJobScheduleOptionalParams)

Habilita una programación de trabajos.

function enableJobSchedule(jobScheduleId: string, options?: EnableJobScheduleOptionalParams): Promise<void>

Parámetros

jobScheduleId: string

options: EnableJobScheduleOptionalParams

Devoluciones

Promise<void>

enableNodeScheduling(string, string, EnableNodeSchedulingOptionalParams)

Puedes activar la planificación de tareas en un nodo de cómputo solo si su estado actual de programación está deshabilitado

function enableNodeScheduling(poolId: string, nodeId: string, options?: EnableNodeSchedulingOptionalParams): Promise<void>

Parámetros

poolId: string

nodeId: string

options: EnableNodeSchedulingOptionalParams

Devoluciones

Promise<void>

enablePoolAutoScale(string, BatchPoolEnableAutoScaleOptions, EnablePoolAutoScaleOptionalParams)

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 enablePoolAutoScale(poolId: string, enableAutoScaleOptions: BatchPoolEnableAutoScaleOptions, options?: EnablePoolAutoScaleOptionalParams): Promise<void>

Parámetros

poolId: string

enableAutoScaleOptions: BatchPoolEnableAutoScaleOptions

options: EnablePoolAutoScaleOptionalParams

Devoluciones

Promise<void>

evaluatePoolAutoScale(string, BatchPoolEvaluateAutoScaleOptions, EvaluatePoolAutoScaleOptionalParams)

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 evaluatePoolAutoScale(poolId: string, evaluateAutoScaleOptions: BatchPoolEvaluateAutoScaleOptions, options?: EvaluatePoolAutoScaleOptionalParams): Promise<AutoScaleRun>

Parámetros

poolId: string

evaluateAutoScaleOptions: BatchPoolEvaluateAutoScaleOptions

options: EvaluatePoolAutoScaleOptionalParams

Devoluciones

Promise<AutoScaleRun>

getApplication(string, GetApplicationOptionalParams)

Esta operación solo devuelve las Aplicaciones y versiones disponibles para su uso en Nodos de Cómputo; es decir, que puede usarse en una referencia de paquete. Para información de administrador sobre aplicaciones y versiones que aún no están disponibles para Compute Nodes, utilice el portal de Azure o la API del Azure Resource Manager.

function getApplication(applicationId: string, options?: GetApplicationOptionalParams): Promise<BatchApplication>

Parámetros

applicationId: string

options: GetApplicationOptionalParams

Devoluciones

Promise<BatchApplication>

getJob(string, GetJobOptionalParams)

Obtiene información sobre el puesto especificado.

function getJob(jobId: string, options?: GetJobOptionalParams): Promise<BatchJob>

Parámetros

jobId: string

options: GetJobOptionalParams

Devoluciones

Promise<BatchJob>

getJobSchedule(string, GetJobScheduleOptionalParams)

Obtiene información sobre el horario de trabajo especificado.

function getJobSchedule(jobScheduleId: string, options?: GetJobScheduleOptionalParams): Promise<BatchJobSchedule>

Parámetros

jobScheduleId: string

options: GetJobScheduleOptionalParams

Devoluciones

Promise<BatchJobSchedule>

getJobTaskCounts(string, GetJobTaskCountsOptionalParams)

Los recuentos de tareas proporcionan un recuento de las tareas por estado activo, en ejecución o completado de la tarea, y un recuento de tareas que se realizaron correctamente o con errores. Las tareas del estado de preparación se cuentan como en ejecución. Tenga en cuenta que es posible que los números devueltos no siempre estén actualizados. Si necesita recuentos exactos de tareas, use una consulta de lista.

function getJobTaskCounts(jobId: string, options?: GetJobTaskCountsOptionalParams): Promise<BatchTaskCountsResult>

Parámetros

jobId: string

options: GetJobTaskCountsOptionalParams

Devoluciones

Promise<BatchTaskCountsResult>

getNode(string, string, GetNodeOptionalParams)

Obtiene información sobre el nodo de proceso especificado.

function getNode(poolId: string, nodeId: string, options?: GetNodeOptionalParams): Promise<BatchNode>

Parámetros

poolId: string

nodeId: string

options: GetNodeOptionalParams

Devoluciones

Promise<BatchNode>

getNodeExtension(string, string, string, GetNodeExtensionOptionalParams)

Obtiene información sobre la Extensión de Nodo de Cómputo especificada.

function getNodeExtension(poolId: string, nodeId: string, extensionName: string, options?: GetNodeExtensionOptionalParams): Promise<BatchNodeVMExtension>

Parámetros

poolId: string

nodeId: string

extensionName: string

options: GetNodeExtensionOptionalParams

Devoluciones

Promise<BatchNodeVMExtension>

getNodeFile(string, string, string, GetNodeFileOptionalParams)

Devuelve el contenido del archivo de Nodo de Cómputo especificado.

function getNodeFile(poolId: string, nodeId: string, filePath: string, options?: GetNodeFileOptionalParams): Promise<Uint8Array>

Parámetros

poolId: string

nodeId: string

filePath: string

options: GetNodeFileOptionalParams

Devoluciones

Promise<Uint8Array>

getNodeFileProperties(string, string, string, GetNodeFilePropertiesOptionalParams)

Obtiene las propiedades del archivo de nodo de proceso especificado.

function getNodeFileProperties(poolId: string, nodeId: string, filePath: string, options?: GetNodeFilePropertiesOptionalParams): Promise<BatchNodeFile>

Parámetros

poolId: string

nodeId: string

filePath: string

options: GetNodeFilePropertiesOptionalParams

Devoluciones

Promise<BatchNodeFile>

getNodeRemoteLoginSettings(string, string, GetNodeRemoteLoginSettingsOptionalParams)

Antes de poder iniciar sesión remotamente en un Nodo de Computación usando la configuración remota de inicio de sesión, debes crear una cuenta de usuario en el Nodo de Computación y configurar los puertos de acceso para SSH y RDP. Para obtener más información, consulte: https://learn.microsoft.com/azure/batch/pool-endpoint-configuration

function getNodeRemoteLoginSettings(poolId: string, nodeId: string, options?: GetNodeRemoteLoginSettingsOptionalParams): Promise<BatchNodeRemoteLoginSettings>

Parámetros

poolId: string

nodeId: string

options: GetNodeRemoteLoginSettingsOptionalParams

Devoluciones

Promise<BatchNodeRemoteLoginSettings>

getPool(string, GetPoolOptionalParams)

Obtiene información sobre el grupo especificado.

function getPool(poolId: string, options?: GetPoolOptionalParams): Promise<BatchPool>

Parámetros

poolId: string

options: GetPoolOptionalParams

Devoluciones

Promise<BatchPool>

getTask(string, string, GetTaskOptionalParams)

Para tareas multiinstancia, información como affinityId, executionInfo y nodeInfo se refiere a la tarea principal. Utiliza la API de subtareas de lista para obtener información sobre subtareas.

function getTask(jobId: string, taskId: string, options?: GetTaskOptionalParams): Promise<BatchTask>

Parámetros

jobId: string

taskId: string

options: GetTaskOptionalParams

Devoluciones

Promise<BatchTask>

getTaskFile(string, string, string, GetTaskFileOptionalParams)

Devuelve el contenido del archivo de tarea especificado.

function getTaskFile(jobId: string, taskId: string, filePath: string, options?: GetTaskFileOptionalParams): Promise<Uint8Array>

Parámetros

jobId: string

taskId: string

filePath: string

options: GetTaskFileOptionalParams

Devoluciones

Promise<Uint8Array>

getTaskFileProperties(string, string, string, GetTaskFilePropertiesOptionalParams)

Obtiene las propiedades del archivo task especificado.

function getTaskFileProperties(jobId: string, taskId: string, filePath: string, options?: GetTaskFilePropertiesOptionalParams): Promise<BatchNodeFile>

Parámetros

jobId: string

taskId: string

filePath: string

options: GetTaskFilePropertiesOptionalParams

Devoluciones

Promise<BatchNodeFile>

jobScheduleExists(string, JobScheduleExistsOptionalParams)

Comprueba que exista el Horario de Trabajo especificado.

function jobScheduleExists(jobScheduleId: string, options?: JobScheduleExistsOptionalParams): Promise<boolean>

Parámetros

jobScheduleId: string

options: JobScheduleExistsOptionalParams

Devoluciones

Promise<boolean>

listApplications(ListApplicationsOptionalParams)

Esta operación solo devuelve las Aplicaciones y versiones disponibles para su uso en Nodos de Cómputo; es decir, que puede usarse en una referencia de paquete. Para información de administrador sobre aplicaciones y versiones que aún no están disponibles para Compute Nodes, utilice el portal Azure o la API Azure Resource Manager.

function listApplications(options?: ListApplicationsOptionalParams): PagedAsyncIterableIterator<BatchApplication, BatchApplication[], PageSettings>

Parámetros

options: ListApplicationsOptionalParams

Devoluciones

PagedAsyncIterableIterator<BatchApplication, BatchApplication[], PageSettings>

listJobPreparationAndReleaseTaskStatus(string, ListJobPreparationAndReleaseTaskStatusOptionalParams)

Esta API devuelve el estado de la tarea de preparación y liberación de trabajos en todos los nodos de proceso que han ejecutado la tarea Preparación del trabajo o Liberación de trabajos. Esto incluye nodos de proceso que se han quitado del grupo. Si esta API se invoca en un trabajo que no tiene ninguna tarea de preparación o liberación de trabajos, el servicio Batch devuelve el código de estado HTTP 409 (conflicto) con un código de error de JobPreparationTaskNotSpecified.

function listJobPreparationAndReleaseTaskStatus(jobId: string, options?: ListJobPreparationAndReleaseTaskStatusOptionalParams): PagedAsyncIterableIterator<BatchJobPreparationAndReleaseTaskStatus, BatchJobPreparationAndReleaseTaskStatus[], PageSettings>

Parámetros

jobId: string

options: ListJobPreparationAndReleaseTaskStatusOptionalParams

Devoluciones

PagedAsyncIterableIterator<BatchJobPreparationAndReleaseTaskStatus, BatchJobPreparationAndReleaseTaskStatus[], PageSettings>

listJobs(ListJobsOptionalParams)

Lista todos los trabajos en la cuenta especificada.

function listJobs(options?: ListJobsOptionalParams): PagedAsyncIterableIterator<BatchJob, BatchJob[], PageSettings>

Parámetros

options: ListJobsOptionalParams

Devoluciones

PagedAsyncIterableIterator<BatchJob, BatchJob[], PageSettings>

listJobSchedules(ListJobSchedulesOptionalParams)

Lista todos los horarios de trabajo en la cuenta especificada.

function listJobSchedules(options?: ListJobSchedulesOptionalParams): PagedAsyncIterableIterator<BatchJobSchedule, BatchJobSchedule[], PageSettings>

Parámetros

options: ListJobSchedulesOptionalParams

Devoluciones

PagedAsyncIterableIterator<BatchJobSchedule, BatchJobSchedule[], PageSettings>

listJobsFromSchedule(string, ListJobsFromScheduleOptionalParams)

Lista los trabajos que se han creado bajo el calendario de trabajos especificado.

function listJobsFromSchedule(jobScheduleId: string, options?: ListJobsFromScheduleOptionalParams): PagedAsyncIterableIterator<BatchJob, BatchJob[], PageSettings>

Parámetros

jobScheduleId: string

options: ListJobsFromScheduleOptionalParams

Devoluciones

PagedAsyncIterableIterator<BatchJob, BatchJob[], PageSettings>

listNodeExtensions(string, string, ListNodeExtensionsOptionalParams)

Lista las extensiones de los nodos de cómputo en el conjunto especificado.

function listNodeExtensions(poolId: string, nodeId: string, options?: ListNodeExtensionsOptionalParams): PagedAsyncIterableIterator<BatchNodeVMExtension, BatchNodeVMExtension[], PageSettings>

Parámetros

poolId: string

nodeId: string

options: ListNodeExtensionsOptionalParams

Devoluciones

PagedAsyncIterableIterator<BatchNodeVMExtension, BatchNodeVMExtension[], PageSettings>

listNodeFiles(string, string, ListNodeFilesOptionalParams)

Enumera todos los archivos de los directorios de tareas en el nodo de proceso especificado.

function listNodeFiles(poolId: string, nodeId: string, options?: ListNodeFilesOptionalParams): PagedAsyncIterableIterator<BatchNodeFile, BatchNodeFile[], PageSettings>

Parámetros

poolId: string

nodeId: string

options: ListNodeFilesOptionalParams

Devoluciones

PagedAsyncIterableIterator<BatchNodeFile, BatchNodeFile[], PageSettings>

listNodes(string, ListNodesOptionalParams)

Enumera los nodos de proceso del grupo especificado.

function listNodes(poolId: string, options?: ListNodesOptionalParams): PagedAsyncIterableIterator<BatchNode, BatchNode[], PageSettings>

Parámetros

poolId: string

options: ListNodesOptionalParams

Devoluciones

PagedAsyncIterableIterator<BatchNode, BatchNode[], PageSettings>

listPoolNodeCounts(ListPoolNodeCountsOptionalParams)

Obtiene el número de nodos de proceso en cada estado, agrupados por grupo. Tenga en cuenta que es posible que los números devueltos no siempre estén actualizados. Si necesita recuentos exactos de nodos, use una consulta de lista.

function listPoolNodeCounts(options?: ListPoolNodeCountsOptionalParams): PagedAsyncIterableIterator<BatchPoolNodeCounts, BatchPoolNodeCounts[], PageSettings>

Parámetros

options: ListPoolNodeCountsOptionalParams

Devoluciones

PagedAsyncIterableIterator<BatchPoolNodeCounts, BatchPoolNodeCounts[], PageSettings>

listPools(ListPoolsOptionalParams)

Enumera todos los grupos de la cuenta especificada.

function listPools(options?: ListPoolsOptionalParams): PagedAsyncIterableIterator<BatchPool, BatchPool[], PageSettings>

Parámetros

options: ListPoolsOptionalParams

Devoluciones

PagedAsyncIterableIterator<BatchPool, BatchPool[], PageSettings>

listPoolUsageMetrics(ListPoolUsageMetricsOptionalParams)

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 listPoolUsageMetrics(options?: ListPoolUsageMetricsOptionalParams): PagedAsyncIterableIterator<BatchPoolUsageMetrics, BatchPoolUsageMetrics[], PageSettings>

Parámetros

options: ListPoolUsageMetricsOptionalParams

Devoluciones

PagedAsyncIterableIterator<BatchPoolUsageMetrics, BatchPoolUsageMetrics[], PageSettings>

listSubTasks(string, string, ListSubTasksOptionalParams)

Si la tarea no es una tarea de varias instancias, devuelve una colección vacía.

function listSubTasks(jobId: string, taskId: string, options?: ListSubTasksOptionalParams): PagedAsyncIterableIterator<BatchSubtask, BatchSubtask[], PageSettings>

Parámetros

jobId: string

taskId: string

options: ListSubTasksOptionalParams

Devoluciones

PagedAsyncIterableIterator<BatchSubtask, BatchSubtask[], PageSettings>

listSupportedImages(ListSupportedImagesOptionalParams)

Enumera todas las imágenes de máquina virtual compatibles con el servicio Azure Batch.

function listSupportedImages(options?: ListSupportedImagesOptionalParams): PagedAsyncIterableIterator<BatchSupportedImage, BatchSupportedImage[], PageSettings>

Parámetros

options: ListSupportedImagesOptionalParams

Devoluciones

PagedAsyncIterableIterator<BatchSupportedImage, BatchSupportedImage[], PageSettings>

listTaskFiles(string, string, ListTaskFilesOptionalParams)

Enumera los archivos del directorio de una tarea en su nodo de proceso.

function listTaskFiles(jobId: string, taskId: string, options?: ListTaskFilesOptionalParams): PagedAsyncIterableIterator<BatchNodeFile, BatchNodeFile[], PageSettings>

Parámetros

jobId: string

taskId: string

options: ListTaskFilesOptionalParams

Devoluciones

PagedAsyncIterableIterator<BatchNodeFile, BatchNodeFile[], PageSettings>

listTasks(string, ListTasksOptionalParams)

Para tareas multiinstancia, información como affinityId, executionInfo y nodeInfo se refiere a la tarea principal. Utiliza la API de subtareas de lista para obtener información sobre subtareas.

function listTasks(jobId: string, options?: ListTasksOptionalParams): PagedAsyncIterableIterator<BatchTask, BatchTask[], PageSettings>

Parámetros

jobId: string

options: ListTasksOptionalParams

Devoluciones

PagedAsyncIterableIterator<BatchTask, BatchTask[], PageSettings>

poolExists(string, PoolExistsOptionalParams)

Obtiene propiedades básicas de un Pool.

function poolExists(poolId: string, options?: PoolExistsOptionalParams): Promise<boolean>

Parámetros

poolId: string

options: PoolExistsOptionalParams

Devoluciones

Promise<boolean>

reactivateTask(string, string, ReactivateTaskOptionalParams)

La reactivación hace que una tarea sea apta para reintentarse de nuevo hasta su recuento máximo de reintentos. El estado de la tarea se cambia a activo. Dado que la tarea ya no está en el estado completado, cualquier código de salida o información de error anterior ya no está disponible después de la reactivación. Cada vez que se reactiva una tarea, su recuento de reintentos se restablece a 0. Se producirá un error en la reactivación de las tareas que no se hayan completado o que se hayan completado correctamente (con un código de salida de 0). Además, se producirá un error si el trabajo se ha completado (o está finalizando o eliminando).

function reactivateTask(jobId: string, taskId: string, options?: ReactivateTaskOptionalParams): Promise<void>

Parámetros

jobId: string

taskId: string

options: ReactivateTaskOptionalParams

Devoluciones

Promise<void>

rebootNode(string, string, RebootNodeOptionalParams)

Solo puede reiniciar un nodo de proceso si está en estado inactivo o en ejecución.

function rebootNode(poolId: string, nodeId: string, options?: RebootNodeOptionalParams): PollerLike<OperationState<void>, void>

Parámetros

poolId: string

nodeId: string

options: RebootNodeOptionalParams

Devoluciones

PollerLike<OperationState<void>, void>

reimageNode(string, string, ReimageNodeOptionalParams)

Puede reinstalar el sistema operativo en un nodo de proceso solo si está en estado inactivo o en ejecución. Esta API solo puede invocarse en pools creados con la propiedad de configuración de servicios en la nube.

function reimageNode(poolId: string, nodeId: string, options?: ReimageNodeOptionalParams): PollerLike<OperationState<void>, void>

Parámetros

poolId: string

nodeId: string

options: ReimageNodeOptionalParams

Devoluciones

PollerLike<OperationState<void>, void>

removeNodes(string, BatchNodeRemoveOptions, RemoveNodesOptionalParams)

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.

function removeNodes(poolId: string, removeOptions: BatchNodeRemoveOptions, options?: RemoveNodesOptionalParams): PollerLike<OperationState<void>, void>

Parámetros

poolId: string

removeOptions: BatchNodeRemoveOptions

options: RemoveNodesOptionalParams

Devoluciones

PollerLike<OperationState<void>, void>

replaceJob(string, BatchJob, ReplaceJobOptionalParams)

Esto reemplaza completamente todas las propiedades actualizables del Job. Por ejemplo, si el Trabajo tiene restricciones asociadas y si no se especifica restricción con esta solicitud, entonces el servicio por lotes eliminará las restricciones existentes.

function replaceJob(jobId: string, job: BatchJob, options?: ReplaceJobOptionalParams): Promise<void>

Parámetros

jobId: string

job: BatchJob

options: ReplaceJobOptionalParams

Devoluciones

Promise<void>

replaceJobSchedule(string, BatchJobSchedule, ReplaceJobScheduleOptionalParams)

Esto reemplaza completamente todas las propiedades actualizables del Horario de Trabajos. Por ejemplo, si la propiedad de horario no se especifica con esta solicitud, el servicio por lotes eliminará el horario existente. Los cambios en un calendario de trabajos solo afectan a los trabajos creados por el horario después de que se haya realizado la actualización; los trabajos que actualmente están en funcionamiento no se ven afectados.

function replaceJobSchedule(jobScheduleId: string, jobSchedule: BatchJobSchedule, options?: ReplaceJobScheduleOptionalParams): Promise<void>

Parámetros

jobScheduleId: string

jobSchedule: BatchJobSchedule

options: ReplaceJobScheduleOptionalParams

Devoluciones

Promise<void>

replaceNodeUser(string, string, string, BatchNodeUserUpdateOptions, ReplaceNodeUserOptionalParams)

Esta operación reemplaza todas las propiedades actualizables de la Cuenta. Por ejemplo, si el elemento expiryTime no se especifica, el valor actual se reemplaza por el valor por defecto, no se deja sin modificar. Puedes actualizar una cuenta de usuario en un Nodo de Cómputo solo cuando esté en estado inactivo o en funcionamiento.

function replaceNodeUser(poolId: string, nodeId: string, userName: string, updateOptions: BatchNodeUserUpdateOptions, options?: ReplaceNodeUserOptionalParams): Promise<void>

Parámetros

poolId: string

nodeId: string

userName: string

updateOptions: BatchNodeUserUpdateOptions

options: ReplaceNodeUserOptionalParams

Devoluciones

Promise<void>

replacePoolProperties(string, BatchPoolReplaceOptions, ReplacePoolPropertiesOptionalParams)

Esto reemplaza completamente todas las propiedades actualizables de la piscina. Por ejemplo, si el Pool tiene asociado un StartTask y si StartTask no está especificado con esta solicitud, entonces el servicio Batch eliminará el StartTask existente.

function replacePoolProperties(poolId: string, pool: BatchPoolReplaceOptions, options?: ReplacePoolPropertiesOptionalParams): Promise<void>

Parámetros

poolId: string

pool: BatchPoolReplaceOptions

options: ReplacePoolPropertiesOptionalParams

Devoluciones

Promise<void>

replaceTask(string, string, BatchTask, ReplaceTaskOptionalParams)

Actualiza las propiedades de la tarea especificada.

function replaceTask(jobId: string, taskId: string, task: BatchTask, options?: ReplaceTaskOptionalParams): Promise<void>

Parámetros

jobId: string

taskId: string

task: BatchTask

options: ReplaceTaskOptionalParams

Devoluciones

Promise<void>

resizePool(string, BatchPoolResizeOptions, ResizePoolOptionalParams)

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 resizePool(poolId: string, resizeOptions: BatchPoolResizeOptions, options?: ResizePoolOptionalParams): PollerLike<OperationState<void>, void>

Parámetros

poolId: string

resizeOptions: BatchPoolResizeOptions

options: ResizePoolOptionalParams

Devoluciones

PollerLike<OperationState<void>, void>

startNode(string, string, StartNodeOptionalParams)

Solo puedes iniciar un Nodo de Cómputo si ha sido dislocato.

function startNode(poolId: string, nodeId: string, options?: StartNodeOptionalParams): PollerLike<OperationState<void>, void>

Parámetros

poolId: string

nodeId: string

options: StartNodeOptionalParams

Devoluciones

PollerLike<OperationState<void>, void>

stopPoolResize(string, StopPoolResizeOptionalParams)

Esto no restaura el Pool a su estado anterior anterior a la operación de redimensionamiento: solo impide que se realicen más cambios, y el Pool mantiene su estado actual. Tras detenerse, el Pool se estabiliza en el número de Nodos de Cómputo en el que se encontraba cuando se realizó la operación de parada. Durante la operación de parada, el estado de asignación del pool cambia primero a parada y luego a estable. Una operación de redimensionamiento no tiene por qué ser una solicitud explícita de Pool de redimensionamiento; esta API también puede usarse para detener el tamaño inicial del Pool cuando se crea.

function stopPoolResize(poolId: string, options?: StopPoolResizeOptionalParams): PollerLike<OperationState<void>, void>

Parámetros

poolId: string

options: StopPoolResizeOptionalParams

Devoluciones

PollerLike<OperationState<void>, void>

terminateJob(string, TerminateJobOptionalParams)

Cuando se recibe una solicitud de Terminar Trabajo, el servicio por lotes establece el Trabajo en el estado de terminación. El servicio por lotes termina entonces cualquier tarea en ejecución asociada al trabajo y ejecuta las tareas de liberación de trabajos necesarias. Luego el Trabajo pasa al estado completado. Si hay alguna Tareas en el Trabajo en estado activo, permanecerán en estado activo. Una vez terminado un trabajo, no se pueden añadir nuevas tareas y no se programarán las tareas activas restantes.

function terminateJob(jobId: string, options?: TerminateJobOptionalParams): PollerLike<OperationState<void>, void>

Parámetros

jobId: string

options: TerminateJobOptionalParams

Devoluciones

PollerLike<OperationState<void>, void>

terminateJobSchedule(string, TerminateJobScheduleOptionalParams)

Finaliza una programación de trabajo.

function terminateJobSchedule(jobScheduleId: string, options?: TerminateJobScheduleOptionalParams): PollerLike<OperationState<void>, void>

Parámetros

jobScheduleId: string

options: TerminateJobScheduleOptionalParams

Devoluciones

PollerLike<OperationState<void>, void>

terminateTask(string, string, TerminateTaskOptionalParams)

Cuando se ha terminado la tarea, se mueve al estado completado. Para las tareas de varias instancias, la operación finalizar tarea se aplica sincrónicamente a la tarea principal; Las subtareas se finalizan de forma asincrónica en segundo plano.

function terminateTask(jobId: string, taskId: string, options?: TerminateTaskOptionalParams): Promise<void>

Parámetros

jobId: string

taskId: string

options: TerminateTaskOptionalParams

Devoluciones

Promise<void>

updateJob(string, BatchJobUpdateOptions, UpdateJobOptionalParams)

Esto reemplaza solo las propiedades del Trabajo especificadas en la solicitud. Por ejemplo, si el Trabajo tiene restricciones y una petición no especifica el elemento restricción, entonces el Trabajo mantiene las restricciones existentes.

function updateJob(jobId: string, job: BatchJobUpdateOptions, options?: UpdateJobOptionalParams): Promise<void>

Parámetros

jobId: string

job: BatchJobUpdateOptions

options: UpdateJobOptionalParams

Devoluciones

Promise<void>

updateJobSchedule(string, BatchJobScheduleUpdateOptions, UpdateJobScheduleOptionalParams)

Esto reemplaza solo las propiedades de Horario de Trabajo especificadas en la solicitud. Por ejemplo, si la propiedad de horario no se especifica con esta solicitud, entonces el servicio por lotes mantendrá el horario existente. Los cambios en un calendario de trabajos solo afectan a los trabajos creados por el horario después de que se haya realizado la actualización; los trabajos que actualmente están en funcionamiento no se ven afectados.

function updateJobSchedule(jobScheduleId: string, jobSchedule: BatchJobScheduleUpdateOptions, options?: UpdateJobScheduleOptionalParams): Promise<void>

Parámetros

jobScheduleId: string

jobSchedule: BatchJobScheduleUpdateOptions

options: UpdateJobScheduleOptionalParams

Devoluciones

Promise<void>

updatePool(string, BatchPoolUpdateOptions, UpdatePoolOptionalParams)

Esto solo reemplaza las propiedades del Pool especificadas en la solicitud. Por ejemplo, si el Pool tiene asociado un StartTask y una solicitud no especifica un elemento StartTask, entonces el Pool mantiene el StartTask existente.

function updatePool(poolId: string, pool: BatchPoolUpdateOptions, options?: UpdatePoolOptionalParams): Promise<void>

Parámetros

poolId: string

pool: BatchPoolUpdateOptions

options: UpdatePoolOptionalParams

Devoluciones

Promise<void>

uploadNodeLogs(string, string, UploadBatchServiceLogsOptions, UploadNodeLogsOptionalParams)

Esto es para recopilar archivos de registro de servicios Azure Batch de forma automatizada desde Compute Nodes si estás experimentando un error y quieres escalar a soporte de Azure. Los archivos de registro del servicio Azure Batch deben compartirse con Soporte técnico de Azure para ayudar a depurar problemas con el servicio Batch.

function uploadNodeLogs(poolId: string, nodeId: string, uploadOptions: UploadBatchServiceLogsOptions, options?: UploadNodeLogsOptionalParams): Promise<UploadBatchServiceLogsResult>

Parámetros

poolId: string

nodeId: string

uploadOptions: UploadBatchServiceLogsOptions

options: UploadNodeLogsOptionalParams

Devoluciones

Promise<UploadBatchServiceLogsResult>

BatchClient class

Constructores

Métodos

Detalles del constructor

BatchClient(string, TokenCredential | AzureNamedKeyCredential, BatchClientOptionalParams)

Parámetros

Detalles del método

createJob(BatchJobCreateOptions, CreateJobOptionalParams)

Parámetros

Devoluciones

createJobSchedule(BatchJobScheduleCreateOptions, CreateJobScheduleOptionalParams)

Parámetros

Devoluciones

createNodeUser(string, string, BatchNodeUserCreateOptions, CreateNodeUserOptionalParams)

Parámetros

Devoluciones

createPool(BatchPoolCreateOptions, CreatePoolOptionalParams)

Parámetros

Devoluciones

createTask(string, BatchTaskCreateOptions, CreateTaskOptionalParams)

Parámetros

Devoluciones

createTaskCollection(string, BatchTaskGroup, CreateTaskCollectionOptionalParams)

Parámetros

Devoluciones

deallocateNode(string, string, DeallocateNodeOptionalParams)

Parámetros

Devoluciones

deleteJob(string, DeleteJobOptionalParams)

Parámetros

Devoluciones

deleteJobSchedule(string, DeleteJobScheduleOptionalParams)

Parámetros

Devoluciones

deleteNodeFile(string, string, string, DeleteNodeFileOptionalParams)

Parámetros

Devoluciones

deleteNodeUser(string, string, string, DeleteNodeUserOptionalParams)

Parámetros

Devoluciones

deletePool(string, DeletePoolOptionalParams)

Parámetros

Devoluciones

deleteTask(string, string, DeleteTaskOptionalParams)

Parámetros

Devoluciones

deleteTaskFile(string, string, string, DeleteTaskFileOptionalParams)

Parámetros

Devoluciones

disableJob(string, BatchJobDisableOptions, DisableJobOptionalParams)

Parámetros

Devoluciones

disableJobSchedule(string, DisableJobScheduleOptionalParams)

Parámetros

Devoluciones

disableNodeScheduling(string, string, DisableNodeSchedulingOptionalParams)

Parámetros

Devoluciones

disablePoolAutoScale(string, DisablePoolAutoScaleOptionalParams)

Parámetros

Devoluciones

enableJob(string, EnableJobOptionalParams)

Parámetros

Devoluciones

enableJobSchedule(string, EnableJobScheduleOptionalParams)

Parámetros

Devoluciones

enableNodeScheduling(string, string, EnableNodeSchedulingOptionalParams)

Parámetros

Devoluciones

enablePoolAutoScale(string, BatchPoolEnableAutoScaleOptions, EnablePoolAutoScaleOptionalParams)

Parámetros

Devoluciones

evaluatePoolAutoScale(string, BatchPoolEvaluateAutoScaleOptions, EvaluatePoolAutoScaleOptionalParams)

Parámetros

Devoluciones

getApplication(string, GetApplicationOptionalParams)

Parámetros

Devoluciones

getJob(string, GetJobOptionalParams)