Job Schedule - List

Enumera todas las programaciones de trabajo de la cuenta especificada.

GET {batchUrl}/jobschedules?api-version=2022-01-01.15.0
GET {batchUrl}/jobschedules?$filter={$filter}&$select={$select}&$expand={$expand}&maxresults={maxresults}&timeout={timeout}&api-version=2022-01-01.15.0

Parámetros de identificador URI

Name In Required Type Description
batchUrl
path True
  • string

Dirección URL base de todas las solicitudes de servicio de Azure Batch.

api-version
query True
  • string

Versión de la API de cliente.

$expand
query
  • string

Una cláusula $expand de OData.

$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-job-schedules.

$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 programaciones de trabajo.

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"

Name Required Type 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

Name Type Description
200 OK

Respuesta que contiene la lista de programaciones de trabajo.

Headers

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

Error del servicio Batch.

Seguridad

azure_auth

Azure Active Directory Flow OAuth2

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

Scopes

Name Description
user_impersonation Suplantación de su cuenta de usuario

Authorization

Type: apiKey
In: header

Ejemplos

JobSchedule list

Sample Request

GET account.region.batch.azure.com/jobschedules?api-version=2022-01-01.15.0


Sample Response

{
  "value": [
    {
      "id": "jobSchedule1",
      "url": "https://account.region.batch.azure.com/jobschedules/jobSchedule1",
      "eTag": "0x8D40FFD2E10996A",
      "lastModified": "2016-11-18T21:52:24.0064874Z",
      "creationTime": "2016-11-18T21:52:22.5431125Z",
      "state": "active",
      "stateTransitionTime": "2016-11-18T21:52:24.0064874Z",
      "previousState": "disabled",
      "previousStateTransitionTime": "2016-11-18T21:52:23.6471782Z",
      "jobSpecification": {
        "priority": 0,
        "maxParallelTasks": -1,
        "allowTaskPreemption": false,
        "usesTaskDependencies": false,
        "onAllTasksComplete": "noaction",
        "onTaskFailure": "noaction",
        "constraints": {
          "maxWallClockTime": "P10675199DT2H48M5.4775807S",
          "maxTaskRetryCount": 0
        },
        "poolInfo": {
          "poolId": "poolId"
        }
      },
      "executionInfo": {
        "recentJob": {
          "url": "https://account.region.batch.azure.com/jobs/jobSchedule1:job-1",
          "id": "jobSchedule1:job-1"
        }
      }
    },
    {
      "id": "jobSchedule2",
      "url": "https://account.region.batch.azure.com/jobschedules/jobSchedule2",
      "eTag": "0x8D40FFCFF760B51",
      "lastModified": "2016-11-18T21:51:05.8184017Z",
      "creationTime": "2016-11-18T21:51:05.8184017Z",
      "state": "active",
      "stateTransitionTime": "2016-11-18T21:51:05.8184017Z",
      "schedule": {
        "doNotRunUntil": "2020-01-01T12:30:00Z"
      },
      "jobSpecification": {
        "priority": 0,
        "maxParallelTasks": -1,
        "usesTaskDependencies": false,
        "onAllTasksComplete": "noaction",
        "onTaskFailure": "noaction",
        "constraints": {
          "maxWallClockTime": "P10675199DT2H48M5.4775807S",
          "maxTaskRetryCount": 0
        },
        "poolInfo": {
          "poolId": "testPool2"
        }
      },
      "executionInfo": {
        "nextRunTime": "2020-01-01T12:30:00Z"
      }
    }
  ]
}

Definiciones

ApplicationPackageReference

Referencia a un paquete que se va a implementar en los nodos de proceso.

AuthenticationTokenSettings

La configuración de un token de autenticación que la tarea puede usar para realizar operaciones de servicio de Batch.

AutoPoolSpecification

Especifica las características de un "grupo automático" temporal. El servicio Batch creará este grupo automático cuando se envíe el trabajo.

AutoUserScope

Ámbito del usuario automático

AutoUserSpecification

Especifica los parámetros del usuario automático que ejecuta una tarea en el servicio Batch.

AzureBlobFileSystemConfiguration

Información usada para conectarse a un contenedor de Azure Storage mediante Blobfuse.

AzureFileShareConfiguration

Información usada para conectarse a un recurso compartido de archivos de Azure.

BatchError

Respuesta de error recibida del servicio Azure Batch.

BatchErrorDetail

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

CachingType

Tipo de almacenamiento en caché que se va a habilitar para el disco.

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.

CIFSMountConfiguration

Información utilizada para conectarse a un sistema de archivos CIFS.

CloudJobSchedule

Programación de trabajos que permite trabajos periódicos especificando cuándo ejecutar trabajos y una especificación usada para crear cada trabajo.

CloudJobScheduleListResult

Resultado de enumerar las programaciones de trabajo en una cuenta.

CloudServiceConfiguration

Configuración de nodos de proceso en un grupo basado en la plataforma de Azure Cloud Services.

ComputeNodeFillType

Cómo se distribuyen las tareas entre nodos de proceso en un grupo.

ComputeNodeIdentityReference

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

ContainerConfiguration

Configuración de grupos habilitados para contenedores.

ContainerRegistry

Un registro de contenedor privado.

ContainerType

Tecnología de contenedor que se va a usar.

ContainerWorkingDirectory

La ubicación del directorio de trabajo task del contenedor.

DataDisk

Configuración que usarán los discos de datos asociados a los nodos de proceso del grupo. Cuando use discos de datos conectados, debe montar y dar formato a los discos desde una máquina virtual para usarlos.

DiffDiskPlacement

Especifica la ubicación del disco efímero para el disco del sistema operativo para todos los nodos de proceso (VM) del grupo.

DiffDiskSettings

Especifica el disco efímero Configuración para el disco del sistema operativo usado por el nodo de proceso (VM).

DiskEncryptionConfiguration

La configuración de cifrado de disco aplicada en los nodos de proceso del grupo. La configuración de cifrado de disco no se admite en el grupo de Linux creado con Shared Image Gallery imagen.

DynamicVNetAssignmentScope

Ámbito de la asignación de red virtual dinámica.

ElevationLevel

Nivel de elevación del usuario.

EnvironmentSetting

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

ErrorMessage

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

HttpHeader

Un par nombre-valor de encabezado HTTP

ImageReference

Referencia a una imagen de Azure Virtual Machines Marketplace o a una imagen de Shared Image 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".

InboundEndpointProtocol

Protocolo del punto de conexión.

InboundNATPool

Un grupo NAT de entrada que se puede usar para abordar puertos específicos en nodos de proceso de un grupo de Batch externamente.

IPAddressProvisioningType

Tipo de aprovisionamiento para direcciones IP públicas para el grupo.

JobConstraints

Restricciones de ejecución para un trabajo.

JobManagerTask

Especifica los detalles de una tarea del Administrador de trabajos.

JobNetworkConfiguration

Configuración de red para el trabajo.

JobPreparationTask

Tarea de preparación de trabajos que se ejecutará antes de cualquier tarea del trabajo en cualquier nodo de proceso determinado.

JobReleaseTask

Una tarea de liberación de trabajos para ejecutarse en la finalización del trabajo en cualquier nodo de proceso en el que se haya ejecutado el trabajo.

JobScheduleExecutionInformation

Contiene información sobre los trabajos que se han ejecutado y se ejecutarán en una programación de trabajos.

JobScheduleState

Estado de la programación del trabajo.

JobScheduleStatistics

Estadísticas de uso de recursos para una programación de trabajos.

JobSpecification

Especifica los detalles de los trabajos que se van a crear según una programación.

LinuxUserConfiguration

Propiedades usadas para crear una cuenta de usuario en un nodo de proceso de Linux.

LoginMode

Modo de inicio de sesión del usuario

MetadataItem

Un par nombre-valor asociado a un recurso de servicio de Batch.

MountConfiguration

Sistema de archivos que se va a montar en cada nodo.

NetworkConfiguration

Configuración de red de un grupo.

NetworkSecurityGroupRule

Una regla de grupo de seguridad de red que se va a aplicar a un punto de conexión de entrada.

NetworkSecurityGroupRuleAccess

Acción que se debe realizar para una dirección IP, un intervalo de subred o una etiqueta especificados.

NFSMountConfiguration

Información usada para conectarse a un sistema de archivos NFS.

NodePlacementConfiguration

Configuración de ubicación del nodo para un grupo.

NodePlacementPolicyType

Directiva de selección de ubicación para asignar nodos en el grupo.

OnAllTasksComplete

La acción que debe realizar el servicio Batch cuando todas las tareas del trabajo están en estado completado.

OnTaskFailure

La acción que el servicio Batch debe realizar cuando se produce un error en cualquier tarea del trabajo.

OSDisk

Configuración para el disco del sistema operativo del nodo de proceso (VM).

OutputFile

Especificación para cargar archivos desde un Azure Batch nodo de proceso a otra ubicación después de que el servicio Batch haya terminado de ejecutar el proceso de tarea.

OutputFileBlobContainerDestination

Especifica un destino de carga de archivos dentro de un contenedor de Azure Blob Storage.

OutputFileDestination

Destino al que se debe cargar un archivo.

OutputFileUploadCondition

Condiciones en las que se debe cargar un archivo de salida de tarea o un conjunto de archivos.

OutputFileUploadOptions

Detalles sobre una operación de carga de archivos de salida, incluidas las condiciones para realizar la carga.

PoolEndpointConfiguration

Configuración del punto de conexión de un grupo.

PoolInformation

Especifica cómo se debe asignar un trabajo a un grupo.

PoolLifetimeOption

La duración mínima de los grupos automáticos creados y cómo se asignan varios trabajos según una programación a grupos.

PoolSpecification

Especificación para crear un nuevo grupo.

PublicIPAddressConfiguration

Configuración de la dirección IP pública de la configuración de red de un grupo.

RecentJob

Información sobre el trabajo más reciente que se va a ejecutar en programación de trabajos.

ResourceFile

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

Schedule

Programación según la cual se crearán trabajos. Todas las horas se fijan respectivamente a utc y no se ven afectadas por el horario de verano.

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 la imagen inicial del nodo de ejecución.

StorageAccountType

Tipo de cuenta de almacenamiento que se va a usar para crear discos de datos.

TaskConstraints

Restricciones de ejecución que se van a aplicar a una tarea.

TaskContainerSettings

Configuración del contenedor de una tarea.

TaskSchedulingPolicy

Especifica cómo se deben distribuir las tareas entre nodos de proceso.

UserAccount

Propiedades usadas para crear un usuario que se usa para ejecutar tareas en un nodo de Azure Batch proceso.

UserIdentity

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

VirtualMachineConfiguration

Configuración de nodos de proceso en un grupo basado en la infraestructura de Azure Virtual Machines.

VMExtension

Configuración de extensiones de máquina virtual.

WindowsConfiguration

Windows configuración del sistema operativo que se va a aplicar a la máquina virtual.

