Pool - Patch
Mises à jour les propriétés du pool spécifié.
Cela remplace uniquement les propriétés de pool spécifiées dans la requête. Par exemple, si un objet StartTask est associé au pool et qu’une requête ne spécifie pas d’élément StartTask, le pool conserve l’objet StartTask existant.
PATCH {batchUrl}/pools/{poolId}?api-version=2023-11-01.18.0
PATCH {batchUrl}/pools/{poolId}?timeout={timeout}&api-version=2023-11-01.18.0
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
batch
|
path | True |
string |
URL de base pour toutes les demandes de service Azure Batch. |
pool
|
path | True |
string |
ID du pool à mettre à jour. |
api-version
|
query | True |
string |
Version de l’API cliente. |
timeout
|
query |
integer int32 |
Durée maximale que le serveur peut consacrer au traitement de la demande, en secondes. La valeur par défaut est 30 secondes. |
En-tête de la demande
Media Types: "application/json; odata=minimalmetadata"
Nom | Obligatoire | Type | Description |
---|---|---|---|
client-request-id |
string uuid |
Identité de requête générée par l’appelant, sous la forme d’un GUID sans décoration telle que des accolades, par exemple 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Indique si le serveur doit retourner le client-request-id dans la réponse. |
|
ocp-date |
string date-time-rfc1123 |
Heure à laquelle la demande a été émise. Les bibliothèques clientes définissent généralement cette valeur sur l’heure actuelle de l’horloge système ; définissez-la explicitement si vous appelez directement l’API REST. |
|
If-Match |
string |
Valeur ETag associée à la version de la ressource connue du client. L’opération est effectuée uniquement si l’ETag actuel de la ressource sur le service correspond exactement à la valeur spécifiée par le client. |
|
If-None-Match |
string |
Valeur ETag associée à la version de la ressource connue du client. L’opération est effectuée uniquement si l’ETag actuel de la ressource sur le service ne correspond pas à la valeur spécifiée par le client. |
|
If-Modified-Since |
string date-time-rfc1123 |
Horodatage indiquant l’heure de la dernière modification de la ressource connue du client. L’opération est effectuée uniquement si la ressource sur le service a été modifiée depuis l’heure spécifiée. |
|
If-Unmodified-Since |
string date-time-rfc1123 |
Horodatage indiquant l’heure de la dernière modification de la ressource connue du client. L’opération est effectuée uniquement si la ressource sur le service n’a pas été modifiée depuis l’heure spécifiée. |
Corps de la demande
Media Types: "application/json; odata=minimalmetadata"
Nom | Type | Description |
---|---|---|
applicationPackageReferences |
Liste des packages à installer sur chaque nœud de calcul du pool. |
|
certificateReferences |
Liste des certificats à installer sur chaque nœud de calcul du pool. Avertissement : cette propriété est déconseillée et sera supprimée après février 2024. Utilisez plutôt l’extension Azure KeyVault . |
|
metadata |
Liste de paires nom-valeur associées au pool en tant que métadonnées. |
|
startTask |
Tâche à exécuter sur chaque nœud de calcul à mesure qu’il joint le pool. La tâche s’exécute lorsque le nœud de calcul est ajouté au pool ou lorsque le nœud de calcul est redémarré. |
|
targetNodeCommunicationMode |
Mode de communication de nœud souhaité pour le pool. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
La demande adressée au service Batch a réussi. Headers
|
|
Other Status Codes |
Erreur du service Batch. |
Sécurité
azure_auth
flux de code d’authentification OAuth 2.0 Microsoft Entra
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nom | Description |
---|---|
user_impersonation | Emprunter l’identité de votre compte d’utilisateur |
Authorization
Type:
apiKey
In:
header
Exemples
Patch the Pool
Sample Request
PATCH account.region.batch.azure.com/pools/poolId?api-version=2023-11-01.18.0
{
"startTask": {
"commandLine": "/bin/bash -c 'echo start task'"
}
}
Sample Response
Définitions
Nom | Description |
---|---|
Application |
Référence à un package à déployer sur des nœuds de calcul. |
Auto |
Étendue de l’utilisateur automatique |
Auto |
Spécifie les paramètres de l’utilisateur automatique qui exécute une tâche sur le service Batch. |
Batch |
Réponse d’erreur reçue du service Azure Batch. |
Batch |
Élément d’informations supplémentaires incluses dans une réponse d’erreur Azure Batch. |
Certificate |
Référence à un certificat à installer sur des nœuds de calcul dans un pool. |
Certificate |
Emplacement du magasin de certificats sur le nœud de calcul dans lequel installer le certificat. |
Certificate |
Quels comptes d’utilisateur sur le nœud de calcul doivent avoir accès aux données privées du certificat. |
Compute |
Référence à une identité affectée par l’utilisateur associée au pool Batch qu’un nœud de calcul utilisera. |
Container |
Registre de conteneurs privé. |
Container |
Emplacement du répertoire de travail de la tâche du conteneur. |
Elevation |
Niveau d’élévation de l’utilisateur. |
Environment |
Variable d’environnement à définir sur un processus Task. |
Error |
Message d’erreur reçu dans une réponse d’erreur Azure Batch. |
Metadata |
Paire nom-valeur associée à une ressource de service Batch. |
Node |
Détermine la façon dont un pool communique avec le service Batch. |
Pool |
Ensemble des modifications à apporter à un pool. |
Resource |
Fichier unique ou plusieurs fichiers à télécharger sur un nœud de calcul. |
Start |
Tâche exécutée lorsqu’un nœud joint un pool dans le service Azure Batch, ou lorsque le nœud de calcul est redémarré ou réinitialisé. |
Task |
Paramètres de conteneur d’une tâche. |
User |
Définition de l’identité utilisateur sous laquelle la tâche est exécutée. |
ApplicationPackageReference
Référence à un package à déployer sur des nœuds de calcul.
Nom | Type | Description |
---|---|---|
applicationId |
string |
ID de l’application à déployer. |
version |
string |
Version de l’application à déployer. En cas d’omission, la version par défaut est déployée. |
AutoUserScope
Étendue de l’utilisateur automatique
Nom | Type | Description |
---|---|---|
pool |
string |
Spécifie que la tâche s’exécute en tant que compte d’utilisateur automatique commun créé sur chaque nœud de calcul d’un pool. |
task |
string |
Spécifie que le service doit créer un utilisateur pour la tâche. |
AutoUserSpecification
Spécifie les paramètres de l’utilisateur automatique qui exécute une tâche sur le service Batch.
Nom | Type | Description |
---|---|---|
elevationLevel |
Niveau d’élévation de l’utilisateur automatique. |
|
scope |
Étendue de l’utilisateur automatique |
BatchError
Réponse d’erreur reçue du service Azure Batch.
Nom | Type | Description |
---|---|---|
code |
string |
Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation. |
message |
Message décrivant l’erreur, destiné à être affiché dans une interface utilisateur. |
|
values |
Collection de paires clé-valeur contenant des détails supplémentaires sur l’erreur. |
BatchErrorDetail
Élément d’informations supplémentaires incluses dans une réponse d’erreur Azure Batch.
Nom | Type | Description |
---|---|---|
key |
string |
Identificateur spécifiant la signification de la propriété Value. |
value |
string |
Informations supplémentaires incluses dans la réponse d’erreur. |
CertificateReference
Référence à un certificat à installer sur des nœuds de calcul dans un pool.
Nom | Type | Description |
---|---|---|
storeLocation |
Emplacement du magasin de certificats sur le nœud de calcul dans lequel installer le certificat. |
|
storeName |
string |
Nom du magasin de certificats sur le nœud de calcul dans lequel installer le certificat. |
thumbprint |
string |
Empreinte numérique du certificat. |
thumbprintAlgorithm |
string |
Algorithme auquel l’empreinte numérique est associée. Il doit s’agir de sha1. |
visibility |
Quels comptes d’utilisateur sur le nœud de calcul doivent avoir accès aux données privées du certificat. |
CertificateStoreLocation
Emplacement du magasin de certificats sur le nœud de calcul dans lequel installer le certificat.
Nom | Type | Description |
---|---|---|
currentuser |
string |
Les certificats doivent être installés dans le magasin de certificats CurrentUser. |
localmachine |
string |
Les certificats doivent être installés dans le magasin de certificats LocalMachine. |
CertificateVisibility
Quels comptes d’utilisateur sur le nœud de calcul doivent avoir accès aux données privées du certificat.
Nom | Type | Description |
---|---|---|
remoteuser |
string |
Le certificat doit être visible pour les comptes d’utilisateur sous lesquels les utilisateurs accèdent à distance au nœud de calcul. |
starttask |
string |
Le certificat doit être visible pour le compte d’utilisateur sous lequel starttask est exécuté. Notez que si AutoUser Scope est pool à la fois pour StartTask et une tâche, ce certificat sera également visible pour la tâche. |
task |
string |
Le certificat doit être visible pour les comptes d’utilisateur sous lesquels les tâches de travail sont exécutées. |
ComputeNodeIdentityReference
Référence à une identité affectée par l’utilisateur associée au pool Batch qu’un nœud de calcul utilisera.
Nom | Type | Description |
---|---|---|
resourceId |
string |
ID de ressource ARM de l’identité affectée par l’utilisateur. |
ContainerRegistry
Registre de conteneurs privé.
Nom | Type | Description |
---|---|---|
identityReference |
Référence à l’identité affectée par l’utilisateur à utiliser pour accéder à un Azure Container Registry au lieu du nom d’utilisateur et du mot de passe. |
|
password |
string |
Mot de passe pour se connecter au serveur de Registre. |
registryServer |
string |
L’URL du registre. |
username |
string |
Nom d’utilisateur à connecter au serveur du Registre. |
ContainerWorkingDirectory
Emplacement du répertoire de travail de la tâche du conteneur.
Nom | Type | Description |
---|---|---|
containerImageDefault |
string |
Utilisez le répertoire de travail défini dans l’image conteneur. Veillez à ce que ce répertoire ne contienne pas les fichiers de ressources téléchargés par Batch. |
taskWorkingDirectory |
string |
Utilisez le répertoire de travail des tâches du service Batch standard, qui contiendra les fichiers de ressources des tâches renseignés par Batch. |
ElevationLevel
Niveau d’élévation de l’utilisateur.
Nom | Type | Description |
---|---|---|
admin |
string |
L’utilisateur est un utilisateur disposant d’un accès élevé et fonctionne avec des autorisations d’administrateur complètes. |
nonadmin |
string |
L’utilisateur est un utilisateur standard sans accès élevé. |
EnvironmentSetting
Variable d’environnement à définir sur un processus Task.
Nom | Type | Description |
---|---|---|
name |
string |
Nom de la variable d’environnement. |
value |
string |
Valeur de la variable d’environnement. |
ErrorMessage
Message d’erreur reçu dans une réponse d’erreur Azure Batch.
Nom | Type | Description |
---|---|---|
lang |
string |
Code de langue du message d’erreur |
value |
string |
Texte du message. |
MetadataItem
Paire nom-valeur associée à une ressource de service Batch.
Nom | Type | Description |
---|---|---|
name |
string |
Nom de l’élément de métadonnées. |
value |
string |
Valeur de l’élément de métadonnées. |
NodeCommunicationMode
Détermine la façon dont un pool communique avec le service Batch.
Nom | Type | Description |
---|---|---|
classic |
string |
Les nœuds utilisant le mode de communication classique nécessitent une communication TCP entrante sur les ports 29876 et 29877 à partir du « BatchNodeManagement . {region} " étiquette de service et communication TCP sortante sur le port 443 vers « Storage.region » et « BatchNodeManagement ». {region} » balises de service. |
default |
string |
Le mode de communication du nœud est automatiquement défini par le service Batch. |
simplified |
string |
Les nœuds utilisant le mode de communication simplifié nécessitent une communication TCP sortante sur le port 443 vers le « BatchNodeManagement . {region} » balise de service. Aucun port entrant ouvert n’est requis. |
PoolPatchParameter
Ensemble des modifications à apporter à un pool.
Nom | Type | Description |
---|---|---|
applicationPackageReferences |
Liste des packages à installer sur chaque nœud de calcul du pool. |
|
certificateReferences |
Liste des certificats à installer sur chaque nœud de calcul du pool. Avertissement : cette propriété est déconseillée et sera supprimée après février 2024. Utilisez plutôt l’extension Azure KeyVault . |
|
metadata |
Liste de paires nom-valeur associées au pool en tant que métadonnées. |
|
startTask |
Tâche à exécuter sur chaque nœud de calcul à mesure qu’il rejoint le pool. La tâche s’exécute lorsque le nœud de calcul est ajouté au pool ou lorsque le nœud de calcul est redémarré. |
|
targetNodeCommunicationMode |
Mode de communication de nœud souhaité pour le pool. |
ResourceFile
Fichier unique ou plusieurs fichiers à télécharger sur un nœud de calcul.
Nom | Type | Description |
---|---|---|
autoStorageContainerName |
string |
Nom du conteneur de stockage dans le compte de stockage automatique. |
blobPrefix |
string |
Préfixe d’objet blob à utiliser lors du téléchargement d’objets blob à partir d’un conteneur Stockage Azure. Seuls les objets blob dont le nom commence par le préfixe spécifié seront téléchargés. |
fileMode |
string |
Attribut du mode d’autorisation de fichier au format octal. |
filePath |
string |
Emplacement sur le nœud de calcul vers lequel télécharger le ou les fichiers, par rapport au répertoire de travail de la tâche. |
httpUrl |
string |
URL du fichier à télécharger. |
identityReference |
Référence à l’identité affectée par l’utilisateur à utiliser pour accéder à Stockage Blob Azure spécifiée par storageContainerUrl ou httpUrl |
|
storageContainerUrl |
string |
URL du conteneur d’objets blob dans Stockage Blob Azure. |
StartTask
Tâche exécutée lorsqu’un nœud joint un pool dans le service Azure Batch, ou lorsque le nœud de calcul est redémarré ou réinitialisé.
Nom | Type | Description |
---|---|---|
commandLine |
string |
Ligne de commande de l’objet StartTask. |
containerSettings |
Paramètres du conteneur sous lequel starttask s’exécute. |
|
environmentSettings |
Liste des paramètres de variable d’environnement pour startTask. |
|
maxTaskRetryCount |
integer |
Nombre maximal de nouvelles tentatives de la tâche. |
resourceFiles |
Liste des fichiers que le service Batch téléchargera sur le nœud de calcul avant d’exécuter la ligne de commande. Il existe une taille maximale pour la liste des fichiers de ressources. Lorsque la taille maximale est dépassée, la demande échoue et le code d’erreur de réponse est RequestEntityTooLarge. Si cela se produit, la collection de ResourceFiles doit être réduite en taille. Vous pouvez y parvenir à l’aide de fichiers .zip, de packages d’application ou de conteneurs Docker. |
|
userIdentity |
Identité de l’utilisateur sous laquelle starttask s’exécute. |
|
waitForSuccess |
boolean |
Indique si le service Batch doit attendre que starttask se termine correctement (autrement dit, pour quitter avec le code de sortie 0) avant de planifier des tâches sur le nœud de calcul. |
TaskContainerSettings
Paramètres de conteneur d’une tâche.
Nom | Type | Description |
---|---|---|
containerRunOptions |
string |
Options supplémentaires pour la commande de création de conteneur. |
imageName |
string |
Image à utiliser pour créer le conteneur dans lequel la tâche s’exécutera. |
registry |
Registre privé qui contient l’image conteneur. |
|
workingDirectory |
Emplacement du répertoire de travail de la tâche du conteneur. |
UserIdentity
Définition de l’identité utilisateur sous laquelle la tâche est exécutée.
Nom | Type | Description |
---|---|---|
autoUser |
Utilisateur automatique sous lequel la tâche est exécutée. |
|
username |
string |
Nom de l’identité utilisateur sous laquelle la tâche est exécutée. |