Compute Node - Get

Service:

Batch Service

API Version:

2023-11-01.18.0

Obtient des informations sur le nœud de calcul spécifié.

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}?$select={$select}&timeout={timeout}&api-version=2023-11-01.18.0

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
batchUrl	path	True	string	URL de base pour toutes les demandes de service Azure Batch.
nodeId	path	True	string	ID du nœud de calcul sur lequel vous souhaitez obtenir des informations.
poolId	path	True	string	ID du pool qui contient le nœud de calcul.
api-version	query	True	string	Version de l’API cliente.
$select	query		string	Clause de $select OData.
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 d’horloge système actuelle ; définissez-la explicitement si vous appelez l’API REST directement.

Réponses

Nom	Type	Description
200 OK	ComputeNode	Réponse contenant le nœud de calcul. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Erreur du service Batch.

Sécurité

azure_auth

Microsoft Entra flux de code d’authentification OAuth 2.0

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

Node get

Sample Request

HTTP

GET account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z?api-version=2023-11-01.18.0

Sample Response

Status code:

200

{
  "id": "tvm-1695681911_2-20161122t193202z",
  "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z",
  "state": "idle",
  "schedulingState": "enabled",
  "stateTransitionTime": "2016-11-22T19:37:31.4285526Z",
  "lastBootTime": "2016-11-22T19:37:28.623369Z",
  "allocationTime": "2016-11-22T19:32:02.8155319Z",
  "ipAddress": "1.1.1.1",
  "affinityId": "TVM:tvm-1695681911_2-20161122t193202z",
  "vmSize": "small",
  "totalTasksRun": 0,
  "totalTasksSucceeded": 0,
  "runningTasksCount": 0,
  "isDedicated": true,
  "startTask": {
    "commandLine": "cmd /c echo hello",
    "userIdentity": {
      "autoUser": {
        "scope": "task",
        "elevationLevel": "nonadmin"
      }
    },
    "maxTaskRetryCount": 0,
    "waitForSuccess": false
  },
  "startTaskInfo": {
    "state": "completed",
    "startTime": "2016-11-22T19:37:31.4285526Z",
    "endTime": "2016-11-22T19:37:31.838028Z",
    "exitCode": 0,
    "retryCount": 0
  },
  "nodeAgentInfo": {
    "version": "1.2.0.0",
    "lastUpdateTime": "2016-11-22T19:37:28.623369Z"
  }
}

Définitions

Nom	Description
AutoUserScope	Étendue de l’utilisateur automatique
AutoUserSpecification	Spécifie les paramètres de l’utilisateur automatique qui exécute une tâche sur le service Batch.
BatchError	Réponse d’erreur reçue du service Azure Batch.
BatchErrorDetail	Élément d’informations supplémentaires inclus dans une réponse d’erreur Azure Batch.
CertificateReference	Référence à un certificat à installer sur des nœuds de calcul dans un pool.
CertificateStoreLocation	Emplacement du magasin de certificats sur le nœud de calcul dans lequel installer le certificat.
CertificateVisibility	Quels comptes d’utilisateur sur le nœud de calcul doivent avoir accès aux données privées du certificat.
ComputeNode	Un nœud de calcul dans le service Batch.
ComputeNodeEndpointConfiguration	Configuration du point de terminaison pour le nœud de calcul.
ComputeNodeError	Erreur rencontrée par un nœud de calcul.
ComputeNodeIdentityReference	Référence à une identité affectée par l’utilisateur associée au pool Batch qu’un nœud de calcul utilisera.
ComputeNodeState	État actuel du nœud de calcul.
ContainerRegistry	Registre de conteneurs privé.
ContainerWorkingDirectory	Emplacement du répertoire de travail de la tâche du conteneur.
ElevationLevel	Niveau d’élévation de l’utilisateur.
EnvironmentSetting	Variable d’environnement à définir sur un processus Task.
ErrorCategory	Catégorie de l’erreur.
ErrorMessage	Message d’erreur reçu dans une réponse d’erreur Azure Batch.
ImageReference	Référence à une image de la Place de marché Azure Machines Virtuelles ou à une image Azure Compute Gallery. Pour obtenir la liste de toutes les références d’images Place de marché Azure vérifiées par Azure Batch, consultez l’opération « Répertorier les images prises en charge ».
InboundEndpoint	Point de terminaison entrant sur un nœud de calcul.
InboundEndpointProtocol	Protocole du point de terminaison.
NameValuePair	Représente une paire nom-valeur.
NodeAgentInformation	Informations sur l’agent Compute Node.
ResourceFile	Fichier unique ou plusieurs fichiers à télécharger sur un nœud de calcul.
SchedulingState	Indique si le nœud de calcul est disponible pour la planification des tâches.
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é.
StartTaskInformation	Informations sur une tâche StartTask exécutée sur un nœud de calcul.
StartTaskState	État du StartTask sur le nœud de calcul.
TaskContainerExecutionInformation	Contient des informations sur le conteneur qu’une tâche exécute.
TaskContainerSettings	Paramètres de conteneur pour une tâche.
TaskExecutionInformation	Informations sur l’exécution d’une tâche.
TaskExecutionResult	Résultat de l’exécution de la tâche.
TaskFailureInformation	Informations sur un échec de tâche.
TaskInformation	Informations sur une tâche en cours d’exécution sur un nœud de calcul.
TaskState	État de la tâche.
UserIdentity	Définition de l’identité utilisateur sous laquelle la tâche est exécutée.
VirtualMachineInfo	Informations sur l’état actuel de la machine virtuelle.

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	ElevationLevel	Niveau d’élévation de l’utilisateur automatique. La valeur par défaut est nonAdmin.
scope	AutoUserScope	Étendue de l’utilisateur automatique La valeur par défaut est pool. Si le pool exécute Windows, une valeur de Tâche doit être spécifiée si une isolation plus stricte entre les tâches est requise. Par exemple, si la tâche mute le Registre d’une manière susceptible d’avoir un impact sur d’autres tâches, ou si des certificats ont été spécifiés sur le pool qui ne doit pas être accessible par les tâches normales, mais doit être accessible par StartTasks.

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	ErrorMessage	Message décrivant l’erreur, destiné à être affiché dans une interface utilisateur.
values	BatchErrorDetail[]	Collection de paires clé-valeur contenant des détails supplémentaires sur l’erreur.

