Compartir a través de


Nodes - List Nodes

Lista los nodos de cómputo en el grupo especificado.

GET {endpoint}/pools/{poolId}/nodes?api-version=2025-06-01
GET {endpoint}/pools/{poolId}/nodes?api-version=2025-06-01&timeOut={timeOut}&maxresults={maxresults}&$filter={$filter}&$select={$select}

Parámetros de identificador URI

Nombre En Requerido Tipo Description
endpoint
path True

string (uri)

Punto de conexión de la cuenta de Batch (por ejemplo: https://batchaccount.eastus2.batch.azure.com).

poolId
path True

string

El ID del Pool del que quieres listar los Nodos de Cómputo.

api-version
query True

string

minLength: 1

La versión de API que se va a utilizar para esta operación.

$filter
query

string

Una cláusula $filter de OData. Para más información sobre cómo construir este filtro, véase https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool.

$select
query

string[]

Una cláusula $select de OData.

maxresults
query

integer (int32)

minimum: 1
maximum: 1000

Número máximo de elementos que se van a devolver en la respuesta. Se pueden devolver un máximo de 1000 solicitudes.

timeOut
query

integer (int32)

Tiempo máximo que el servidor puede dedicar a procesar la solicitud, en segundos. El valor predeterminado es 30 segundos. Si el valor es mayor que 30, se usará el valor predeterminado en su lugar.".

Encabezado de la solicitud

Nombre Requerido Tipo Description
client-request-id

string

La identidad de solicitud generada por el autor de la llamada, en forma de GUID sin decoración como llaves, por ejemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-id

boolean

Si el servidor debe devolver el client-request-id en la respuesta.

ocp-date

string (date-time-rfc7231)

Hora en que se emitió la solicitud. Las bibliotecas cliente suelen establecer esto en la hora del reloj del sistema actual; establézcalo explícitamente si llama directamente a la API REST.

Respuestas

Nombre Tipo Description
200 OK

BatchNodeListResult

La solicitud se ha realizado correctamente.

Encabezados

  • ETag: string
  • Last-Modified: string
  • client-request-id: string
  • request-id: string
Other Status Codes

BatchError

Una respuesta de error inesperada.

Seguridad

OAuth2Auth

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ámbitos

Nombre Description
https://batch.core.windows.net//.default

Ejemplos

Node list

Solicitud de ejemplo

GET {endpoint}/pools/poolId/nodes?api-version=2025-06-01


Respuesta de muestra

{
  "value": [
    {
      "id": "tvm-1695681911_1-20161122t193202z",
      "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z",
      "state": "idle",
      "schedulingState": "enabled",
      "stateTransitionTime": "2025-11-22T22:22:27.2236818Z",
      "lastBootTime": "2025-11-22T22:22:24.4634125Z",
      "allocationTime": "2025-11-22T19:32:02.8155319Z",
      "ipAddress": "1.1.1.1",
      "ipv6Address": "1.1.1.1",
      "affinityId": "TVM:tvm-1695681911_1-20161122t193202z",
      "vmSize": "Standard_D2_v5",
      "totalTasksRun": 0,
      "totalTasksSucceeded": 0,
      "runningTasksCount": 0,
      "runningTaskSlotsCount": 0,
      "isDedicated": true,
      "startTask": {
        "commandLine": "cmd /c echo hello",
        "userIdentity": {
          "autoUser": {
            "scope": "task",
            "elevationLevel": "nonadmin"
          }
        },
        "maxTaskRetryCount": 0,
        "waitForSuccess": false
      },
      "virtualMachineInfo": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "ubuntu-24_04-lts",
          "sku": "server",
          "version": "latest",
          "exactVersion": "latest"
        }
      },
      "startTaskInfo": {
        "state": "completed",
        "startTime": "2025-11-22T22:22:27.2236818Z",
        "endTime": "2025-11-22T22:22:27.567189Z",
        "exitCode": 0,
        "retryCount": 0
      },
      "nodeAgentInfo": {
        "version": "1.2.0.0",
        "lastUpdateTime": "2025-11-22T22:22:24.4634125Z"
      }
    },
    {
      "id": "tvm-1695681911_2-20161122t193202z",
      "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z",
      "state": "idle",
      "schedulingState": "enabled",
      "stateTransitionTime": "2025-11-22T19:37:31.4285526Z",
      "lastBootTime": "2025-11-22T19:37:28.623369Z",
      "allocationTime": "2025-11-22T19:32:02.8155319Z",
      "ipAddress": "1.1.1.1",
      "ipv6Address": "1.1.1.1",
      "affinityId": "TVM:tvm-1695681911_2-20161122t193202z",
      "vmSize": "Standard_D2_v5",
      "totalTasksRun": 0,
      "totalTasksSucceeded": 0,
      "runningTasksCount": 0,
      "runningTaskSlotsCount": 0,
      "isDedicated": true,
      "startTask": {
        "commandLine": "cmd /c echo hello",
        "userIdentity": {
          "autoUser": {
            "scope": "task",
            "elevationLevel": "nonadmin"
          }
        },
        "maxTaskRetryCount": 0,
        "waitForSuccess": false
      },
      "virtualMachineInfo": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "ubuntu-24_04-lts",
          "sku": "server",
          "version": "latest",
          "exactVersion": "latest"
        }
      },
      "startTaskInfo": {
        "state": "completed",
        "startTime": "2025-11-22T19:37:31.4285526Z",
        "endTime": "2025-11-22T19:37:31.838028Z",
        "exitCode": 0,
        "retryCount": 0
      },
      "nodeAgentInfo": {
        "version": "1.2.0.0",
        "lastUpdateTime": "2025-11-22T22:22:24.4634125Z"
      }
    },
    {
      "id": "tvm-1695681911_3-20161122t193202z",
      "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_3-20161122t193202z",
      "state": "idle",
      "schedulingState": "enabled",
      "stateTransitionTime": "2025-11-22T19:36:51.0013378Z",
      "lastBootTime": "2025-11-22T19:36:48.21721Z",
      "allocationTime": "2025-11-22T19:32:02.8155319Z",
      "ipAddress": "1.1.1.1",
      "ipv6Address": "1.1.1.1",
      "affinityId": "TVM:tvm-1695681911_3-20161122t193202z",
      "vmSize": "Standard_D2_v5",
      "totalTasksRun": 0,
      "totalTasksSucceeded": 0,
      "runningTasksCount": 0,
      "runningTaskSlotsCount": 0,
      "isDedicated": true,
      "startTask": {
        "commandLine": "cmd /c echo hello",
        "userIdentity": {
          "autoUser": {
            "scope": "task",
            "elevationLevel": "nonadmin"
          }
        },
        "maxTaskRetryCount": 0,
        "waitForSuccess": false
      },
      "virtualMachineInfo": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "ubuntu-24_04-lts",
          "sku": "server",
          "version": "latest",
          "exactVersion": "latest"
        }
      },
      "startTaskInfo": {
        "state": "completed",
        "startTime": "2025-11-22T19:36:51.0013378Z",
        "endTime": "2025-11-22T19:36:51.2363447Z",
        "exitCode": 0,
        "retryCount": 0
      },
      "nodeAgentInfo": {
        "version": "1.2.0.0",
        "lastUpdateTime": "2025-11-22T22:22:24.4634125Z"
      }
    }
  ]
}