WindowsUserConfiguration

Propiedades usadas para crear una cuenta de usuario en un nodo de proceso de Windows.

ApplicationPackageReference

Referencia a un paquete que se va a implementar en los nodos de proceso.

Name Type Description
applicationId
  • string

Identificador de la aplicación que se va a implementar.

version
  • string

Versión de la aplicación que se va a implementar. Si se omite, se implementa la versión predeterminada.
Si se omite en un grupo y no se especifica ninguna versión predeterminada para esta aplicación, se produce un error en la solicitud con el código de error InvalidApplicationPackageReferences y el código de estado HTTP 409. Si se omite en una tarea y no se especifica ninguna versión predeterminada para esta aplicación, se produce un error de procesamiento previo a la tarea.

AuthenticationTokenSettings

La configuración de un token de autenticación que la tarea puede usar para realizar operaciones de servicio de Batch.

Name Type Description
access
  • string[]

Los recursos de Batch a los que el token concede acceso.
El token de autenticación concede acceso a un conjunto limitado de operaciones del servicio Batch. Actualmente, el único valor admitido para la propiedad de acceso es "job", que concede acceso a todas las operaciones relacionadas con el trabajo que contiene la tarea.

AutoPoolSpecification

Especifica las características de un "grupo automático" temporal. El servicio Batch creará este grupo automático cuando se envíe el trabajo.

Name Type Description
autoPoolIdPrefix
  • string

Prefijo que se va a agregar al identificador único cuando se crea automáticamente un grupo.
El servicio Batch asigna a cada grupo automático un identificador único al crearse. Para distinguir entre grupos creados con distintos fines, puede especificar este elemento para agregar un prefijo al identificador asignado. El prefijo puede tener una longitud máxima de 20 caracteres.

keepAlive
  • boolean

Si se debe mantener activo un grupo automático después de que expire su duración.
Si es false, el servicio Batch elimina el grupo una vez que la duración (determinada por la configuración poolLifetimeOption) expira; es decir, cuando se completa el trabajo o la programación del trabajo. Si es true, el servicio Batch no elimina automáticamente el grupo. El usuario puede eliminar grupos automáticos creados con esta opción.

pool

Especificación del grupo para el grupo automático.

poolLifetimeOption

La duración mínima de los grupos automáticos creados y cómo se asignan varios trabajos según una programación a grupos.

AutoUserScope

Ámbito del usuario automático

Name Type 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 del usuario automático que ejecuta una tarea en el servicio Batch.

Name Type Description
elevationLevel

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

scope

Ámbito del usuario automático
El valor predeterminado es pool. Si el grupo se está ejecutando 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 tareas normales, pero deben ser accesibles por StartTasks.

AzureBlobFileSystemConfiguration

Información usada para conectarse a un contenedor de Azure Storage mediante Blobfuse.

Name Type Description
accountKey
  • string

Clave de cuenta Azure Storage.
Esta propiedad es mutuamente excluyente con sasKey e identidad; exactamente uno debe especificarse.

accountName
  • string

Nombre de Azure Storage cuenta.

blobfuseOptions
  • string

Opciones de línea de comandos adicionales para pasar al comando mount.
Estas son opciones de "net use" en Windows y opciones de "montaje" en Linux.

containerName
  • string

Nombre del contenedor de Azure Blob Storage.

identityReference

Referencia a la identidad asignada por el usuario que se va a usar para acceder a containerName
Esta propiedad es mutuamente excluyente tanto con accountKey como con sasKey; exactamente uno debe especificarse.

relativeMountPath
  • string

Ruta de acceso relativa en el nodo de proceso donde se montará el sistema de archivos.
Todos los sistemas de archivos se montan en relación con el directorio de montajes de Batch, accesibles a través de la variable de entorno AZ_BATCH_NODE_MOUNTS_DIR.

sasKey
  • string

Token de SAS de Azure Storage.
Esta propiedad es mutuamente excluyente tanto con accountKey como con la identidad; exactamente uno debe especificarse.

AzureFileShareConfiguration

Información usada para conectarse a un recurso compartido de archivos de Azure.

Name Type Description
accountKey
  • string

clave de la cuenta de Azure Storage.

accountName
  • string

Nombre de la cuenta Azure Storage.

azureFileUrl
  • string

Dirección URL de Azure Files.
Tiene el formato "https://{account}.file.core.windows.net/".

mountOptions
  • string

Opciones de línea de comandos adicionales para pasar al comando mount.
Estas son opciones de "net use" en Windows y opciones de "montaje" en Linux.

relativeMountPath
  • string

Ruta de acceso relativa en el nodo de proceso donde se montará el sistema de archivos.
Todos los sistemas de archivos se montan en relación con el directorio de montajes de Batch, accesibles a través de la variable de entorno AZ_BATCH_NODE_MOUNTS_DIR.

BatchError

Respuesta de error recibida del servicio Azure Batch.

Name Type Description
code
  • string

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

message

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

values

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.

Name Type Description
key
  • string

Identificador que especifica el significado de la propiedad Value.

value
  • string

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

CachingType

Tipo de almacenamiento en caché que se va a habilitar para el disco.

Name Type Description
none
  • string

El modo de almacenamiento en caché del disco no está habilitado.

readonly
  • string

El modo de almacenamiento en caché del disco es de solo lectura.

readwrite
  • string

El modo de almacenamiento en caché del disco es de lectura y escritura.

CertificateReference

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