BatchErrorDetail

Élément d’informations supplémentaires inclus 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	CertificateStoreLocation	Emplacement du magasin de certificats sur le nœud de calcul dans lequel installer le certificat. La valeur par défaut est currentuser. Cette propriété s’applique uniquement aux pools configurés avec des nœuds de calcul Windows (c’est-à-dire créés avec cloudServiceConfiguration ou avec virtualMachineConfiguration à l’aide d’une référence d’image Windows). Pour les nœuds de calcul Linux, les certificats sont stockés dans un répertoire à l’intérieur du répertoire de travail de la tâche et une variable d’environnement AZ_BATCH_CERTIFICATES_DIR est fournie à la tâche pour rechercher cet emplacement. Pour les certificats avec une visibilité de « remoteUser », un répertoire « certs » est créé dans le répertoire de base de l’utilisateur (par exemple, /home/{nom-utilisateur}/certs) et les certificats sont placés dans ce répertoire.
storeName	string	Nom du magasin de certificats sur le nœud de calcul dans lequel installer le certificat. Cette propriété s’applique uniquement aux pools configurés avec des nœuds de calcul Windows (c’est-à-dire créés avec cloudServiceConfiguration ou avec virtualMachineConfiguration à l’aide d’une référence d’image Windows). Les noms de magasins courants incluent : My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, mais tout nom de magasin personnalisé peut également être utilisé. La valeur par défaut est My.
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	CertificateVisibility[]	Quels comptes d’utilisateur sur le nœud de calcul doivent avoir accès aux données privées du certificat. Vous pouvez spécifier plusieurs visibilités dans cette collection. La valeur par défaut est tous les comptes.

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.

ComputeNode

Un nœud de calcul dans le service Batch.