Definiciones

Nombre Description
AutoUserScope

Enums de AutoUserScope

AutoUserSpecification

Especifica las opciones del usuario automático que ejecuta una tarea de Azure Batch.

BatchError

Respuesta de error recibida del servicio Azure Batch.

BatchErrorDetail

Un elemento de información adicional incluida en una respuesta de error de Azure Batch.

BatchErrorMessage

Mensaje de error recibido en una respuesta de error de Azure Batch.

BatchErrorSourceCategory

Enums BatchErrorSourceCategory

BatchNode

Un nodo de proceso en el servicio Batch.

BatchNodeAgentInfo

El agente de nodo de proceso de Batch es un programa que se ejecuta en cada nodo de proceso del grupo y proporciona la funcionalidad Batch en el nodo de proceso.

BatchNodeEndpointConfiguration

Configuración del punto de conexión para el nodo de proceso.

BatchNodeError

Error detectado por un nodo de proceso.

BatchNodeIdentityReference

Referencia a una identidad asignada por el usuario asociada al grupo de Batch que usará un nodo de proceso.

BatchNodeListResult

Resultado de enumerar los nodos de proceso en un grupo.

BatchNodeState

Enums BatchNodeState

BatchStartTask

Batch volverá a intentar tareas cuando se desencadene una operación de recuperación en un nodo. Algunos ejemplos de operaciones de recuperación son (pero no están limitados a) cuando se reinicia un nodo incorrecto o un nodo de proceso desaparece debido a un error de host. Los reintentos debido a las operaciones de recuperación son independientes de y no se cuentan con maxTaskRetryCount. Incluso si maxTaskRetryCount es 0, puede producirse un reintento interno debido a una operación de recuperación. Por este motivo, todas las tareas deben ser idempotentes. Esto significa que las tareas deben tolerar que se interrumpan y se reinicien sin causar daños ni datos duplicados. El procedimiento recomendado para tareas de larga duración es usar algún tipo de punto de control. En algunos casos, startTask puede volver a ejecutarse aunque no se haya reiniciado el nodo de proceso. Se debe tener especial cuidado para evitar startTasks que creen servicios de interrupción o instalación o inicio desde el directorio de trabajo startTask, ya que esto impedirá que Batch pueda volver a ejecutar StartTask.

BatchStartTaskInfo

Información sobre una startTask que se ejecuta en un nodo de proceso.

BatchStartTaskState

Enums de BatchStartTaskState

BatchTaskContainerExecutionInfo

Contiene información sobre el contenedor que se está ejecutando una tarea.

BatchTaskContainerSettings

Configuración del contenedor de una tarea.

BatchTaskExecutionInfo

Información sobre la ejecución de una tarea.

BatchTaskExecutionResult

Enums BatchTaskExecutionResult

BatchTaskFailureInfo

Información sobre un error de tarea.

BatchTaskInfo

Información sobre una tarea que se ejecuta en un nodo de proceso.

BatchTaskState

Enums de BatchTaskState

BatchVmImageReference

Referencia a una imagen de Marketplace de Azure Virtual Machines o a una imagen de Azure Compute Gallery. Para obtener la lista de todas las referencias de imágenes de Azure Marketplace verificadas por Azure Batch, consulte la operación "Enumerar imágenes admitidas".

ContainerHostBatchBindMountEntry

La entrada de la ruta de acceso y el modo de montaje que desea montar en el contenedor de tareas.

ContainerHostDataPath

Rutas de acceso que se montarán en el contenedor de la tarea de contenedor.

ContainerRegistryReference

Un registro de contenedor privado.

ContainerWorkingDirectory

ContainerWorkingDirectory enums

ElevationLevel

Enums de ElevationLevel

EnvironmentSetting

Variable de entorno que se va a establecer en un proceso de tarea.

InboundEndpoint

Un punto de conexión de entrada en un nodo de proceso.

InboundEndpointProtocol

InboundEndpointProtocol enums

NameValuePair

Representa un par nombre-valor.

ResourceFile

Un único archivo o varios archivos que se van a descargar en un nodo de proceso.

SchedulingState

ProgramaciónEnums estatales

UserIdentity

Definición de la identidad de usuario en la que se ejecuta la tarea. Especifique la propiedad userName o autoUser, pero no ambas.

VirtualMachineInfo

Información sobre el estado actual de la máquina virtual.

AutoUserScope

Enums de AutoUserScope

Valor Description
task

Especifica que el servicio debe crear un nuevo usuario para la Tarea.

pool

Especifica que la tarea se ejecuta como la cuenta de usuario automática común, que se crea en cada nodo de cómputo de un pool.

AutoUserSpecification

Especifica las opciones del usuario automático que ejecuta una tarea de Azure Batch.

Nombre Tipo Description
elevationLevel

ElevationLevel

Nivel de elevación del usuario automático. El valor predeterminado es nonAdmin.