Name Type Description
storeLocation

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 Windows nodos de proceso (es decir, creados con cloudServiceConfiguration o con virtualMachineConfiguration mediante una referencia de imagen de Windows). 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.

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 Windows nodos de proceso (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
  • string[]

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.

Name Type 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.

CIFSMountConfiguration

Información utilizada para conectarse a un sistema de archivos CIFS.

Name Type Description
mountOptions
  • string

Opciones de línea de comandos adicionales para pasar al comando mount.
Estas son opciones de "net use" en Windows y opciones de "montaje" en Linux.

password
  • string

Contraseña que se va a usar para la autenticación en el sistema de archivos CIFS.

relativeMountPath
  • string

Ruta de acceso relativa en el nodo de proceso donde se montará el sistema de archivos.
Todos los sistemas de archivos se montan en relación con el directorio de montajes de Batch, accesibles a través de la variable de entorno AZ_BATCH_NODE_MOUNTS_DIR.

source
  • string

URI del sistema de archivos que se va a montar.

username
  • string

El usuario que se va a usar para la autenticación en el sistema de archivos CIFS.

CloudJobSchedule

Programación de trabajos que permite trabajos periódicos especificando cuándo ejecutar trabajos y una especificación usada para crear cada trabajo.

Name Type Description
creationTime
  • string

Hora de creación de la programación del trabajo.

displayName
  • string

Nombre para mostrar de la programación.

eTag
  • string

ETag de la programación del trabajo.
Se trata de una cadena opaca. Puede usarlo para detectar si la programación de trabajos ha cambiado entre solicitudes. En concreto, puede pasar la etiqueta ETag con una solicitud de programación de trabajo de actualización para especificar que los cambios deben surtir efecto solo si nadie más ha modificado la programación mientras tanto.

executionInfo

Información sobre los trabajos que se han ejecutado y se ejecutarán en esta programación.

id
  • string

Cadena que identifica de forma única la programación dentro de la cuenta.

jobSpecification

Los detalles de los trabajos que se van a crear en esta programación.

lastModified
  • string

Hora de la última modificación de la programación del trabajo.
Esta es la última vez en la que cambiaron los datos de nivel de programación, como la especificación del trabajo o la información de periodicidad. No tiene en cuenta los cambios en el nivel de trabajo, como los nuevos trabajos que se crean o los trabajos cambian de estado.

metadata

Lista de pares nombre-valor asociados a la programación como metadatos.
El servicio Batch no asigna ningún significado a los metadatos; es únicamente para el uso del código de usuario.

previousState

Estado anterior de la programación del trabajo.
Esta propiedad no está presente si la programación de trabajos está en su estado activo inicial.

previousStateTransitionTime
  • string

Hora a la que la programación del trabajo entró en su estado anterior.
Esta propiedad no está presente si la programación de trabajos está en su estado activo inicial.

schedule

Programación según la cual se crearán trabajos.
Todas las horas se fijan respectivamente a utc y no se ven afectadas por el horario de verano.

state

Estado actual de la programación del trabajo.

stateTransitionTime
  • string

Hora a la que la programación del trabajo entró en el estado actual.

stats

Estadísticas de uso de recursos de duración para la programación de trabajos. Es posible que las estadísticas no estén disponibles inmediatamente. El servicio Batch realiza una acumulación periódica de estadísticas. El retraso típico es de aproximadamente 30 minutos.

url
  • string

Dirección URL de la programación del trabajo.

CloudJobScheduleListResult

Resultado de enumerar las programaciones de trabajo en una cuenta.

Name Type Description
odata.nextLink
  • string

Dirección URL para obtener el siguiente conjunto de resultados.

value

Lista de programaciones de trabajo.

CloudServiceConfiguration

Configuración de nodos de proceso en un grupo basado en la plataforma de Azure Cloud Services.

Name Type Description
osFamily
  • string

La familia de so invitado de Azure que se va a instalar en las máquinas virtuales del grupo.
Los valores posibles son: 2 - Familia del sistema operativo 2, equivalente a Windows Server 2008 R2 SP1. 3 - Familia 3 del sistema operativo, equivalente a Windows Server 2012. 4 - Familia 4 del sistema operativo, equivalente a Windows Server 2012 R2. 5 - Familia 5 del sistema operativo, equivalente a Windows Server 2016. 6 - Familia 6 del sistema operativo, equivalente a Windows Server 2019. Para más información, consulte Versiones del sistema operativo invitado de Azure (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases).

osVersion
  • string

La versión del sistema operativo invitado de Azure que se va a instalar en las máquinas virtuales del grupo.
El valor predeterminado es * que especifica la versión más reciente del sistema operativo para la familia de sistema operativo especificada.

ComputeNodeFillType

Cómo se distribuyen las tareas entre nodos de proceso en un grupo.

Name Type Description
pack
  • string

Se deben asignar tantas tareas como sea posible (taskSlotsPerNode) a cada nodo de proceso del grupo antes de que se asignen tareas al siguiente nodo de proceso del grupo.

spread
  • string

Las tareas se deben asignar uniformemente en todos los nodos de proceso del grupo.

ComputeNodeIdentityReference

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

Name Type Description
resourceId
  • string

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

ContainerConfiguration

Configuración de grupos habilitados para contenedores.

Name Type Description
containerImageNames
  • string[]

Colección de nombres de imagen de contenedor.
Esta es la referencia de imagen completa, como se especificaría en "docker pull". Se obtendrá una imagen del registro de Docker predeterminado, a menos que image esté completa con un registro alternativo.

containerRegistries

Registros privados adicionales de los que se pueden extraer contenedores.
Si se debe descargar alguna imagen de un registro privado que requiera credenciales, esas credenciales deben proporcionarse aquí.

type

Tecnología de contenedor que se va a usar.

ContainerRegistry

Un registro de contenedor privado.

Name Type Description
identityReference

Referencia a la identidad asignada por el usuario que se va a usar para acceder a un Azure Container Registry en lugar de nombre de usuario y 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.

ContainerType

Tecnología de contenedor que se va a usar.

Name Type Description
dockerCompatible
  • string

Se usará una tecnología de contenedor compatible con Docker para iniciar los contenedores.

ContainerWorkingDirectory

La ubicación del directorio de trabajo task del contenedor.

Name Type 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 task del servicio Batch estándar, que contendrá los archivos de recursos de tarea rellenados por Batch.

DataDisk

Configuración que usarán los discos de datos asociados a los nodos de proceso del grupo. Cuando use discos de datos conectados, debe montar y dar formato a los discos desde una máquina virtual para usarlos.

Name Type Description
caching

Tipo de almacenamiento en caché que se va a habilitar para los discos de datos.
El valor predeterminado para el almacenamiento en caché es readwrite. Para obtener información sobre las opciones de almacenamiento en caché, vea: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.

diskSizeGB
  • integer

Tamaño inicial del disco en gigabytes.

lun
  • integer

Número de unidad lógica.
El lun se usa para identificar de forma única cada disco de datos. Si conecta varios discos, cada uno debe tener un lun distinto. El valor debe estar comprendido entre 0 y 63, ambos incluidos.

storageAccountType

Tipo de cuenta de almacenamiento que se va a usar para el disco de datos.
Si se omite, el valor predeterminado es "standard_lrs".

DiffDiskPlacement

Especifica la ubicación del disco efímero para el disco del sistema operativo para todos los nodos de proceso (VM) del grupo.

Name Type Description
CacheDisk
  • string

El disco del sistema operativo efímero se almacena en la memoria caché de la máquina virtual.

DiffDiskSettings

Especifica el disco efímero Configuración para el disco del sistema operativo usado por el nodo de proceso (VM).

Name Type Description
placement

Especifica la ubicación del disco efímero para el disco del sistema operativo para todas las máquinas virtuales del grupo.
El usuario puede usar esta propiedad en la solicitud para elegir la ubicación, por ejemplo, el espacio en disco de caché para el aprovisionamiento de discos del sistema operativo efímero. Para más información sobre los requisitos de tamaño de disco del sistema operativo efímero, consulte Requisitos de tamaño de disco del sistema operativo efímero para Windows máquinas virtuales en https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements y máquinas virtuales Linux en https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.

DiskEncryptionConfiguration

La configuración de cifrado de disco aplicada en los nodos de proceso del grupo. La configuración de cifrado de disco no se admite en el grupo de Linux creado con Shared Image Gallery imagen.

Name Type Description
targets
  • string[]

La lista de destinos de disco que el servicio Batch cifrará en el nodo de proceso.
Si se omite, no se cifrará ningún disco en los nodos de proceso del grupo. En el grupo de Linux, solo se admite "TemporaryDisk"; en Windows grupo, debe especificarse "OsDisk" y "TemporaryDisk".

DynamicVNetAssignmentScope

Ámbito de la asignación de red virtual dinámica.

Name Type Description
job
  • string

La asignación de red virtual dinámica se realiza por trabajo.

none
  • string

No hay ninguna asignación de red virtual dinámica habilitada.

ElevationLevel

Nivel de elevación del usuario.

Name Type 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.

Name Type Description
name
  • string

Nombre de la variable de entorno.

value
  • string

Valor de la variable de entorno.

ErrorMessage

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

Name Type Description
lang
  • string

Código de idioma del mensaje de error

value
  • string

Texto del mensaje.

HttpHeader

Un par nombre-valor de encabezado HTTP

Name Type Description
name
  • string

Nombre que no distingue mayúsculas de minúsculas del encabezado que se va a usar al cargar archivos de salida

value
  • string

Valor del encabezado que se va a usar al cargar archivos de salida.

ImageReference

Referencia a una imagen de Azure Virtual Machines Marketplace o a una imagen de Shared Image 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".

Name Type Description
exactVersion
  • string

Versión específica de la imagen de plataforma o 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 Shared Image Gallery. Los nodos de proceso del grupo se crearán con este identificador de imagen. Se trata del formulario /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. El Shared Image Gallery Image 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.

InboundEndpointProtocol

Protocolo del punto de conexión.

Name Type Description
tcp
  • string

Use TCP para el punto de conexión.

udp
  • string

Use UDP para el punto de conexión.

InboundNATPool

Un grupo NAT de entrada que se puede usar para abordar puertos específicos en nodos de proceso de un grupo de Batch externamente.

Name Type Description
backendPort
  • integer

Número de puerto en el nodo de ejecución.
Debe ser único dentro de un grupo de Batch. Los valores aceptables están comprendidos entre 1 y 65535, excepto 22, 3389, 29876 y 29877, ya que están reservados. Si se proporcionan valores reservados, se produce un error en la solicitud con el código de estado HTTP 400.

frontendPortRangeEnd
  • integer

El último número de puerto del intervalo de puertos externos que se usarán para proporcionar acceso de entrada a backendPort en nodos de proceso individuales.
Los valores aceptables oscilan entre 1 y 65534, excepto los puertos de 50000 a 55000 que están reservados por el servicio Batch. Todos los intervalos de un grupo deben ser distintos y no se pueden superponer. Cada intervalo debe contener al menos 40 puertos. Si se proporcionan valores reservados o superpuestos, se produce un error en la solicitud con el código de estado HTTP 400.

frontendPortRangeStart
  • integer

El primer número de puerto del intervalo de puertos externos que se usarán para proporcionar acceso entrante a backendPort en nodos de proceso individuales.
Los valores aceptables oscilan entre 1 y 65534, excepto los puertos de 50000 a 55000 que están reservados. Todos los intervalos de un grupo deben ser distintos y no se pueden superponer. Cada intervalo debe contener al menos 40 puertos. Si se proporcionan valores reservados o superpuestos, se produce un error en la solicitud con el código de estado HTTP 400.

name
  • string

Nombre del punto de conexión.
El nombre debe ser único dentro de un grupo de lotes, puede contener letras, números, caracteres de subrayado, puntos y guiones. Los nombres deben comenzar con una letra o un número, deben terminar con una letra, un número o un carácter de subrayado, y no pueden superar los 77 caracteres. Si se proporcionan valores no válidos, se produce un error en la solicitud con el código de estado HTTP 400.

networkSecurityGroupRules

Lista de reglas de grupo de seguridad de red que se aplicarán al punto de conexión.
El número máximo de reglas que se pueden especificar en todos los puntos de conexión de un grupo de lotes es 25. Si no se especifica ninguna regla de grupo de seguridad de red, se creará una regla predeterminada para permitir el acceso entrante al back-endPort especificado. Si se supera el número máximo de reglas de grupo de seguridad de red, se produce un error en la solicitud con el código de estado HTTP 400.

protocol

Protocolo del punto de conexión.

IPAddressProvisioningType

Tipo de aprovisionamiento para direcciones IP públicas para el grupo.

Name Type Description
batchmanaged
  • string

Batch creará y administrará una dirección IP pública. Puede haber varias direcciones IP públicas en función del tamaño del grupo.

nopublicipaddresses
  • string

No se creará ninguna dirección IP pública.

usermanaged
  • string

El usuario proporciona direcciones IP públicas y se usará para aprovisionar los nodos de proceso.

JobConstraints

Restricciones de ejecución para un trabajo.

Name Type Description
maxTaskRetryCount
  • integer

Número máximo de veces que se puede reintentar cada 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á cada tarea una vez y, a continuación, puede reintentar hasta este límite. Por ejemplo, si el número máximo de reintentos es 3, Batch intenta una tarea hasta 4 veces (un intento inicial y tres reintentos). Si el número máximo de reintentos es 0, el servicio Batch no vuelve a intentar tareas. 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)

maxWallClockTime
  • string

Tiempo máximo transcurrido durante el que se puede ejecutar el trabajo, medido desde el momento en que se crea el trabajo.
Si el trabajo no se completa dentro del límite de tiempo, el servicio Batch finaliza y las tareas que todavía se están ejecutando. En este caso, el motivo de finalización será MaxWallClockTimeExpiry. Si no se especifica esta propiedad, no hay ningún límite de tiempo durante cuánto tiempo se puede ejecutar el trabajo.

JobManagerTask

Especifica los detalles de una tarea del Administrador de trabajos.

Name Type Description
allowLowPriorityNode
  • boolean

Si la tarea del Administrador de trabajos se puede ejecutar en un nodo de proceso de prioridad baja o puntual.
El valor predeterminado es true.

applicationPackageReferences

Lista de paquetes de aplicación que el servicio Batch implementará en el nodo de proceso antes de ejecutar la línea de comandos.
Los paquetes de aplicación se descargan e implementan en un directorio compartido, no en el directorio de trabajo de la tarea. Por lo tanto, si un paquete de aplicación al que se hace referencia ya está en el nodo de proceso y está actualizado, no se vuelve a descargar; se usa la copia existente en el nodo de ejecución. Si no se puede instalar un paquete de aplicación al que se hace referencia, por ejemplo porque se ha eliminado el paquete o porque se produjo un error en la descarga, se produce un error en la tarea.

authenticationTokenSettings

La configuración de un token de autenticación que la tarea puede usar para realizar operaciones del servicio Batch.
Si se establece esta propiedad, el servicio Batch proporciona a la tarea un token de autenticación que se puede usar para autenticar las operaciones del servicio Batch sin necesidad de una clave de acceso de la cuenta. El token se proporciona a través de la variable de entorno AZ_BATCH_AUTHENTICATION_TOKEN. Las operaciones que la tarea puede llevar a cabo con el token dependen de la configuración. Por ejemplo, una tarea puede solicitar permisos de trabajo para agregar otras tareas al trabajo, o comprobar el estado del trabajo o de otras tareas en el trabajo.

commandLine
  • string

Línea de comandos de la tarea Administrador de trabajos.
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, mediante "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).

constraints

Restricciones que se aplican a la tarea Administrador de trabajos.

containerSettings

La configuración del contenedor en el que se ejecuta la tarea administrador de trabajos.
Si el grupo que ejecutará esta tarea tiene establecido containerConfiguration, también se debe establecer. Si el grupo que ejecutará esta tarea no tiene establecido containerConfiguration, no se debe establecer. Cuando se especifica, todos los directorios se asignan 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.

displayName
  • string

Nombre para mostrar de la tarea Administrador de trabajos.
No es necesario ser único y puede contener cualquier carácter Unicode hasta una longitud máxima de 1024.

environmentSettings

Lista de opciones de configuración de variables de entorno para la tarea Administrador de trabajos.

