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 |
---|---|---|---|---|
batch
|
path | True |
string |
Dirección URL base de todas las solicitudes de servicio de Azure Batch. |
job
|
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 |
Respuesta que contiene el trabajo. Encabezados
|
|
Other Status Codes |
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 |
---|---|
Access |
Recursos de Batch a los que el token concede acceso. |
Application |
Referencia a un paquete que se va a implementar en nodos de proceso. |
Authentication |
La configuración de un token de autenticación que la tarea puede usar para realizar operaciones del servicio Batch. |
Automatic |
Los parámetros de configuración que se usan para realizar la actualización automática del sistema operativo. |
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 del usuario automático que ejecuta una tarea en el servicio Batch. |
Azure |
Información que se usa para conectarse a un contenedor de Azure Storage mediante Blobfuse. |
Azure |
Información que se usa para conectarse a un recurso compartido de archivos de Azure. |
Batch |
Respuesta de error recibida del servicio Azure Batch. |
Batch |
Un elemento de información adicional incluida en una respuesta de error de 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 |
Un trabajo de Azure Batch. |
Compute |
Cómo se distribuyen las tareas entre nodos de proceso de 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 |
La entrada de la ruta de acceso y el modo de montaje que desea montar en el contenedor de tareas. |
Container |
Rutas de acceso que se montarán en el contenedor de la tarea de contenedor. |
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. Al usar discos de datos conectados, debe montar y dar formato a los discos desde una máquina virtual para usarlos. |
Diff |
Especifica la colocación de 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. No se admite la configuración de cifrado de disco en el grupo de Linux creado con la imagen de Azure Compute Gallery. |
Disk |
La lista de destinos de disco de Batch Service cifrará en el nodo de proceso. |
Dynamic |
Ámbito de la asignación dinámica de red virtual. |
Elevation |
Nivel de elevación del usuario. |
Environment |
Variable de entorno que se va a establecer en un proceso de tarea. |
Error |
Categoría del error. |
Error |
Mensaje de error recibido en una respuesta de error de Azure Batch. |
Http |
Un par nombre-valor de encabezado HTTP |
Image |
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". |
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 |
Contiene información sobre la ejecución de un trabajo en el servicio Azure Batch. |
Job |
Especifica los detalles de una tarea del Administrador de trabajos. |
Job |
Configuración de red para el trabajo. |
Job |
Tarea de preparación de trabajos que se ejecutará antes de cualquier tarea del trabajo en cualquier nodo de proceso determinado. |
Job |
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. |
Job |
Error detectado por el servicio Batch al programar un trabajo. |
Job |
Estado del trabajo. |
Job |
Estadísticas de uso de recursos para 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 |
Par nombre-valor asociado a un recurso de servicio de Batch. |
Mount |
Sistema de archivos que se va a montar en cada nodo. |
Name |
Representa un par nombre-valor. |
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 utilizada 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. |
On |
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). |
Output |
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. |
Output |
Especifica un destino de carga de archivos dentro de un contenedor de Azure Blob Storage. |
Output |
Destino al que se debe cargar un archivo. |
Output |
Condiciones en las que se debe cargar un archivo de salida de tarea o un conjunto de archivos. |
Output |
Detalles sobre una operación de carga de archivos de salida, incluidas las condiciones para realizar la carga. |
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. |
Rolling |
Los parámetros de configuración usados al realizar una actualización gradual. |
Security |
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. |
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 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 del nodo de proceso. |
Storage |
Tipo de cuenta de almacenamiento que se usa para crear discos de datos o disco del sistema operativo. |
Task |
Restricciones de ejecución que se aplicarán a una tarea. |
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. |
Upgrade |
Especifica el modo de una actualización a las máquinas virtuales del conjunto de escalado. |
Upgrade |
Describe una directiva de actualización: automática, manual o gradual. |
User |
Propiedades usadas para crear un usuario que se usa para ejecutar tareas en un nodo de proceso de Azure Batch. |
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. |
VMDisk |
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. |
Windows |
Configuración del sistema operativo Windows que se aplicará a la máquina virtual. |
Windows |
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. |
version |
string |
Versión de la aplicación que se va a implementar. Si se omite, se implementa la versión predeterminada. |
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 |
Recursos de Batch a los que el token concede acceso. |
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. |
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. |
keepAlive |
boolean |
Indica si se debe mantener activo un grupo automático después de que expire su duración. |
pool |
Especificación del grupo para el grupo automático. |
|
poolLifetimeOption |
La duración mínima de los grupos automáticos creados y cómo se asignan varios trabajos según una programación a 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 |
Nivel de elevación del usuario automático. |
|
scope |
Ámbito del usuario automático |
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. |
accountName |
string |
Nombre de la cuenta de Azure Storage. |
blobfuseOptions |
string |
Opciones de línea de comandos adicionales para pasar al comando de montaje. |
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 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. |
mountOptions |
string |
Opciones de línea de comandos adicionales para pasar al comando de montaje. |
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 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 |
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 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. |
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. |
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 |
|
commonEnvironmentSettings |
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). |
||
constraints |
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. |
|
executionInfo |
Información de ejecución del trabajo. |
||
id |
string |
Cadena que identifica de forma única el trabajo dentro de la cuenta. |
|
jobManagerTask |
Detalles de una tarea del Administrador de trabajos que se va a iniciar cuando se inicia el trabajo. |
||
jobPreparationTask |
Tarea de preparación del trabajo. |
||
jobReleaseTask |
Tarea Liberación del trabajo. |
||
lastModified |
string |
Hora de la última modificación del trabajo. |
|
maxParallelTasks |
integer |
-1 |
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. |
||
networkConfiguration |
Configuración de red para el trabajo. |
||
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. |
||
poolInfo |
Configuración del grupo asociada al trabajo. |
||
previousState |
Estado anterior del trabajo. |
||
previousStateTransitionTime |
string |
Hora en la que el trabajo entró en su estado anterior. |
|
priority |
integer |
Prioridad del trabajo. |
|
state |
Estado actual del trabajo. |
||
stateTransitionTime |
string |
Hora en la que el trabajo entró en su estado actual. |
|
stats |
Estadísticas de uso de recursos para toda la duración del trabajo. |
||
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. |
containerRegistries |
Registros privados adicionales desde los que se pueden extraer contenedores. |
|
type |
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). |
source |
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 |
Referencia a la identidad asignada por el usuario que se va a usar para acceder a una instancia de Azure Container Registry en lugar de un nombre de usuario y una contraseña. |
|
password |
string |
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 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 |
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 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 |
Especifica la colocación de 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. 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 |
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 |
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. |
publisher |
string |
Publicador de la imagen de Marketplace de Azure Virtual Machines. |
sharedGalleryImageId |
string |
Identificador único de la imagen de la galería compartida |
sku |
string |
SKU de la imagen de Marketplace de Azure Virtual Machines. |
version |
string |
Versión de la imagen de Marketplace de Azure Virtual Machines. |
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. |
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 |
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 vuelve a intentar una tarea si su código de salida es distinto de cero. |
maxWallClockTime |
string |
Tiempo máximo transcurrido que se puede ejecutar el trabajo, medido desde el momento en que se crea 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. |
poolId |
string |
Identificador del grupo al que se asigna este trabajo. |
schedulingError |
Detalles de cualquier error detectado por el servicio al iniciar el trabajo. |
|
startTime |
string |
Hora de inicio del trabajo. |
terminateReason |
string |
Cadena que describe el motivo por el que finalizó el 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. |
applicationPackageReferences |
Lista de paquetes de aplicación que el servicio Batch implementará en el nodo de proceso antes de ejecutar la línea de comandos. |
|
authenticationTokenSettings |
La configuración de un token de autenticación que la tarea puede usar para realizar operaciones del servicio Batch. |
|
commandLine |
string |
Línea de comandos de la tarea Administrador de trabajos. |
constraints |
Restricciones que se aplican a la tarea Administrador de trabajos. |
|
containerSettings |
Configuración del contenedor en el que se ejecuta la tarea Administrador de trabajos. |
|
displayName |
string |
Nombre para mostrar de la tarea Administrador de trabajos. |
environmentSettings |
Lista de opciones de configuración de variables de entorno para la tarea Administrador de trabajos. |
|
id |
string |
Cadena que identifica de forma única la tarea administrador de trabajos dentro del trabajo. |
killJobOnCompletion |
boolean |
Si la finalización de la tarea administrador de trabajos indica la finalización de todo el trabajo. |
outputFiles |
Lista de archivos que el servicio Batch cargará desde el nodo de proceso después de ejecutar la línea de comandos. |
|
requiredSlots |
integer |
Número de ranuras de programación que requiere la tarea para ejecutarse. |
resourceFiles |
Lista de archivos que el servicio Batch descargará en el nodo de proceso antes de ejecutar la línea de comandos. |
|
runExclusive |
boolean |
Si la tarea del Administrador de trabajos requiere un uso exclusivo del nodo de proceso donde se ejecuta. |
userIdentity |
Identidad de usuario en la que se ejecuta la tarea Administrador de trabajos. |
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. |
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. |
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. |
constraints |
Restricciones que se aplican a la tarea de preparación del trabajo. |
|
containerSettings |
Configuración del contenedor en el que se ejecuta la tarea de preparación del trabajo. |
|
environmentSettings |
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. |
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. |
resourceFiles |
Lista de archivos que el servicio Batch descargará en el nodo de proceso antes de ejecutar la línea de comandos. |
|
userIdentity |
Identidad de usuario en la que se ejecuta la tarea de preparación del trabajo. |
|
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. |
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. |
containerSettings |
La configuración del contenedor en el que se ejecuta la tarea De liberación de trabajos. |
|
environmentSettings |
Lista de opciones de configuración de variables de entorno para la tarea De liberación de trabajos. |
|
id |
string |
Cadena que identifica de forma única la tarea de liberación de trabajos dentro del trabajo. |
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 |
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. |
|
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. |
userIdentity |
Identidad de usuario en la que se ejecuta la tarea de liberación de trabajos. |
JobSchedulingError
Error detectado por el servicio Batch al programar un trabajo.
Nombre | Tipo | Description |
---|---|---|
category |
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 |
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. |
numSucceededTasks |
integer |
Número total de tareas completadas correctamente en el trabajo durante el intervalo de tiempo especificado. |
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. |
wallClockTime |
string |
Tiempo total del reloj de todas las tareas del trabajo. |
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. |
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 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 |
Especifica la configuración del perfil de seguridad para el disco administrado. |
|
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 |
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. |
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 |
Ámbito de la asignación dinámica de red virtual. |
|
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. Este es 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 coincidirán 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 |
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. |
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 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 |
Tipo de directiva de selección de ubicación de nodo en grupos de lotes. |
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 |
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 de disco inicial en GB al crear un nuevo disco del sistema operativo. |
ephemeralOSDiskSettings |
Especifica la configuración de disco efímero 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. |
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 |
Destino de los archivos de salida. |
|
filePattern |
string |
Patrón que indica qué archivos se van a cargar. |
uploadOptions |
Opciones adicionales para la operación de carga, incluidas las condiciones para realizar la carga. |
OutputFileBlobContainerDestination
Especifica un destino de carga de archivos dentro de un contenedor de Azure Blob Storage.
Nombre | Tipo | Description |
---|---|---|
containerUrl |
string |
Dirección URL del contenedor dentro de Azure Blob Storage en la que se cargan los archivos. |
identityReference |
Referencia a la identidad asignada por el usuario que se va a usar para acceder a Azure Blob Storage especificado por containerUrl |
|
path |
string |
Blob de destino o directorio virtual dentro del contenedor de Azure Storage. |
uploadHeaders |
Lista de pares nombre-valor para los encabezados que se usarán en la carga de archivos de salida |
OutputFileDestination
Destino al que se debe cargar un archivo.
Nombre | Tipo | Description |
---|---|---|
container |
Ubicación en Azure Blob Storage en la que se cargan los archivos. |
OutputFileUploadCondition
Condiciones en las que se debe cargar un archivo de salida de tarea o un conjunto de archivos.
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 |
Condiciones en las que se debe cargar el archivo de salida de la tarea o el conjunto de archivos. |
PoolEndpointConfiguration
Configuración del punto de conexión de un grupo.
Nombre | Tipo | Description |
---|---|---|
inboundNATPools |
Lista de grupos NAT entrantes que se pueden usar para abordar puertos específicos en un nodo de proceso 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 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 |
Lista de paquetes que se van a instalar en cada nodo de proceso del grupo. |
|
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. |
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 el de extensión de Azure KeyVault de |
|
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 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 de un grupo. |
|
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. |
upgradePolicy |
Directiva de actualización del 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 |
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 comienzan por el prefijo especificado. |
fileMode |
string |
Atributo del 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 |
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. |
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 |
Especifica 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 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 |
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. |
containerSettings |
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 en tamaño. Esto se puede lograr mediante archivos de .zip, paquetes de aplicación o contenedores de Docker. |
|
userIdentity |
Identidad de usuario en 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 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. |
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. |
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. |
TaskContainerSettings
Configuración del contenedor de una tarea.
Nombre | Tipo | Description |
---|---|---|
containerHostBatchBindMounts |
Las rutas de acceso que desea montar en la tarea contenedora. |
|
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 de 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 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 |
Parámetros de configuración usados para realizar la actualización automática del sistema operativo. |
|
mode |
Especifica el modo de una actualización a las máquinas virtuales del conjunto de escalado. |
|
rollingUpgradePolicy |
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 |
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 caracteres Unicode de hasta una longitud máxima de 20. |
password |
string |
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 |
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 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. |
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. |
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 |
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. |
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. |
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 del usuario |