scope

AutoUserScope

Ámbito del usuario automático. El valor predeterminado es pool. Si el grupo ejecuta Windows, se debe especificar un valor de Task si se requiere un aislamiento más estricto entre las tareas. Por ejemplo, si la tarea muta el Registro de una manera que podría afectar a otras tareas.

BatchError

Respuesta de error recibida del servicio Azure Batch.

Nombre Tipo Description
code

string

Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.

message

BatchErrorMessage

Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.

values

BatchErrorDetail[]

Colección de pares clave-valor que contienen detalles adicionales sobre el error.

BatchErrorDetail

Un elemento de información adicional incluida en una respuesta de error de Azure Batch.

Nombre Tipo Description
key

string

Identificador que especifica el significado de la propiedad Value.

value

string

La información adicional incluida con la respuesta de error.

BatchErrorMessage

Mensaje de error recibido en una respuesta de error de Azure Batch.

Nombre Tipo Description
lang

string

El código de idioma del mensaje de error.

value

string

El texto del mensaje.

BatchErrorSourceCategory

Enums BatchErrorSourceCategory

Valor Description
usererror

El error se debe a un problema del usuario, como una mala configuración.

servererror

El error se debe a un problema interno del servidor.

BatchNode

Un nodo de proceso en el servicio Batch.

Nombre Tipo Description
affinityId

string

Identificador que se puede pasar al agregar una tarea para solicitar que la tarea se programe en este nodo de proceso. Tenga en cuenta que esto es simplemente una afinidad suave. Si el nodo de proceso de destino está ocupado o no está disponible en el momento en que se programa la tarea, la tarea se programará en otro lugar.

allocationTime

string (date-time)

Hora a la que se asignó este nodo de proceso al grupo. Este es el momento en que se asignó inicialmente el nodo de proceso y no cambia una vez establecido. No se actualiza cuando se recupera o se adelanta el nodo de proceso.

endpointConfiguration

BatchNodeEndpointConfiguration

Configuración del punto de conexión para el nodo de proceso.

errors

BatchNodeError[]

Lista de errores que se encuentran actualmente en el nodo de proceso.

id

string

Identificador del nodo de proceso. A cada nodo de proceso que se agrega a un grupo se le asigna un identificador único. Cada vez que se quita un nodo de proceso de un grupo, se eliminan todos sus archivos locales y se reclama el identificador y se puede reutilizar para los nuevos nodos de proceso.

ipAddress

string

Dirección IP que otros nodos pueden usar para comunicarse con este nodo de proceso. A cada nodo de proceso que se agrega a un grupo se le asigna una dirección IP única. Cada vez que se quita un nodo de proceso de un grupo, se eliminan todos sus archivos locales y se reclama la dirección IP y se puede reutilizar para los nuevos nodos de proceso.

ipv6Address

string

La dirección IPv6 que otros nodos pueden usar para comunicarse con este nodo de proceso. A cada nodo de proceso que se agrega a un grupo se le asigna una dirección IP única. Cada vez que se quita un nodo de proceso de un grupo, se eliminan todos sus archivos locales y se reclama la dirección IP y se puede reutilizar para los nuevos nodos de proceso. Esta propiedad no estará presente si el grupo no está configurado para IPv6.

isDedicated

boolean

Si este nodo de proceso es un nodo de proceso dedicado. Si es false, el nodo de proceso es un nodo de proceso de prioridad baja o de acceso puntual.

lastBootTime

string (date-time)

La última vez en la que se inició el nodo de proceso. Es posible que esta propiedad no esté presente si no se puede usar el estado del nodo de proceso.

nodeAgentInfo

BatchNodeAgentInfo

Información sobre la versión del agente de Nodo de proceso y la hora en que el nodo de proceso se actualizó a una nueva versión.

recentTasks

BatchTaskInfo[]

Lista de tareas cuyo estado ha cambiado recientemente. Esta propiedad solo está presente si al menos una tarea se ha ejecutado en este nodo de proceso desde que se asignó al grupo.

runningTaskSlotsCount

integer (int32)

Número total de ranuras de programación usadas actualmente por la ejecución de tareas de trabajo en el nodo de proceso. Esto incluye tareas del Administrador de trabajos y tareas normales, pero no la preparación del trabajo, la versión del trabajo o las tareas de inicio.

runningTasksCount

integer (int32)

Número total de tareas de trabajo que se están ejecutando actualmente en el nodo de proceso. Esto incluye tareas del Administrador de trabajos y tareas normales, pero no la preparación del trabajo, la versión del trabajo o las tareas de inicio.

schedulingState

SchedulingState

Indica si el nodo de proceso está disponible para la programación de tareas.

startTask

BatchStartTask

Tarea especificada para ejecutarse en el nodo de proceso a medida que se une al grupo.

startTaskInfo

BatchStartTaskInfo

Información en tiempo de ejecución sobre la ejecución de StartTask en el nodo de proceso.

state

BatchNodeState

Estado actual del nodo de proceso.

stateTransitionTime

string (date-time)

Hora en la que el nodo de proceso entró en su estado actual.

totalTasksRun

integer (int32)

Número total de tareas de trabajo completadas en el nodo de proceso. Esto incluye tareas del Administrador de trabajos y tareas normales, pero no la preparación del trabajo, la versión del trabajo o las tareas de inicio.

totalTasksSucceeded

integer (int32)

Número total de tareas de trabajo que se completaron correctamente (con exitCode 0) en el nodo de proceso. Esto incluye tareas del Administrador de trabajos y tareas normales, pero no la preparación del trabajo, la versión del trabajo o las tareas de inicio.

url

string (uri)

Dirección URL del nodo de proceso.

virtualMachineInfo

VirtualMachineInfo

Información sobre el estado actual de la máquina virtual.

vmSize

string

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

BatchNodeAgentInfo

El agente de nodo de proceso de Batch es un programa que se ejecuta en cada nodo de proceso del grupo y proporciona la funcionalidad Batch en el nodo de proceso.

Nombre Tipo Description
lastUpdateTime

string (date-time)