Nom	Type	Description
affinityId	string	Identificateur qui peut être passé lors de l’ajout d’une tâche pour demander que la tâche soit planifiée sur ce nœud de calcul. Notez qu’il s’agit simplement d’une affinité douce. Si le nœud de calcul cible est occupé ou indisponible au moment où la tâche est planifiée, la tâche est planifiée ailleurs.
allocationTime	string	Heure à laquelle ce nœud de calcul a été alloué au pool. Il s’agit de l’heure à laquelle le nœud de calcul a été initialement alloué et ne change pas une fois défini. Il n’est pas mis à jour lorsque le nœud de calcul est réparé ou préempté.
certificateReferences	CertificateReference[]	Liste des certificats installés sur le nœud de calcul. Pour les nœuds Windows, le service Batch installe les certificats dans le magasin de certificats et l’emplacement spécifiés. Pour les nœuds de calcul Linux, les certificats sont stockés dans un répertoire à l’intérieur du répertoire de travail de la tâche et une variable d’environnement AZ_BATCH_CERTIFICATES_DIR est fournie à la tâche pour rechercher cet emplacement. Pour les certificats avec une visibilité de « remoteUser », un répertoire « certs » est créé dans le répertoire de base de l’utilisateur (par exemple, /home/{nom-utilisateur}/certs) et les certificats sont placés dans ce répertoire. Avertissement : cette propriété est déconseillée et sera supprimée après février 2024. Utilisez plutôt l’extension Azure KeyVault .
endpointConfiguration	ComputeNodeEndpointConfiguration	Configuration du point de terminaison pour le nœud de calcul.
errors	ComputeNodeError[]	Liste des erreurs actuellement rencontrées par le nœud de calcul.
id	string	ID du nœud de calcul. Chaque nœud de calcul ajouté à un pool se voit attribuer un ID unique. Chaque fois qu’un nœud de calcul est supprimé d’un pool, tous ses fichiers locaux sont supprimés, et l’ID est récupéré et peut être réutilisé pour les nouveaux nœuds de calcul.
ipAddress	string	Adresse IP que d’autres nœuds peuvent utiliser pour communiquer avec ce nœud de calcul. Chaque nœud de calcul ajouté à un pool se voit attribuer une adresse IP unique. Chaque fois qu’un nœud de calcul est supprimé d’un pool, tous ses fichiers locaux sont supprimés et l’adresse IP est récupérée et peut être réutilisée pour de nouveaux nœuds de calcul.
isDedicated	boolean	Indique si ce nœud de calcul est un nœud de calcul dédié. Si la valeur est false, le nœud de calcul est un nœud de calcul spot/basse priorité.
lastBootTime	string	Dernière heure à laquelle le nœud de calcul a été démarré. Cette propriété peut ne pas être présente si l’état du nœud de calcul est inutilisable.
nodeAgentInfo	NodeAgentInformation	Informations sur la version de l’agent Compute Node et l’heure à laquelle le nœud de calcul a été mis à niveau vers une nouvelle version. L’agent Batch Compute Node est un programme qui s’exécute sur chaque nœud de calcul du pool et fournit la fonctionnalité Batch sur le nœud de calcul.
recentTasks	TaskInformation[]	Liste des tâches dont l’état a récemment changé. Cette propriété est présente uniquement si au moins une tâche s’est exécutée sur ce nœud de calcul depuis qu’elle a été affectée au pool.
runningTaskSlotsCount	integer	Nombre total d’emplacements de planification utilisés par les tâches de travail en cours d’exécution sur le nœud de calcul. Cela inclut les tâches du gestionnaire de travaux et les tâches normales, mais pas la préparation du travail, la mise en production ou les tâches de démarrage.
runningTasksCount	integer	Nombre total de tâches de travail en cours d’exécution sur le nœud de calcul. Cela inclut les tâches du gestionnaire de travaux et les tâches normales, mais pas la préparation du travail, la mise en production ou les tâches de démarrage.
schedulingState	SchedulingState	Indique si le nœud de calcul est disponible pour la planification des tâches.
startTask	StartTask	Tâche spécifiée pour s’exécuter sur le nœud de calcul à mesure qu’il rejoint le pool. Batch effectue une nouvelle tentative de tâches lorsqu’une opération de récupération est déclenchée sur un nœud. Les exemples d’opérations de récupération incluent (mais ne sont pas limités à) lorsqu’un nœud non sain est redémarré ou qu’un nœud de calcul a disparu en raison d’une défaillance de l’hôte. Les nouvelles tentatives dues aux opérations de récupération sont indépendantes de et ne sont pas comptabilisées dans maxTaskRetryCount. Même si maxTaskRetryCount est 0, une nouvelle tentative interne en raison d’une opération de récupération peut se produire. Pour cette raison, toutes les tâches doivent être idempotentes. Cela signifie que les tâches doivent tolérer l’interruption et le redémarrage sans provoquer d’altération ou de doublon des données. La meilleure pratique pour les tâches de longue durée consiste à utiliser une forme de point de contrôle. Dans certains cas, starttask peut être réexécuter même si le nœud de calcul n’a pas été redémarré. Une attention particulière doit être prise pour éviter les tâches StartTasks qui créent un processus d’interruption ou installent/lancent des services à partir du répertoire de travail StartTask, car cela empêchera Batch de pouvoir réexécuter starttask.
startTaskInfo	StartTaskInformation	Informations d’exécution sur l’exécution de StartTask sur le nœud de calcul.
state	ComputeNodeState	État actuel du nœud de calcul. Le nœud de calcul spot/basse priorité a été préempté. Les tâches qui s’exécutaient sur le nœud de calcul lorsqu’il a été préempté seront replanifiées lorsqu’un autre nœud de calcul sera disponible.
stateTransitionTime	string	Heure à laquelle le nœud de calcul est entré dans son état actuel.
totalTasksRun	integer	Nombre total de tâches de travail effectuées sur le nœud de calcul. Cela inclut les tâches du gestionnaire de travaux et les tâches normales, mais pas la préparation du travail, la mise en production ou les tâches de démarrage.
totalTasksSucceeded	integer	Nombre total de tâches de travail qui se sont terminées avec succès (avec exitCode 0) sur le nœud de calcul. Cela inclut les tâches du gestionnaire de travaux et les tâches normales, mais pas la préparation du travail, la mise en production ou les tâches de démarrage.
url	string	URL du nœud de calcul.
virtualMachineInfo	VirtualMachineInfo	Informations sur l’état actuel de la machine virtuelle.
vmSize	string	Taille de la machine virtuelle hébergeant le nœud de calcul. Pour plus d’informations sur les tailles disponibles des machines virtuelles dans les pools, consultez Choisir une taille de machine virtuelle pour les nœuds de calcul dans un pool Azure Batch (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

ComputeNodeEndpointConfiguration

Configuration du point de terminaison pour le nœud de calcul.

Nom	Type	Description
inboundEndpoints	InboundEndpoint[]	Liste des points de terminaison entrants accessibles sur le nœud de calcul.

ComputeNodeError

Erreur rencontrée par un nœud de calcul.

Nom	Type	Description
code	string	Identificateur de l’erreur de nœud de calcul. Les codes sont invariants et sont destinés à être consommés par programmation.
errorDetails	NameValuePair[]	Liste des détails d’erreur supplémentaires liés à l’erreur de nœud de calcul.
message	string	Message décrivant l’erreur de nœud de calcul, destiné à être affiché dans une interface utilisateur.

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.

ComputeNodeState

État actuel du nœud de calcul.

Nom	Type	Description
creating	string	Le service Batch a obtenu la machine virtuelle sous-jacente à partir d’Azure Compute, mais il n’a pas encore commencé à rejoindre le pool.
idle	string	Le nœud de calcul n’exécute actuellement pas de tâche.
leavingpool	string	Le nœud de calcul quitte le pool, soit parce que l’utilisateur l’a supprimé explicitement, soit parce que le pool est en cours de redimensionnement ou de mise à l’échelle automatique.
offline	string	Le nœud de calcul n’exécute actuellement pas de tâche et la planification de nouvelles tâches sur le nœud de calcul est désactivée.
preempted	string	Le nœud de calcul spot/basse priorité a été préempté. Les tâches qui s’exécutaient sur le nœud de calcul lorsqu’il a été préempté seront replanifiées lorsqu’un autre nœud de calcul sera disponible.
rebooting	string	Le nœud de calcul redémarre.
reimaging	string	Le nœud de calcul est en cours de réinitialisation.
running	string	Le nœud de calcul exécute une ou plusieurs tâches (autres qu’une tâche StartTask).
starting	string	Le service Batch démarre sur la machine virtuelle sous-jacente.
starttaskfailed	string	StartTask a échoué sur le nœud de calcul (et a épuisé toutes les nouvelles tentatives), et waitForSuccess est défini. Le nœud de calcul n’est pas utilisable pour exécuter des tâches.
unknown	string	Le service Batch a perdu le contact avec le nœud de calcul et ne connaît pas son état réel.
unusable	string	Le nœud de calcul ne peut pas être utilisé pour l’exécution de la tâche en raison d’erreurs.
waitingforstarttask	string	StartTask a commencé à s’exécuter sur le nœud de calcul, mais waitForSuccess est défini et starttask n’est pas encore terminé.

ContainerRegistry

Registre de conteneurs privé.

Nom	Type	Description
identityReference	ComputeNodeIdentityReference	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. Référence à une identité affectée par l’utilisateur associée au pool Batch qu’un nœud de calcul utilisera.
password	string	Mot de passe pour se connecter au serveur de Registre.
registryServer	string	L’URL du registre. En cas d’omission, la valeur par défaut est « docker.io ».
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.

ErrorCategory

Catégorie de l’erreur.

Nom	Type	Description
servererror	string	L’erreur est due à un problème de serveur interne.
usererror	string	L’erreur est due à un problème utilisateur, tel qu’une configuration incorrecte.

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.

ImageReference

Référence à une image de la Place de marché Azure Machines Virtuelles ou à une image Azure Compute Gallery. Pour obtenir la liste de toutes les références d’images Place de marché Azure vérifiées par Azure Batch, consultez l’opération « Répertorier les images prises en charge ».

Nom	Type	Description
exactVersion	string	Version spécifique de l’image de plateforme ou de la Place de marché utilisée pour créer le nœud. Ce champ en lecture seule diffère de « version » uniquement si la valeur spécifiée pour « version » lors de la création du pool était « latest ».
offer	string	Type d’offre de l’image de la Place de marché Azure Machines Virtuelles. Par exemple, UbuntuServer ou WindowsServer.
publisher	string	Éditeur de l’image de la Place de marché Azure Machines Virtuelles. Par exemple, Canonical ou MicrosoftWindowsServer.
sku	string	Référence SKU de l’image de la Place de marché Azure Machines Virtuelles. Par exemple, 18.04-LTS ou 2019-Datacenter.
version	string	Version de l’image de la Place de marché Azure Machines Virtuelles. Vous pouvez spécifier la valeur « latest » pour sélectionner la dernière version d’une image. En cas d’omission, la valeur par défaut est « latest ».
virtualMachineImageId	string	Identificateur de ressource ARM de l’image Azure Compute Gallery. Les nœuds de calcul dans le pool seront créés à l’aide de cet ID d’image. Il s’agit de la forme /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} ou /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} pour toujours utiliser par défaut la dernière version d’image. Cette propriété s’exclue mutuellement avec d’autres propriétés ImageReference. L’image Azure Compute Gallery doit avoir des réplicas dans la même région et doit se trouver dans le même abonnement que le compte Azure Batch. Si la version de l’image n’est pas spécifiée dans l’imageId, la dernière version est utilisée. Pour plus d’informations sur les paramètres de pare-feu de l’agent de nœud de calcul Batch pour communiquer avec le service Batch, consultez https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