id
  • string

Cadena que identifica de forma única la tarea administrador de trabajos dentro del trabajo.
El identificador puede contener cualquier combinación de caracteres alfanuméricos, incluidos guiones y caracteres de subrayado, y no puede contener más de 64 caracteres.

killJobOnCompletion
  • boolean

Si la finalización de la tarea administrador de trabajos significa la finalización de todo el trabajo.
Si es true, cuando se completa la tarea administrador de trabajos, el servicio Batch marca el trabajo como completado. Si alguna tarea todavía se está ejecutando en este momento (aparte de la versión del trabajo), esas tareas se finalizan. Si es false, la finalización de la tarea administrador de trabajos no afecta al estado del trabajo. En este caso, debe usar el atributo onAllTasksComplete para finalizar el trabajo, o hacer que un cliente o usuario finalice el trabajo explícitamente. Un ejemplo de esto es si el Administrador de trabajos crea un conjunto de tareas pero, a continuación, no tiene ningún rol adicional en su ejecución. El valor predeterminado es true. Si usa los atributos onAllTasksComplete y onTaskFailure para controlar la duración del trabajo y usar la tarea del Administrador de trabajos solo para crear las tareas para el trabajo (no para supervisar el progreso), es importante establecer killJobOnCompletion en false.

outputFiles

Lista de archivos que el servicio Batch cargará desde el nodo de proceso después de ejecutar la línea de comandos.
En el caso de las tareas de varias instancias, los archivos solo se cargarán desde el nodo de ejecución en el que se ejecuta la tarea principal.

requiredSlots
  • integer

Número de ranuras de programación que requiere la tarea para ejecutarse.
El valor predeterminado es 1. Una tarea solo se puede programar para ejecutarse en un nodo de proceso si el nodo tiene suficientes ranuras de programación libres disponibles. En el caso de las tareas de varias instancias, esta propiedad no se admite y no se debe especificar.

resourceFiles

Lista de archivos que el servicio Batch descargará en el nodo de proceso antes de ejecutar la línea de comandos.
Los archivos enumerados en este elemento se encuentran en el directorio de trabajo de la tarea. 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 .zip, paquetes de aplicación o contenedores de Docker.

runExclusive
  • boolean

Si la tarea administrador de trabajos requiere un uso exclusivo del nodo de ejecución donde se ejecuta.
Si es true, ninguna otra tarea se ejecutará en el mismo nodo mientras se ejecute el Administrador de trabajos. Si es false, otras tareas se pueden ejecutar simultáneamente con el Administrador de trabajos en un nodo de ejecución. La tarea del Administrador de trabajos cuenta normalmente con respecto al límite de tareas simultáneas del nodo de proceso, por lo que esto solo es relevante si el nodo de proceso permite varias tareas simultáneas. El valor predeterminado es true.

userIdentity

Identidad de usuario en la que se ejecuta la tarea administrador de trabajos.
Si se omite, la tarea se ejecuta como un usuario no administrativo único para la tarea.

JobNetworkConfiguration

Configuración de red para el trabajo.

Name Type Description
subnetId
  • string

El identificador de recurso arm de la subred de red virtual que los nodos de proceso que ejecutan tareas desde el trabajo se unirán durante la tarea. Esto solo funcionará con un grupo de virtualMachineConfiguration.
La red virtual debe estar en la misma región y suscripción que la cuenta de Azure Batch. La subred especificada debe tener suficientes direcciones IP libres para acomodar el número de nodos de proceso que ejecutarán tareas desde el trabajo. Puede ser hasta el número de nodos de proceso del grupo. La entidad de servicio "MicrosoftAzureBatch" debe tener el rol "Colaborador de máquina virtual clásica" Role-Based Access Control (RBAC) para la red virtual especificada para que Azure Batch servicio pueda programar tareas en los nodos. Esto se puede comprobar comprobando si la red virtual especificada tiene algún grupo de seguridad de red (NSG) asociado. Si un grupo de seguridad de red deniega la comunicación con los nodos de la subred especificada, el servicio Batch establecerá el estado de los nodos de proceso en inutilizables. Tiene el formato /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. Si la red virtual especificada tiene algún grupo de seguridad de red (NSG) asociado, se deben habilitar algunos puertos del sistema reservados para la comunicación entrante desde el servicio Azure Batch. Para los grupos creados con una configuración de máquina virtual, habilite los puertos 29876 y 29877, así como el puerto 22 para Linux y el puerto 3389 para Windows. El puerto 443 también debe estar abierto para las conexiones salientes para las comunicaciones a Azure Storage. Para más información, consulte: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

JobPreparationTask

Tarea de preparación de trabajos que se ejecutará antes de cualquier tarea del trabajo en cualquier nodo de proceso determinado.

Name Type Description
commandLine
  • string

Línea de comandos de la tarea de preparación del trabajo.
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, mediante "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).

constraints

Restricciones que se aplican a la tarea de preparación del trabajo.

containerSettings

La configuración del contenedor en el que se ejecuta la tarea de preparación del trabajo.
Cuando se especifica, todos los directorios se asignan 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

Lista de opciones de configuración de variables de entorno para la tarea de preparación del trabajo.

id
  • string

Cadena que identifica de forma única la tarea de preparación del trabajo dentro del trabajo.
El identificador puede contener cualquier combinación de caracteres alfanuméricos, incluidos guiones y caracteres de subrayado, y no puede contener más de 64 caracteres. Si no especifica esta propiedad, el servicio Batch asigna un valor predeterminado de "jobpreparation". Ninguna otra tarea del trabajo puede tener el mismo identificador que la tarea de preparación del trabajo. Si intenta enviar una tarea con el mismo identificador, el servicio Batch rechaza la solicitud con el código de error TaskIdSameAsJobPreparationTask; Si llama directamente a la API REST, el código de estado HTTP es 409 (conflicto).

rerunOnNodeRebootAfterSuccess
  • boolean

Si el servicio Batch debe volver a ejecutar la tarea de preparación del trabajo después de reiniciar un nodo de proceso.
La tarea de preparación del trabajo siempre se vuelve a ejecutar si se vuelve a crear una imagen inicial de un nodo de proceso o si la tarea de preparación del trabajo no se completó (por ejemplo, porque se produjo el reinicio mientras se estaba ejecutando la tarea). Por lo tanto, siempre debe escribir una tarea de preparación del trabajo para que sea idempotente y para comportarse correctamente si se ejecuta varias veces. El valor predeterminado es true.

resourceFiles

Lista de archivos que el servicio Batch descargará en el nodo de proceso antes de ejecutar la línea de comandos.
Los archivos enumerados en este elemento se encuentran en el directorio de trabajo de la tarea. 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 .zip, paquetes de aplicación o contenedores de Docker.

userIdentity

Identidad de usuario en la que se ejecuta la tarea de preparación del trabajo.
Si se omite, la tarea se ejecuta como un usuario no administrativo único para la tarea en Windows nodos de ejecución o un usuario no administrativo único para el grupo en nodos de ejecución de Linux.

waitForSuccess
  • boolean

Si el servicio Batch debe esperar a que la tarea de preparación del trabajo se complete correctamente antes de programar cualquier otra tarea del trabajo en el nodo de proceso. Una tarea de preparación del trabajo se ha completado correctamente si se cierra con el código de salida 0.
Si es true y se produce un error en la tarea de preparación del trabajo en un nodo, el servicio Batch reintenta la tarea de preparación del trabajo hasta su número máximo de reintentos (como se especifica en el elemento constraints). Si la tarea todavía no se ha completado correctamente después de todos los reintentos, el servicio Batch no programará tareas del trabajo en el nodo. El nodo permanece activo y apto para ejecutar tareas de otros trabajos. Si es false, el servicio Batch no esperará a que se complete la tarea de preparación del trabajo. En este caso, otras tareas del trabajo pueden empezar a ejecutarse en el nodo de proceso mientras la tarea de preparación del trabajo todavía se está ejecutando; e incluso si se produce un error en la tarea de preparación del trabajo, las nuevas tareas se seguirán programando en el nodo de proceso. El valor predeterminado es true.

JobReleaseTask

Una tarea de liberación de trabajos para ejecutarse en la finalización del trabajo en cualquier nodo de proceso en el que se haya ejecutado el trabajo.

Name Type Description
commandLine
  • string

Línea de comandos de la tarea de liberación de trabajos.
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, mediante "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

La configuración del contenedor en el que se ejecuta la tarea de liberación de trabajos.
Cuando se especifica, todos los directorios se asignan 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

Lista de opciones de configuración de variables de entorno para la tarea de liberación de trabajos.

id
  • string

Cadena que identifica de forma única la tarea de liberación de trabajos dentro del trabajo.
El identificador puede contener cualquier combinación de caracteres alfanuméricos, incluidos guiones y caracteres de subrayado, y no puede contener más de 64 caracteres. Si no especifica esta propiedad, el servicio Batch asigna un valor predeterminado de "jobrelease". Ninguna otra tarea del trabajo puede tener el mismo identificador que la tarea de liberación de trabajos. Si intenta enviar una tarea con el mismo identificador, el servicio Batch rechaza la solicitud con el código de error TaskIdSameAsJobReleaseTask; Si llama directamente a la API REST, el código de estado HTTP es 409 (conflicto).

maxWallClockTime
  • string

Tiempo máximo transcurrido que la tarea de liberación de trabajos puede ejecutarse en un nodo de proceso determinado, medido desde el momento en que se inicia la tarea. Si la tarea no se completa dentro del límite de tiempo, el servicio Batch la finaliza. El valor predeterminado es 15 minutos. Es posible que no especifique un tiempo de espera superior a 15 minutos. Si lo hace, el servicio Batch lo rechaza con un error; Si llama directamente a la API REST, el código de estado HTTP es 400 (solicitud incorrecta).

resourceFiles

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 .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.

retentionTime
  • string

Tiempo mínimo para conservar el directorio task de la tarea de liberación de trabajos en el nodo de proceso. Después de este tiempo, el servicio Batch puede eliminar el directorio Task y todo su contenido.
El valor predeterminado es 7 días, es decir, el directorio Task se conservará durante 7 días a menos que se quite el nodo de proceso o se elimine el trabajo.

userIdentity

Identidad de usuario en la que se ejecuta la tarea de liberación de trabajos.
Si se omite, la tarea se ejecuta como un usuario no administrativo único para la tarea.

JobScheduleExecutionInformation

Contiene información sobre los trabajos que se han ejecutado y se ejecutarán en una programación de trabajos.

Name Type Description
endTime
  • string

Hora a la que finalizó la programación.
Esta propiedad solo se establece si la programación del trabajo está en estado completado.

nextRunTime
  • string

La próxima vez que se cree un trabajo en esta programación.
Esta propiedad solo es significativa si la programación está en el estado activo cuando llega el momento. Por ejemplo, si la programación está deshabilitada, no se creará ningún trabajo en nextRunTime a menos que el trabajo esté habilitado antes de entonces.