El momento en que el agente del Nodo de Cómputo se actualizó en el Nodo de Cómputo. Esta es la última vez que el agente de Nodo de Cómputo se actualizó a una nueva versión.

version

string

La versión del agente del Nodo de Cómputo por Lotes que se ejecuta en el Nodo de Cómputo. Este número de versión puede comprobarse con las notas de versión del agente de Compute Node ubicadas en https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.md.

BatchNodeEndpointConfiguration

Configuración del punto de conexión para el nodo de proceso.

Nombre Tipo Description
inboundEndpoints

InboundEndpoint[]

La lista de puntos finales entrantes accesibles en el Nodo de Cómputo.

BatchNodeError

Error detectado por un nodo de proceso.

Nombre Tipo Description
code

string

Un identificador para el error de Nodo de Cálculo. Los códigos son invariables y están diseñados para consumirse mediante programación.

errorDetails

NameValuePair[]

La lista de detalles adicionales de error relacionados con el error de Nodo de Cálculo.

message

string

Un mensaje que describe el error de Nodo de Cómputo, destinado a ser adecuado para su visualización en una interfaz de usuario.

BatchNodeIdentityReference

Referencia a una identidad asignada por el usuario asociada al grupo de Batch que usará un nodo de proceso.

Nombre Tipo Description
resourceId

string (arm-id)

Identificador de recurso de ARM de la identidad asignada por el usuario.

BatchNodeListResult

Resultado de enumerar los nodos de proceso en un grupo.

Nombre Tipo Description
odata.nextLink

string (uri)

La URL para obtener el siguiente conjunto de resultados.

value

BatchNode[]

La lista de nodos de cómputo.

BatchNodeState

Enums BatchNodeState

Valor Description
idle

El Nodo de Cómputo no está ejecutando actualmente una Tarea.

rebooting

El Nodo de Cómputo se está reiniciando.

reimaging

El Nodo de Cómputo está reimaginando.

running

El Nodo de Cómputo está ejecutando una o más Tareas (excepto una Tarea de Inicio).

unusable

El Nodo de Cómputo no puede usarse para la ejecución de tareas debido a errores.

creating

El servicio por lotes ha obtenido la máquina virtual subyacente de Azure Compute, pero aún no ha empezado a unirse al Pool.

starting

El servicio por lotes comienza en la máquina virtual subyacente.

waitingforstarttask

El StartTask ha comenzado a ejecutarse en el Nodo de Cálculo, pero waitForSuccess está configurado y el StartTask aún no se ha completado.

starttaskfailed

El StartTask ha fallado en el Nodo de Cómputo (y ha agotado todos los intentos), y waitForSuccess está activado. El Nodo de Cómputo no es utilizable para ejecutar Tareas.

unknown

El servicio por lotes ha perdido contacto con el Nodo de Cómputo y no conoce su estado real.

leavingpool

El Nodo de Cómputo está abandonando el Pool, ya sea porque el usuario lo eliminó explícitamente o porque el Pool se está redimensionando o autoescalando hacia abajo.

offline

El Nodo de Cómputo no está ejecutando actualmente una Tarea, y la programación de nuevas Tareas en el Nodo de Cómputo está deshabilitada.

preempted

Se ha adelantado el nodo de proceso spot/prioridad baja. Las tareas que se estaban ejecutando en el nodo de proceso cuando se adelantó se volverán a programar cuando haya otro nodo de proceso disponible.

upgradingos

El Nodo de Cómputo está sometiéndose a una operación de actualización del sistema operativo.

deallocated

El Nodo de Cómputo se asigna.

deallocating

El Nodo de Cómputo está desalojando.

BatchStartTask

Batch volverá a intentar tareas cuando se desencadene una operación de recuperación en un nodo. Algunos ejemplos de operaciones de recuperación son (pero no están limitados a) cuando se reinicia un nodo incorrecto o un nodo de proceso desaparece debido a un error de host. Los reintentos debido a las operaciones de recuperación son independientes de y no se cuentan con maxTaskRetryCount. Incluso si maxTaskRetryCount es 0, puede producirse un reintento interno debido a una operación de recuperación. Por este motivo, todas las tareas deben ser idempotentes. Esto significa que las tareas deben tolerar que se interrumpan y se reinicien sin causar daños ni datos duplicados. El procedimiento recomendado para tareas de larga duración es usar algún tipo de punto de control. En algunos casos, startTask puede volver a ejecutarse aunque no se haya reiniciado el nodo de proceso. Se debe tener especial cuidado para evitar startTasks que creen servicios de interrupción o instalación o inicio desde el directorio de trabajo startTask, ya que esto impedirá que Batch pueda volver a ejecutar StartTask.

Nombre Tipo Description
commandLine

string

Línea de comandos de StartTask. La línea de comandos no se ejecuta en un shell y, por tanto, no puede aprovechar las características del shell, como la expansión de variables de entorno. Si desea aprovechar estas características, debe invocar el shell en la línea de comandos, por ejemplo, con "cmd /c MyCommand" en Windows o "/bin/sh -c MyCommand" en Linux. Si la línea de comandos hace referencia a rutas de acceso de archivo, debe usar una ruta de acceso relativa (relativa al directorio de trabajo de la tarea) o usar la variable de entorno proporcionada por Batch (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables).

containerSettings

BatchTaskContainerSettings

La configuración del contenedor bajo el cual se ejecuta la Tarea de Iniciar. Cuando esto se especifica, todos los directorios recursivamente por debajo del AZ_BATCH_NODE_ROOT_DIR (la raíz de los directorios de Azure Batch en el nodo) se mapean en el contenedor, todas las variables del entorno de Tarea se mapean en el contenedor y la línea de comandos de Tarea se ejecuta en el contenedor. Los archivos producidos en el contenedor fuera de AZ_BATCH_NODE_ROOT_DIR pueden no reflejarse en el disco anfitrión, lo que significa que las APIs de archivos por lotes no podrán acceder a esos archivos.

environmentSettings

EnvironmentSetting[]

Lista de opciones de configuración de variables de entorno para StartTask.

maxTaskRetryCount

integer (int32)

