Compartir a través de


Job - Get

Obtiene información sobre el trabajo especificado.

GET {batchUrl}/jobs/{jobId}?api-version=2024-07-01.20.0
GET {batchUrl}/jobs/{jobId}?$select={$select}&$expand={$expand}&timeout={timeout}&api-version=2024-07-01.20.0

Parámetros de identificador URI

Nombre En Requerido Tipo Description
batchUrl
path True

string

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

jobId
path True

string

Identificador del trabajo.

api-version
query True

string

Versión de la API de cliente.

$expand
query

string

Una cláusula $expand OData.

$select
query

string

Una cláusula $select de OData.

timeout
query

integer

int32

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

Encabezado de la solicitud

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

Nombre Requerido Tipo Description
client-request-id

string

uuid

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

return-client-request-id

boolean

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

ocp-date

string

date-time-rfc1123

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

If-Match

string

Valor ETag asociado a la versión del recurso conocido para el cliente. La operación solo se realizará si la ETag actual del recurso en el servicio coincide exactamente con el valor especificado por el cliente.

If-None-Match

string

Valor ETag asociado a la versión del recurso conocido para el cliente. La operación solo se realizará si la ETag actual del recurso en el servicio no coincide con el valor especificado por el cliente.

If-Modified-Since

string

date-time-rfc1123

Marca de tiempo que indica la hora de última modificación del recurso conocido para el cliente. La operación solo se realizará si el recurso del servicio se ha modificado desde el momento especificado.

If-Unmodified-Since

string

date-time-rfc1123

Marca de tiempo que indica la hora de última modificación del recurso conocido para el cliente. La operación solo se realizará si el recurso del servicio no se ha modificado desde el momento especificado.

Respuestas

Nombre Tipo Description
200 OK

CloudJob

Respuesta que contiene el trabajo.

Encabezados

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

BatchError

Error del servicio Batch.

Seguridad

azure_auth

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

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

Ámbitos

Nombre Description
user_impersonation Suplantar la cuenta de usuario

Authorization

Tipo: apiKey
En: header

Ejemplos

Job get

Solicitud de ejemplo

GET account.region.batch.azure.com/jobs/jobId?api-version=2024-07-01.20.0


Respuesta de muestra

{
  "id": "jobId",
  "url": "https://account.region.batch.azure.com/jobs/jobId",
  "eTag": "0x8D4100FC49F0278",
  "lastModified": "2016-11-19T00:05:27.5391608Z",
  "creationTime": "2016-11-19T00:05:25.311915Z",
  "state": "completed",
  "stateTransitionTime": "2016-11-19T00:05:27.578581Z",
  "previousState": "active",
  "previousStateTransitionTime": "2016-11-19T00:05:27.2137716Z",
  "priority": 0,
  "maxParallelTasks": -1,
  "allowTaskPreemption": false,
  "usesTaskDependencies": false,
  "constraints": {
    "maxWallClockTime": "P10675199DT2H48M5.4775807S",
    "maxTaskRetryCount": 0
  },
  "poolInfo": {
    "poolId": "poolId"
  },
  "executionInfo": {
    "startTime": "2016-11-19T00:05:25.3309105Z",
    "endTime": "2016-11-19T00:05:27.578581Z",
    "poolId": "poolId",
    "terminateReason": "UserTerminate"
  },
  "onAllTasksComplete": "noaction",
  "onTaskFailure": "noaction"
}

Definiciones

Nombre Description
AccessScope

Recursos de Batch a los que el token concede acceso.

ApplicationPackageReference

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

AuthenticationTokenSettings

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

AutomaticOSUpgradePolicy

Los parámetros de configuración que se usan para realizar la actualización automática del sistema operativo.

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 que se usa para conectarse a un contenedor de Azure Storage mediante Blobfuse.

AzureFileShareConfiguration

Información que se usa para conectarse a un recurso compartido de archivos de Azure.

BatchError

Respuesta de error recibida del servicio Azure Batch.

BatchErrorDetail

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

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.

CertificateVisibility

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

CIFSMountConfiguration

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

CloudJob

Un trabajo de Azure Batch.

ComputeNodeFillType

Cómo se distribuyen las tareas entre nodos de proceso de 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.

ContainerHostBatchBindMountEntry

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

ContainerHostDataPath

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

ContainerRegistry

Un registro de contenedor privado.

ContainerType

Tecnología de contenedor que se va a usar.

ContainerWorkingDirectory

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

DataDisk

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

DiffDiskPlacement

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

DiffDiskSettings

Especifica la configuración de disco efímero 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. No se admite la configuración de cifrado de disco en el grupo de Linux creado con la imagen de Azure Compute Gallery.

DiskEncryptionTarget

La lista de destinos de disco de Batch Service cifrará en el nodo de proceso.

DynamicVNetAssignmentScope

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

ElevationLevel

Nivel de elevación del usuario.

EnvironmentSetting

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

ErrorCategory

Categoría del error.

ErrorMessage

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

HttpHeader

Un par nombre-valor de encabezado HTTP

ImageReference

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

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 en un grupo de lotes externamente.

IPAddressProvisioningType

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

JobConstraints

Restricciones de ejecución para un trabajo.

JobExecutionInformation

Contiene información sobre la ejecución de un trabajo en el servicio Azure Batch.

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.

JobSchedulingError

Error detectado por el servicio Batch al programar un trabajo.

JobState

Estado del trabajo.

JobStatistics

Estadísticas de uso de recursos para un trabajo.

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

ManagedDisk
MetadataItem

Par nombre-valor asociado a un recurso de servicio de Batch.

MountConfiguration

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

NameValuePair

Representa un par nombre-valor.

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 utilizada para conectarse a un sistema de archivos NFS.

NodeCommunicationMode

Determina cómo se comunica un grupo con el servicio Batch.

NodePlacementConfiguration

Configuración de ubicación de 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 debe realizar el servicio Batch cuando se produce un error en cualquier tarea del trabajo.

OSDisk

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

OutputFile

Especificación para cargar archivos desde un nodo de proceso de Azure Batch 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 los grupos.

PoolSpecification

Especificación para crear un nuevo grupo.

PublicIPAddressConfiguration

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

ResourceFile

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

RollingUpgradePolicy

Los parámetros de configuración usados al realizar una actualización gradual.

SecurityEncryptionTypes

Especifica encryptionType del disco administrado. Se establece en VMGuestStateOnly para el cifrado de solo el blob VMGuestState y NonPersistedTPM para no conservar el estado de firmware en el blob VMGuestState. Nota: solo se puede establecer para máquinas virtuales confidenciales y se requiere cuando se usan máquinas virtuales confidenciales.

SecurityProfile

Especifica la configuración del perfil de seguridad para la máquina virtual o el conjunto de escalado de máquinas virtuales.

SecurityTypes

Especifica securityType de la máquina virtual. Debe establecerse en cualquier valor especificado para habilitar UefiSettings.

ServiceArtifactReference

Especifica el identificador de referencia del artefacto de servicio que se usa para establecer la misma versión de imagen para todas las máquinas virtuales del conjunto de escalado cuando se usa la versión de imagen "más reciente".

StartTask

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

StorageAccountType

Tipo de cuenta de almacenamiento que se usa para crear discos de datos o disco del sistema operativo.

TaskConstraints

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

TaskContainerSettings

Configuración del contenedor de una tarea.

TaskSchedulingPolicy

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

UefiSettings

Especifica la configuración de seguridad, como el arranque seguro y vTPM que se usa al crear la máquina virtual.

UpgradeMode

Especifica el modo de una actualización a las máquinas virtuales del conjunto de escalado.