InboundEndpoint

Point de terminaison entrant sur un nœud de calcul.

Nom	Type	Description
backendPort	integer	Numéro de port principal du point de terminaison.
frontendPort	integer	Numéro de port public du point de terminaison.
name	string	Nom du point de terminaison.
protocol	InboundEndpointProtocol	Protocole du point de terminaison.
publicFQDN	string	Nom de domaine complet public pour le nœud de calcul.
publicIPAddress	string	Adresse IP publique du nœud de calcul.

InboundEndpointProtocol

Protocole du point de terminaison.

Nom	Type	Description
tcp	string	Utilisez TCP pour le point de terminaison.
udp	string	Utilisez UDP pour le point de terminaison.

NameValuePair

Représente une paire nom-valeur.

Nom	Type	Description
name	string	Nom dans la paire nom-valeur.
value	string	Valeur de la paire nom-valeur.

NodeAgentInformation

Informations sur l’agent Compute Node.

Nom	Type	Description
lastUpdateTime	string	Heure à laquelle l’agent Compute Node a été mis à jour sur le nœud de calcul. Il s’agit de la dernière fois que l’agent Compute Node a été mis à jour vers une nouvelle version.
version	string	Version de l’agent Batch Compute Node s’exécutant sur le nœud de calcul. Ce numéro de version peut être vérifié par rapport aux notes de publication de l’agent Compute Node situées à l’adresse https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.md.

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. Les propriétés autoStorageContainerName, storageContainerUrl et httpUrl s’excluent mutuellement et l’une d’elles doit être spécifiée.
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. La propriété est valide uniquement quand autoStorageContainerName ou storageContainerUrl est utilisé. Ce préfixe peut être un nom de fichier partiel ou un sous-répertoire. Si aucun préfixe n’est spécifié, tous les fichiers du conteneur sont téléchargés.
fileMode	string	Attribut du mode d’autorisation de fichier au format octal. Cette propriété s’applique uniquement aux fichiers téléchargés sur les nœuds de calcul Linux. Il sera ignoré s’il est spécifié pour un resourceFile qui sera téléchargé sur un nœud de calcul Windows. Si cette propriété n’est pas spécifiée pour un nœud de calcul Linux, la valeur par défaut 0770 est appliquée au fichier.
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. Si la propriété httpUrl est spécifiée, le filePath est obligatoire et décrit le chemin d’accès vers lequel le fichier sera téléchargé, y compris le nom de fichier. Sinon, si la propriété autoStorageContainerName ou storageContainerUrl est spécifiée, filePath est facultatif et est le répertoire vers lequel télécharger les fichiers. Dans le cas où filePath est utilisé comme répertoire, toute structure de répertoires déjà associée aux données d’entrée est conservée dans son intégralité et ajoutée au répertoire filePath spécifié. Le chemin d’accès relatif spécifié ne peut pas sortir du répertoire de travail de la tâche (par exemple, à l’aide de « .. »).
httpUrl	string	URL du fichier à télécharger. Les propriétés autoStorageContainerName, storageContainerUrl et httpUrl s’excluent mutuellement et l’une d’elles doit être spécifiée. Si l’URL pointe vers Stockage Blob Azure, elle doit être lisible à partir de nœuds de calcul. Il existe trois façons d’obtenir cette URL pour un objet blob dans le stockage Azure : inclure une signature d’accès partagé (SAP) accordant des autorisations de lecture sur l’objet blob, utiliser une identité managée avec une autorisation de lecture ou définir la liste de contrôle d’accès pour l’objet blob ou son conteneur afin d’autoriser l’accès public.
identityReference	ComputeNodeIdentityReference	Référence à l’identité affectée par l’utilisateur à utiliser pour accéder à Stockage Blob Azure spécifiée par storageContainerUrl ou httpUrl Référence à une identité affectée par l’utilisateur associée au pool Batch qu’un nœud de calcul utilisera.
storageContainerUrl	string	URL du conteneur d’objets blob dans Stockage Blob Azure. Les propriétés autoStorageContainerName, storageContainerUrl et httpUrl s’excluent mutuellement et l’une d’elles doit être spécifiée. Cette URL doit être lisible et listable à partir de nœuds de calcul. Il existe trois façons d’obtenir cette URL pour un conteneur dans le stockage Azure : inclure une signature d’accès partagé (SAP) accordant des autorisations de lecture et de liste sur le conteneur, utiliser une identité managée avec des autorisations de lecture et de liste, ou définir la liste de contrôle d’accès du conteneur pour autoriser l’accès public.