Número máximo de veces que se puede reintentar la tarea. El servicio Batch vuelve a intentar una tarea si su código de salida es distinto de cero. Tenga en cuenta que este valor controla específicamente el número de reintentos. El servicio Batch probará la tarea una vez y, a continuación, podrá volver a intentarlo hasta este límite. Por ejemplo, si el número máximo de reintentos es 3, Batch intenta la tarea hasta 4 veces (un intento inicial y 3 reintentos). Si el número máximo de reintentos es 0, el servicio Batch no vuelve a intentar la tarea. Si el número máximo de reintentos es -1, el servicio Batch reintenta la tarea sin límite, pero esto no se recomienda para una tarea de inicio ni para ninguna tarea. El valor predeterminado es 0 (sin reintentos).

resourceFiles

ResourceFile[]

Lista de archivos que el servicio Batch descargará en el nodo de proceso antes de ejecutar la línea de comandos. Hay un tamaño máximo para la lista de archivos de recursos. Cuando se supera el tamaño máximo, se producirá un error en la solicitud y el código de error de respuesta será RequestEntityTooLarge. Si esto ocurre, la colección de ResourceFiles debe reducirse en tamaño. Esto se puede lograr mediante archivos de .zip, paquetes de aplicación o contenedores de Docker. Los archivos enumerados en este elemento se encuentran en el directorio de trabajo de la tarea.

userIdentity

UserIdentity

La identidad de usuario bajo la cual se ejecuta la Tarea de Inicio. Si se omite, la tarea se ejecuta como un usuario no administrativo único de la tarea.

waitForSuccess

boolean

Si el servicio Batch debe esperar a que StartTask se complete correctamente (es decir, salir con el código de salida 0) antes de programar cualquier tarea en el nodo de proceso. Si es true y StartTask se produce un error en un nodo, el servicio Batch reintenta startTask hasta su número máximo de reintentos (maxTaskRetryCount). Si la tarea todavía no se ha completado correctamente después de todos los reintentos, el servicio Batch marca el nodo inutilizable y no programará tareas en él. Esta condición se puede detectar a través del estado del nodo de proceso y los detalles de información de error. Si es false, el servicio Batch no esperará a que se complete StartTask. En este caso, otras tareas pueden empezar a ejecutarse en el nodo de proceso mientras startTask todavía se está ejecutando; e incluso si se produce un error en StartTask, las nuevas tareas seguirán programando en el nodo de proceso. El valor predeterminado es true.

BatchStartTaskInfo

Información sobre una startTask que se ejecuta en un nodo de proceso.

Nombre Tipo Description
containerInfo

BatchTaskContainerExecutionInfo

Información sobre el contenedor bajo el que se ejecuta la Tarea. Esta propiedad se establece solo si la tarea se ejecuta en un contexto de contenedor.

endTime

string (date-time)

El momento en que el StartTask dejó de ejecutarse. Esta es la hora de finalización de la última partida de StartTask, si esa partida se ha completado (incluso si esa partida falló y hay un nuevo intento pendiente). Este elemento no está presente si la Tarea de Inicio está en ejecución actualmente.

exitCode

integer (int32)

El código de salida del programa especificado en la línea de comandos StartTask. Esta propiedad se activa solo si el StartTask está en estado completado. En general, el código de salida de un proceso refleja la convención específica implementada por el desarrollador de la aplicación para ese proceso. Si usas el valor del código de salida para tomar decisiones en tu código, asegúrate de conocer la convención del código de salida utilizada por el proceso de solicitud. Sin embargo, si el servicio Batch termina la Tarea de Inicio (debido a timeout o a la terminación del usuario a través de la API), puede que veas un código de salida definido por el sistema operativo.

failureInfo

BatchTaskFailureInfo

Información que describa el fallo de la tarea, si es que la hay. Esta propiedad solo se activa si la tarea está en estado completado y ha tenido un fallo.

lastRetryTime

string (date-time)

La última vez en la que empezó a ejecutarse una nueva prueba de la Tarea. Este elemento solo está presente si la Tarea se ha vuelto a intentar (es decir, el recuento de reintentos es distinto de cero). Si está presente, esto suele ser igual que el inicio del tiempo, pero puede ser diferente si la tarea se ha reiniciado por razones distintas a reintentar; por ejemplo, si el Nodo de Cómputo se reinició durante un reintento, entonces el startTime se actualiza pero el lastRetryTime no.

result

BatchTaskExecutionResult

El resultado de la ejecución de la Tarea. Si el valor es 'fallido', entonces los detalles del fallo pueden encontrarse en la propiedad failInfo.

retryCount

integer (int32)

El número de veces que el servicio de lotes ha vuelto a intentar la tarea. Se vuelven a intentar fallos de la aplicación de la tarea (código de salida distinto de cero), se vuelven a intentar errores de preprocesamiento (la tarea no pudo ejecutarse) y errores de subida de archivos. El servicio por lotes volverá a intentar la tarea hasta el límite especificado por las restricciones.

startTime

string (date-time)

La hora en la que empezó a ejecutarse la Tarea de Inicio. Este valor se restablece cada vez que la Tarea se reinicia o se vuelve a intentar (es decir, es la última vez que la Tarea de Inicio ha empezado a ejecutarse).

state

BatchStartTaskState

El estado de la StartTask en el Nodo de Cómputo.

BatchStartTaskState

Enums de BatchStartTaskState

Valor Description
running

El StartTask está ejecutándose actualmente.

completed

El StartTask ha cerrado con el código de salida 0, o el StartTask ha fallado y se ha alcanzado el límite de reintentos, o el proceso StartTask no se ha ejecutado debido a errores de preparación de la tarea (como fallos en la descarga de archivos de recursos).

BatchTaskContainerExecutionInfo

Contiene información sobre el contenedor que se está ejecutando una tarea.

Nombre Tipo Description
containerId

string

La ID del contenedor.

error

string

Información detallada sobre errores sobre el contenedor. Esta es la cadena de error detallada del servicio Docker, si está disponible. Es equivalente al campo de error que devuelve "docker inspect".

state

string