Los valores posibles son:

manual: controla la aplicación de actualizaciones en las máquinas virtuales del conjunto de escalado. Para ello, use la acción manualUpgrade.

Automático: todas las máquinas virtuales del conjunto de escalado se actualizan automáticamente al mismo tiempo.

rolling: el conjunto de escalado realiza actualizaciones en lotes con un tiempo de pausa opcional entre sí.

UpgradePolicy

Describe una directiva de actualización: automática, manual o gradual.

UserAccount

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

UserIdentity

Definición de la identidad de 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.

VMDiskSecurityProfile

Especifica la configuración del perfil de seguridad para el disco administrado. Nota: solo se puede establecer para máquinas virtuales confidenciales y necesarias al usar máquinas virtuales confidenciales.

VMExtension

Configuración de extensiones de máquina virtual.

WindowsConfiguration

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

WindowsUserConfiguration

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

AccessScope

Recursos de Batch a los que el token concede acceso.

Nombre Tipo Description
job

string

Concede acceso para realizar todas las operaciones en el trabajo que contiene la tarea.

ApplicationPackageReference

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

Nombre Tipo Description
applicationId

string

Identificador de la aplicación que se va a implementar.
Al crear un grupo, el identificador de aplicación del paquete debe estar completo (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).

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, la tarea produce un error de preprocesamiento.

AuthenticationTokenSettings

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

Nombre Tipo Description
access

AccessScope[]

Recursos de Batch a los que el token concede acceso.
El token de autenticación concede acceso a un conjunto limitado de operaciones de servicio de 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.

AutomaticOSUpgradePolicy

Los parámetros de configuración que se usan para realizar la actualización automática del sistema operativo.

Nombre Tipo Description
disableAutomaticRollback

boolean

Indica si se debe deshabilitar la característica de reversión de imágenes del sistema operativo.

enableAutomaticOSUpgrade

boolean

Indica si las actualizaciones del sistema operativo se deben aplicar automáticamente a las instancias del conjunto de escalado de forma gradual cuando esté disponible una versión más reciente de la imagen del sistema operativo.

Si se establece en true para los grupos basados en Windows, WindowsConfiguration.enableAutomaticUpdates no se puede establecer en true.

osRollingUpgradeDeferral

boolean

Aplazar las actualizaciones del sistema operativo en los TELEVISORes si están ejecutando tareas.

useRollingUpgradePolicy

boolean

Indica si se debe usar la directiva de actualización gradual durante la actualización automática del sistema operativo. La actualización automática del sistema operativo se revertirá a la directiva predeterminada si no se define ninguna directiva en VMSS.

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.

Nombre Tipo 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 hasta 20 caracteres.

keepAlive

boolean

Indica 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 su 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. Es necesario que el usuario elimine los grupos automáticos creados con esta opción.

pool

PoolSpecification

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

poolLifetimeOption

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

AutoUserScope

Ámbito del usuario automático

Nombre Tipo Description
pool

string

Especifica que la tarea se ejecuta como la cuenta de usuario automático común que se crea en cada nodo de proceso de un grupo.

task

string

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

AutoUserSpecification

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

Nombre Tipo Description
elevationLevel

ElevationLevel

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

scope

AutoUserScope

Ámbito del usuario automático
El valor predeterminado es pool. Si el grupo ejecuta Windows, se debe especificar un valor de Task si se requiere un aislamiento más estricto entre las tareas. Por ejemplo, si la tarea muta el registro de una manera que podría afectar a otras tareas, o si se han especificado certificados en el grupo al que no deben acceder las tareas normales, pero deben ser accesibles por StartTasks.

AzureBlobFileSystemConfiguration

Información que se usa para conectarse a un contenedor de Azure Storage mediante Blobfuse.

Nombre Tipo Description
accountKey

string

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

accountName

string

Nombre de la cuenta de Azure Storage.

blobfuseOptions

string

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

containerName

string

Nombre del contenedor de Azure Blob Storage.

identityReference

ComputeNodeIdentityReference

Referencia a la identidad asignada por el usuario que se va a usar para acceder a containerName
Esta propiedad es mutuamente excluyente con accountKey y 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 que se usa para conectarse a un recurso compartido de archivos de Azure.

Nombre Tipo Description
accountKey

string

Clave de cuenta de Azure Storage.

accountName

string

Nombre de la cuenta de Azure Storage.

azureFileUrl

string

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

mountOptions

string

Opciones de línea de comandos adicionales para pasar al comando de montaje.
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.

Nombre Tipo Description
code

string

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

message

ErrorMessage

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

values

BatchErrorDetail[]

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

BatchErrorDetail

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

Nombre Tipo Description
key

string

Identificador que especifica el significado de la propiedad Value.

value

string

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

CachingType

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

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

Nombre Tipo Description
storeLocation

CertificateStoreLocation