SchedulingState

Indique si le nœud de calcul est disponible pour la planification des tâches.

Nom	Type	Description
disabled	string	Aucune nouvelle tâche n’est planifiée sur le nœud de calcul. Les tâches déjà en cours d’exécution sur le nœud de calcul peuvent toujours s’exécuter jusqu’à l’achèvement. Tous les nœuds de calcul commencent avec la planification activée.
enabled	string	Les tâches peuvent être planifiées sur le nœud de calcul.

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. La ligne de commande ne s’exécute pas sous un interpréteur de commandes et ne peut donc pas tirer parti des fonctionnalités de l’interpréteur de commandes telles que l’expansion des variables d’environnement. Si vous souhaitez tirer parti de ces fonctionnalités, vous devez appeler l’interpréteur de commandes dans la ligne de commande, par exemple en utilisant « cmd /c MyCommand » dans Windows ou « /bin/sh -c MyCommand » dans Linux. Si la ligne de commande fait référence à des chemins de fichier, elle doit utiliser un chemin relatif (relatif au répertoire de travail De la tâche) ou utiliser la variable d’environnement fournie par Batch (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
containerSettings	TaskContainerSettings	Paramètres du conteneur sous lequel starttask s’exécute. Lorsque cela est spécifié, tous les répertoires sous le AZ_BATCH_NODE_ROOT_DIR (la racine des répertoires Azure Batch sur le nœud) sont mappés dans le conteneur, toutes les variables d’environnement de tâche sont mappées dans le conteneur et la ligne de commande Tâche est exécutée dans le conteneur. Les fichiers produits dans le conteneur en dehors de AZ_BATCH_NODE_ROOT_DIR peuvent ne pas être répercutés sur le disque hôte, ce qui signifie que les API de fichiers Batch ne pourront pas accéder à ces fichiers.
environmentSettings	EnvironmentSetting[]	Liste des paramètres de variable d’environnement pour startTask.
maxTaskRetryCount	integer	Nombre maximal de nouvelles tentatives de la tâche. Le service Batch retente une tâche si son code de sortie est différent de zéro. Notez que cette valeur contrôle spécifiquement le nombre de nouvelles tentatives. Le service Batch essaiera la tâche une fois, puis peut réessayer jusqu’à cette limite. Par exemple, si le nombre maximal de nouvelles tentatives est de 3, Batch tente la tâche jusqu’à 4 fois (une tentative initiale et 3 tentatives). Si le nombre maximal de nouvelles tentatives est 0, le service Batch ne réessaye pas la tâche. Si le nombre maximal de nouvelles tentatives est -1, le service Batch retente la tâche sans limite. Toutefois, cela n’est pas recommandé pour une tâche de démarrage ou une tâche. La valeur par défaut est 0 (aucune nouvelle tentative).
resourceFiles	ResourceFile[]	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. Les fichiers répertoriés sous cet élément se trouvent dans le répertoire de travail de la tâche.
userIdentity	UserIdentity	Identité de l’utilisateur sous laquelle starttask s’exécute. Si elle est omise, la tâche s’exécute en tant qu’utilisateur non administratif unique à la tâche.
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. Si la valeur est true et que startTask échoue sur un nœud, le service Batch retente starttask jusqu’à son nombre maximal de nouvelles tentatives (maxTaskRetryCount). Si la tâche n’est toujours pas terminée après toutes les nouvelles tentatives, le service Batch marque le nœud inutilisable et ne planifie pas les tâches. Cette condition peut être détectée via les détails de l’état du nœud de calcul et des informations d’échec. Si la valeur est false, le service Batch n’attend pas que starttask se termine. Dans ce cas, d’autres tâches peuvent commencer à s’exécuter sur le nœud de calcul pendant que starttask est toujours en cours d’exécution ; et même si starttask échoue, de nouvelles tâches continueront d’être planifiées sur le nœud de calcul. La valeur par défaut est true.

StartTaskInformation

Informations sur une tâche StartTask exécutée sur un nœud de calcul.

Nom	Type	Description
containerInfo	TaskContainerExecutionInformation	Informations sur le conteneur sous lequel la tâche s’exécute. Cette propriété est définie uniquement si la tâche s’exécute dans un contexte de conteneur.
endTime	string	Heure à laquelle starttask a cessé de s’exécuter. Il s’agit de l’heure de fin de l’exécution la plus récente de StartTask, si cette exécution est terminée (même si cette exécution a échoué et qu’une nouvelle tentative est en attente). Cet élément n’est pas présent si StartTask est en cours d’exécution.
exitCode	integer	Code de sortie du programme spécifié sur la ligne de commande StartTask. Cette propriété est définie uniquement si starttask est à l’état terminé. En général, le code de sortie d’un processus reflète la convention spécifique implémentée par le développeur d’applications pour ce processus. Si vous utilisez la valeur du code de sortie pour prendre des décisions dans votre code, veillez à connaître la convention de code de sortie utilisée par le processus d’application. Toutefois, si le service Batch met fin à StartTask (en raison du délai d’expiration ou de l’arrêt de l’utilisateur via l’API), vous pouvez voir un code de sortie défini par le système d’exploitation.
failureInfo	TaskFailureInformation	Informations décrivant l’échec de la tâche, le cas échéant. Cette propriété est définie uniquement si la tâche est à l’état terminé et a rencontré un échec.
lastRetryTime	string	Heure la plus récente à laquelle une nouvelle tentative de la tâche a commencé à s’exécuter. Cet élément est présent uniquement si la tâche a été retentée (c’est-à-dire que retryCount est différent de zéro). Le cas échéant, il s’agit généralement de la même valeur que startTime, mais peut être différent si la tâche a été redémarrée pour des raisons autres que la nouvelle tentative ; par exemple, si le nœud de calcul a été redémarré pendant une nouvelle tentative, startTime est mis à jour, mais pas lastRetryTime.
result	TaskExecutionResult	Résultat de l’exécution de la tâche. Si la valeur est « failed », les détails de l’échec se trouvent dans la propriété failureInfo.
retryCount	integer	Nombre de tentatives de la tâche par le service Batch. Les échecs d’application de tâche (code de sortie non nul) sont retentés, les erreurs de prétraitement (impossible d’exécuter la tâche) et les erreurs de chargement de fichier ne sont pas retentées. Le service Batch retentera la tâche jusqu’à la limite spécifiée par les contraintes.
startTime	string	Heure à laquelle starttask a commencé à s’exécuter. Cette valeur est réinitialisée chaque fois que la tâche est redémarrée ou retentée (autrement dit, il s’agit de l’heure la plus récente à laquelle l’exécution de StartTask a commencé).
state	StartTaskState	État de starttask sur le nœud de calcul.

StartTaskState

État du StartTask sur le nœud de calcul.

Nom	Type	Description
completed	string	StartTask s’est arrêté avec le code de sortie 0, ou startTask a échoué et la limite de nouvelles tentatives a été atteinte, ou le processus StartTask n’a pas été exécuté en raison d’erreurs de préparation des tâches (telles que des échecs de téléchargement de fichiers de ressources).
running	string	StartTask est en cours d’exécution.

TaskContainerExecutionInformation

Contient des informations sur le conteneur qu’une tâche exécute.

Nom	Type	Description
containerId	string	ID du conteneur.
error	string	Informations détaillées sur l’erreur sur le conteneur. Il s’agit de la chaîne d’erreur détaillée du service Docker, si disponible. Il équivaut au champ d’erreur retourné par « docker inspect ».
state	string	État du conteneur. Il s’agit de l’état du conteneur en fonction du service Docker. Il équivaut au champ status retourné par « docker inspect ».

TaskContainerSettings

Paramètres de conteneur pour une tâche.

Nom	Type	Description
containerRunOptions	string	Options supplémentaires de la commande de création de conteneur. Ces options supplémentaires sont fournies sous forme d’arguments à la commande « docker create », en plus de celles contrôlées par le service Batch.
imageName	string	Image à utiliser pour créer le conteneur dans lequel la tâche s’exécutera. Il s’agit de la référence d’image complète, comme serait spécifié sur « docker pull ». Si aucune balise n’est fournie dans le cadre du nom de l’image, la balise « :latest » est utilisée par défaut.
registry	ContainerRegistry	Registre privé qui contient l’image conteneur. Ce paramètre peut être omis s’il a déjà été fourni lors de la création du pool.
workingDirectory	ContainerWorkingDirectory	Emplacement du répertoire de travail de la tâche du conteneur. La valeur par défaut est « taskWorkingDirectory ».

TaskExecutionInformation

Informations sur l’exécution d’une tâche.

Nom	Type	Description
containerInfo	TaskContainerExecutionInformation	Informations sur le conteneur sous lequel la tâche s’exécute. Cette propriété est définie uniquement si la tâche s’exécute dans un contexte de conteneur.
endTime	string	Heure à laquelle la tâche s’est terminée. Cette propriété est définie uniquement si la tâche est à l’état Terminé.
exitCode	integer	Code de sortie du programme spécifié sur la ligne de commande Tâche. Cette propriété est définie uniquement si la tâche est à l’état terminé. En général, le code de sortie d’un processus reflète la convention spécifique implémentée par le développeur d’application pour ce processus. Si vous utilisez la valeur du code de sortie pour prendre des décisions dans votre code, veillez à connaître la convention du code de sortie utilisée par le processus d’application. Toutefois, si le service Batch met fin à la tâche (en raison d’un délai d’expiration ou d’un arrêt de l’utilisateur via l’API), vous pouvez voir un code de sortie défini par le système d’exploitation.
failureInfo	TaskFailureInformation	Informations décrivant l’échec de la tâche, le cas échéant. Cette propriété est définie uniquement si la tâche est à l’état terminé et a rencontré un échec.
lastRequeueTime	string	Heure la plus récente à laquelle la tâche a été mise en file d’attente par le service Batch à la suite d’une demande utilisateur. Cette propriété est définie uniquement si requeueCount est différent de zéro.
lastRetryTime	string	Heure la plus récente à laquelle une nouvelle tentative de la tâche a commencé à s’exécuter. Cet élément n’est présent que si la tâche a été retentée (c’est-à-dire que retryCount est différent de zéro). S’il est présent, cela est généralement identique à startTime, mais peut être différent si la tâche a été redémarrée pour des raisons autres que de réessayer ; par exemple, si le nœud de calcul a été redémarré lors d’une nouvelle tentative, le startTime est mis à jour, mais le lastRetryTime ne l’est pas.
requeueCount	integer	Nombre de fois où la tâche a été mise en file d’attente par le service Batch à la suite d’une demande utilisateur. Lorsque l’utilisateur supprime des nœuds de calcul d’un pool (en redimensionnement/réduction du pool) ou lorsque le travail est désactivé, l’utilisateur peut spécifier que les tâches en cours d’exécution sur les nœuds de calcul doivent être remises en file d’attente pour exécution. Ce nombre permet de suivre le nombre de fois où la tâche a été mise en file d’attente pour ces raisons.
result	TaskExecutionResult	Résultat de l’exécution de la tâche. Si la valeur est « failed », les détails de l’échec se trouvent dans la propriété failureInfo.
retryCount	integer	Nombre de fois où la tâche a été retentée par le service Batch. Les échecs d’application de tâche (code de sortie non nul) sont retentés, les erreurs de prétraitement (la tâche n’a pas pu être exécutée) et les erreurs de chargement de fichiers ne sont pas retentées. Le service Batch effectue une nouvelle tentative de la tâche jusqu’à la limite spécifiée par les contraintes.
startTime	string	Heure à laquelle la tâche a commencé à s’exécuter. « En cours d’exécution » correspond à l’état d’exécution. Par conséquent, si la tâche spécifie des fichiers de ressources ou des packages, l’heure de début reflète l’heure à laquelle la tâche a commencé à télécharger ou à déployer ces fichiers. Si la tâche a été redémarrée ou retentée, il s’agit de l’heure la plus récente à laquelle l’exécution de la tâche a commencé. Cette propriété est présente uniquement pour les tâches en cours d’exécution ou terminées.

TaskExecutionResult

Résultat de l’exécution de la tâche.

Nom	Type	Description
failure	string	Une erreur s’est produite lors du traitement de la tâche. L’échec peut s’être produit avant le lancement du processus de tâche, pendant l’exécution du processus de tâche ou après la fin du processus de tâche.
success	string	La tâche s’est exécutée avec succès.

TaskFailureInformation

Informations sur un échec de tâche.

Nom	Type	Description
category	ErrorCategory	Catégorie de l’erreur de tâche.
code	string	Identificateur de l’erreur de tâche. Les codes sont invariants et sont destinés à être consommés par programmation.
details	NameValuePair[]	Liste des détails supplémentaires liés à l’erreur.
message	string	Message décrivant l’erreur de tâche, destiné à être adapté à l’affichage dans une interface utilisateur.

TaskInformation

Informations sur une tâche en cours d’exécution sur un nœud de calcul.

Nom	Type	Description
executionInfo	TaskExecutionInformation	Informations sur l’exécution de la tâche.
jobId	string	ID du travail auquel appartient la tâche.
subtaskId	integer	ID de la tâche subordonnée si la tâche est une tâche multi-instance.
taskId	string	ID de la tâche.
taskState	TaskState	État actuel de la tâche.
taskUrl	string	URL de la tâche.

TaskState

État de la tâche.

Nom	Type	Description
active	string	La tâche est mise en file d’attente et peut s’exécuter, mais n’est actuellement pas affectée à un nœud de calcul. Une tâche passe à cet état lorsqu’elle est créée, lorsqu’elle est activée après avoir été désactivée ou lorsqu’elle attend une nouvelle tentative après un échec d’exécution.
completed	string	La tâche n’est plus éligible à l’exécution, généralement parce qu’elle s’est terminée correctement, ou parce que la tâche a échoué et a épuisé sa limite de nouvelles tentatives. Une tâche est également marquée comme terminée si une erreur s’est produite au lancement de la tâche ou lorsque la tâche a été arrêtée.
preparing	string	La tâche a été affectée à un nœud de calcul, mais elle attend qu’une tâche de préparation du travail requise se termine sur le nœud de calcul. Si la tâche de préparation du travail réussit, la tâche passe à l’exécution. Si la tâche de préparation du travail échoue, la tâche revient à active et peut être affectée à un autre nœud de calcul.
running	string	La tâche s’exécute sur un nœud de calcul. Cela inclut la préparation au niveau de la tâche, telle que le téléchargement des fichiers de ressources ou le déploiement de packages spécifiés sur la tâche. Cela ne signifie pas nécessairement que la ligne de commande Tâche a commencé à s’exécuter.

UserIdentity

Définition de l’identité utilisateur sous laquelle la tâche est exécutée.

Nom	Type	Description
autoUser	AutoUserSpecification	Utilisateur automatique sous lequel la tâche est exécutée. Les propriétés userName et autoUser s’excluent mutuellement ; vous devez en spécifier un, mais pas les deux.
username	string	Nom de l’identité utilisateur sous laquelle la tâche est exécutée. Les propriétés userName et autoUser s’excluent mutuellement ; vous devez en spécifier un, mais pas les deux.

VirtualMachineInfo

Informations sur l’état actuel de la machine virtuelle.

Nom	Type	Description
imageReference	ImageReference	Référence à l’image de la Place de marché de la machine virtuelle Azure.
scaleSetVmResourceId	string	ID de ressource de la machine virtuelle actuelle du groupe de machines virtuelles identiques du nœud de calcul. Défini uniquement si le compte Batch a été créé avec sa propriété poolAllocationMode définie sur « UserSubscription ».