El estado del contenedor. Este es el estado del contenedor según el servicio Docker. Es equivalente al campo de estado que devuelve "docker inspect".

BatchTaskContainerSettings

Configuración del contenedor de una tarea.

Nombre Tipo Description
containerHostBatchBindMounts

ContainerHostBatchBindMountEntry[]

Las rutas de acceso que desea montar en la tarea contenedora. Si esta matriz es nula o no está presente, la tarea de contenedor montará toda la unidad de disco temporal en windows (o AZ_BATCH_NODE_ROOT_DIR en Linux). No montará ninguna ruta de acceso de datos en el contenedor si esta matriz está establecida como vacía.

containerRunOptions

string

Opciones adicionales para el comando container create. Estas opciones adicionales se proporcionan como argumentos para el comando "docker create", además de las controladas por el servicio Batch.

imageName

string

La imagen que se usará para crear el contenedor en el que se ejecutará la tarea. Esta es la referencia completa de Image, tal como se especificaría en "docker pull". Si no se proporciona ninguna etiqueta como parte del nombre de la imagen, la etiqueta ":latest" se usa como predeterminada.

registry

ContainerRegistryReference

El registro privado que contiene la imagen del contenedor. Esta configuración puede omitirse si ya se proporcionó en la creación del Pool.

workingDirectory

ContainerWorkingDirectory

La ubicación del directorio de trabajo de tareas del contenedor. El valor predeterminado es "taskWorkingDirectory".

BatchTaskExecutionInfo

Información sobre la ejecución de una tarea.

Nombre Tipo Description
containerInfo

BatchTaskContainerExecutionInfo

Información sobre el contenedor bajo el que se ejecuta la Tarea. Esta propiedad se establece solo si la tarea se ejecuta en un contexto de contenedor.

endTime

string (date-time)

El momento en que se completó la Tarea. Esta propiedad se activa solo si la tarea está en estado Completado.

exitCode

integer (int32)

El código de salida del programa especificado en la línea de comandos de Tarea. Esta propiedad solo se activa si la tarea está en estado completado. En general, el código de salida de un proceso refleja la convención específica implementada por el desarrollador de la aplicación para ese proceso. Si usas el valor del código de salida para tomar decisiones en tu código, asegúrate de conocer la convención del código de salida utilizada por el proceso de solicitud. Sin embargo, si el servicio por lotes termina la tarea (debido al tiempo de espera o a la terminación del usuario a través de la API), puede que veas un código de salida definido por el sistema operativo.

failureInfo

BatchTaskFailureInfo

Información que describa el fallo de la tarea, si es que la hay. Esta propiedad solo se activa si la tarea está en estado completado y ha tenido un fallo.

lastRequeueTime

string (date-time)

La última vez en la que la tarea ha sido recolocada en cola por el servicio por lotes como resultado de una solicitud de un usuario. Esta propiedad se establece solo si el requeueCount es distinto de cero.

lastRetryTime

string (date-time)

La última vez en la que empezó a ejecutarse una nueva prueba de la Tarea. Este elemento solo está presente si la Tarea se ha vuelto a intentar (es decir, el recuento de reintentos es distinto de cero). Si está presente, esto suele ser igual que el inicio del tiempo, pero puede ser diferente si la tarea se ha reiniciado por razones distintas a reintentar; por ejemplo, si el Nodo de Cómputo se reinició durante un reintento, entonces el startTime se actualiza pero el lastRetryTime no.

requeueCount

integer (int32)

El número de veces que la tarea ha sido recola por el servicio por lotes como resultado de una solicitud de usuario. Cuando el usuario elimina Nodos de Cómputo de un Pool (redimensionando/reduciendo el pool) o cuando el Trabajo está siendo deshabilitado, puede especificar que las Tareas en ejecución en los Nodos de Cómputo se vuelvan a poner en cola para su ejecución. Este recuento registra cuántas veces la tarea ha sido recolocada en cola por estas razones.

result

BatchTaskExecutionResult

El resultado de la ejecución de la Tarea. Si el valor es 'fallido', entonces los detalles del fallo pueden encontrarse en la propiedad failInfo.

retryCount

integer (int32)

El número de veces que el servicio de lotes ha vuelto a intentar la tarea. Se vuelven a intentar fallos de la aplicación de la tarea (código de salida distinto de cero), se vuelven a intentar errores de preprocesamiento (la tarea no pudo ejecutarse) y errores de subida de archivos. El servicio por lotes volverá a intentar la tarea hasta el límite especificado por las restricciones.

startTime

string (date-time)

La hora en que la Tarea empezó a ejecutarse. 'Ejecutando' corresponde al estado en ejecución, así que si la tarea especifica archivos de recursos o paquetes, la hora de inicio refleja el momento en que la tarea comenzó a descargarlos o desplegarlos. Si la Tarea se ha reiniciado o vuelto a intentar, esta es la última vez que la Tarea ha empezado a ejecutarse. Esta propiedad solo está presente para tareas que están en estado de ejecución o completadas.

BatchTaskExecutionResult

Enums BatchTaskExecutionResult

Valor Description
success

La Prueba se desarrolló con éxito.

failure

Hubo un error durante el procesamiento de la Tarea. El fallo pudo haber ocurrido antes de que se iniciara el proceso de tarea, mientras se ejecutaba o después de que el proceso de tarea se cerrara.

BatchTaskFailureInfo

Información sobre un error de tarea.

Nombre Tipo Description
category

BatchErrorSourceCategory

La categoría del error de tarea.

code

string

Un identificador para el error Tarea. Los códigos son invariables y están diseñados para consumirse mediante programación.

details

NameValuePair[]

Una lista de detalles adicionales relacionados con el error.

message

string

Un mensaje que describe el error de Tarea, destinado a ser adecuado para mostrarse en una interfaz de usuario.

BatchTaskInfo

Información sobre una tarea que se ejecuta en un nodo de proceso.

Nombre Tipo Description
executionInfo

BatchTaskExecutionInfo

Información sobre la ejecución de la Tarea.

jobId

string

El ID del Trabajo al que pertenece la Tarea.

subtaskId

integer (int32)

El ID de la subtarea si la tarea es una tarea de múltiples instancias.

