Job - Patch
Novedades las propiedades del trabajo especificado.
Esto reemplaza solo las propiedades de trabajo especificadas en la solicitud. Por ejemplo, si el trabajo tiene restricciones y una solicitud no especifica el elemento constraints, el trabajo mantiene las restricciones existentes.
PATCH {batchUrl}/jobs/{jobId}?api-version=2023-11-01.18.0
PATCH {batchUrl}/jobs/{jobId}?timeout={timeout}&api-version=2023-11-01.18.0
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
batch
|
path | True |
string |
Dirección URL base de todas las solicitudes de servicio de Azure Batch. |
job
|
path | True |
string |
Identificador del trabajo cuyas propiedades desea actualizar. |
api-version
|
query | True |
string |
Versión de la API de cliente. |
timeout
|
query |
integer int32 |
Tiempo máximo que el servidor puede dedicar a procesar la solicitud, en segundos. El valor predeterminado es 30 segundos. |
Encabezado de la solicitud
Media Types: "application/json; odata=minimalmetadata"
Nombre | Requerido | Tipo | Description |
---|---|---|---|
client-request-id |
string uuid |
La identidad de solicitud generada por el autor de la llamada, en forma de GUID sin decoración como llaves, por ejemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Si el servidor debe devolver el client-request-id en la respuesta. |
|
ocp-date |
string date-time-rfc1123 |
Hora a la que se emitió la solicitud. Normalmente, las bibliotecas cliente establecen esto en la hora actual del reloj del sistema; establézcalo explícitamente si llama directamente a la API REST. |
|
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 se realizará solo 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 la ú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 la última modificación del recurso conocido para el cliente. La operación se realizará solo si el recurso del servicio no se ha modificado desde el momento especificado. |
Cuerpo de la solicitud
Media Types: "application/json; odata=minimalmetadata"
Nombre | Tipo | Description |
---|---|---|
allowTaskPreemption |
boolean |
Si las tareas de este trabajo pueden ser adelantadas por otros trabajos de prioridad alta |
constraints |
Restricciones de ejecución para el trabajo. |
|
maxParallelTasks |
integer |
Número máximo de tareas que se pueden ejecutar en paralelo para el trabajo. |
metadata |
Lista de pares nombre-valor asociados al trabajo como metadatos. |
|
onAllTasksComplete |
La acción que debe realizar el servicio Batch cuando todas las tareas del trabajo están en estado completado. |
|
poolInfo |
Grupo en el que el servicio Batch ejecuta las tareas del trabajo. |
|
priority |
integer |
Prioridad del trabajo. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
La solicitud al servicio Batch se realizó correctamente. Headers
|
|
Other Status Codes |
Error del servicio Batch. |
Seguridad
azure_auth
flujo de código de autenticación de OAuth 2.0 Microsoft Entra
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nombre | Description |
---|---|
user_impersonation | Suplantación de su cuenta de usuario |
Authorization
Type:
apiKey
In:
header
Ejemplos
Job patch
Sample Request
PATCH account.region.batch.azure.com/jobs/jobId?api-version=2023-11-01.18.0
{
"priority": 100,
"constraints": {
"maxWallClockTime": "PT1H",
"maxTaskRetryCount": -1
},
"poolInfo": {
"poolId": "poolId"
}
}
Sample Response
Definiciones
Nombre | Description |
---|---|
Application |
Referencia a un paquete que se va a implementar en nodos de proceso. |
Auto |
Especifica las características de un "grupo automático" temporal. El servicio Batch creará este grupo automático cuando se envíe el trabajo. |
Auto |
Ámbito del usuario automático |
Auto |
Especifica los parámetros para el usuario automático que ejecuta una tarea en el servicio Batch. |
Azure |
Información usada para conectarse a un contenedor de Azure Storage mediante Blobfuse. |
Azure |
Información usada para conectarse a un recurso compartido de archivos de Azure. |
Batch |
Respuesta de error recibida del servicio Azure Batch. |
Batch |
Elemento de información adicional incluida en una respuesta de error Azure Batch. |
Caching |
Tipo de almacenamiento en caché que se va a habilitar para el disco. |
Certificate |
Referencia a un certificado que se va a instalar en nodos de proceso de un grupo. |
Certificate |
Ubicación del almacén de certificados en el nodo de proceso en el que se va a instalar el certificado. |
Certificate |
Qué cuentas de usuario del nodo de proceso deben tener acceso a los datos privados del certificado. |
CIFSMount |
Información usada para conectarse a un sistema de archivos CIFS. |
Cloud |
Configuración de nodos de proceso en un grupo basado en la plataforma de Azure Cloud Services. |
Compute |
Cómo se distribuyen las tareas entre nodos de proceso en un grupo. |
Compute |
Referencia a una identidad asignada por el usuario asociada al grupo de Batch que usará un nodo de proceso. |
Container |
Configuración de grupos habilitados para contenedores. |
Container |
Un registro de contenedor privado. |
Container |
Tecnología de contenedor que se va a usar. |
Container |
Ubicación del directorio de trabajo de la tarea de contenedor. |
Data |
Configuración que usarán los discos de datos asociados a los nodos de proceso del grupo. Cuando use discos de datos conectados, debe montar y dar formato a los discos desde una máquina virtual para usarlos. |
Diff |
Especifica la ubicación del disco efímero para el disco del sistema operativo para todos los nodos de proceso (VM) del grupo. |
Diff |
Especifica la configuración de disco efímero para el disco del sistema operativo usado por el nodo de proceso (VM). |
Disk |
La configuración de cifrado de disco aplicada en los nodos de proceso del grupo. La configuración de cifrado de disco no se admite en el grupo de Linux creado con la imagen de Azure Compute Gallery. |
Disk |
La lista de destinos de disco que el servicio Batch cifrará en el nodo de proceso. |
Dynamic |
Ámbito de asignación de red virtual dinámica. |
Elevation |
Nivel de elevación del usuario. |
Environment |
Variable de entorno que se va a establecer en un proceso de tarea. |
Error |
Mensaje de error recibido en una respuesta de error Azure Batch. |
Image |
Referencia a una imagen de Azure Virtual Machines Marketplace o a una imagen de Azure Compute Gallery. Para obtener la lista de todas las referencias de imagen de Azure Marketplace verificadas por Azure Batch, consulte la operación "Enumerar imágenes admitidas". |
Inbound |
Protocolo del punto de conexión. |
Inbound |
Un grupo NAT de entrada que se puede usar para abordar puertos específicos en nodos de proceso en un grupo de lotes externamente. |
IPAddress |
Tipo de aprovisionamiento para direcciones IP públicas para el grupo. |
Job |
Restricciones de ejecución para un trabajo. |
Job |
Conjunto de cambios que se van a realizar en un trabajo. |
Linux |
Propiedades usadas para crear una cuenta de usuario en un nodo de proceso de Linux. |
Login |
Modo de inicio de sesión del usuario |
Managed |
|
Metadata |
Un par nombre-valor asociado a un recurso de servicio de Batch. |
Mount |
Sistema de archivos que se va a montar en cada nodo. |
Network |
Configuración de red de un grupo. |
Network |
Una regla de grupo de seguridad de red que se va a aplicar a un punto de conexión de entrada. |
Network |
Acción que se debe realizar para una dirección IP, un intervalo de subred o una etiqueta especificados. |
NFSMount |
Información usada para conectarse a un sistema de archivos NFS. |
Node |
Determina cómo se comunica un grupo con el servicio Batch. |
Node |
Configuración de ubicación de nodo para un grupo. |
Node |
Directiva de selección de ubicación para asignar nodos en el grupo. |
On |
La acción que debe realizar el servicio Batch cuando todas las tareas del trabajo están en estado completado. |
OSDisk |
Configuración del disco del sistema operativo del nodo de proceso (VM). |
Pool |
Configuración del punto de conexión de un grupo. |
Pool |
Especifica cómo se debe asignar un trabajo a un grupo. |
Pool |
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. |
Pool |
Especificación para crear un nuevo grupo. |
Public |
Configuración de dirección IP pública de la configuración de red de un grupo. |
Resource |
Un único archivo o varios archivos que se van a descargar en un nodo de proceso. |
Security |
Especifica la configuración del perfil de seguridad para la máquina virtual o el conjunto de escalado de máquinas virtuales. |
Security |
Especifica el SecurityType de la máquina virtual. Debe establecerse en cualquier valor especificado para habilitar UefiSettings. |
Service |
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". |
Start |
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. |
Storage |
Tipo de cuenta de almacenamiento para su uso en la creación de discos de datos o disco del sistema operativo. |
Task |
Configuración del contenedor de una tarea. |
Task |
Especifica cómo se deben distribuir las tareas entre nodos de proceso. |
Uefi |
Especifica la configuración de seguridad, como el arranque seguro y vTPM que se usa al crear la máquina virtual. |
User |
Propiedades usadas para crear un usuario que se usa para ejecutar tareas en un nodo de Azure Batch proceso. |
User |
Definición de la identidad de usuario en la que se ejecuta la tarea. |
Virtual |
Configuración de nodos de proceso en un grupo basado en la infraestructura de Azure Virtual Machines. |
VMExtension |
Configuración de extensiones de máquina virtual. |
Windows |
Configuración del sistema operativo Windows que se va a aplicar a la máquina virtual. |
Windows |
Propiedades usadas para crear una cuenta de usuario en un nodo de proceso de Windows. |
ApplicationPackageReference
Referencia a un paquete que se va a implementar en nodos de proceso.
Nombre | Tipo | Description |
---|---|---|
applicationId |
string |
Identificador de la aplicación que se va a implementar. |
version |
string |
Versión de la aplicación que se va a implementar. Si se omite, se implementa la versión predeterminada. |
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. |
keepAlive |
boolean |
Indica si se debe mantener activo un grupo automático después de que expire su duración. |
pool |
Especificación pool para el grupo automático. |
|
poolLifetimeOption |
La duración mínima de los grupos automáticos creados y cómo se asignan varios trabajos según una programación a 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 para el usuario automático que ejecuta una tarea en el servicio Batch.
Nombre | Tipo | Description |
---|---|---|
elevationLevel |
Nivel de elevación del usuario automático. |
|
scope |
Ámbito del usuario automático |
AzureBlobFileSystemConfiguration
Información usada para conectarse a un contenedor de Azure Storage mediante Blobfuse.
Nombre | Tipo | Description |
---|---|---|
accountKey |
string |
Clave de la cuenta de Azure Storage. |
accountName |
string |
El nombre de la cuenta de Azure Storage. |
blobfuseOptions |
string |
Opciones de línea de comandos adicionales para pasar al comando mount. |
containerName |
string |
Nombre del contenedor de Azure Blob Storage. |
identityReference |
Referencia a la identidad asignada por el usuario que se va a usar para acceder a containerName |
|
relativeMountPath |
string |
Ruta de acceso relativa en el nodo de proceso donde se montará el sistema de archivos. |
sasKey |
string |
Token de SAS de Azure Storage. |
AzureFileShareConfiguration
Información usada para conectarse a un recurso compartido de archivos de Azure.
Nombre | Tipo | Description |
---|---|---|
accountKey |
string |
clave de la cuenta de Azure Storage. |
accountName |
string |
Nombre de la cuenta de Azure Storage. |
azureFileUrl |
string |
Dirección URL de Azure Files. |
mountOptions |
string |
Opciones de línea de comandos adicionales para pasar al comando mount. |
relativeMountPath |
string |
Ruta de acceso relativa en el nodo de proceso donde se montará el sistema de archivos. |
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 |
Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario. |
|
values |
Colección de pares clave-valor que contiene detalles adicionales sobre el error. |
BatchErrorDetail
Elemento de información adicional incluida en una respuesta de error Azure Batch.
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 |
Ubicación del almacén de certificados en el nodo de proceso en el que se va a instalar el certificado. |
|
storeName |
string |
Nombre del almacén de certificados en el nodo de proceso en el que se va a instalar el certificado. |
thumbprint |
string |
Huella digital del certificado. |
thumbprintAlgorithm |
string |
Algoritmo con el que está asociada la huella digital. Debe ser sha1. |
visibility |
Qué cuentas de usuario del nodo de proceso deben tener acceso a los datos privados del certificado. |
CertificateStoreLocation
Ubicación del almacén de certificados en el nodo de proceso en el que se va a instalar el certificado.
Nombre | Tipo | Description |
---|---|---|
currentuser |
string |
Los certificados deben instalarse en el almacén de certificados CurrentUser. |
localmachine |
string |
Los certificados deben instalarse en el almacén de certificados localMachine. |
CertificateVisibility
Qué cuentas de usuario del nodo de proceso deben tener acceso a los datos privados del certificado.
Nombre | Tipo | Description |
---|---|---|
remoteuser |
string |
El certificado debe ser visible para las cuentas de usuario en las que los usuarios acceden de forma remota al nodo de proceso. |
starttask |
string |
El certificado debe ser visible para la cuenta de usuario en la que se ejecuta StartTask. Tenga en cuenta que si El ámbito de autousuario es Grupo para startTask y una tarea, este certificado también será visible para la tarea. |
task |
string |
El certificado debe ser visible para las cuentas de usuario en las que se ejecutan las tareas de trabajo. |
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 mount. |
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. |
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. |
CloudServiceConfiguration
Configuración de nodos de proceso en un grupo basado en la plataforma de Azure Cloud Services.
Nombre | Tipo | Description |
---|---|---|
osFamily |
string |
La familia de so invitado de Azure que se va a instalar en las máquinas virtuales del grupo. |
osVersion |
string |
La versión del sistema operativo invitado de Azure que se va a instalar en las máquinas virtuales del grupo. |
ComputeNodeFillType
Cómo se distribuyen las tareas entre nodos de proceso en 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 que se asignen 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. |
containerRegistries |
Registros privados adicionales de los que se pueden extraer contenedores. |
|
type |
Tecnología de contenedor que se va a usar. |
ContainerRegistry
Un registro de contenedor privado.
Nombre | Tipo | Description |
---|---|---|
identityReference |
Referencia a la identidad asignada por el usuario que se va a usar para acceder a un Azure Container Registry en lugar de nombre de usuario y contraseña. |
|
password |
string |
Contraseña que se va a iniciar sesión en el servidor del Registro. |
registryServer |
string |
Dirección URL del registro. |
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 tareas rellenados por Batch. |
DataDisk
Configuración que usarán los discos de datos asociados a los nodos de proceso del grupo. Cuando use discos de datos conectados, debe montar y dar formato a los discos desde una máquina virtual para usarlos.
Nombre | Tipo | Description |
---|---|---|
caching |
Tipo de almacenamiento en caché que se va a habilitar para los discos de datos. |
|
diskSizeGB |
integer |
Tamaño inicial del disco en gigabytes. |
lun |
integer |
Número de unidad lógica. |
storageAccountType |
Tipo de cuenta de almacenamiento que se va a usar para el disco de datos. |
DiffDiskPlacement
Especifica la ubicación del 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 |
Especifica la ubicación del disco efímero para el disco del sistema operativo para todas las máquinas virtuales del grupo. |
DiskEncryptionConfiguration
La configuración de cifrado de disco aplicada en los nodos de proceso del grupo. La configuración de cifrado de disco no se admite en el grupo de Linux creado con la imagen de Azure Compute Gallery.
Nombre | Tipo | Description |
---|---|---|
targets |
La lista de destinos de disco de Batch Service cifrará en el nodo de proceso. |
DiskEncryptionTarget
La lista de destinos de disco que el servicio Batch 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 los discos de datos montados) cuando se produce el cifrado en tiempo de arranque. |
DynamicVNetAssignmentScope
Ámbito de asignación de red virtual dinámica.
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. |
ErrorMessage
Mensaje de error recibido en una respuesta de error Azure Batch.
Nombre | Tipo | Description |
---|---|---|
lang |
string |
Código de idioma del mensaje de error |
value |
string |
Texto del mensaje. |
ImageReference
Referencia a una imagen de Azure Virtual Machines Marketplace o a una imagen de Azure Compute Gallery. Para obtener la lista de todas las referencias de imagen de Azure Marketplace verificadas por Azure Batch, consulte la operación "Enumerar imágenes admitidas".
Nombre | Tipo | Description |
---|---|---|
exactVersion |
string |
La versión específica de la imagen de plataforma o la imagen de Marketplace que se usa para crear el nodo. Este campo de solo lectura difiere de "version" solo si el valor especificado para "version" cuando se creó el grupo era "latest". |
offer |
string |
El tipo de oferta de la imagen de Marketplace de Azure Virtual Machines. |
publisher |
string |
Publicador de la imagen de Marketplace de Azure Virtual Machines. |
sku |
string |
SKU de la imagen de Marketplace de Azure Virtual Machines. |
version |
string |
La versión de la imagen de Azure Virtual Machines Marketplace. |
virtualMachineImageId |
string |
Identificador de recurso de ARM de la imagen de Azure Compute Gallery. Los nodos de proceso del grupo se crearán con este identificador de imagen. Tiene el formato /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} o /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName} para la versión de imagen más reciente. |
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. |
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. |
frontendPortRangeStart |
integer |
El primer número de puerto del intervalo de puertos externos que se usarán para proporcionar acceso entrante a backendPort en nodos de proceso individuales. |
name |
string |
Nombre del punto de conexión. |
networkSecurityGroupRules |
Lista de reglas de grupo de seguridad de red que se aplicarán al punto de conexión. |
|
protocol |
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 reintenta una tarea si su código de salida es distinto de cero. |
maxWallClockTime |
string |
Tiempo máximo transcurrido durante el que se puede ejecutar el trabajo, medido desde el momento en que se crea el trabajo. |
JobPatchParameter
Conjunto de cambios que se van a realizar en un trabajo.
Nombre | Tipo | Description |
---|---|---|
allowTaskPreemption |
boolean |
Si las tareas de este trabajo pueden ser adelantadas por otros trabajos de prioridad alta |
constraints |
Restricciones de ejecución para el trabajo. |
|
maxParallelTasks |
integer |
Número máximo de tareas que se pueden ejecutar en paralelo para el trabajo. |
metadata |
Lista de pares nombre-valor asociados al trabajo como metadatos. |
|
onAllTasksComplete |
La acción que debe realizar el servicio Batch cuando todas las tareas del trabajo están en estado completado. |
|
poolInfo |
Grupo en el que el servicio Batch ejecuta las tareas del trabajo. |
|
priority |
integer |
Prioridad 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. |
sshPrivateKey |
string |
Clave privada SSH para la cuenta de usuario. |
uid |
integer |
Identificador de usuario de la cuenta de usuario. |
LoginMode
Modo de inicio de sesión del usuario
Nombre | Tipo | Description |
---|---|---|
batch |
string |
El LOGON32_LOGON_BATCH modo de inicio de sesión de Win32. Se recomienda el modo de inicio de sesión por lotes para procesos paralelos de larga duración. |
interactive |
string |
El LOGON32_LOGON_INTERACTIVE modo de inicio de sesión de Win32. UAC está habilitado en grupos de Windows VirtualMachineConfiguration. Si esta opción se usa con una identidad de usuario con privilegios elevados en un grupo de Windows VirtualMachineConfiguration, la sesión de usuario no se elevará a menos que la aplicación ejecutada por la línea de comandos tarea esté configurada para requerir siempre privilegios administrativos o para requerir siempre el privilegio máximo. |
ManagedDisk
Nombre | Tipo | Description |
---|---|---|
storageAccountType |
Tipo de cuenta de almacenamiento para disco administrado. |
MetadataItem
Un 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 |
Contenedor de Azure Storage que se va a montar mediante BLOB FUSE en cada nodo. |
|
azureFileShareConfiguration |
Recurso compartido de archivos de Azure que se va a montar en cada nodo. |
|
cifsMountConfiguration |
Sistema de archivos CIFS/SMB que se va a montar en cada nodo. |
|
nfsMountConfiguration |
Sistema de archivos NFS que se va a montar en cada nodo. |
NetworkConfiguration
Configuración de red de un grupo.
Nombre | Tipo | Description |
---|---|---|
dynamicVNetAssignmentScope |
Ámbito de la asignación de red virtual dinámica. |
|
enableAcceleratedNetworking |
boolean |
Si este grupo debe habilitar las redes aceleradas. |
endpointConfiguration |
Configuración de puntos de conexión en nodos de proceso en el grupo de lotes. |
|
publicIPAddressConfiguration |
Configuración de IP públicaAddress para nodos de proceso en el grupo de lotes. |
|
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. Tiene el formato /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. |
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 |
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. |
sourceAddressPrefix |
string |
Prefijo o etiqueta de dirección de origen que debe coincidir con la regla. |
sourcePortRanges |
string[] |
Intervalos de puertos de origen que deben coincidir con la regla. |
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 |
Permita el acceso. |
deny |
string |
Deniegue el acceso. |
NFSMountConfiguration
Información usada para conectarse a un sistema de archivos NFS.
Nombre | Tipo | Description |
---|---|---|
mountOptions |
string |
Opciones de línea de comandos adicionales para pasar al comando mount. |
relativeMountPath |
string |
Ruta de acceso relativa en el nodo de proceso donde se montará el sistema de archivos. |
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 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 |
Tipo de directiva de selección de ubicación de nodo en grupos de batch. |
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 equilibrio de mejor 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 se termine o deshabilite por algún otro medio. |
terminatejob |
string |
Finalice el trabajo. TerminateReason del trabajo se establece en "AllTasksComplete". |
OSDisk
Configuración del disco del sistema operativo del nodo de proceso (VM).
Nombre | Tipo | Description |
---|---|---|
caching |
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. |
|
diskSizeGB |
integer |
Tamaño inicial del disco en GB al crear un nuevo disco del sistema operativo. |
ephemeralOSDiskSettings |
Especifica la configuración de disco efímera para el disco del sistema operativo usado por el nodo de proceso (VM). |
|
managedDisk |
Parámetros de disco administrado. |
|
writeAcceleratorEnabled |
boolean |
Especifica si writeAccelerator debe estar habilitado o deshabilitado en el disco. |
PoolEndpointConfiguration
Configuración del punto de conexión de un grupo.
Nombre | Tipo | Description |
---|---|---|
inboundNATPools |
Lista de grupos NAT de entrada que se pueden usar para abordar puertos específicos en un nodo de ejecución individual externamente. |
PoolInformation
Especifica cómo se debe asignar un trabajo a un grupo.
Nombre | Tipo | Description |
---|---|---|
autoPoolSpecification |
Características de un "grupo automático" temporal. El servicio Batch creará este grupo automático cuando se envíe el trabajo. |
|
poolId |
string |
Identificador de un grupo existente. Todas las tareas del trabajo se ejecutarán en el grupo especificado. |
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 del trabajo. El servicio Batch crea el grupo cuando crea el primer trabajo según la programación. Puede aplicar esta opción solo a programaciones de trabajos, no a trabajos. |
PoolSpecification
Especificación para crear un nuevo grupo.
Nombre | Tipo | Description |
---|---|---|
applicationLicenses |
string[] |
La lista de licencias de aplicación que el servicio Batch pondrá a disposición en cada nodo de proceso del grupo. |
applicationPackageReferences |
Lista de paquetes que se van a instalar en cada nodo de proceso del grupo. |
|
autoScaleEvaluationInterval |
string |
Intervalo de tiempo en el que ajustar automáticamente el tamaño del grupo según la fórmula de escalado automático. |
autoScaleFormula |
string |
Fórmula para el número deseado de nodos de proceso en el grupo. |
certificateReferences |
Lista de certificados que se van a instalar en cada nodo de proceso del grupo. Advertencia: esta propiedad está en desuso y se quitará después de febrero de 2024. Use la extensión De Azure KeyVault en su lugar. |
|
cloudServiceConfiguration |
Configuración del servicio en la nube para el grupo. |
|
displayName |
string |
Nombre para mostrar del grupo. |
enableAutoScale |
boolean |
Si el tamaño del grupo se debe ajustar automáticamente con el tiempo. |
enableInterNodeCommunication |
boolean |
Si el grupo permite la comunicación directa entre los nodos de proceso. |
metadata |
Lista de pares nombre-valor asociados al grupo como metadatos. |
|
mountConfiguration |
Lista de sistemas de archivos que se van a montar en cada nodo del grupo. |
|
networkConfiguration |
Configuración de red para el grupo. |
|
resizeTimeout |
string |
Tiempo de espera para la asignación de nodos de proceso al grupo. |
resourceTags |
object |
Etiquetas especificadas por el usuario asociadas al grupo. |
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. |
|
targetDedicatedNodes |
integer |
Número deseado de nodos de proceso dedicados en el grupo. |
targetLowPriorityNodes |
integer |
Número deseado de nodos de proceso de prioridad baja o de acceso puntual en el grupo. |
targetNodeCommunicationMode |
Modo de comunicación de nodo deseado para el grupo. |
|
taskSchedulingPolicy |
Cómo se distribuyen las tareas entre nodos de proceso en un grupo. |
|
taskSlotsPerNode |
integer |
El número de ranuras de tareas que pueden usarse para ejecutar tareas simultáneas en un solo nodo de ejecución en el grupo. |
userAccounts |
Lista de cuentas de usuario que se van a crear en cada nodo de proceso del grupo. |
|
virtualMachineConfiguration |
Configuración de la máquina virtual para el grupo. |
|
vmSize |
string |
Tamaño de las máquinas virtuales del grupo. Todas las máquinas virtuales de un grupo tienen el mismo tamaño. |
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. |
provision |
Tipo de aprovisionamiento para direcciones IP públicas para el grupo. |
ResourceFile
Un único archivo o varios archivos que se van a descargar en un nodo de proceso.
Nombre | Tipo | Description |
---|---|---|
autoStorageContainerName |
string |
El nombre del contenedor de almacenamiento en la cuenta de almacenamiento automática. |
blobPrefix |
string |
Prefijo de blob que se va a usar al descargar blobs de un contenedor de Azure Storage. Solo se descargarán los blobs cuyos nombres comiencen por el prefijo especificado. |
fileMode |
string |
Atributo de modo de permiso de archivo en formato octal. |
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. |
httpUrl |
string |
La dirección URL del archivo que se va a descargar. |
identityReference |
Referencia a la identidad asignada por el usuario que se va a usar para acceder a Azure Blob Storage especificado por storageContainerUrl o httpUrl |
|
storageContainerUrl |
string |
Dirección URL del contenedor de blobs en Azure Blob Storage. |
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 disco de recurso o temporal en el propio host. |
securityType |
Especifica el SecurityType de la máquina virtual. Debe establecerse en cualquier valor especificado para habilitar UefiSettings. |
|
uefiSettings |
Especifica la configuración de seguridad como el arranque seguro y vTPM que se usa al crear la máquina virtual. |
SecurityTypes
Especifica el SecurityType de la máquina virtual. Debe establecerse en cualquier valor especificado para habilitar UefiSettings.
Nombre | Tipo | Description |
---|---|---|
trustedLaunch |
string |
El inicio seguro protege frente a técnicas de ataque persistentes y avanzadas. |
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 |
StartTask
Tarea que se ejecuta cuando un nodo se une a un grupo en el servicio Azure Batch o cuando se reinicia o se vuelve a crear una imagen de imagen.
Nombre | Tipo | Description |
---|---|---|
commandLine |
string |
Línea de comandos de StartTask. |
containerSettings |
La configuración del contenedor en el que se ejecuta StartTask. |
|
environmentSettings |
Lista de opciones de configuración de variables de entorno para StartTask. |
|
maxTaskRetryCount |
integer |
Número máximo de veces que se puede reintentar la tarea. |
resourceFiles |
Lista de archivos que el servicio Batch descargará en el nodo de proceso antes de ejecutar la línea de comandos. Hay un tamaño máximo para la lista de archivos de recursos. Cuando se supera el tamaño máximo, se producirá un error en la solicitud y el código de error de respuesta será RequestEntityTooLarge. Si esto ocurre, la colección de ResourceFiles debe reducirse de tamaño. Esto se puede lograr mediante archivos .zip, paquetes de aplicación o contenedores de Docker. |
|
userIdentity |
Identidad de usuario con la que se ejecuta StartTask. |
|
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. |
StorageAccountType
Tipo de cuenta de almacenamiento para su uso en la creación de discos de datos o disco del sistema operativo.
Nombre | Tipo | Description |
---|---|---|
premium_lrs |
string |
El disco de datos o disco del sistema operativo debe usar el almacenamiento con redundancia local Premium. |
standard_lrs |
string |
El disco de datos o disco del sistema operativo debe usar el almacenamiento con redundancia local estándar. |
standardssd_lrs |
string |
El disco de datos o disco del sistema operativo debe usar el almacenamiento con redundancia local ssd estándar. |
TaskContainerSettings
Configuración del contenedor de una tarea.
Nombre | Tipo | Description |
---|---|---|
containerRunOptions |
string |
Opciones adicionales para el comando container create. |
imageName |
string |
Imagen que se va a usar para crear el contenedor en el que se ejecutará la tarea. |
registry |
Registro privado que contiene la imagen de contenedor. |
|
workingDirectory |
Ubicación del directorio de trabajo de la tarea de contenedor. |
TaskSchedulingPolicy
Especifica cómo se deben distribuir las tareas entre nodos de proceso.
Nombre | Tipo | Description |
---|---|---|
nodeFillType |
Cómo se distribuyen las tareas entre nodos de proceso en un grupo. |
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 habilitarse en la máquina virtual. |
UserAccount
Propiedades usadas para crear un usuario que se usa para ejecutar tareas en un nodo de Azure Batch proceso.
Nombre | Tipo | Description |
---|---|---|
elevationLevel |
Nivel de elevación de la cuenta de usuario. |
|
linuxUserConfiguration |
Configuración de usuario específica de Linux para la cuenta de usuario. |
|
name |
string |
Nombre de la cuenta de usuario. Los nombres pueden contener cualquier carácter Unicode hasta una longitud máxima de 20. |
password |
string |
La contraseña de la cuenta de usuario. |
windowsUserConfiguration |
Configuración de usuario específica de Windows para la cuenta de usuario. |
UserIdentity
Definición de la identidad de usuario en la que se ejecuta la tarea.
Nombre | Tipo | Description |
---|---|---|
autoUser |
Usuario automático en el que se ejecuta la tarea. |
|
username |
string |
Nombre 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.
Nombre | Tipo | Description |
---|---|---|
containerConfiguration |
Configuración del contenedor para el grupo. |
|
dataDisks |
Data |
La configuración de los discos de datos conectados a los nodos de proceso del grupo. |
diskEncryptionConfiguration |
Configuración de cifrado de disco para el grupo. |
|
extensions |
Extensión de máquina virtual para el grupo. |
|
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. Windows_Server: la licencia local es para Windows Server. Windows_Client: la licencia local es para el cliente windows. |
nodeAgentSKUId |
string |
SKU del agente de batch Compute Node que se va a aprovisionar en nodos de proceso del grupo. |
nodePlacementConfiguration |
Configuración de ubicación del nodo para el grupo. |
|
osDisk |
Configuración del disco del sistema operativo de la máquina virtual. |
|
securityProfile |
Especifica la configuración del perfil de seguridad para la máquina virtual o el conjunto de escalado de máquinas virtuales. |
|
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". |
|
windowsConfiguration |
Configuración del sistema operativo Windows en la máquina virtual. |
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 hay una disponible en el momento de la implementación. Sin embargo, una vez implementada, la extensión no actualizará las versiones secundarias a menos que se vuelva a implementar, incluso con esta propiedad establecida en true. |
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. |
publisher |
string |
Nombre del publicador del controlador de extensiones. |
settings |
object |
Configuración pública con formato JSON para la extensión. |
type |
string |
El tipo de extensión. |
typeHandlerVersion |
string |
Versión del controlador de script. |
WindowsConfiguration
Configuración del sistema operativo Windows que se va a aplicar a la máquina virtual.
Nombre | Tipo | Description |
---|---|---|
enableAutomaticUpdates |
boolean |
Si las actualizaciones automáticas están habilitadas en la máquina virtual. |
WindowsUserConfiguration
Propiedades usadas para crear una cuenta de usuario en un nodo de proceso de Windows.
Nombre | Tipo | Description |
---|---|---|
loginMode |
Modo de inicio de sesión para el usuario |