Compute Node - List

Service:

Batch Service

API Version:

2023-11-01.18.0

Enumera los nodos de proceso del grupo especificado.

GET {batchUrl}/pools/{poolId}/nodes?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/pools/{poolId}/nodes?$filter={$filter}&$select={$select}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
batchUrl	path	True	string	Dirección URL base de todas las solicitudes de servicio de Azure Batch.
poolId	path	True	string	Identificador del grupo desde el que desea enumerar los nodos de proceso.
api-version	query	True	string	Versión de la API de cliente.
$filter	query		string	Una cláusula de $filter OData. Para obtener más información sobre cómo construir este filtro, vea https://docs.microsoft.com/en-us/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	Número máximo de elementos que se van a devolver en la respuesta. Se puede devolver un máximo de 1000 nodos de proceso.
timeout	query		integer int32	Tiempo máximo que el servidor puede dedicar a procesar la solicitud, en segundos. El valor predeterminado es 30 segundos.

Encabezado de la solicitud

Media Types: "application/json; odata=minimalmetadata"

Nombre	Requerido	Tipo	Description
client-request-id		string uuid	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-rfc1123	Hora a la que se emitió la solicitud. Normalmente, las bibliotecas cliente establecen esto en la hora actual del reloj del sistema; establézcalo explícitamente si llama directamente a la API REST.

Respuestas

Nombre	Tipo	Description
200 OK	ComputeNodeListResult	Respuesta que contiene la lista de nodos de proceso. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Error del servicio Batch.

Seguridad

azure_auth

flujo de código de autenticación de OAuth 2.0 Microsoft Entra

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	Suplantación de su cuenta de usuario

Authorization

Type: apiKey
In: header

Ejemplos

Node list

Sample Request

HTTP

GET account.region.batch.azure.com/pools/poolId/nodes?api-version=2023-11-01.18.0

Sample Response

Status code:

200

{
  "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": "2016-11-22T22:22:27.2236818Z",
      "lastBootTime": "2016-11-22T22:22:24.4634125Z",
      "allocationTime": "2016-11-22T19:32:02.8155319Z",
      "ipAddress": "1.1.1.1",
      "affinityId": "TVM:tvm-1695681911_1-20161122t193202z",
      "vmSize": "small",
      "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
      },
      "startTaskInfo": {
        "state": "completed",
        "startTime": "2016-11-22T22:22:27.2236818Z",
        "endTime": "2016-11-22T22:22:27.567189Z",
        "exitCode": 0,
        "retryCount": 0
      },
      "nodeAgentInfo": {
        "version": "1.2.0.0",
        "lastUpdateTime": "2016-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": "2016-11-22T19:37:31.4285526Z",
      "lastBootTime": "2016-11-22T19:37:28.623369Z",
      "allocationTime": "2016-11-22T19:32:02.8155319Z",
      "ipAddress": "1.1.1.1",
      "affinityId": "TVM:tvm-1695681911_2-20161122t193202z",
      "vmSize": "small",
      "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
      },
      "startTaskInfo": {
        "state": "completed",
        "startTime": "2016-11-22T19:37:31.4285526Z",
        "endTime": "2016-11-22T19:37:31.838028Z",
        "exitCode": 0,
        "retryCount": 0
      },
      "nodeAgentInfo": {
        "version": "1.2.0.0",
        "lastUpdateTime": "2016-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": "2016-11-22T19:36:51.0013378Z",
      "lastBootTime": "2016-11-22T19:36:48.21721Z",
      "allocationTime": "2016-11-22T19:32:02.8155319Z",
      "ipAddress": "1.1.1.1",
      "affinityId": "TVM:tvm-1695681911_3-20161122t193202z",
      "vmSize": "small",
      "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
      },
      "startTaskInfo": {
        "state": "completed",
        "startTime": "2016-11-22T19:36:51.0013378Z",
        "endTime": "2016-11-22T19:36:51.2363447Z",
        "exitCode": 0,
        "retryCount": 0
      },
      "nodeAgentInfo": {
        "version": "1.2.0.0",
        "lastUpdateTime": "2016-11-22T22:22:24.4634125Z"
      }
    }
  ]
}

Definiciones