taskId

string

La identificación de la tarea.

taskState

BatchTaskState

El estado actual de la tarea.

taskUrl

string (uri)

La URL de la tarea.

BatchTaskState

Enums de BatchTaskState

Valor Description
active

La tarea está en cola y puede ejecutarse, pero actualmente no está asignada a un nodo de cómputo. Una tarea entra en este estado cuando se crea, cuando se habilita tras ser deshabilitada o cuando espera un nuevo intento tras una ejecución fallida.

preparing

La tarea ha sido asignada a un Nodo de Cómputo, pero está esperando a que se complete una tarea de Preparación de Trabajo requerida en el Nodo de Cómputo. Si la Tarea de Preparación de Tareas tiene éxito, la Tarea pasará a ejecutarse. Si la Tarea de Preparación de Tareas falla, la Tarea volverá a estar activa y será elegible para ser asignada a otro Nodo de Cómputo.

running

La tarea se ejecuta en un nodo de cómputo. Esto incluye la preparación a nivel de tarea, como descargar archivos de recursos o desplegar paquetes especificados en la tarea; no significa necesariamente que la línea de comandos de la tarea haya comenzado a ejecutarse.

completed

La Tarea ya no es elegible para ejecutarse, normalmente porque la Tarea ha terminado con éxito, o la Tarea ha sido terminada sin éxito y ha agotado su límite de reintentos. Una tarea también se marca como completada si se produjo un error al iniciar la tarea o cuando la tarea ha sido terminada.

BatchVmImageReference

Referencia a una imagen de Marketplace de Azure Virtual Machines o a una imagen de Azure Compute Gallery. Para obtener la lista de todas las referencias de imágenes de Azure Marketplace verificadas por Azure Batch, consulte la operación "Enumerar imágenes admitidas".

Nombre Tipo Description
communityGalleryImageId

string

La imagen de la galería comunitaria identifica únicamente. Esta propiedad es mutuamente excluyente con otras propiedades y se puede capturar desde la llamada GET de imagen de la galería de la comunidad.

exactVersion

string

La versión específica de la imagen de plataforma o de marketplace utilizada para crear el nodo. Este campo de solo lectura difiere de 'versión' solo si el valor especificado para 'versión' cuando se creó el pool era 'más reciente'.

offer

string

El tipo de oferta de la imagen Azure Virtual Machines Marketplace. Por ejemplo, UbuntuServer o WindowsServer.

publisher

string

El editor de la imagen Azure Virtual Machines Marketplace. Por ejemplo, Canonical o MicrosoftWindowsServer.

sharedGalleryImageId

string

Identificador único de la imagen de galería compartida. Esta propiedad es mutuamente excluyente con otras propiedades y se puede capturar desde la llamada GET de imagen de galería compartida.

sku

string

El SKU de la imagen Azure Virtual Machines Marketplace. Por ejemplo, 18.04-LTS o 2019-Datacenter.

version

string

La versión de la Imagen del Marketplace de Máquinas Virtuales de Azure. Se puede especificar un valor de 'más reciente' para seleccionar la última versión de una Imagen. Si se omite, el valor predeterminado es "latest".

virtualMachineImageId

string (arm-id)

Identificador de recursos de ARM de la imagen de Azure Compute Gallery. Los nodos de cómputo en el Pool se crearán usando este ID de Imagen. Esto es del tipo /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} o /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} para siempre usar por defecto la última versión de la imagen. Esta propiedad es mutuamente excluyente con otras propiedades de ImageReference. La Imagen de la Galería de Computación de Azure debe tener réplicas en la misma región y debe estar en la misma suscripción que la cuenta de lotes de Azure. Si la versión de la imagen no se especifica en el imageId, se utilizará la versión más reciente. Para información sobre la configuración del cortafuegos del agente del Nodo de Cómputo por Lotes para comunicarse con el servicio por lotes, véase https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration.

ContainerHostBatchBindMountEntry

La entrada de la ruta de acceso y el modo de montaje que desea montar en el contenedor de tareas.

Nombre Tipo Description
isReadOnly

boolean

Monte esta ruta de acceso de origen como modo de solo lectura o no. El valor predeterminado es false (modo de lectura y escritura). Para Linux, si monta esta ruta de acceso como modo de lectura y escritura, esto no significa que todos los usuarios del contenedor tengan acceso de lectura y escritura para la ruta de acceso, depende del acceso en la máquina virtual host. Si esta ruta de acceso está montada de solo lectura, todos los usuarios del contenedor no podrán modificar la ruta de acceso.

source

ContainerHostDataPath

La ruta de acceso que se va a montar en el cliente contenedor puede seleccionar.

ContainerHostDataPath

Rutas de acceso que se montarán en el contenedor de la tarea de contenedor.

Valor Description
Shared

Ruta de acceso de la tarea de varias instancias para compartir sus archivos.

Startup

Ruta de acceso para la tarea de inicio.

VfsMounts

La ruta de acceso contiene todos los sistemas de archivos virtuales que se montan en este nodo.

Task

Ruta de acceso de la tarea.

JobPrep

Ruta de acceso de la tarea de preparación del trabajo.

Applications

Ruta de acceso de las aplicaciones.

ContainerRegistryReference

Un registro de contenedor privado.

Nombre Tipo Description
identityReference

BatchNodeIdentityReference

Referencia a la identidad asignada por el usuario que se va a usar para acceder a una instancia de Azure Container Registry en lugar de un nombre de usuario y una contraseña.

password

string (password)

Contraseña que se va a iniciar sesión en el servidor del Registro.

registryServer

string (uri)

Dirección URL del registro. Si se omite, el valor predeterminado es "docker.io".

username

string

Nombre de usuario que se va a iniciar sesión en el servidor del Registro.

ContainerWorkingDirectory

ContainerWorkingDirectory enums

Valor Description
taskWorkingDirectory

Utiliza el directorio estándar de trabajo de tareas de servicio por lotes, que contendrá los archivos de recursos de la tarea rellenados por lote.

containerImageDefault