Ubicación del almacén de certificados en el nodo de proceso en el que se va a instalar el certificado.
El valor predeterminado es currentuser. Esta propiedad solo es aplicable a los grupos configurados con nodos de proceso de Windows. En el caso de los nodos de proceso de Linux, los certificados se almacenan en un directorio dentro del directorio de trabajo de la tarea y se proporciona una variable de entorno AZ_BATCH_CERTIFICATES_DIR a la tarea para consultar esta ubicación. En el caso de los certificados con visibilidad de "remoteUser", se crea un directorio "certs" en el directorio principal del usuario (por ejemplo, /home/{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 es aplicable a los grupos configurados con nodos de proceso de Windows. Los nombres de almacén comunes incluyen: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, pero también se puede usar cualquier nombre de almacén personalizado. El valor predeterminado es My.

thumbprint

string

Huella digital del certificado.

thumbprintAlgorithm

string

Algoritmo con el que está asociada la huella digital. Debe ser sha1.

visibility

CertificateVisibility[]

Qué cuentas de usuario del nodo de proceso deben tener acceso a los datos privados del certificado.
Puede especificar más de una visibilidad en esta colección. El valor predeterminado es todas las cuentas.

CertificateStoreLocation

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

Nombre Tipo Description
currentuser

string

Los certificados deben instalarse en el almacén de certificados CurrentUser.

localmachine

string

Los certificados deben instalarse en el almacén de certificados LocalMachine.

CertificateVisibility

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

Nombre Tipo Description
remoteuser

string

El certificado debe ser visible para las cuentas de usuario en las que los usuarios acceden de forma remota al nodo de proceso.

starttask

string

El certificado debe estar visible para la cuenta de usuario en la que se ejecuta StartTask. Tenga en cuenta que si El ámbito de autousuario es Pool para StartTask y una tarea, este certificado también será visible para la tarea.

task

string

El certificado debe estar visible para las cuentas de usuario en las que se ejecutan las tareas de trabajo.

CIFSMountConfiguration

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

Nombre Tipo Description
mountOptions

string

Opciones de línea de comandos adicionales para pasar al comando de montaje.
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.

CloudJob

Un trabajo de Azure Batch.

Nombre Tipo Valor predeterminado Description
allowTaskPreemption

boolean

Si otras 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

EnvironmentSetting[]

Lista de valores comunes de variables de entorno. Estas variables de entorno se establecen para todas las tareas del trabajo (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

JobConstraints

Restricciones de ejecución para el trabajo.

creationTime

string

Hora de creación del trabajo.

displayName

string

Nombre para mostrar del trabajo.

eTag

string

ETag del trabajo.
Se trata de una cadena opaca. Puede usarlo para detectar si el trabajo ha cambiado entre solicitudes. En concreto, puede pasar la ETag al actualizar un trabajo para especificar que los cambios deben surtir efecto solo si nadie más ha modificado el trabajo mientras tanto.

executionInfo

JobExecutionInformation

Información de ejecución del trabajo.

id

string

Cadena que identifica de forma única el trabajo dentro de la cuenta.
El identificador se conserva entre mayúsculas y minúsculas y no distingue mayúsculas de minúsculas (es decir, es posible que no tenga dos identificadores dentro de una cuenta que solo difiere por caso).

jobManagerTask

JobManagerTask

Detalles de una tarea del Administrador de trabajos que se va a iniciar cuando se inicia el trabajo.
La tarea Administrador de trabajos se inicia automáticamente cuando se crea el trabajo. El servicio Batch intenta programar la tarea administrador de trabajos antes de cualquier otra tarea del trabajo. Al reducir un grupo, el servicio Batch intenta conservar los nodos en los que las tareas del Administrador de trabajos se ejecutan durante tanto tiempo como sea posible (es decir, los nodos de proceso que ejecutan tareas "normales" se quitan antes de que los nodos de proceso ejecuten tareas del Administrador de trabajos). Cuando se produce un error en una tarea del Administrador de trabajos y debe reiniciarse, el sistema intenta programarla con la prioridad más alta. Si no hay nodos de proceso inactivos disponibles, el sistema puede finalizar una de las tareas en ejecución en el grupo y devolverla a la cola para que la tarea del Administrador de trabajos se reinicie. Tenga en cuenta que una tarea del Administrador de trabajos en un trabajo no tiene prioridad sobre las tareas de otros trabajos. En los trabajos, solo se observan prioridades de nivel de trabajo. Por ejemplo, si es necesario reiniciar un administrador de trabajos en una prioridad 0, no desplazará las tareas de un trabajo de prioridad 1. Batch volverá a intentar tareas cuando se desencadene una operación de recuperación en un nodo. Algunos ejemplos de operaciones de recuperación son (pero no están limitados a) cuando se reinicia un nodo incorrecto o un nodo de proceso desaparece debido a un error de host. Los reintentos debido a las operaciones de recuperación son independientes de y no se cuentan con maxTaskRetryCount. Incluso si maxTaskRetryCount es 0, puede producirse un reintento interno debido a una operación de recuperación. Por este motivo, todas las tareas deben ser idempotentes. Esto significa que las tareas deben tolerar que se interrumpan y se reinicien sin causar daños ni datos duplicados. El procedimiento recomendado para tareas de larga duración es usar algún tipo de punto de control.

jobPreparationTask

JobPreparationTask

Tarea de preparación del trabajo.
La tarea de preparación del trabajo es una tarea especial que se ejecuta en cada nodo de proceso antes de cualquier otra tarea del trabajo.

jobReleaseTask

JobReleaseTask

Tarea Liberación del trabajo.
La tarea De liberación de trabajos es una tarea especial que se ejecuta al final del trabajo en cada nodo de proceso que haya ejecutado cualquier otra tarea del trabajo.

lastModified

string

Hora de la última modificación del trabajo.
Esta es la última vez en la que cambian los datos de nivel de trabajo, como el estado del trabajo o la prioridad. No tiene en cuenta los cambios en el nivel de tarea, como agregar nuevos estados tareas o tareas cambiantes.

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 los maxParallelTasks de un trabajo después de que se haya creado mediante la API de trabajo de actualización.

metadata

MetadataItem[]

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

networkConfiguration

JobNetworkConfiguration

Configuración de red para el trabajo.

onAllTasksComplete

OnAllTasksComplete

La acción que debe realizar el servicio Batch cuando todas las tareas del trabajo estén en estado completado.
El valor predeterminado es noaction.

onTaskFailure

OnTaskFailure

La acción que debe realizar el servicio Batch cuando se produce un error en cualquier tarea del trabajo.
Se considera que se ha producido un error en una tarea si tiene un errorInfo. Se establece un errorInfo 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

PoolInformation

Configuración del grupo asociada al trabajo.

previousState

JobState

Estado anterior del trabajo.
Esta propiedad no se establece si el trabajo está en su estado activo inicial.

previousStateTransitionTime

string

Hora en la que el trabajo entró en su estado anterior.
Esta propiedad no se establece si el trabajo está en su estado activo inicial.

priority

integer

Prioridad del trabajo.
Los valores de prioridad pueden oscilar entre -1000 y 1000, y -1000 ser la prioridad más baja y 1000 es la prioridad más alta. El valor predeterminado es 0.

state

JobState

Estado actual del trabajo.

stateTransitionTime

string

Hora en la que el trabajo entró en su estado actual.

stats

JobStatistics

Estadísticas de uso de recursos para toda la duración del trabajo.
Esta propiedad se rellena solo si cloudJob se recuperó con una cláusula expand, incluido el atributo 'stats'; de lo contrario, es null. 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 del trabajo.

usesTaskDependencies

boolean

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

ComputeNodeFillType

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

Nombre Tipo Description
pack

string

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

spread

string

Las tareas deben asignarse 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.

Nombre Tipo Description
resourceId

string

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

ContainerConfiguration

Configuración de grupos habilitados para contenedores.

Nombre Tipo 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 generará una imagen del registro de Docker predeterminado a menos que la imagen esté completa con un registro alternativo.

containerRegistries

ContainerRegistry[]

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

type

ContainerType

Tecnología de contenedor que se va a usar.

ContainerHostBatchBindMountEntry

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

Nombre Tipo Description
isReadOnly

boolean

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

source

ContainerHostDataPath

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

ContainerHostDataPath

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

Nombre Tipo Description
Applications

string

Ruta de acceso de las aplicaciones.

JobPrep

string

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

Shared

string

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

Startup

string

Ruta de acceso para la tarea de inicio.

Task

string

Ruta de acceso de la tarea.

VfsMounts

string

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

ContainerRegistry

Un registro de contenedor privado.

Nombre Tipo Description
identityReference

ComputeNodeIdentityReference

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

password

string

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

registryServer

string

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

username

string

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

ContainerType

Tecnología de contenedor que se va a usar.

Nombre Tipo Description
criCompatible

string

Se usará una tecnología basada en CRI para iniciar los contenedores.

dockerCompatible

string

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

ContainerWorkingDirectory

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

Nombre Tipo Description
containerImageDefault

string

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

taskWorkingDirectory

string

Use el directorio de trabajo de tarea del servicio Batch estándar, que contendrá los archivos de recursos de tarea rellenados por Batch.

DataDisk

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

Nombre Tipo Description
caching

CachingType

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é, consulte: 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

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 colocación de disco efímero para el disco del sistema operativo para todos los nodos de proceso (VM) del grupo.

Nombre Tipo Description
CacheDisk

string

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

DiffDiskSettings

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

Nombre Tipo Description
placement

DiffDiskPlacement

Especifica la colocación de 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 obtener 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 máquinas virtuales Windows en https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements y máquinas virtuales Linux en https://docs.microsoft.com/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. No se admite la configuración de cifrado de disco en el grupo de Linux creado con la imagen de Azure Compute Gallery.

Nombre Tipo Description
targets

DiskEncryptionTarget[]

La lista de destinos de disco de Batch Service cifrará en el nodo de proceso.
La lista de destinos de disco de Batch Service cifrará en el nodo de proceso.

DiskEncryptionTarget

La lista de destinos de disco de Batch Service cifrará en el nodo de proceso.

Nombre Tipo Description
osdisk

string

El disco del sistema operativo en el nodo de proceso está cifrado.

temporarydisk

string

El disco temporal del nodo de proceso está cifrado. En Linux, este cifrado se aplica a otras particiones (como las de discos de datos montados) cuando se produce el cifrado en tiempo de arranque.

DynamicVNetAssignmentScope

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

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

Nombre Tipo Description
admin

string

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

nonadmin

string

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

EnvironmentSetting

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

Nombre Tipo Description
name

string

Nombre de la variable de entorno.

value

string

Valor de la variable de entorno.

ErrorCategory

Categoría del error.

Nombre Tipo Description
servererror

string

El error se debe a un problema interno del servidor.

usererror

string

El error se debe a un problema de usuario, como una configuración incorrecta.

ErrorMessage

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

Nombre Tipo Description
lang

string

El código de idioma del mensaje de error

value

string

Texto del mensaje.

HttpHeader

Un par nombre-valor de encabezado HTTP

Nombre Tipo 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 Marketplace de Azure Virtual Machines o a una imagen de Azure Compute Gallery. Para obtener la lista de todas las referencias de imágenes de Azure Marketplace verificadas por Azure Batch, consulte la operación "Enumerar imágenes admitidas".

Nombre Tipo Description
communityGalleryImageId

string

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

exactVersion

string

La versión específica de la imagen de plataforma o la imagen de Marketplace usada 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

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.

sharedGalleryImageId

string

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

sku

string

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

version

string

Versión de la imagen de Marketplace de Azure Virtual Machines.
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 recursos de ARM de la imagen de Azure Compute 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. La imagen de Azure Compute Gallery debe tener réplicas en la misma región y debe estar en la misma suscripción que la cuenta de Azure Batch. Si no se especifica la versión de la imagen 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 nodo de proceso de Batch se comunique con el servicio Batch, consulte https://docs.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration.

InboundEndpointProtocol

Protocolo del punto de conexión.

Nombre Tipo Description
tcp

string

Use TCP para el punto de conexión.

udp

string

Use UDP para el punto de conexión.

InboundNATPool

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

Nombre Tipo Description
backendPort

integer

Número de puerto en el nodo de proceso.
Debe ser único dentro de un grupo de lotes. Los valores aceptables están comprendidos entre 1 y 65535, excepto para 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 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 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

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

NetworkSecurityGroupRule[]

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 a backendPort 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

InboundEndpointProtocol

Protocolo del punto de conexión.

IPAddressProvisioningType

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

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

Nombre Tipo Description
maxTaskRetryCount

integer

Número máximo de veces que se puede reintentar cada tarea. El servicio Batch vuelve a intentar una tarea si su código de salida es distinto de cero.
Tenga en cuenta que este valor controla específicamente el número de reintentos. El servicio Batch probará cada tarea una vez y, a continuación, volverá a intentarlo 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 3 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 vuelve a intentar tareas sin límite. El valor predeterminado es 0 (sin reintentos).

maxWallClockTime

string

Tiempo máximo transcurrido 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 lo finaliza y las tareas que todavía se están ejecutando. En este caso, el motivo de terminació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.

JobExecutionInformation

Contiene información sobre la ejecución de un trabajo en el servicio Azure Batch.

Nombre Tipo Description
endTime

string

Hora de finalización del trabajo.
Esta propiedad solo se establece si el trabajo está en estado completado.

poolId

string

Identificador del grupo al que se asigna este trabajo.
Este elemento contiene el grupo real donde se asigna el trabajo. Al obtener los detalles del trabajo del servicio, también contienen un elemento poolInfo, que contiene los datos de configuración del grupo desde el momento en que se agregó o actualizó el trabajo. Ese elemento poolInfo también puede contener un elemento poolId. Si es así, los dos identificadores son los mismos. Si no es así, significa que el trabajo se ejecutó en un grupo automático y esta propiedad contiene el identificador de ese grupo automático.

schedulingError

JobSchedulingError

Detalles de cualquier error detectado por el servicio al iniciar el trabajo.
Esta propiedad no se establece si no se produjo ningún error al iniciar el trabajo.

startTime

string

Hora de inicio del trabajo.
Este es el momento en el que se creó el trabajo.

terminateReason

string

Cadena que describe el motivo por el que finalizó el trabajo.
Esta propiedad solo se establece si el trabajo está en estado completado. Si el servicio Batch finaliza el trabajo, establece el motivo como se indica a continuación: JMComplete: la tarea administrador de trabajos completada y killJobOnCompletion se estableció en true. MaxWallClockTimeExpiry: el trabajo alcanzó su restricción maxWallClockTime. TerminateJobSchedule: el trabajo se ejecutó como parte de una programación y la programación finalizó. AllTasksComplete: el atributo onAllTasksComplete del trabajo se establece en terminatejob y se completan todas las tareas del trabajo. TaskFailed: el atributo onTaskFailure del trabajo está establecido en performExitOptionsJobAction y una tarea en el trabajo produjo un error con una condición de salida que especificó un jobAction de terminatejob. Cualquier otra cadena es un motivo definido por el usuario especificado en una llamada a la operación "Finalizar un trabajo".

JobManagerTask

Especifica los detalles de una tarea del Administrador de trabajos.

Nombre Tipo Description
allowLowPriorityNode

boolean

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

applicationPackageReferences

ApplicationPackageReference[]

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

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 mediante 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, con "cmd /c MyCommand" en Windows o "/bin/sh -c MyCommand" en Linux. Si la línea de comandos hace referencia a rutas de acceso de archivo, debe usar una ruta de acceso relativa (relativa al directorio de trabajo de la tarea) o usar la variable de entorno proporcionada por Batch (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables).

constraints

TaskConstraints

Restricciones que se aplican a la tarea Administrador de trabajos.

containerSettings

TaskContainerSettings

Configuración del contenedor en el que se ejecuta la tarea Administrador de trabajos.
Si el grupo que ejecutará esta tarea tiene el conjunto containerConfiguration, también debe establecerse. Si el grupo que ejecutará esta tarea no tiene establecido containerConfiguration, no se debe establecer. Cuando se especifica esto, todos los directorios se asignan de forma recursiva debajo del AZ_BATCH_NODE_ROOT_DIR (la raíz de los directorios de Azure Batch en el nodo) en el 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 caracteres Unicode de hasta una longitud máxima de 1024.

environmentSettings

EnvironmentSetting[]

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 indica 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 asume 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 administrador de trabajos solo para crear las tareas para el trabajo (no supervisar el progreso), es importante establecer killJobOnCompletion en false.

outputFiles

OutputFile[]

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

ResourceFile[]

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 de .zip, paquetes de aplicación o contenedores de Docker.

runExclusive

boolean

Si la tarea del Administrador de trabajos requiere un uso exclusivo del nodo de proceso 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 proceso. La tarea 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

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.

Nombre Tipo Description
skipWithdrawFromVNet

boolean

Si se retiran los nodos de proceso de la red virtual a DNC cuando se finaliza o se elimina el trabajo.
Si es true, los nodos permanecerán unidos a la red virtual a DNC. Si es false, los nodos se retirarán automáticamente cuando finalice el trabajo. El valor predeterminado es false.

subnetId

string

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.
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 dar cabida al 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 Control de acceso (RBAC) para la red virtual especificada para que el servicio Azure Batch pueda programar tareas en los nodos. Para comprobarlo, compruebe si la red virtual especificada tiene algún grupo de seguridad de red (NSG) asociado. Si una NSG deniega la comunicación con los nodos de la subred especificada, el servicio Batch establecerá el estado de los nodos de proceso en inutilizables. Este es 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. También es necesario abrir el puerto 443 para las conexiones salientes para las comunicaciones con Azure Storage. Para obtener más información, consulte: https://docs.microsoft.com/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.

Nombre Tipo 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, con "cmd /c MyCommand" en Windows o "/bin/sh -c MyCommand" en Linux. Si la línea de comandos hace referencia a rutas de acceso de archivo, debe usar una ruta de acceso relativa (relativa al directorio de trabajo de la tarea) o usar la variable de entorno proporcionada por Batch (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables).

constraints

TaskConstraints

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

containerSettings

TaskContainerSettings

Configuración del contenedor en el que se ejecuta la tarea de preparación del trabajo.
Cuando se especifica esto, todos los directorios se asignan de forma recursiva debajo del AZ_BATCH_NODE_ROOT_DIR (la raíz de los directorios de Azure Batch en el nodo) en el contenedor, todas las variables de entorno task se asignan al contenedor y la línea de comandos task se ejecuta en el contenedor. Es posible que los archivos generados en el contenedor fuera de AZ_BATCH_NODE_ROOT_DIR no se reflejen en el disco host, lo que significa que las API de archivos de Batch no podrán acceder a esos archivos.

environmentSettings

EnvironmentSetting[]

Lista de la 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 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

ResourceFile[]

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 de .zip, paquetes de aplicación o contenedores de Docker.

userIdentity

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 nodos de proceso de Windows o un usuario no administrativo único para el grupo en nodos de proceso 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 de trabajos 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 recuento 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 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.

Nombre Tipo 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, con "cmd /c MyCommand" en Windows o "/bin/sh -c MyCommand" en Linux. Si la línea de comandos hace referencia a rutas de acceso de archivo, debe usar una ruta de acceso relativa (relativa al directorio de trabajo de la tarea) o usar la variable de entorno proporcionada por Batch (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables).

containerSettings

TaskContainerSettings

La configuración del contenedor en el que se ejecuta la tarea De liberación de trabajos.
Cuando se especifica esto, todos los directorios se asignan de forma recursiva debajo del AZ_BATCH_NODE_ROOT_DIR (la raíz de los directorios de Azure Batch en el nodo) en el contenedor, todas las variables de entorno task se asignan al contenedor y la línea de comandos task se ejecuta en el contenedor. Es posible que los archivos generados en el contenedor fuera de AZ_BATCH_NODE_ROOT_DIR no se reflejen en el disco host, lo que significa que las API de archivos de Batch no podrán acceder a esos archivos.

environmentSettings

EnvironmentSetting[]

Lista de opciones de configuración de variables de entorno para 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 lo finaliza. El valor predeterminado es de 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

ResourceFile[]

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

retentionTime

string

El 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

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.

JobSchedulingError

Error detectado por el servicio Batch al programar un trabajo.

Nombre Tipo Description
category

ErrorCategory

Categoría del error de programación de trabajos.

code

string

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

details

NameValuePair[]

Lista de detalles de error adicionales relacionados con el error de programación.

message

string

Mensaje que describe el error de programación de trabajos, destinado a ser adecuado para mostrarse en una interfaz de usuario.

JobState

Estado del trabajo.

Nombre Tipo Description
active

string

El trabajo está disponible para tener tareas programadas.

completed

string

Todas las tareas han finalizado y el sistema no aceptará más tareas ni ningún cambio adicional en el trabajo.

deleting

string

Un usuario ha solicitado que se elimine el trabajo, pero la operación de eliminación todavía está en curso (por ejemplo, porque el sistema sigue terminando las tareas en ejecución).

disabled

string

Un usuario ha deshabilitado el trabajo. No se está ejecutando ninguna tarea y no se programará ninguna nueva tarea.

disabling

string

Un usuario ha solicitado que se deshabilite el trabajo, pero la operación de deshabilitación sigue en curso (por ejemplo, esperando a que finalicen las tareas).

enabling

string

Un usuario ha solicitado que el trabajo esté habilitado, pero la operación de habilitación todavía está en curso.

terminating

string

El trabajo está a punto de completarse, ya sea porque se ha completado una tarea del Administrador de trabajos o porque el usuario ha terminado el trabajo, pero la operación de finalización sigue en curso (por ejemplo, porque se están ejecutando tareas de liberación de trabajos).

JobStatistics

Estadísticas de uso de recursos para un trabajo.

Nombre Tipo 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 del trabajo.

lastUpdateTime

string

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

numFailedTasks

integer

Número total de tareas del trabajo que produjo un error durante el intervalo de tiempo especificado.
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

Número total de tareas completadas correctamente en el trabajo durante el intervalo de tiempo especificado.
Una tarea se completa correctamente si devuelve el código de salida 0.

numTaskRetries

integer

Número total de reintentos en todas las tareas del trabajo durante el intervalo de tiempo especificado.

readIOGiB

number

Cantidad total de datos en GiB leídos desde el disco por todas las tareas del trabajo.

readIOps

integer

Número total de operaciones de lectura de disco realizadas por todas las tareas del trabajo.

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) consumidos por todas las tareas del trabajo.

waitTime

string

Tiempo de espera total de todas las tareas del trabajo.
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 del trabajo.
La hora del reloj de pared es el tiempo transcurrido desde el momento en que la tarea comenzó a ejecutarse en un nodo de proceso a cuando finalizó (o hasta la última vez que se actualizaron las estadísticas, si la tarea no se había terminado entonces). Si se reintentó una tarea, esto incluye la hora del reloj de todos los reintentos de tarea.

writeIOGiB

number

Cantidad total de datos de GiB escritos en disco por todas las tareas del trabajo.

writeIOps

integer

Número total de operaciones de escritura de disco realizadas por todas las tareas del trabajo.

LinuxUserConfiguration

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

Nombre Tipo 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

Nombre Tipo Description
batch

string

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

interactive

string

El modo de inicio de sesión de Win32 LOGON32_LOGON_INTERACTIVE. UAC está habilitado en grupos de Windows. Si esta opción se usa con una identidad de usuario con privilegios elevados en un grupo de Windows, 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.

ManagedDisk

Nombre Tipo Description
securityProfile

VMDiskSecurityProfile

Especifica la configuración del perfil de seguridad para el disco administrado.
Especifica la configuración del perfil de seguridad para el disco administrado. Nota: solo se puede establecer para máquinas virtuales confidenciales y necesarias al usar máquinas virtuales confidenciales.

storageAccountType

StorageAccountType

Tipo de cuenta de almacenamiento para el disco administrado.

MetadataItem

Par nombre-valor asociado a un recurso de servicio de Batch.

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

Nombre Tipo Description
azureBlobFileSystemConfiguration

AzureBlobFileSystemConfiguration

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

azureFileShareConfiguration

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

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

NFSMountConfiguration

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

NameValuePair

Representa un par nombre-valor.

Nombre Tipo Description
name

string

Nombre del par nombre-valor.

value

string

Valor del par nombre-valor.

NetworkConfiguration

Configuración de red de un grupo.

Nombre Tipo Description
dynamicVNetAssignmentScope

DynamicVNetAssignmentScope

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

enableAcceleratedNetworking

boolean

Si este grupo debe habilitar las redes aceleradas.
Las redes aceleradas permiten la virtualización de E/S raíz única (SR-IOV) a una máquina virtual, lo que puede dar lugar a un rendimiento de red mejorado. Para obtener más información, consulte: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview.

endpointConfiguration

PoolEndpointConfiguration

Configuración de puntos de conexión en nodos de proceso en el grupo de Lotes.

publicIPAddressConfiguration

PublicIPAddressConfiguration

Configuración de IP PúblicaAddress para nodos de proceso en el grupo de lotes.
Configuración de dirección IP pública de la configuración de red de un grupo.

subnetId

string

Identificador de recurso de ARM de la subred de red virtual a la que se unirán los nodos de proceso del grupo. Este es 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 dar cabida al número de nodos de proceso del 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 Control de acceso (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. Para comprobarlo, compruebe si la red virtual especificada tiene algún grupo de seguridad de red (NSG) asociado. Si una NSG deniega la comunicación con los nodos de la subred especificada, el servicio Batch establecerá el estado de los nodos de proceso en inutilizables. Solo se admiten redes virtuales arm ("Microsoft.Network/virtualNetworks") . 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, incluidos los puertos 29876 y 29877. Habilite también las conexiones salientes a Azure Storage en el puerto 443. Para obtener más información, consulte: https://docs.microsoft.com/azure/batch/nodes-and-pools#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.

Nombre Tipo Description
access

NetworkSecurityGroupRuleAccess

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, mayor será la prioridad. 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 coincidirán 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 en el intervalo de 0 a 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.

Nombre Tipo Description
allow

string

Permitir el acceso.

deny

string

Denegar el acceso.

NFSMountConfiguration

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

Nombre Tipo Description
mountOptions

string

Opciones de línea de comandos adicionales para pasar al comando de montaje.
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.

NodeCommunicationMode

Determina cómo se comunica un grupo con el servicio Batch.

Nombre Tipo Description
classic

string

Los nodos que usan el modo de comunicación clásica requieren la comunicación TCP entrante en los puertos 29876 y 29877 de BatchNodeManagement. {region}" etiqueta de servicio y comunicación TCP saliente en el puerto 443 a "Storage.region" y "BatchNodeManagement". Etiquetas de servicio {region}".

default

string

El servicio Batch establece automáticamente el modo de comunicación de nodo.

simplified

string

Los nodos que usan el modo de comunicación simplificada requieren la comunicación TCP saliente en el puerto 443 a "BatchNodeManagement. Etiqueta de servicio {region}". No se requieren puertos de entrada abiertos.

NodePlacementConfiguration

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

Nombre Tipo Description
policy

NodePlacementPolicyType

Tipo de directiva de selección de ubicación de nodo en grupos de lotes.
Directiva de asignación que usa Batch Service 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.

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

Nombre Tipo Description
noaction

string

No haga nada. El trabajo permanece activo a menos que haya terminado o deshabilitado por algún otro medio.

terminatejob

string

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

OnTaskFailure

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

Nombre Tipo Description
noaction

string

No haga nada. El trabajo permanece activo a menos que haya terminado o deshabilitado 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 del disco del sistema operativo del nodo de proceso (VM).

Nombre Tipo Description
caching

CachingType

Especifica los requisitos de almacenamiento en caché. Los valores posibles son: None, ReadOnly, ReadWrite. Los valores predeterminados son: Ninguno para el almacenamiento estándar. ReadOnly para Premium Storage.
El valor predeterminado para el almacenamiento en caché no es ninguno. Para obtener información sobre las opciones de almacenamiento en caché, consulte: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.

diskSizeGB

integer

Tamaño de disco inicial en GB al crear un nuevo disco del sistema operativo.

ephemeralOSDiskSettings

DiffDiskSettings

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

managedDisk

ManagedDisk

Parámetros de disco administrado.

writeAcceleratorEnabled

boolean

Especifica si writeAccelerator debe estar habilitado o deshabilitado en el disco.

OutputFile

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

Nombre Tipo Description
destination

OutputFileDestination

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 único, [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, pero a, b o c). Si un nombre de archivo comienza con "." 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 la tarea 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

OutputFileUploadOptions

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.

Nombre Tipo Description
containerUrl

string

Dirección URL del contenedor dentro de Azure Blob Storage en la que se cargan 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

ComputeNodeIdentityReference

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

HttpHeader[]

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. Documento oficial sobre encabezados permitidos al cargar blobs: https://docs.microsoft.com/rest/api/storageservices/put-blob#request-headers-all-blob-types

OutputFileDestination

Destino al que se debe cargar un archivo.

Nombre Tipo Description
container

OutputFileBlobContainerDestination

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.

Nombre Tipo Description
taskcompletion

string

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

taskfailure

string

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

tasksuccess

string

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

Nombre Tipo Description
uploadCondition

OutputFileUploadCondition

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.

Nombre Tipo Description
inboundNATPools

InboundNATPool[]

Lista de grupos NAT entrantes 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 entrantes, 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.

Nombre Tipo Description
autoPoolSpecification

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

Nombre Tipo 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 trabajo, no a trabajos.

PoolSpecification

Especificación para crear un nuevo grupo.

Nombre Tipo Description
applicationPackageReferences

ApplicationPackageReference[]

Lista de paquetes que se van a instalar en cada nodo de proceso del grupo.
Al crear un grupo, el identificador de aplicación del paquete debe estar completo (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). 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 imágenes. Hay un máximo de 10 referencias de paquete en cualquier grupo determinado.

autoScaleEvaluationInterval

string

Intervalo de tiempo en el que se ajusta automáticamente el tamaño del grupo según la fórmula de escalado automático.
El valor predeterminado es de 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 llama 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 se debe especificar 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 de error detallada.

certificateReferences

CertificateReference[]

Lista de certificados que se van a instalar en cada nodo de proceso del grupo.
En el caso de los nodos de Windows, el servicio Batch instala los certificados en el almacén de certificados y la ubicación especificados. En el caso de los nodos de proceso de Linux, los certificados se almacenan en un directorio dentro del directorio de trabajo de la tarea y se proporciona una variable de entorno AZ_BATCH_CERTIFICATES_DIR a la tarea para consultar esta ubicación. En el caso de los certificados con visibilidad de "remoteUser", se crea un directorio "certs" en el directorio principal del usuario (por ejemplo, /home/{user-name}/certs) y los certificados se colocan en ese directorio.

Advertencia: esta propiedad está en desuso y se quitará después de febrero de 2024. Use el de extensión de Azure KeyVault de .

displayName

string

Nombre para mostrar del grupo.
El nombre para mostrar no debe ser único y puede contener caracteres Unicode de 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 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

MetadataItem[]

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

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

NetworkConfiguration

Configuración de red para el 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 de 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 llama directamente a la API REST, el código de estado HTTP es 400 (solicitud incorrecta).

resourceTags

object

Etiquetas especificadas por el usuario asociadas al grupo.
Etiquetas definidas por el usuario que se van a asociar al grupo de Azure Batch. Cuando se especifica, estas etiquetas se propagan a los recursos de Azure de respaldo asociados al grupo. Esta propiedad solo se puede especificar cuando se creó la cuenta de Batch con la propiedad poolAllocationMode establecida en "UserSubscription".

startTask

StartTask

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

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 se establece 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 se establece en false, debe establecer targetDedicatedNodes, targetLowPriorityNodes o ambos.

targetNodeCommunicationMode

NodeCommunicationMode

Modo de comunicación de nodo deseado para el grupo.
Si se omite, el valor predeterminado es Default.

taskSchedulingPolicy

TaskSchedulingPolicy

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

taskSlotsPerNode

integer

Número de ranuras de tareas que se pueden usar para ejecutar tareas simultáneas en un único nodo de proceso del grupo.
El valor predeterminado es 1. El valor máximo es el menor de 4 veces el número de núcleos de vmSize del grupo o 256.

upgradePolicy

UpgradePolicy

Directiva de actualización del grupo.
Describe una directiva de actualización: automática, manual o gradual.

userAccounts

UserAccount[]

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

virtualMachineConfiguration

VirtualMachineConfiguration

Configuración de la máquina virtual para el grupo.
Esta propiedad debe especificarse.

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 dirección IP pública de la configuración de red de un grupo.

Nombre Tipo 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 de acceso puntual se pueden 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

IPAddressProvisioningType

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

ResourceFile

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

Nombre Tipo Description
autoStorageContainerName

string

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 comienzan por el prefijo especificado.
La propiedad solo es válida cuando se usa autoStorageContainerName o storageContainerUrl. Este prefijo puede ser un nombre de archivo parcial o un subdirectorio. Si no se especifica un prefijo, se descargarán todos los archivos del contenedor.

fileMode

string

Atributo del modo de permiso de archivo en formato octal.
Esta propiedad solo se aplica a los archivos que se descargan en nodos de proceso de Linux. Se omitirá si se especifica para un resourceFile que se descargará en un nodo de proceso de Windows. Si no se especifica esta propiedad para un nodo de proceso 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 a la que se descargará el archivo, incluido el nombre de archivo. De lo contrario, si se especifica la propiedad autoStorageContainerName o storageContainerUrl, filePath es opcional y es el directorio al que descargar los archivos. En el caso de que filePath se use como directorio, cualquier estructura de directorios que ya esté asociada a los datos de entrada se conservará en su totalidad y se anexará al directorio filePath especificado. La ruta de acceso relativa especificada no puede dividirse en el directorio de trabajo de la tarea (por ejemplo, mediante '..').

httpUrl

string

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

identityReference

ComputeNodeIdentityReference

Referencia a la identidad asignada por el usuario que se va a usar para acceder a Azure Blob Storage especificado por storageContainerUrl o httpUrl
Referencia a una identidad asignada por el usuario asociada al grupo de Batch que usará un nodo de proceso.

storageContainerUrl

string

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

RollingUpgradePolicy

Los parámetros de configuración usados al realizar una actualización gradual.

Nombre Tipo Description
enableCrossZoneUpgrade

boolean

Permitir que VMSS omita los límites de AZ al construir lotes de actualización. Tenga en cuenta el dominio de actualización y maxBatchInstancePercent para determinar el tamaño del lote. Este campo solo se puede establecer en true o false cuando se usa NodePlacementConfiguration como zonal.

maxBatchInstancePercent

integer

Porcentaje máximo de instancias de máquina virtual totales que se actualizarán simultáneamente mediante la actualización gradual en un lote. Dado que se trata de un número máximo de instancias incorrectas en lotes anteriores o futuros, puede provocar que el porcentaje de instancias de un lote disminuya para garantizar una mayor confiabilidad. El valor de este campo debe estar comprendido entre 5 y 100, ambos incluidos. Si se asignan maxBatchInstancePercent y maxUnhealthyInstancePercent con el valor , el valor de maxBatchInstancePercent no debe ser mayor que maxUnhealthyInstancePercent.

maxUnhealthyInstancePercent

integer

El porcentaje máximo de las instancias de máquina virtual totales del conjunto de escalado que pueden estar en mal estado simultáneamente, ya sea como resultado de la actualización o si se encuentra en un estado incorrecto por parte de las comprobaciones de estado de la máquina virtual antes de que se anule la actualización gradual. Esta restricción se comprobará antes de iniciar cualquier lote. El valor de este campo debe estar comprendido entre 5 y 100, ambos incluidos. Si se asignan maxBatchInstancePercent y maxUnhealthyInstancePercent con el valor , el valor de maxBatchInstancePercent no debe ser mayor que maxUnhealthyInstancePercent.

maxUnhealthyUpgradedInstancePercent

integer

Porcentaje máximo de instancias de máquina virtual actualizadas que se pueden encontrar en un estado incorrecto. Esta comprobación se realizará después de actualizar cada lote. Si se supera este porcentaje alguna vez, se anula la actualización gradual. El valor de este campo debe estar comprendido entre 0 y 100, ambos incluidos.

pauseTimeBetweenBatches

string

Tiempo de espera entre completar la actualización de todas las máquinas virtuales de un lote e iniciar el siguiente lote. La duración del tiempo debe especificarse en formato ISO 8601.

prioritizeUnhealthyInstances

boolean

Actualice todas las instancias incorrectas de un conjunto de escalado antes de cualquier instancia correcta.

rollbackFailedInstancesOnPolicyBreach

boolean

Las instancias con error de reversión en el modelo anterior si se infringe la directiva de actualización gradual.

SecurityEncryptionTypes

Especifica encryptionType del disco administrado. Se establece en VMGuestStateOnly para el cifrado de solo el blob VMGuestState y NonPersistedTPM para no conservar el estado de firmware en el blob VMGuestState. Nota: solo se puede establecer para máquinas virtuales confidenciales y se requiere cuando se usan máquinas virtuales confidenciales.

Nombre Tipo Description
NonPersistedTPM

string

VMGuestStateOnly

string

SecurityProfile

Especifica la configuración del perfil de seguridad para la máquina virtual o el conjunto de escalado de máquinas virtuales.

Nombre Tipo Description
encryptionAtHost

boolean

El usuario puede usar esta propiedad en la solicitud para habilitar o deshabilitar el cifrado de host para la máquina virtual o el conjunto de escalado de máquinas virtuales. Esto habilitará el cifrado para todos los discos, incluido el recurso o el disco temporal en el propio host. Para obtener más información sobre el cifrado en los requisitos de host, consulte https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizes.

securityType

SecurityTypes

Especifica securityType de la máquina virtual. Debe establecerse en cualquier valor especificado para habilitar UefiSettings.

uefiSettings

UefiSettings

Especifica la configuración de seguridad, como el arranque seguro y vTPM que se usa al crear la máquina virtual.
Especifica la configuración de seguridad, como el arranque seguro y vTPM que se usa al crear la máquina virtual.

SecurityTypes

Especifica securityType de la máquina virtual. Debe establecerse en cualquier valor especificado para habilitar UefiSettings.

Nombre Tipo Description
confidentialVM

string

La informática confidencial de Azure ofrece máquinas virtuales confidenciales para los inquilinos con requisitos de alta seguridad y confidencialidad. Estas máquinas virtuales proporcionan un límite seguro y aplicado por hardware para ayudar a satisfacer sus necesidades de seguridad. Puede usar máquinas virtuales confidenciales para migraciones sin realizar cambios en el código, con la plataforma que protege el estado de la máquina virtual para que se lea o modifique.

trustedLaunch

string

El inicio de confianza protege contra técnicas de ataque avanzadas y persistentes.

ServiceArtifactReference

Especifica el identificador de referencia del artefacto de servicio que se usa para establecer la misma versión de imagen para todas las máquinas virtuales del conjunto de escalado cuando se usa la versión de imagen "más reciente".

Nombre Tipo Description
id

string

Identificador de referencia del artefacto de servicio de ServiceArtifactReference
Identificador de referencia del artefacto de servicio en forma de /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

StartTask

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

Nombre Tipo Description
commandLine

string

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

containerSettings

TaskContainerSettings

Configuración del contenedor en el que se ejecuta StartTask.
Cuando se especifica esto, todos los directorios se asignan de forma recursiva debajo del AZ_BATCH_NODE_ROOT_DIR (la raíz de los directorios de Azure Batch en el nodo) en el contenedor, todas las variables de entorno task se asignan al contenedor y la línea de comandos task se ejecuta en el contenedor. Es posible que los archivos generados en el contenedor fuera de AZ_BATCH_NODE_ROOT_DIR no se reflejen en el disco host, lo que significa que las API de archivos de Batch no podrán acceder a esos archivos.

environmentSettings

EnvironmentSetting[]

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

maxTaskRetryCount

integer

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

resourceFiles

ResourceFile[]

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

userIdentity

UserIdentity

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

StorageAccountType

Tipo de cuenta de almacenamiento que se usa para crear discos de datos o disco del sistema operativo.

Nombre Tipo Description
premium_lrs

string

El disco de datos o el disco del sistema operativo debe usar el almacenamiento con redundancia local Premium.

standard_lrs

string

El disco de datos o el disco del sistema operativo debe usar el almacenamiento estándar con redundancia local.

standardssd_lrs

string

El disco de datos o el disco del sistema operativo debe usar el almacenamiento estándar con redundancia local de SSD.

TaskConstraints

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

Nombre Tipo Description
maxTaskRetryCount

integer

Número máximo de veces que se puede reintentar la tarea. El servicio Batch vuelve a intentar una tarea si su código de salida es distinto de cero.
Tenga en cuenta que este valor controla específicamente el número de reintentos 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, podrá volver a intentarlo hasta este límite. Por ejemplo, si el número máximo de reintentos es 3, Batch intenta la tarea hasta 4 veces (un intento inicial y 3 reintentos). Si el número máximo de reintentos es 0, el servicio Batch no vuelve a intentar la tarea 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 lo 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ó, desde el momento en que completa 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.

Nombre Tipo Description
containerHostBatchBindMounts

ContainerHostBatchBindMountEntry[]

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

containerRunOptions

string

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

imageName

string

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

registry

ContainerRegistry

Registro privado que contiene la imagen de contenedor.
Esta configuración se puede omitir si ya se proporcionó en la creación del grupo.

workingDirectory

ContainerWorkingDirectory

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

TaskSchedulingPolicy

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

Nombre Tipo Description
nodeFillType

ComputeNodeFillType

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

UefiSettings

Especifica la configuración de seguridad, como el arranque seguro y vTPM que se usa al crear la máquina virtual.

Nombre Tipo Description
secureBootEnabled

boolean

Especifica si se debe habilitar el arranque seguro en la máquina virtual.

vTpmEnabled

boolean

Especifica si vTPM debe estar habilitado en la máquina virtual.

UpgradeMode

Especifica el modo de una actualización a las máquinas virtuales del conjunto de escalado.

Los valores posibles son:

manual: controla la aplicación de actualizaciones en las máquinas virtuales del conjunto de escalado. Para ello, use la acción manualUpgrade.

Automático: todas las máquinas virtuales del conjunto de escalado se actualizan automáticamente al mismo tiempo.

rolling: el conjunto de escalado realiza actualizaciones en lotes con un tiempo de pausa opcional entre sí.

Nombre Tipo Description
automatic

string

Todas las máquinas virtuales del conjunto de escalado se actualizan automáticamente al mismo tiempo.

manual

string

Puede controlar la aplicación de actualizaciones en máquinas virtuales del conjunto de escalado. Para ello, use la acción manualUpgrade.

rolling

string

Las instancias existentes de un conjunto de escalado se reducen en lotes que se van a actualizar. Una vez completado el lote actualizado, las instancias comenzarán a tomar el tráfico de nuevo y se iniciará el siguiente lote. Esto continúa hasta que todas las instancias han traído up-to-date.

UpgradePolicy

Describe una directiva de actualización: automática, manual o gradual.

Nombre Tipo Description
automaticOSUpgradePolicy

AutomaticOSUpgradePolicy

Parámetros de configuración usados para realizar la actualización automática del sistema operativo.
Los parámetros de configuración que se usan para realizar la actualización automática del sistema operativo.

mode

UpgradeMode

Especifica el modo de una actualización a las máquinas virtuales del conjunto de escalado.

Los valores posibles son:

manual: controla la aplicación de actualizaciones en las máquinas virtuales del conjunto de escalado. Para ello, use la acción manualUpgrade.

Automático: todas las máquinas virtuales del conjunto de escalado se actualizan automáticamente al mismo tiempo.

rolling: el conjunto de escalado realiza actualizaciones en lotes con un tiempo de pausa opcional entre sí.

rollingUpgradePolicy

RollingUpgradePolicy

Los parámetros de configuración usados al realizar una actualización gradual.
Los parámetros de configuración usados al realizar una actualización gradual.

UserAccount

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

Nombre Tipo Description
elevationLevel

ElevationLevel

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

linuxUserConfiguration

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. Los nombres pueden contener caracteres Unicode de hasta una longitud máxima de 20.

password

string

Contraseña de la cuenta de usuario.

windowsUserConfiguration

WindowsUserConfiguration

Configuración de usuario específica de 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 de usuario en la que se ejecuta la tarea.

Nombre Tipo Description
autoUser

AutoUserSpecification

Usuario automático en el que se ejecuta la tarea.
Las propiedades userName y autoUser son mutuamente excluyentes; debe especificar uno pero no ambos.

username

string

Nombre de la identidad de usuario en la que se ejecuta la tarea.
Las propiedades userName y autoUser son mutuamente excluyentes; debe especificar uno pero no ambos.

VirtualMachineConfiguration

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

Nombre Tipo Description
containerConfiguration

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

DataDisk[]

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, también se eliminan el disco y todos los datos asociados a él. El disco no tiene formato después de estar conectado, debe tener formato antes de usarlo; para obtener más información, vea https://docs.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux y https://docs.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine.

diskEncryptionConfiguration

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

VMExtension[]

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

ImageReference

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

licenseType

string

Tipo de licencia local que se va a 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 cuando contenga 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 el cliente de Windows.

nodeAgentSKUId

string

SKU del agente de nodo de proceso por lotes 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 Nodo de proceso, conocidas como SKU, para diferentes 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 nodo de proceso compatibles junto con su lista de referencias de imágenes comprobadas, consulte la operación "Enumerar SKU de agente de nodo de proceso compatibles".

nodePlacementConfiguration

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

OSDisk

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

securityProfile

SecurityProfile

Especifica la configuración del perfil de seguridad para la máquina virtual o el conjunto de escalado de máquinas virtuales.
Especifica la configuración del perfil de seguridad para la máquina virtual o el conjunto de escalado de máquinas virtuales.

serviceArtifactReference

ServiceArtifactReference

Especifica el identificador de referencia del artefacto de servicio que se usa para establecer la misma versión de imagen para todas las máquinas virtuales del conjunto de escalado cuando se usa la versión de imagen "más reciente".
Identificador de referencia del artefacto de servicio en forma de /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

windowsConfiguration

WindowsConfiguration

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

VMDiskSecurityProfile

Especifica la configuración del perfil de seguridad para el disco administrado. Nota: solo se puede establecer para máquinas virtuales confidenciales y necesarias al usar máquinas virtuales confidenciales.

Nombre Tipo Description
securityEncryptionType

SecurityEncryptionTypes

Especifica encryptionType del disco administrado. Se establece en VMGuestStateOnly para el cifrado de solo el blob VMGuestState y NonPersistedTPM para no conservar el estado de firmware en el blob VMGuestState. Nota: solo se puede establecer para máquinas virtuales confidenciales y se requiere cuando se usan máquinas virtuales confidenciales.

VMExtension

Configuración de extensiones de máquina virtual.

Nombre Tipo Description
autoUpgradeMinorVersion

boolean

Indica si la extensión debe usar una versión secundaria más reciente si está 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.

enableAutomaticUpgrade

boolean

Indica si la plataforma debe actualizar automáticamente la extensión si hay una versión más reciente de la extensión disponible.

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

Tipo de la extensión.

typeHandlerVersion

string

Versión del controlador de script.

WindowsConfiguration

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

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

Nombre Tipo Description
loginMode

LoginMode

Modo de inicio de sesión del usuario
El valor predeterminado es "batch".