Nombre	Description
AutoUserScope	Ámbito del usuario automático
AutoUserSpecification	Especifica los parámetros para el usuario automático que ejecuta una tarea en el servicio Batch.
BatchError	Respuesta de error recibida del servicio Azure Batch.
BatchErrorDetail	Elemento de información adicional incluida en una respuesta de error Azure Batch.
CertificateReference	Referencia a un certificado que se va a instalar en nodos de proceso de un grupo.
CertificateStoreLocation	Ubicación del almacén de certificados en el nodo de proceso en el que se va a instalar el certificado.
CertificateVisibility	Qué cuentas de usuario del nodo de proceso deben tener acceso a los datos privados del certificado.
ComputeNode	Un nodo de proceso en el servicio Batch.
ComputeNodeEndpointConfiguration	Configuración del punto de conexión para el nodo de proceso.
ComputeNodeError	Error detectado por un nodo de proceso.
ComputeNodeIdentityReference	Referencia a una identidad asignada por el usuario asociada al grupo de Batch que usará un nodo de proceso.
ComputeNodeListResult	Resultado de enumerar los nodos de proceso en un grupo.
ComputeNodeState	Estado actual del nodo de ejecución.
ContainerRegistry	Un registro de contenedor privado.
ContainerWorkingDirectory	Ubicación del directorio de trabajo de la tarea de contenedor.
ElevationLevel	Nivel de elevación del usuario.
EnvironmentSetting	Variable de entorno que se va a establecer en un proceso de tarea.
ErrorCategory	Categoría del error.
ErrorMessage	Mensaje de error recibido en una respuesta de error Azure Batch.
ImageReference	Referencia a una imagen de Azure Virtual Machines Marketplace o a una imagen de Azure Compute Gallery. Para obtener la lista de todas las referencias de imagen de Azure Marketplace verificadas por Azure Batch, consulte la operación "Enumerar imágenes admitidas".
InboundEndpoint	Un punto de conexión de entrada en un nodo de proceso.
InboundEndpointProtocol	Protocolo del punto de conexión.
NameValuePair	Representa un par nombre-valor.
NodeAgentInformation	Información sobre el agente de Compute Node.
ResourceFile	Un único archivo o varios archivos que se van a descargar en un nodo de proceso.
SchedulingState	Si el nodo de proceso está disponible para la programación de tareas.
StartTask	Tarea que se ejecuta cuando un nodo se une a un grupo en el servicio Azure Batch o cuando se reinicia o se vuelve a crear una imagen de imagen.
StartTaskInformation	Información sobre una startTask que se ejecuta en un nodo de proceso.
StartTaskState	Estado de StartTask en el nodo de proceso.
TaskContainerExecutionInformation	Contiene información sobre el contenedor que se está ejecutando una tarea.
TaskContainerSettings	Configuración del contenedor de una tarea.
TaskExecutionInformation	Información sobre la ejecución de una tarea.
TaskExecutionResult	Resultado de la ejecución de la tarea.
TaskFailureInformation	Información sobre un error de tarea.
TaskInformation	Información sobre una tarea que se ejecuta en un nodo de proceso.
TaskState	Estado de la tarea.
UserIdentity	Definición de la identidad de usuario en la que se ejecuta la tarea.
VirtualMachineInfo	Información sobre el estado actual de la máquina virtual.

AutoUserScope

Ámbito del usuario automático

Nombre	Tipo	Description
pool	string	Especifica que la tarea se ejecuta como la cuenta de usuario automático común que se crea en cada nodo de proceso de un grupo.
task	string	Especifica que el servicio debe crear un nuevo usuario para la tarea.

AutoUserSpecification

Especifica los parámetros para el usuario automático que ejecuta una tarea en el servicio 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, o si se han especificado certificados en el grupo que no deben ser accesibles por las tareas normales, pero deben ser accesibles por StartTasks.

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	ErrorMessage	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 contiene detalles adicionales sobre el error.

BatchErrorDetail

Elemento de información adicional incluida en una respuesta de error 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.

CertificateReference

Referencia a un certificado que se va a instalar en nodos de proceso de un grupo.