recentJob

Información sobre el trabajo más reciente en programación de trabajos.
Esta propiedad solo está presente si el al menos un trabajo se ha ejecutado bajo la programación.

JobScheduleState

Estado de la programación del trabajo.

Name Type Description
active
  • string

La programación de trabajos está activa y creará trabajos según su programación.

completed
  • string

La programación del trabajo ha finalizado, ya sea llegando a su hora de finalización o al usuario que la termina explícitamente.

deleting
  • string

El usuario ha solicitado que se elimine la programación del trabajo, pero la operación de eliminación todavía está en curso. El programador no iniciará ningún nuevo trabajo para esta programación de trabajos y eliminará los trabajos y las tareas existentes en la programación de trabajos, incluido cualquier trabajo activo. La programación de trabajos se eliminará cuando se hayan eliminado todos los trabajos y tareas de la programación de trabajos.

disabled
  • string

El usuario ha deshabilitado la programación del trabajo. El programador no iniciará ningún nuevo trabajo en esta programación, pero cualquier trabajo activo existente seguirá ejecutándose.

terminating
  • string

La programación de trabajos no tiene más trabajo que hacer o el usuario ha terminado explícitamente, pero la operación de finalización sigue en curso. El programador no iniciará ningún nuevo trabajo para esta programación de trabajos, ni tampoco ningún trabajo existente activo.

JobScheduleStatistics

Estadísticas de uso de recursos para una programación de trabajos.

Name Type Description
kernelCPUTime
  • string

Tiempo total de CPU del modo kernel (sumado en todos los núcleos y todos los nodos de proceso) consumido por todas las tareas de todos los trabajos creados en la programación.

lastUpdateTime
  • string

Hora a la que se actualizaron por última vez las estadísticas. Todas las estadísticas se limitan al intervalo entre startTime y lastUpdateTime.

numFailedTasks
  • integer

El número total de tareas que no se pudieron realizar durante el intervalo de tiempo especificado en Trabajos creados según la programación. Se produce un error en una tarea si agota su número máximo de reintentos sin devolver el código de salida 0.

numSucceededTasks
  • integer

El número total de tareas completadas correctamente durante el intervalo de tiempo especificado en Trabajos creados según la programación. Una tarea se completa correctamente si devuelve el código de salida 0.

numTaskRetries
  • integer

Número total de reintentos durante el intervalo de tiempo especificado en todas las tareas de todos los trabajos creados según la programación.

readIOGiB
  • number

El total de gibibytes leídos del disco por todas las tareas de todos los trabajos creados según la programación.

readIOps
  • integer

Número total de operaciones de lectura de disco realizadas por todas las tareas de todos los trabajos creados según la programación.

startTime
  • string

Hora de inicio del intervalo de tiempo cubierto por las estadísticas.

url
  • string

Dirección URL de las estadísticas.

userCPUTime
  • string

Tiempo total de CPU del modo de usuario (sumado en todos los núcleos y todos los nodos de proceso) consumido por todas las tareas de todos los trabajos creados en la programación.

waitTime
  • string

Tiempo de espera total de todas las tareas de todos los trabajos creados en la programación. El tiempo de espera de una tarea se define como el tiempo transcurrido entre la creación de la tarea y el inicio de la ejecución de la tarea. (Si se reintenta la tarea debido a errores, el tiempo de espera es el tiempo de ejecución de la tarea más reciente).
Este valor solo se notifica en las estadísticas de duración de la cuenta; no se incluye en las estadísticas de trabajo.

wallClockTime
  • string

Tiempo total del reloj de todas las tareas de todos los trabajos creados según la programación.
La hora del reloj es el tiempo transcurrido desde el momento en que la tarea comenzó a ejecutarse en un nodo de proceso hasta que finalizó (o hasta la última vez que se actualizaron las estadísticas, si la tarea no había finalizado). Si se reintentó una tarea, esto incluye el tiempo del reloj de todos los reintentos de la tarea.

writeIOGiB
  • number

El total de gibibytes escritos en el disco por todas las tareas de todos los trabajos creados bajo la programación.

writeIOps
  • integer

Número total de operaciones de escritura en disco realizadas por todas las tareas de todos los trabajos creados en la programación.

JobSpecification

Especifica los detalles de los trabajos que se van a crear según una programación.

Name Type Default Value Description
allowTaskPreemption
  • boolean

Si las tareas de este trabajo pueden ser adelantadas por otros trabajos de prioridad alta
Si el valor se establece en True, otros trabajos de prioridad alta enviados al sistema tendrán prioridad y podrán volver a poner en cola las tareas de este trabajo. Puede actualizar allowTaskPreemption de un trabajo después de que se haya creado mediante la API de trabajo de actualización.

commonEnvironmentSettings

Una lista de la configuración común de las variables de entorno. Estas variables de entorno se establecen para todas las tareas de los trabajos creados en esta programación (incluidos el Administrador de trabajos, la preparación del trabajo y las tareas de liberación de trabajos).
Las tareas individuales pueden invalidar una configuración de entorno especificada aquí especificando el mismo nombre de configuración con un valor diferente.

constraints

Restricciones de ejecución para trabajos creados en esta programación.

displayName
  • string

Nombre para mostrar de trabajos creados en esta programación.
El nombre no debe ser único y puede contener cualquier carácter Unicode hasta una longitud máxima de 1024.

jobManagerTask

Los detalles de una tarea del Administrador de trabajos que se va a iniciar cuando se inicia un trabajo en esta programación.
Si el trabajo no especifica una tarea del Administrador de trabajos, el usuario debe agregar explícitamente tareas al trabajo mediante task API. Si el trabajo especifica una tarea del Administrador de trabajos, el servicio Batch crea la tarea administrador de trabajos cuando se crea el trabajo e intentará programar la tarea del Administrador de trabajos antes de programar otras tareas en el trabajo.

jobPreparationTask

Tarea de preparación del trabajo para trabajos creados en esta programación.
Si un trabajo tiene una tarea de preparación del trabajo, el servicio Batch ejecutará la tarea de preparación del trabajo en un nodo antes de iniciar cualquier tarea de ese trabajo en ese nodo de proceso.

jobReleaseTask

Tarea de liberación de trabajos para trabajos creados en esta programación.
El propósito principal de la tarea de liberación de trabajos es deshacer los cambios realizados en los nodos realizados por la tarea de preparación del trabajo. Entre las actividades de ejemplo se incluyen la eliminación de archivos locales o el apagado de servicios que se iniciaron como parte de la preparación del trabajo. No se puede especificar una tarea de liberación de trabajos sin especificar también una tarea de preparación del trabajo. El servicio Batch ejecuta la tarea de liberación de trabajos en los nodos de proceso que han ejecutado la tarea de preparación del trabajo.

maxParallelTasks
  • integer
-1

Número máximo de tareas que se pueden ejecutar en paralelo para el trabajo.
El valor de maxParallelTasks debe ser -1 o mayor que 0 si se especifica. Si no se especifica, el valor predeterminado es -1, lo que significa que no hay ningún límite para el número de tareas que se pueden ejecutar a la vez. Puede actualizar maxParallelTasks de un trabajo una vez creado mediante la API de trabajo de actualización.

metadata

Lista de pares nombre-valor asociados a cada trabajo creado en esta programación como metadatos.
El servicio Batch no asigna ningún significado a los metadatos; es únicamente para el uso del código de usuario.

networkConfiguration

Configuración de red para el trabajo.

onAllTasksComplete

La acción que debe realizar el servicio Batch cuando todas las tareas de un trabajo creado en esta programación están en estado completado.
Tenga en cuenta que si un trabajo no contiene ninguna tarea, todas las tareas se consideran completadas. Por lo tanto, esta opción se usa con más frecuencia con una tarea del Administrador de trabajos; Si desea usar la finalización automática del trabajo sin un Administrador de trabajos, debe establecer inicialmente onAllTasksComplete en noaction y actualizar las propiedades del trabajo para establecer onAllTasksComplete para finalizarjob una vez que haya terminado de agregar Tareas. El valor predeterminado es noaction.

onTaskFailure

La acción que debe realizar el servicio Batch cuando se produce un error en cualquier tarea en un trabajo creado en esta programación. Se considera que se ha producido un error en una tarea si se ha producido un error si tiene un failureInfo. Se establece un failureInfo si la tarea se completa con un código de salida distinto de cero después de agotar su recuento de reintentos, o si se produjo un error al iniciar la tarea, por ejemplo debido a un error de descarga del archivo de recursos.
El valor predeterminado es noaction.

poolInfo

Grupo en el que el servicio Batch ejecuta las tareas de los trabajos creados en esta programación.

priority
  • integer

Prioridad de trabajos creados en esta programación.
Los valores de prioridad pueden oscilar entre -1000 y 1000, siendo -1000 la prioridad más baja y 1000 la prioridad más alta. El valor predeterminado es 0. Esta prioridad se usa como valor predeterminado para todos los trabajos en la programación de trabajos. Puede actualizar la prioridad de un trabajo después de que se haya creado mediante la API de trabajo de actualización.

usesTaskDependencies
  • boolean

Si las tareas del trabajo pueden definir dependencias entre sí. El valor predeterminado es false.

LinuxUserConfiguration

Propiedades usadas para crear una cuenta de usuario en un nodo de proceso de Linux.

Name Type Description
gid
  • integer

Identificador de grupo de la cuenta de usuario.
Las propiedades uid y gid deben especificarse juntas o no en absoluto. Si no se especifica el sistema operativo subyacente, elige el gid.

sshPrivateKey
  • string

Clave privada SSH para la cuenta de usuario.
La clave privada no debe estar protegida con contraseña. La clave privada se usa para configurar automáticamente la autenticación basada en claves asimétricas para SSH entre nodos de proceso en un grupo de Linux cuando la propiedad enableInterNodeCommunication del grupo es true (se omite si enableInterNodeCommunication es false). Para ello, coloca el par de claves en el directorio .ssh del usuario. Si no se especifica, ssh sin contraseña no está configurado entre nodos de proceso (no se realiza ninguna modificación del directorio .ssh del usuario).

uid
  • integer

Identificador de usuario de la cuenta de usuario.
Las propiedades uid y gid deben especificarse juntas o no en absoluto. Si no se especifica el sistema operativo subyacente, elige el uid.

LoginMode

Modo de inicio de sesión del usuario

Name Type Description
batch
  • string

El LOGON32_LOGON_BATCH modo de inicio de sesión de Win32. Se recomienda el modo de inicio de sesión por lotes para procesos paralelos de larga duración.

interactive
  • string

El LOGON32_LOGON_INTERACTIVE modo de inicio de sesión de Win32. UAC está habilitado en Windows grupos de VirtualMachineConfiguration. Si esta opción se usa con una identidad de usuario con privilegios elevados en un grupo de Windows VirtualMachineConfiguration, la sesión de usuario no se elevará a menos que la aplicación ejecutada por la línea de comandos task esté configurada para requerir siempre privilegios administrativos o para requerir siempre el privilegio máximo.

