Pool - Update Properties
Actualiza las propiedades del grupo especificado.
Esto reemplaza por completo todas las propiedades actualizables del grupo. Por ejemplo, si el grupo tiene un StartTask asociado a él y si StartTask no se especifica con esta solicitud, el servicio Batch quitará el startTask existente.
POST {batchUrl}/pools/{poolId}/updateproperties?api-version=2024-07-01.20.0
POST {batchUrl}/pools/{poolId}/updateproperties?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. |
pool
|
path | True |
string |
Identificador del grupo que se va a 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. 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. |
Cuerpo de la solicitud
Media Types: "application/json; odata=minimalmetadata"
Nombre | Requerido | Tipo | Description |
---|---|---|---|
applicationPackageReferences | True |
Lista de paquetes de aplicación que se van a instalar en cada nodo de proceso del grupo. |
|
certificateReferences | True |
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 |
|
metadata | True |
Lista de pares nombre-valor asociados al grupo como metadatos. |
|
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. |
||
targetNodeCommunicationMode |
Modo de comunicación de nodo deseado para el grupo. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
204 No Content |
La solicitud al servicio Batch se realizó correctamente. 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
Pool update
Solicitud de ejemplo
POST account.region.batch.azure.com/pools/poolId/updateproperties?api-version=2024-07-01.20.0
{
"startTask": {
"commandLine": "/bin/bash -c 'echo start task'"
},
"certificateReferences": [],
"applicationPackageReferences": [],
"metadata": []
}
Respuesta de muestra
Definiciones
Nombre | Description |
---|---|
Application |
Referencia a un paquete que se va a implementar en nodos de proceso. |
Auto |
Ámbito del usuario automático |
Auto |
Especifica los parámetros del usuario automático que ejecuta una tarea en el servicio Batch. |
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. |
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. |
Compute |
Referencia a una identidad asignada por el usuario asociada al grupo de Batch que usará un nodo de proceso. |
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 |
Ubicación del directorio de trabajo de la tarea de contenedor. |
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 de Azure Batch. |
Metadata |
Par nombre-valor asociado a un recurso de servicio de Batch. |
Node |
Determina cómo se comunica un grupo con el servicio Batch. |
Pool |
Conjunto de cambios que se van a realizar en un grupo. |
Resource |
Un único archivo o varios archivos que se van a descargar en un nodo de proceso. |
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. |
Task |
Configuración del contenedor de una tarea. |
User |
Definición de la identidad de usuario en la que se ejecuta 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. |
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 |
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. |
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. |
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. |
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. |
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. |
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 de Azure Batch.
Nombre | Tipo | Description |
---|---|---|
lang |
string |
El código de idioma del mensaje de error |
value |
string |
Texto del mensaje. |
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. |
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. |
PoolUpdatePropertiesParameter
Conjunto de cambios que se van a realizar en un grupo.
Nombre | Tipo | Description |
---|---|---|
applicationPackageReferences |
Lista de paquetes de aplicación que se van a instalar en cada nodo de proceso del 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 |
|
metadata |
Lista de pares nombre-valor asociados al grupo como metadatos. |
|
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. |
|
targetNodeCommunicationMode |
Modo de comunicación de nodo deseado 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. |
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. |
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. |
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. |