Nombre	Tipo	Description
storeLocation	CertificateStoreLocation	Ubicación del almacén de certificados en el nodo de proceso en el que se va a instalar el certificado. El valor predeterminado es currentuser. Esta propiedad solo se aplica a los grupos configurados con nodos de proceso de Windows (es decir, creados con cloudServiceConfiguration o con virtualMachineConfiguration mediante una referencia de imagen de Windows). En el caso de los nodos de proceso de Linux, los certificados se almacenan en un directorio dentro del directorio de trabajo de la tarea y se proporciona una variable de entorno AZ_BATCH_CERTIFICATES_DIR a la tarea para consultar esta ubicación. En el caso de los certificados con visibilidad de "remoteUser", se crea un directorio "certs" en el directorio principal del usuario (por ejemplo, /home/{nombre-de-usuario}/certs) y los certificados se colocan en ese directorio.
storeName	string	Nombre del almacén de certificados en el nodo de proceso en el que se va a instalar el certificado. Esta propiedad solo se aplica a los grupos configurados con nodos de proceso de Windows (es decir, creados con cloudServiceConfiguration o con virtualMachineConfiguration mediante una referencia de imagen de Windows). Los nombres de almacén comunes incluyen: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, pero también se puede usar cualquier nombre de almacén personalizado. El valor predeterminado es My.
thumbprint	string	Huella digital del certificado.
thumbprintAlgorithm	string	Algoritmo con el que está asociada la huella digital. Debe ser sha1.
visibility	CertificateVisibility[]	Qué cuentas de usuario del nodo de proceso deben tener acceso a los datos privados del certificado. Puede especificar más de una visibilidad en esta colección. El valor predeterminado es todas las cuentas.

CertificateStoreLocation

Ubicación del almacén de certificados en el nodo de proceso en el que se va a instalar el certificado.

Nombre	Tipo	Description
currentuser	string	Los certificados deben instalarse en el almacén de certificados CurrentUser.
localmachine	string	Los certificados deben instalarse en el almacén de certificados localMachine.

CertificateVisibility

Qué cuentas de usuario del nodo de proceso deben tener acceso a los datos privados del certificado.

Nombre	Tipo	Description
remoteuser	string	El certificado debe ser visible para las cuentas de usuario en las que los usuarios acceden de forma remota al nodo de proceso.
starttask	string	El certificado debe ser visible para la cuenta de usuario en la que se ejecuta StartTask. Tenga en cuenta que si El ámbito de autousuario es Grupo para startTask y una tarea, este certificado también será visible para la tarea.
task	string	El certificado debe ser visible para las cuentas de usuario en las que se ejecutan las tareas de trabajo.

ComputeNode

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 se trata simplemente de una afinidad flexible. Si el nodo de ejecución 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	Hora a la que se asignó este nodo de proceso al grupo. Esta es la hora en que se asignó inicialmente el nodo de ejecución y no cambia una vez establecido. No se actualiza cuando el nodo de proceso se recupera o se adelanta.
certificateReferences	CertificateReference[]	Lista de certificados instalados en el nodo de proceso. En el caso de los nodos de Windows, el servicio Batch instala los certificados en el almacén de certificados y la ubicación especificados. En el caso de los nodos de ejecución de Linux, los certificados se almacenan en un directorio dentro del directorio de trabajo de la tarea y se proporciona una variable de entorno AZ_BATCH_CERTIFICATES_DIR a la tarea para consultar esta ubicación. En el caso de los certificados con visibilidad de "remoteUser", se crea un directorio "certs" en el directorio principal del usuario (por ejemplo, /home/{user-name}/certs) y los certificados se colocan en ese directorio. Advertencia: esta propiedad está en desuso y se quitará después de febrero de 2024. Use la extensión Azure KeyVault en su lugar.
endpointConfiguration	ComputeNodeEndpointConfiguration	Configuración del punto de conexión para el nodo de ejecución.
errors	ComputeNodeError[]	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 ejecución. 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.
isDedicated	boolean	Si este nodo de proceso es un nodo de ejecución dedicado. Si es false, el nodo de proceso es un nodo de ejecución de prioridad baja o de acceso puntual.
lastBootTime	string	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 ejecución.
nodeAgentInfo	NodeAgentInformation	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. El agente de Batch Compute Node es un programa que se ejecuta en cada nodo de proceso del grupo y proporciona funcionalidad de Batch en el nodo de proceso.
recentTasks	TaskInformation[]	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 ejecución desde que se asignó al grupo.
runningTaskSlotsCount	integer	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 las tareas del Administrador de trabajos y las tareas normales, pero no la preparación del trabajo, la liberación del trabajo o las tareas de inicio.
runningTasksCount	integer	Número total de tareas de trabajo que se están ejecutando actualmente en el nodo de proceso. Esto incluye las tareas del Administrador de trabajos y las tareas normales, pero no la preparación del trabajo, la liberación del trabajo o las tareas de inicio.
schedulingState	SchedulingState	Si el nodo de proceso está disponible para la programación de tareas.
startTask	StartTask	Tarea especificada para ejecutarse en el nodo de ejecución a medida que se une al grupo. Batch volverá a intentar tareas cuando se desencadene una operación de recuperación en un nodo. Entre los ejemplos de operaciones de recuperación se incluyen (pero no se limitan a) cuando se reinicia un nodo incorrecto o un nodo de proceso desaparece debido a un error de host. Los reintentos debidos a 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 el nodo de proceso no se haya reiniciado. Se debe tener especial cuidado para evitar StartTasks que creen un proceso de interrupción o instalen o inicien servicios desde el directorio de trabajo StartTask, ya que esto impedirá que Batch pueda volver a ejecutar StartTask.
startTaskInfo	StartTaskInformation	Información en tiempo de ejecución sobre la ejecución de StartTask en el nodo de ejecución.
state	ComputeNodeState	Estado actual del nodo de ejecución. Se ha adelantado el nodo de ejecución spot/prioridad baja. Las tareas que se estaban ejecutando en el nodo de ejecución cuando se adelantó se reprogramarán cuando haya otro nodo de proceso disponible.
stateTransitionTime	string	Hora a la que el nodo de ejecución entró en su estado actual.
totalTasksRun	integer	Número total de tareas de trabajo completadas en el nodo de ejecución. Esto incluye las tareas del Administrador de trabajos y las tareas normales, pero no la preparación del trabajo, la liberación del trabajo o las tareas de inicio.
totalTasksSucceeded	integer	Número total de tareas de trabajo que se completaron correctamente (con exitCode 0) en el nodo de proceso. Esto incluye las tareas del Administrador de trabajos y las tareas normales, pero no la preparación del trabajo, la liberación del trabajo o las tareas de inicio.
url	string	Dirección URL del nodo de ejecución.
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://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