MetadataItem

Un par nombre-valor asociado a un recurso de servicio de Batch.

Name Type Description
name
  • string

Nombre del elemento de metadatos.

value
  • string

Valor del elemento de metadatos.

MountConfiguration

Sistema de archivos que se va a montar en cada nodo.

Name Type Description
azureBlobFileSystemConfiguration

El contenedor de Azure Storage que se va a montar mediante FUSE de blob en cada nodo.
Esta propiedad es mutuamente excluyente con todas las demás propiedades.

azureFileShareConfiguration

Recurso compartido de archivos de Azure que se va a montar en cada nodo.
Esta propiedad es mutuamente excluyente con todas las demás propiedades.

cifsMountConfiguration

Sistema de archivos CIFS/SMB que se va a montar en cada nodo.
Esta propiedad es mutuamente excluyente con todas las demás propiedades.

nfsMountConfiguration

Sistema de archivos NFS que se va a montar en cada nodo.
Esta propiedad es mutuamente excluyente con todas las demás propiedades.

NetworkConfiguration

Configuración de red de un grupo.

Name Type Description
dynamicVNetAssignmentScope

Ámbito de asignación de red virtual dinámica.

endpointConfiguration

La configuración de los puntos de conexión en nodos de proceso en el grupo de Batch.
La configuración del punto de conexión del grupo solo se admite en Grupos con la propiedad virtualMachineConfiguration.

publicIPAddressConfiguration

Configuración de IP públicaAddress para nodos de proceso en el grupo de lotes.
La propiedad de configuración de IP pública solo se admite en Grupos con la propiedad virtualMachineConfiguration.

subnetId
  • string

Identificador de recursos arm de la subred de red virtual a la que se unirán los nodos de proceso del grupo. Tiene el formato /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}.
La red virtual debe estar en la misma región y suscripción que la cuenta de Azure Batch. La subred especificada debe tener suficientes direcciones IP libres para acomodar el número de nodos de proceso en el grupo. Si la subred no tiene suficientes direcciones IP libres, el grupo asignará parcialmente nodos y se producirá un error de cambio de tamaño. La entidad de servicio "MicrosoftAzureBatch" debe tener el rol "Colaborador de máquina virtual clásica" Role-Based Access Control (RBAC) para la red virtual especificada. La subred especificada debe permitir la comunicación desde el servicio Azure Batch para poder programar tareas en los nodos. Esto se puede comprobar comprobando si la red virtual especificada tiene algún grupo de seguridad de red (NSG) asociado. Si un grupo de seguridad de red deniega la comunicación con los nodos de la subred especificada, el servicio Batch establecerá el estado de los nodos de proceso en inutilizables. En el caso de los grupos creados con virtualMachineConfiguration, solo se admiten redes virtuales arm ("Microsoft.Network/virtualNetworks") pero para los grupos creados con cloudServiceConfiguration se admiten las redes virtuales de ARM y clásicas. Si la red virtual especificada tiene grupos de seguridad de red (NSG) asociados, será preciso habilitar varios puertos del sistema reservados para las comunicaciones entrantes. Para los grupos creados con una configuración de máquina virtual, habilite los puertos 29876 y 29877, así como el puerto 22 para Linux y el puerto 3389 para Windows. Para los grupos creados con una configuración de servicio en la nube, habilite los puertos 10100, 20100 y 30100. Habilite también las conexiones salientes a Azure Storage en el puerto 443. Para más información, consulte: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

Una regla de grupo de seguridad de red que se va a aplicar a un punto de conexión de entrada.

Name Type Description
access

Acción que se debe realizar para una dirección IP, un intervalo de subred o una etiqueta especificados.

priority
  • integer

Prioridad de esta regla.
Las prioridades dentro de un grupo deben ser únicas y se evalúan en orden de prioridad. Cuanto menor sea el número de prioridad, mayor será la prioridad de la regla. Por ejemplo, se podrían especificar reglas con números de orden de 150, 250 y 350. La regla con el número de orden de 150 tiene prioridad sobre la regla que tiene un orden de 250. Las prioridades permitidas son de 150 a 4096. Si se proporcionan valores reservados o duplicados, se produce un error en la solicitud con el código de estado HTTP 400.

sourceAddressPrefix
  • string

Prefijo o etiqueta de dirección de origen que debe coincidir con la regla.
Los valores válidos son una sola dirección IP (es decir, 10.10.10.10), subred IP (es decir, 192.168.1.0/24), etiqueta predeterminada o * (para todas las direcciones). Si se proporcionan otros valores, se produce un error en la solicitud con el código de estado HTTP 400.

sourcePortRanges
  • string[]

Intervalos de puertos de origen que deben coincidir con la regla.
Los valores válidos son "" (para todos los puertos 0 - 65535), un puerto específico (es decir, 22) o un intervalo de puertos (es decir, 100-200). Los puertos deben estar comprendidos entre 0 y 65535. Cada entrada de esta colección no debe superponerse a ninguna otra entrada (ya sea un intervalo o un puerto individual). Si se proporcionan otros valores, se produce un error en la solicitud con el código de estado HTTP 400. El valor predeterminado es "".

NetworkSecurityGroupRuleAccess

Acción que se debe realizar para una dirección IP, un intervalo de subred o una etiqueta especificados.

Name Type Description
allow
  • string

Permita el acceso.

deny
  • string

Deniegue el acceso.

NFSMountConfiguration

Información usada para conectarse a un sistema de archivos NFS.

Name Type Description
mountOptions
  • string

Opciones de línea de comandos adicionales para pasar al comando mount.
Estas son opciones de "net use" en Windows y opciones de "montaje" en Linux.

relativeMountPath
  • string

Ruta de acceso relativa en el nodo de proceso donde se montará el sistema de archivos.
Todos los sistemas de archivos se montan en relación con el directorio de montajes de Batch, accesibles a través de la variable de entorno AZ_BATCH_NODE_MOUNTS_DIR.

source
  • string

URI del sistema de archivos que se va a montar.

NodePlacementConfiguration

Configuración de ubicación del nodo para un grupo.

Name Type Description
policy

Tipo de directiva de selección de ubicación de nodo en grupos de Batch.
Directiva de asignación usada por el servicio Batch para aprovisionar los nodos. Si no se especifica, Batch usará la directiva regional.

NodePlacementPolicyType

Directiva de selección de ubicación para asignar nodos en el grupo.

Name Type Description
regional
  • string

Todos los nodos del grupo se asignarán en la misma región.

zonal
  • string

Los nodos del grupo se distribuirán entre diferentes zonas de disponibilidad con el mejor equilibrio de esfuerzo.

OnAllTasksComplete

La acción que debe realizar el servicio Batch cuando todas las tareas del trabajo están en estado completado.

Name Type Description
noaction
  • string

No haga nada. El trabajo permanece activo a menos que se termine o deshabilite por algún otro medio.

terminatejob
  • string

Finalice el trabajo. TerminateReason del trabajo se establece en "AllTasksComplete".

OnTaskFailure

La acción que el servicio Batch debe realizar cuando se produce un error en cualquier tarea del trabajo.

Name Type Description
noaction
  • string

No haga nada. El trabajo permanece activo a menos que se termine o deshabilite por algún otro medio.

performexitoptionsjobaction
  • string

Realice la acción asociada a la condición De salida de la tarea en la colección exitConditions de la tarea. (Esto puede dar lugar a que no se realice ninguna acción, si es lo que especifica la tarea).

OSDisk

Configuración para el disco del sistema operativo del nodo de proceso (VM).

Name Type Description
ephemeralOSDiskSettings

Especifica el disco efímero Configuración para el disco del sistema operativo usado por el nodo de proceso (VM).

OutputFile

Especificación para cargar archivos desde un Azure Batch nodo de proceso a otra ubicación después de que el servicio Batch haya terminado de ejecutar el proceso de tarea.

Name Type Description
destination

Destino de los archivos de salida.

filePattern
  • string

Patrón que indica qué archivos se van a cargar.
Se admiten rutas de acceso relativas y absolutas. Las rutas de acceso relativas son relativas al directorio de trabajo de la tarea. Se admiten los siguientes caracteres comodín: * coincide con 0 o más caracteres (por ejemplo, el patrón abc* coincidiría con abc o abcdef), ** coincide con cualquier directorio, ? coincide con cualquier carácter individual, [abc] coincide con un carácter entre corchetes y [a-c] coincide con un carácter del intervalo. Los corchetes pueden incluir una negación para que coincida con cualquier carácter no especificado (por ejemplo[!abc] coincide con cualquier carácter, excepto a, b o c). Si un nombre de archivo comienza por "." se omite de forma predeterminada, pero puede coincidir especificando explícitamente (por ejemplo ,.gif no coincidirá con .a.gif, pero ..gif). Un ejemplo sencillo: ***.txt coincide con cualquier archivo que no se inicie en '.' y termine con .txt en el directorio de trabajo de tareas o en cualquier subdirectorio. Si el nombre de archivo contiene un carácter comodín, se puede escapar mediante corchetes (por ejemplo, abc[] coincidiría con un archivo denominado abc). Tenga en cuenta que tanto \ como / se tratan como separadores de directorio en Windows, pero solo / está en Linux. Las variables de entorno (%var% en Windows o $var en Linux) se expanden antes de aplicar el patrón.

uploadOptions

Opciones adicionales para la operación de carga, incluidas las condiciones para realizar la carga.

OutputFileBlobContainerDestination

Especifica un destino de carga de archivos dentro de un contenedor de Azure Blob Storage.

Name Type Description
containerUrl
  • string

Dirección URL del contenedor en Azure Blob Storage en la que se van a cargar los archivos.
Si no usa una identidad administrada, la dirección URL debe incluir una firma de acceso compartido (SAS) que conceda permisos de escritura al contenedor.

identityReference

Referencia a la identidad asignada por el usuario que se va a usar para acceder a Azure Blob Storage especificado por containerUrl
La identidad debe tener acceso de escritura al contenedor de Azure Blob Storage

path
  • string

Blob de destino o directorio virtual dentro del contenedor Azure Storage.
Si filePattern hace referencia a un archivo específico (es decir, no contiene caracteres comodín), la ruta de acceso es el nombre del blob al que cargar ese archivo. Si filePattern contiene uno o varios caracteres comodín (y, por lo tanto, pueden coincidir con varios archivos), la ruta de acceso es el nombre del directorio virtual del blob (que se antepone a cada nombre de blob) al que cargar los archivos. Si se omite, los archivos se cargan en la raíz del contenedor con un nombre de blob que coincida con su nombre de archivo.

uploadHeaders

Lista de pares nombre-valor para los encabezados que se usarán en la carga de archivos de salida.
Estos encabezados se especificarán al cargar archivos en Azure Storage. Para obtener más información, vea Encabezados de solicitud (todos los tipos de blobs).