Utiliza el directorio de trabajo definido en la imagen del contenedor. Ten en cuenta que este directorio no contendrá los archivos de recursos descargados por Batch.

ElevationLevel

Enums de ElevationLevel

Valor Description
nonadmin

El usuario es un usuario estándar sin acceso elevado.

admin

El usuario es un usuario con acceso elevado y funciona con permisos de administrador completos.

EnvironmentSetting

Variable de entorno que se va a establecer en un proceso de tarea.

Nombre Tipo Description
name

string

Nombre de la variable de entorno.

value

string

Valor de la variable de entorno.

InboundEndpoint

Un punto de conexión de entrada en un nodo de proceso.

Nombre Tipo Description
backendPort

integer (int32)

El número de puerto backend del endpoint.

frontendPort

integer (int32)

El número de puerto público del endpoint.

name

string

Nombre del punto de conexión.

protocol

InboundEndpointProtocol

Protocolo del punto de conexión.

publicFQDN

string

El dominio público totalmente calificado para el Nodo de Cómputo.

publicIPAddress

string

La dirección IP pública del Nodo de Cómputo.

InboundEndpointProtocol

InboundEndpointProtocol enums

Valor Description
tcp

Use TCP para el punto de conexión.

udp

Use UDP para el punto de conexión.

NameValuePair

Representa un par nombre-valor.

Nombre Tipo Description
name

string

El nombre en el par nombre-valor.

value

string

El valor en el par nombre-valor.

ResourceFile

Un único archivo o varios archivos que se van a descargar en un nodo de proceso.

Nombre Tipo Description
autoStorageContainerName

string

El nombre del contenedor de almacenamiento está en la cuenta de almacenamiento automático. Las propiedades autoStorageContainerName, storageContainerUrl y httpUrl son mutuamente excluyentes y se debe especificar una de ellas.

blobPrefix

string

Prefijo de blob que se va a usar al descargar blobs de un contenedor de Azure Storage. Solo se descargarán los blobs cuyos nombres comienzan por el prefijo especificado. La propiedad solo es válida cuando se usa autoStorageContainerName o storageContainerUrl. Este prefijo puede ser un nombre de archivo parcial o un subdirectorio. Si no se especifica un prefijo, se descargarán todos los archivos del contenedor.

fileMode

string

Atributo del modo de permiso de archivo en formato octal. Esta propiedad se aplica únicamente a archivos que se descargan en nodos de cómputo de Linux. Se ignorará si se especifica para un archivo de recurso que se descargará en un Nodo de Cómputo de Windows. Si esta propiedad no se especifica para un nodo de cálculo de Linux, entonces se aplica un valor por defecto de 0770 al archivo.

filePath

string

La ubicación en el Nodo de Cómputo donde descargar el(los) archivo(s), en relación con el directorio de trabajo de la Tarea. Si se especifica la propiedad httpUrl, se requiere filePath y describe la ruta de acceso a la que se descargará el archivo, incluido el nombre de archivo. De lo contrario, si se especifica la propiedad autoStorageContainerName o storageContainerUrl, filePath es opcional y es el directorio al que descargar los archivos. En el caso de que filePath se use como directorio, cualquier estructura de directorios que ya esté asociada a los datos de entrada se conservará en su totalidad y se anexará al directorio filePath especificado. La ruta relativa especificada no puede salir del directorio de trabajo de la Tarea (por ejemplo, usando '..').

httpUrl

string (uri)

Dirección URL del archivo que se va a descargar. Las propiedades autoStorageContainerName, storageContainerUrl y httpUrl son mutuamente excluyentes y se debe especificar una de ellas. Si la dirección URL apunta a Azure Blob Storage, debe ser legible desde los nodos de proceso. Hay tres maneras de obtener esta dirección URL para un blob en Azure Storage: incluya una firma de acceso compartido (SAS) que conceda permisos de lectura en el blob, use una identidad administrada con permiso de lectura o establezca la ACL para el blob o su contenedor para permitir el acceso público.

identityReference

BatchNodeIdentityReference

La referencia a la identidad asignada por el usuario para acceder a Azure Blob Storage especificada por storageContainerUrl o httpUrl.

storageContainerUrl

string (uri)

Dirección URL del contenedor de blobs en Azure Blob Storage. Las propiedades autoStorageContainerName, storageContainerUrl y httpUrl son mutuamente excluyentes y se debe especificar una de ellas. Esta dirección URL debe ser legible y enumerable desde los nodos de proceso. Hay tres maneras de obtener esta dirección URL para un contenedor en Azure Storage: incluya una firma de acceso compartido (SAS) que conceda permisos de lectura y lista en el contenedor, use una identidad administrada con permisos de lectura y lista, o establezca la ACL para que el contenedor permita el acceso público.

SchedulingState

ProgramaciónEnums estatales

Valor Description
enabled

Las tareas pueden programarse en el Nodo de Cómputo.

disabled

No se programarán nuevas tareas en el Nodo de Cómputo. Las tareas que ya se ejecutan en el Nodo de Cómputo pueden seguir ejecutándose hasta completarse. Todos los nodos de cómputo comienzan con la programación activada.

UserIdentity

Definición de la identidad de usuario en la que se ejecuta la tarea. Especifique la propiedad userName o autoUser, pero no ambas.

Nombre Tipo Description
autoUser

AutoUserSpecification

El usuario automático bajo el cual se ejecuta la Tarea. Las propiedades userName y autoUser son mutuamente excluyentes; debe especificar uno pero no ambos.

username

string

El nombre de la identidad de usuario bajo la cual se ejecuta la Tarea. Las propiedades userName y autoUser son mutuamente excluyentes; debe especificar uno pero no ambos.

VirtualMachineInfo

Información sobre el estado actual de la máquina virtual.

Nombre Tipo Description
imageReference

BatchVmImageReference

La referencia a la imagen del Marketplace de Azure Virtual Machine.

scaleSetVmResourceId

string

El ID de recurso de la VM actual de Conjunto de Escalas de la Máquina Virtual del Nodo de Cálculo. Solo se definía si la cuenta de lote se creaba con su propiedad poolAllocationMode configurada en 'UserSubscription'.