ComputeNodeEndpointConfiguration

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

Nombre	Tipo	Description
inboundEndpoints	InboundEndpoint[]	Lista de puntos de conexión entrantes a los que se puede acceder en el nodo de proceso.

ComputeNodeError

Error detectado por un nodo de proceso.

Nombre	Tipo	Description
code	string	Identificador del error del nodo de proceso. Los códigos son invariables y están diseñados para consumirse mediante programación.
errorDetails	NameValuePair[]	Lista de detalles de error adicionales relacionados con el error del nodo de proceso.
message	string	Mensaje que describe el error de nodo de proceso, diseñado para ser adecuado para su visualización en una interfaz de usuario.

ComputeNodeIdentityReference

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

Nombre	Tipo	Description
resourceId	string	Identificador de recurso de ARM de la identidad asignada por el usuario.

ComputeNodeListResult

Resultado de enumerar los nodos de proceso en un grupo.

Nombre	Tipo	Description
odata.nextLink	string	Dirección URL para obtener el siguiente conjunto de resultados.
value	ComputeNode[]	Lista de nodos de ejecución.

ComputeNodeState

Estado actual del nodo de ejecución.

Nombre	Tipo	Description
creating	string	El servicio Batch ha obtenido la máquina virtual subyacente de Azure Compute, pero aún no ha empezado a unirse al grupo.
idle	string	El nodo de proceso no está ejecutando actualmente una tarea.
leavingpool	string	El nodo de proceso deja el grupo, ya sea porque el usuario lo quitó explícitamente o porque el grupo está ajustando el tamaño o el escalado automático.
offline	string	El nodo de ejecución no está ejecutando actualmente una tarea y la programación de nuevas tareas en el nodo de proceso está deshabilitada.
preempted	string	Se ha adelantado el nodo de ejecución spot/prioridad baja. Las tareas que se estaban ejecutando en el nodo de ejecución cuando se adelantó se reprogramarán cuando haya otro nodo de proceso disponible.
rebooting	string	El nodo de proceso se está reiniciando.
reimaging	string	El nodo de proceso se vuelve a calcular.
running	string	El nodo de ejecución ejecuta una o varias tareas (distintas de StartTask).
starting	string	El servicio Batch se inicia en la máquina virtual subyacente.
starttaskfailed	string	StartTask ha producido un error en el nodo de proceso (y ha agotado todos los reintentos) y se ha establecido waitForSuccess. El nodo de ejecución no se puede usar para ejecutar tareas.
unknown	string	El servicio Batch ha perdido el contacto con el nodo de proceso y no conoce su verdadero estado.
unusable	string	No se puede usar el nodo de proceso para la ejecución de tareas debido a errores.
waitingforstarttask	string	StartTask ha empezado a ejecutarse en el nodo de ejecución, pero waitForSuccess está establecido y StartTask aún no se ha completado.