OutputFileDestination

Destino al que se debe cargar un archivo.

Name Type Description
container

Ubicación en Azure Blob Storage en la que se cargan los archivos.

OutputFileUploadCondition

Condiciones en las que se debe cargar un archivo de salida de tarea o un conjunto de archivos.

Name Type Description
taskcompletion
  • string

Upload los archivos después de que se cierre el proceso de tarea, independientemente del código de salida.

taskfailure
  • string

Upload los archivos solo después de que el proceso de tarea salga con un código de salida distinto de cero.

tasksuccess
  • string

Upload los archivos solo después de que el proceso de tarea salga con un código de salida de 0.

OutputFileUploadOptions

Detalles sobre una operación de carga de archivos de salida, incluidas las condiciones para realizar la carga.

Name Type Description
uploadCondition

Condiciones en las que se debe cargar el archivo de salida de la tarea o el conjunto de archivos.
El valor predeterminado es taskcompletion.

PoolEndpointConfiguration

Configuración del punto de conexión de un grupo.

Name Type Description
inboundNATPools

Lista de grupos NAT de entrada que se pueden usar para abordar puertos específicos en un nodo de proceso individual externamente.
El número máximo de grupos NAT entrantes por grupo de lotes es 5. Si se supera el número máximo de grupos NAT de entrada, se produce un error en la solicitud con el código de estado HTTP 400. No se puede especificar si IPAddressProvisioningType es NoPublicIPAddresses.

PoolInformation

Especifica cómo se debe asignar un trabajo a un grupo.

Name Type Description
autoPoolSpecification

Características de un "grupo automático" temporal. El servicio Batch creará este grupo automático cuando se envíe el trabajo.
Si se produce un error en la creación automática del grupo, el servicio Batch mueve el trabajo a un estado completado y el error de creación del grupo se establece en la propiedad error de programación del trabajo. El servicio Batch administra la duración (tanto la creación como, a menos que se especifique keepAlive, la eliminación) del grupo automático. Cualquier acción de usuario que afecte a la duración del grupo automático mientras el trabajo está activo dará como resultado un comportamiento inesperado. Debe especificar el identificador del grupo o la especificación del grupo automático, pero no ambos.

poolId
  • string

Identificador de un grupo existente. Todas las tareas del trabajo se ejecutarán en el grupo especificado.
Debe asegurarse de que existe el grupo al que hace referencia esta propiedad. Si el grupo no existe en el momento en que el servicio Batch intenta programar un trabajo, no se ejecutará ninguna tarea para el trabajo hasta que cree un grupo con ese identificador. Tenga en cuenta que el servicio Batch no rechazará la solicitud de trabajo; simplemente no ejecutará tareas hasta que exista el grupo. Debe especificar el identificador del grupo o la especificación del grupo automático, pero no ambos.

PoolLifetimeOption

La duración mínima de los grupos automáticos creados y cómo se asignan varios trabajos según una programación a grupos.

Name Type Description
job
  • string

El grupo existe durante la vigencia del trabajo al que está dedicado. El servicio Batch crea el grupo cuando crea el trabajo. Si la opción "trabajo" se aplica a una programación de trabajos, el servicio Batch crea un nuevo grupo automático para cada trabajo creado según la programación.

jobschedule
  • string

El grupo existe durante la vigencia de la programación de trabajos. El servicio Batch crea el grupo cuando crea el primer trabajo según la programación. Puede aplicar esta opción solo a programaciones de trabajos, no a trabajos.

PoolSpecification

Especificación para crear un nuevo grupo.

Name Type Description
applicationLicenses
  • string[]

La lista de licencias de aplicación que el servicio Batch pondrá a disposición en cada nodo de proceso del grupo.
La lista de licencias de aplicación debe ser un subconjunto de las licencias de aplicación de servicio de Batch disponibles. Si se solicita una licencia que no se admite, se producirá un error en la creación del grupo. Las licencias permitidas disponibles en el Grupo son "maya", "vray", "3dsmax", "arnold". Se aplica un cargo adicional por cada licencia de aplicación agregada al grupo.

applicationPackageReferences

Lista de paquetes que se van a instalar en cada nodo de proceso del grupo.
Los cambios en las referencias de paquete afectan a todos los nodos nuevos que se unen al grupo, pero no afectan a los nodos de proceso que ya están en el grupo hasta que se reinician o se vuelven a crear una imagen inicial. Hay un máximo de 10 referencias de paquete en cualquier grupo determinado.

autoScaleEvaluationInterval
  • string

Intervalo de tiempo en el que ajustar automáticamente el tamaño del grupo según la fórmula de escalado automático.
El valor predeterminado es 15 minutos. El valor mínimo y máximo son 5 minutos y 168 horas respectivamente. Si especifica un valor inferior a 5 minutos o superior a 168 horas, el servicio Batch rechaza la solicitud con un error de valor de propiedad no válido; Si va a llamar directamente a la API REST, el código de estado HTTP es 400 (solicitud incorrecta).

autoScaleFormula
  • string

Fórmula para el número deseado de nodos de proceso en el grupo.
Esta propiedad no debe especificarse si enableAutoScale está establecido en false. Es necesario si enableAutoScale está establecido en true. La fórmula se comprueba si hay validez antes de crear el grupo. Si la fórmula no es válida, el servicio Batch rechaza la solicitud con información detallada de error.

certificateReferences

Lista de certificados que se van a instalar en cada nodo de proceso del grupo.
Para Windows nodos, 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.

cloudServiceConfiguration

Configuración del servicio en la nube para el grupo.
Esta propiedad debe especificarse si el grupo debe crearse con máquinas virtuales paaS de Azure. Esta propiedad y virtualMachineConfiguration son mutuamente excluyentes y se debe especificar una de las propiedades. Si no se especifica ninguno, el servicio Batch devuelve un error; Si va a llamar directamente a la API REST, el código de estado HTTP es 400 (solicitud incorrecta). Esta propiedad no se puede especificar si la cuenta de Batch se creó con su propiedad poolAllocationMode establecida en "UserSubscription".

displayName
  • string

Nombre para mostrar del grupo.
El nombre para mostrar no debe ser único y puede contener cualquier carácter Unicode hasta una longitud máxima de 1024.

enableAutoScale
  • boolean

Si el tamaño del grupo se debe ajustar automáticamente con el tiempo.
Si es false, se debe especificar al menos uno de targetDedicatedNodes y targetLowPriorityNodes. Si es true, se requiere el elemento autoScaleFormula. El grupo cambia automáticamente el tamaño según la fórmula. El valor predeterminado es false.

enableInterNodeCommunication
  • boolean

Si el grupo permite la comunicación directa entre los nodos de proceso.
Habilitar la comunicación entre nodos limita el tamaño máximo del grupo debido a restricciones de implementación en los nodos de proceso del grupo. Esto puede dar lugar a que el grupo no alcance su tamaño deseado. El valor predeterminado es false.

metadata

Lista de pares nombre-valor asociados al grupo como metadatos.
El servicio Batch no asigna ningún significado a los metadatos; es únicamente para el uso del código de usuario.

mountConfiguration

Lista de sistemas de archivos que se van a montar en cada nodo del grupo.
Esto admite Azure Files, NFS, CIFS/SMB y Blobfuse.

networkConfiguration

Configuración de red del grupo.
Configuración de red de un grupo.

resizeTimeout
  • string

Tiempo de espera para la asignación de nodos de proceso al grupo.
Este tiempo de espera solo se aplica al escalado manual; no tiene ningún efecto cuando enableAutoScale se establece en true. El valor predeterminado es 15 minutos. El valor mínimo es de 5 minutos. Si especifica un valor inferior a 5 minutos, el servicio Batch rechaza la solicitud con un error; Si va a llamar directamente a la API REST, el código de estado HTTP es 400 (solicitud incorrecta).

startTask

Tarea que se va a ejecutar en cada nodo de ejecución a medida que se une al grupo. La tarea se ejecuta cuando se agrega el nodo de ejecución al grupo o cuando se reinicia el nodo de ejecución.
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.

targetDedicatedNodes
  • integer

Número deseado de nodos de proceso dedicados en el grupo.
Esta propiedad no debe especificarse si enableAutoScale está establecido en true. Si enableAutoScale está establecido en false, debe establecer targetDedicatedNodes, targetLowPriorityNodes o ambos.

targetLowPriorityNodes
  • integer

Número deseado de nodos de proceso de prioridad baja o de acceso puntual en el grupo.
Esta propiedad no debe especificarse si enableAutoScale está establecido en true. Si enableAutoScale está establecido en false, debe establecer targetDedicatedNodes, targetLowPriorityNodes o ambos.

taskSchedulingPolicy

Cómo se distribuyen las tareas entre nodos de proceso en un grupo.
Si no se especifica, el valor predeterminado se distribuye.

taskSlotsPerNode
  • integer

El número de ranuras de tareas que pueden usarse para ejecutar tareas simultáneas en un solo nodo de ejecución en el grupo.
El valor predeterminado es 1. El valor máximo es el menor de 4 veces el número de núcleos del vmSize del grupo o 256.

userAccounts

Lista de cuentas de usuario que se van a crear en cada nodo de proceso del grupo.

virtualMachineConfiguration

Configuración de la máquina virtual para el grupo.
Esta propiedad debe especificarse si el grupo debe crearse con máquinas virtuales iaaS de Azure. Esta propiedad y cloudServiceConfiguration son mutuamente excluyentes y se debe especificar una de las propiedades. Si no se especifica ninguno, el servicio Batch devuelve un error; Si va a llamar directamente a la API REST, el código de estado HTTP es 400 (solicitud incorrecta).

vmSize
  • string

Tamaño de las máquinas virtuales del grupo. Todas las máquinas virtuales de un grupo tienen el mismo tamaño.
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).

PublicIPAddressConfiguration

Configuración de la dirección IP pública de la configuración de red de un grupo.

Name Type Description
ipAddressIds
  • string[]

Lista de direcciones IP públicas que usará el servicio Batch al aprovisionar nodos de proceso.
El número de direcciones IP especificadas aquí limita el tamaño máximo del grupo: 100 nodos dedicados o 100 nodos de prioridad baja o puntual se puede asignar para cada dirección IP pública. Por ejemplo, un grupo que necesita 250 máquinas virtuales dedicadas necesitaría al menos 3 direcciones IP públicas especificadas. Cada elemento de esta colección tiene el formato: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.

provision

Tipo de aprovisionamiento para direcciones IP públicas para el grupo.
El valor predeterminado es BatchManaged.

RecentJob

Información sobre el trabajo más reciente que se va a ejecutar en programación de trabajos.

Name Type Description
id
  • string

Identificador del trabajo.

url
  • string

Dirección URL del trabajo.

ResourceFile

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

Name Type 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 Windows nodo de ejecución. 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

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.

Schedule