ContainerRegistry

Un registro de contenedor privado.

Nombre	Tipo	Description
identityReference	ComputeNodeIdentityReference	Referencia a la identidad asignada por el usuario que se va a usar para acceder a un Azure Container Registry en lugar de un nombre de usuario y una contraseña. Referencia a una identidad asignada por el usuario asociada al grupo de Batch que usará un nodo de proceso.
password	string	Contraseña que se va a iniciar sesión en el servidor del Registro.
registryServer	string	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

Ubicación del directorio de trabajo de la tarea de contenedor.

Nombre	Tipo	Description
containerImageDefault	string	Use el directorio de trabajo definido en la imagen del contenedor. Tenga en cuenta que este directorio no contendrá los archivos de recursos descargados por Batch.
taskWorkingDirectory	string	Use el directorio de trabajo de tarea del servicio Batch estándar, que contendrá los archivos de recursos de tareas rellenados por Batch.

ElevationLevel

Nivel de elevación del usuario.

Nombre	Tipo	Description
admin	string	El usuario es un usuario con acceso elevado y funciona con permisos de administrador completos.
nonadmin	string	El usuario es un usuario estándar sin acceso elevado.

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.

ErrorCategory

Categoría del error.

Nombre	Tipo	Description
servererror	string	El error se debe a un problema interno del servidor.
usererror	string	El error se debe a un problema de usuario, como la configuración incorrecta.

ErrorMessage

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

Nombre	Tipo	Description
lang	string	Código de idioma del mensaje de error
value	string	Texto del mensaje.

ImageReference

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

Nombre	Tipo	Description
exactVersion	string	La versión específica de la imagen de plataforma o la imagen de Marketplace que se usa para crear el nodo. Este campo de solo lectura difiere de "version" solo si el valor especificado para "version" cuando se creó el grupo era "latest".
offer	string	El tipo de oferta de la imagen de Marketplace de Azure Virtual Machines. Por ejemplo, UbuntuServer o WindowsServer.
publisher	string	Publicador de la imagen de Marketplace de Azure Virtual Machines. Por ejemplo, Canonical o MicrosoftWindowsServer.
sku	string	SKU de la imagen de Marketplace de Azure Virtual Machines. Por ejemplo, 18.04-LTS o 2019-Datacenter.
version	string	La versión de la imagen de Azure Virtual Machines Marketplace. Se puede especificar un valor de "latest" para seleccionar la versión más reciente de una imagen. Si se omite, el valor predeterminado es "latest".
virtualMachineImageId	string	Identificador de recurso de ARM de la imagen de Azure Compute Gallery. Los nodos de proceso del grupo se crearán con este identificador de imagen. Tiene el formato /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} o /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName} para la versión de imagen más reciente. Esta propiedad es mutuamente excluyente con otras propiedades ImageReference. La imagen de Azure Compute Gallery debe tener réplicas en la misma región y debe estar en la misma suscripción que la cuenta de Azure Batch. Si la versión de la imagen no se especifica en imageId, se usará la versión más reciente. Para obtener información sobre la configuración del firewall para que el agente de Batch Compute Node se comunique con el servicio Batch, consulte https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

InboundEndpoint

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

Nombre	Tipo	Description
backendPort	integer	Número de puerto de back-end del punto de conexión.
frontendPort	integer	Número de puerto público del punto de conexión.
name	string	Nombre del punto de conexión.
protocol	InboundEndpointProtocol	Protocolo del punto de conexión.
publicFQDN	string	Nombre de dominio completo público para el nodo de ejecución.
publicIPAddress	string	La dirección IP pública del nodo de ejecución.

InboundEndpointProtocol

Protocolo del punto de conexión.

Nombre	Tipo	Description
tcp	string	Use TCP para el punto de conexión.
udp	string	Use UDP para el punto de conexión.

NameValuePair

Representa un par nombre-valor.

Nombre	Tipo	Description
name	string	Nombre del par nombre-valor.
value	string	Valor del par nombre-valor.

NodeAgentInformation

Información sobre el agente de Compute Node.