Programación según la cual se crearán trabajos. Todas las horas se fijan respectivamente a utc y no se ven afectadas por el horario de verano.

Name Type Description
doNotRunAfter
  • string

Una hora después de la cual no se creará ningún trabajo en esta programación de trabajo. La programación pasará al estado completado en cuanto haya transcurrido esta fecha límite y no haya ningún trabajo activo en esta programación de trabajos.
Si no especifica una hora doNotRunAfter y está creando una programación de trabajo periódica, la programación del trabajo permanecerá activa hasta que la finalice explícitamente.

doNotRunUntil
  • string

La hora más temprana en la que se puede crear cualquier trabajo en esta programación de trabajo.
Si no especifica una hora doNotRunUntil, la programación estará lista para crear trabajos inmediatamente.

recurrenceInterval
  • string

Intervalo de tiempo entre las horas de inicio de dos trabajos sucesivos en la programación de trabajos. Una programación de trabajos puede tener como máximo un trabajo activo en él en un momento dado.
Dado que una programación de trabajos puede tener como máximo un trabajo activo en él en un momento dado, si es el momento de crear un nuevo trabajo en una programación de trabajos, pero el trabajo anterior todavía se está ejecutando, el servicio Batch no creará el nuevo trabajo hasta que finalice el trabajo anterior. Si el trabajo anterior no finaliza dentro del período startWindow de la nueva recurrenceInterval, no se programará ningún nuevo trabajo para ese intervalo. Para trabajos periódicos, normalmente debe especificar un jobManagerTask en jobSpecification. Si no usa jobManagerTask, necesitará un proceso externo para supervisar cuándo se crean trabajos, agregue Tareas a los trabajos y finalice los trabajos listos para la siguiente periodicidad. El valor predeterminado es que la programación no se repite: se crea un trabajo, dentro de startWindow después de la hora doNotRunUntil y la programación se completa en cuanto finaliza el trabajo. El valor mínimo es de 1 minuto. Si especifica un valor inferior, el servicio Batch rechaza la programación con un error; Si llama directamente a la API REST, el código de estado HTTP es 400 (solicitud incorrecta).

startWindow
  • string

El intervalo de tiempo, a partir del momento en el que la programación indica que se debe crear un trabajo, dentro del cual se debe crear un trabajo.
Si no se crea un trabajo dentro del intervalo startWindow, se pierde la "oportunidad" ; no se creará ningún trabajo hasta la siguiente periodicidad de la programación. Si la programación es periódica y startWindow es mayor que el intervalo de periodicidad, esto equivale a un startWindow infinito, porque el trabajo que es "debido" en una periodicidadInterval no se lleva a cabo en el siguiente intervalo de periodicidad. El valor predeterminado es infinite. El valor mínimo es de 1 minuto. Si especifica un valor inferior, el servicio Batch rechaza la programación con un error; Si llama directamente a la API REST, el código de estado HTTP es 400 (solicitud incorrecta).

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 la imagen inicial del nodo de ejecución.

Name Type 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, mediante "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

La configuración del contenedor en el que se ejecuta StartTask.
Cuando se especifica, todos los directorios se asignan 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

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 reintentar 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 tres 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

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 .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

Identidad de usuario en 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 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 ejecución 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 ejecución mientras se está ejecutando startTask; e incluso si se produce un error en StartTask, las nuevas tareas se seguirán programando en el nodo de ejecución. El valor predeterminado es true.

StorageAccountType

Tipo de cuenta de almacenamiento que se va a usar para crear discos de datos.

Name Type Description
premium_lrs
  • string

El disco de datos debe usar almacenamiento con redundancia local Premium.

standard_lrs
  • string

El disco de datos debe usar el almacenamiento estándar con redundancia local.

TaskConstraints

Restricciones de ejecución que se van a aplicar a una tarea.

Name Type Description
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 para el ejecutable task debido a un código de salida distinto de cero. El servicio Batch probará la tarea una vez y, a continuación, puede reintentar 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 tres reintentos). Si el número máximo de reintentos es 0, el servicio Batch no vuelve a intentar la tarea después del primer intento. 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)

maxWallClockTime
  • string

Tiempo máximo transcurrido que se puede ejecutar la tarea, medido desde el momento en que se inicia la tarea. Si la tarea no se completa dentro del límite de tiempo, el servicio Batch la finaliza.
Si no se especifica, no hay ningún límite de tiempo durante cuánto tiempo se puede ejecutar la tarea.

retentionTime
  • string

El tiempo mínimo para conservar el directorio Task en el nodo de proceso donde se ejecutó, a partir del momento en que finaliza la ejecución. Después de este tiempo, el servicio Batch puede eliminar el directorio Task y todo su contenido.
El valor predeterminado es 7 días, es decir, el directorio Task se conservará durante 7 días a menos que se quite el nodo de proceso o se elimine el trabajo.

TaskContainerSettings

Configuración del contenedor de una tarea.

Name Type 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

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

Ubicación del directorio de trabajo de la tarea de contenedor.
El valor predeterminado es "taskWorkingDirectory".

TaskSchedulingPolicy

Especifica cómo se deben distribuir las tareas entre nodos de proceso.

Name Type Description
nodeFillType

Cómo se distribuyen las tareas entre nodos de proceso en un grupo.
Si no se especifica, el valor predeterminado se distribuye.

UserAccount

Propiedades usadas para crear un usuario que se usa para ejecutar tareas en un nodo de Azure Batch proceso.

Name Type Description
elevationLevel

Nivel de elevación de la cuenta de usuario.
El valor predeterminado es nonAdmin.

linuxUserConfiguration

Configuración de usuario específica de Linux para la cuenta de usuario.
Esta propiedad se omite si se especifica en un grupo de Windows. Si no se especifica, el usuario se crea con las opciones predeterminadas.

name
  • string

Nombre de la cuenta de usuario.

password
  • string

La contraseña de la cuenta de usuario.

windowsUserConfiguration

Configuración de usuario específica del Windows para la cuenta de usuario.
Esta propiedad solo se puede especificar si el usuario está en un grupo de Windows. Si no se especifica y en un grupo de Windows, el usuario se crea con las opciones predeterminadas.

UserIdentity

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

Name Type Description
autoUser

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.

VirtualMachineConfiguration

Configuración de nodos de proceso en un grupo basado en la infraestructura de Azure Virtual Machines.

Name Type Description
containerConfiguration

Configuración del contenedor para el grupo.
Si se especifica, la instalación se realiza en cada nodo de proceso del grupo para permitir que las tareas se ejecuten en contenedores. Todas las tareas normales y tareas del administrador de trabajos que se ejecutan en este grupo deben especificar la propiedad containerSettings y todas las demás tareas pueden especificarla.

dataDisks

La configuración de los discos de datos conectados a los nodos de proceso del grupo.
Esta propiedad debe especificarse si los nodos de proceso del grupo deben tener discos de datos vacíos conectados a ellos. No se puede actualizar. Cada nodo de proceso obtiene su propio disco (el disco no es un recurso compartido de archivos). Los discos existentes no se pueden conectar, cada disco conectado está vacío. Cuando se quita el nodo de proceso del grupo, el disco y todos los datos asociados a él también se eliminan. El disco no tiene formato después de conectarse, debe tener formato antes de usarlo; para obtener más información, vea https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux y https://docs.microsoft.com/en-us/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine.

diskEncryptionConfiguration

Configuración de cifrado de disco para el grupo.
Si se especifica, el cifrado se realiza en cada nodo del grupo durante el aprovisionamiento de nodos.

extensions

Extensión de máquina virtual para el grupo.
Si se especifica, las extensiones mencionadas en esta configuración se instalarán en cada nodo.

imageReference

Referencia a la imagen de Azure Virtual Machines Marketplace o a la imagen de máquina virtual personalizada que se va a usar.

licenseType
  • string

Tipo de licencia local que se usará al implementar el sistema operativo.
Esto solo se aplica a las imágenes que contienen el sistema operativo Windows y solo se deben usar al contener licencias locales válidas para los nodos de proceso que se implementarán. Si se omite, no se aplica ningún descuento de licencia local. Los valores son:

Windows_Server: la licencia local es para Windows Server. Windows_Client: la licencia local es para Windows Cliente.

nodeAgentSKUId
  • string

SKU del agente de nodo de proceso de Batch que se va a aprovisionar en los nodos de proceso del grupo.
El agente de Batch Compute Node es un programa que se ejecuta en cada nodo de proceso del grupo y proporciona la interfaz de comando y control entre el nodo de proceso y el servicio Batch. Hay diferentes implementaciones del agente de Compute Node, conocidas como SKU, para distintos sistemas operativos. Debe especificar una SKU del agente de Nodo de proceso que coincida con la referencia de imagen seleccionada. Para obtener la lista de SKU de agente de Node de proceso compatibles junto con su lista de referencias de imágenes comprobadas, consulte la operación "Enumeración de SKU de agente de nodo de proceso compatibles".

nodePlacementConfiguration

Configuración de ubicación del nodo para el grupo.
Esta configuración especificará reglas sobre cómo se asignarán físicamente los nodos del grupo.

osDisk

Configuración para el disco del sistema operativo de la máquina virtual.

windowsConfiguration

Windows la configuración del sistema operativo en la máquina virtual.
Esta propiedad no se debe especificar si la propiedad imageReference especifica una imagen del sistema operativo Linux.

VMExtension

Configuración de extensiones de máquina virtual.

Name Type Description
autoUpgradeMinorVersion
  • boolean

Indica si la extensión debe usar una versión secundaria más reciente si hay una disponible en el momento de la implementación. Sin embargo, una vez implementada, la extensión no actualizará las versiones secundarias a menos que se vuelva a implementar, incluso con esta propiedad establecida en true.

name
  • string

Nombre de la extensión de máquina virtual.

protectedSettings
  • object

La extensión puede contener protectedSettings o protectedSettingsFromKeyVault o ninguna configuración protegida.

provisionAfterExtensions
  • string[]

Colección de nombres de extensión.
Colección de nombres de extensión después de los cuales se debe aprovisionar esta extensión.

publisher
  • string

Nombre del publicador de controladores de extensión.

settings
  • object

Configuración pública con formato JSON para la extensión.

type
  • string

El tipo de extensión.

typeHandlerVersion
  • string

Versión del controlador de script.

WindowsConfiguration

Windows configuración del sistema operativo que se va a aplicar a la máquina virtual.

Name Type Description
enableAutomaticUpdates
  • boolean

Si las actualizaciones automáticas están habilitadas en la máquina virtual.
Si se omite, el valor predeterminado es true.

WindowsUserConfiguration

Propiedades usadas para crear una cuenta de usuario en un nodo de proceso de Windows.

Name Type Description
loginMode

Modo de inicio de sesión para el usuario
El valor predeterminado para los grupos de virtualMachineConfiguration es "batch" y para los grupos de CloudServiceConfiguration es "interactivo".