Nombre	Tipo	Description
lastUpdateTime	string	Hora en que se actualizó el agente de Nodo de proceso en el nodo de proceso. Esta es la última vez que el agente de Compute Node se actualizó a una nueva versión.
version	string	La versión del agente de Batch Compute Node que se ejecuta en el nodo de proceso. Este número de versión se puede comprobar con las notas de la versión del agente de Compute Node ubicadas en https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.md.

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 en la cuenta de almacenamiento automática. 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 comiencen 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 de modo de permiso de archivo en formato octal. Esta propiedad solo se aplica a los archivos que se descargan en nodos de proceso de Linux. Se omitirá si se especifica para un resourceFile que se descargará en un nodo de proceso de Windows. Si no se especifica esta propiedad para un nodo de ejecución de Linux, se aplica un valor predeterminado de 0770 al archivo.
filePath	string	Ubicación en el nodo de proceso al que se van a descargar los archivos, 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 en 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 de acceso relativa especificada no puede interrumpir el directorio de trabajo de la tarea (por ejemplo, mediante "..").
httpUrl	string	La 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	ComputeNodeIdentityReference	Referencia a la identidad asignada por el usuario que se va a usar para acceder a Azure Blob Storage especificado por storageContainerUrl o httpUrl Referencia a una identidad asignada por el usuario asociada al grupo de Batch que usará un nodo de proceso.
storageContainerUrl	string	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

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

Nombre	Tipo	Description
disabled	string	No se programarán nuevas tareas en el nodo de proceso. Las tareas que ya se ejecutan en el nodo de ejecución pueden seguir ejecutándose hasta su finalización. Todos los nodos de proceso comienzan con la programación habilitada.
enabled	string	Las tareas se pueden programar en el nodo de ejecución.

StartTask

Tarea que se ejecuta cuando un nodo se une a un grupo en el servicio Azure Batch o cuando se reinicia o se vuelve a crear una imagen de imagen.

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 tarea) o usar la variable de entorno proporcionada por Batch (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
containerSettings	TaskContainerSettings	La configuración del contenedor en el que se ejecuta StartTask. Cuando se especifica esto, todos los directorios de forma recursiva debajo del AZ_BATCH_NODE_ROOT_DIR (la raíz de Azure Batch directorios del nodo) se asignan al contenedor, todas las variables de entorno task se asignan al contenedor y la línea de comandos Task se ejecuta en el contenedor. Es posible que los archivos generados en el contenedor fuera de AZ_BATCH_NODE_ROOT_DIR no se reflejen en el disco host, lo que significa que las API de archivos de Batch no podrán acceder a esos archivos.
environmentSettings	EnvironmentSetting[]	Lista de opciones de configuración de variables de entorno para StartTask.
maxTaskRetryCount	integer	Número máximo de veces que se puede reintentar la tarea. El servicio Batch reintenta 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, puede 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 reintenta 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 ningún reintento).
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 de tamaño. Esto se puede lograr mediante archivos .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	Identidad de usuario con la que se ejecuta StartTask. Si se omite, la tarea se ejecuta como un usuario no administrativo único para 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 se sigue ejecutando StartTask; 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.

StartTaskInformation

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

Nombre	Tipo	Description
containerInfo	TaskContainerExecutionInformation	Información sobre el contenedor en el que se ejecuta la tarea. Esta propiedad solo se establece si la tarea se ejecuta en un contexto de contenedor.
endTime	string	Hora en la que StartTask dejó de ejecutarse. Esta es la hora de finalización de la ejecución más reciente de StartTask, si esa ejecución se ha completado (incluso si se produjo un error en la ejecución y hay pendiente un reintento). Este elemento no está presente si startTask se está ejecutando actualmente.
exitCode	integer	Código de salida del programa especificado en la línea de comandos StartTask. Esta propiedad solo se establece si 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 aplicaciones para ese proceso. Si usa el valor de código de salida para tomar decisiones en el código, asegúrese de que conoce la convención de código de salida usada por el proceso de aplicación. Sin embargo, si el servicio Batch finaliza startTask (debido al tiempo de espera o a la finalización del usuario a través de la API), es posible que vea un código de salida definido por el sistema operativo.
failureInfo	TaskFailureInformation	Información que describe el error de tarea, si existe. Esta propiedad solo se establece si la tarea está en estado completado y encontró un error.
lastRetryTime	string	La hora más reciente en la que se inició un reintento de la tarea. Este elemento solo está presente si se reintentó la tarea (es decir, retryCount es distinto de cero). Si está presente, suele ser el mismo que startTime, pero puede ser diferente si la tarea se ha reiniciado por motivos distintos del reintento; por ejemplo, si el nodo de proceso se ha reiniciado durante un reintento, se actualiza startTime, pero lastRetryTime no.
result	TaskExecutionResult	Resultado de la ejecución de la tarea. Si el valor es "failed", los detalles del error se pueden encontrar en la propiedad failureInfo.
retryCount	integer	Número de veces que el servicio Batch ha reintentado la tarea. Los errores de aplicación de tareas (código de salida distinto de cero) se reintentan, se reintentan los errores de preprocesamiento (no se pudo ejecutar la tarea) y no se reintentan los errores de carga de archivos. El servicio Batch reintentará la tarea hasta el límite especificado por las restricciones.
startTime	string	Hora a la que se inició la ejecución de StartTask. Este valor se restablece cada vez que se reinicia o se vuelve a intentar la tarea (es decir, esta es la hora más reciente en la que se inició la ejecución de StartTask).
state	StartTaskState	Estado de StartTask en el nodo de proceso.

StartTaskState

Estado de StartTask en el nodo de proceso.

Nombre	Tipo	Description
completed	string	StartTask se ha cerrado con el código de salida 0 o se ha producido un error en StartTask y se ha alcanzado el límite de reintentos, o bien el proceso StartTask no se ejecutó debido a errores de preparación de la tarea (por ejemplo, errores de descarga de archivos de recursos).
running	string	StartTask se está ejecutando actualmente.

TaskContainerExecutionInformation

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 del error sobre el contenedor. Esta es la cadena de error detallada del servicio Docker, si está disponible. Es equivalente al campo de error devuelto por "docker inspect".
state	string	Estado del contenedor. Este es el estado del contenedor según el servicio Docker. Es equivalente al campo de estado devuelto por "docker inspect".

TaskContainerSettings

Configuración del contenedor de una tarea.

Nombre	Tipo	Description
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	Imagen que se va a usar para crear el contenedor en el que se ejecutará la tarea. Se trata de la referencia de imagen completa, 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 valor predeterminado.
registry	ContainerRegistry	Registro privado que contiene la imagen de contenedor. Esta configuración se puede omitir si ya se proporcionó en la creación del grupo.
workingDirectory	ContainerWorkingDirectory	Ubicación del directorio de trabajo de la tarea de contenedor. El valor predeterminado es "taskWorkingDirectory".

TaskExecutionInformation

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

Nombre	Tipo	Description
containerInfo	TaskContainerExecutionInformation	Información sobre el contenedor en el que se ejecuta la tarea. Esta propiedad solo se establece si la tarea se ejecuta en un contexto de contenedor.
endTime	string	Hora a la que se completó la tarea. Esta propiedad solo se establece si la tarea está en estado Completado.
exitCode	integer	Código de salida del programa especificado en la línea de comandos task. Esta propiedad solo se establece 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 aplicaciones para ese proceso. Si usa el valor de código de salida para tomar decisiones en el código, asegúrese de que conoce la convención de código de salida usada por el proceso de aplicación. Sin embargo, si el servicio Batch finaliza la tarea (debido al tiempo de espera o a la finalización del usuario a través de la API), es posible que vea un código de salida definido por el sistema operativo.
failureInfo	TaskFailureInformation	Información que describe el error de tarea, si existe. Esta propiedad solo se establece si la tarea está en estado completado y encontró un error.
lastRequeueTime	string	La hora más reciente en la que el servicio Batch ha vuelto a poner en cola la tarea como resultado de una solicitud de usuario. Esta propiedad solo se establece si requeueCount es distinto de cero.
lastRetryTime	string	La hora más reciente en la que se inició la ejecución de un reintento de la tarea. Este elemento solo está presente si se reintentó la tarea (es decir, retryCount es distinto de cero). Si está presente, suele ser el mismo que startTime, pero puede ser diferente si la tarea se ha reiniciado por motivos distintos del reintento; por ejemplo, si el nodo de proceso se ha reiniciado durante un reintento, se actualiza startTime, pero lastRetryTime no.
requeueCount	integer	Número de veces que el servicio Batch ha puesto en cola la tarea como resultado de una solicitud de usuario. Cuando el usuario quita nodos de proceso de un grupo (mediante el cambio de tamaño o reducción del grupo) o cuando el trabajo está deshabilitado, el usuario puede especificar que las tareas en ejecución en los nodos de proceso se vuelvan a poner en cola para su ejecución. Este recuento realiza un seguimiento de cuántas veces se ha vuelto a poner en cola la tarea por estos motivos.
result	TaskExecutionResult	Resultado de la ejecución de la tarea. Si el valor es "failed", los detalles del error se pueden encontrar en la propiedad failureInfo.
retryCount	integer	Número de veces que el servicio Batch ha reintentado la tarea. Los errores de la aplicación de tareas (código de salida distinto de cero) se reintentan, se reintentan los errores de procesamiento previo (no se pudo ejecutar la tarea) y no se reintentan los errores de carga de archivos. El servicio Batch reintentará la tarea hasta el límite especificado por las restricciones.
startTime	string	Hora en la que se inició la ejecución de la tarea. "En ejecución" corresponde al estado en ejecución, por lo que si la tarea especifica archivos de recursos o paquetes, la hora de inicio refleja la hora en la que la tarea comenzó a descargar o implementarlas. Si se ha reiniciado o reintentado la tarea, esta es la hora más reciente en la que se inició la ejecución de la tarea. Esta propiedad solo está presente para las tareas que están en estado en ejecución o completado.

TaskExecutionResult

Resultado de la ejecución de la tarea.

Nombre	Tipo	Description
failure	string	Se produjo un error durante el procesamiento de la tarea. Es posible que el error se haya producido antes de que se inicie el proceso de tarea, mientras se estaba ejecutando el proceso de tarea o después de salir del proceso de tarea.
success	string	La tarea se ejecutó correctamente.

TaskFailureInformation

Información sobre un error de tarea.

Nombre	Tipo	Description
category	ErrorCategory	Categoría del error de tarea.
code	string	Identificador del error de tarea. Los códigos son invariables y están diseñados para consumirse mediante programación.
details	NameValuePair[]	Lista de detalles adicionales relacionados con el error.
message	string	Mensaje que describe el error de tarea, diseñado para ser adecuado para mostrarse en una interfaz de usuario.

TaskInformation

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

Nombre	Tipo	Description
executionInfo	TaskExecutionInformation	Información sobre la ejecución de la tarea.
jobId	string	Identificador del trabajo al que pertenece la tarea.
subtaskId	integer	Identificador de la subtarea si la tarea es una tarea de varias instancias.
taskId	string	Identificador de la tarea.
taskState	TaskState	Estado actual de la tarea.
taskUrl	string	Dirección URL de la tarea.

TaskState

Estado de la tarea.

Nombre	Tipo	Description
active	string	La tarea se pone en cola y se puede ejecutar, pero no está asignada actualmente a un nodo de proceso. Una tarea entra en este estado cuando se crea, cuando se habilita después de deshabilitarse o cuando está esperando un reintento después de una ejecución errónea.
completed	string	La tarea ya no es apta para ejecutarse, normalmente porque la tarea ha finalizado correctamente o la tarea ha finalizado sin éxito y ha agotado su límite de reintento. Una tarea también se marca como completada si se produjo un error al iniciar la tarea o cuando se ha terminado la tarea.
preparing	string	La tarea se ha asignado a un nodo de proceso, pero espera a que se complete una tarea de preparación de trabajo necesaria en el nodo de proceso. Si la tarea de preparación del trabajo se realiza correctamente, la tarea pasará a ejecutarse. Si se produce un error en la tarea de preparación del trabajo, la tarea volverá a activa y será apta para asignarse a otro nodo de proceso.
running	string	La tarea se ejecuta en un nodo de proceso. Esto incluye la preparación de nivel de tarea, como la descarga de archivos de recursos o la implementación de paquetes especificados en la tarea; no significa necesariamente que la línea de comandos task haya empezado a ejecutarse.

UserIdentity

Definición de la identidad de usuario en la que se ejecuta la tarea.

Nombre	Tipo	Description
autoUser	AutoUserSpecification	Usuario automático en el que se ejecuta la tarea. Las propiedades userName y autoUser son mutuamente excluyentes; debe especificar uno pero no ambos.
username	string	Nombre de la identidad de usuario en la que 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	ImageReference	Referencia a la imagen de Marketplace de la máquina virtual de Azure.
scaleSetVmResourceId	string	Identificador de recurso de la máquina virtual actual del conjunto de escalado de máquinas virtuales del nodo de proceso. Solo se define si la cuenta de Batch se creó con su propiedad poolAllocationMode establecida en "UserSubscription".