BatchClient class
Classe client pour accéder au service Azure Batch.
Constructeurs
| Batch |
Méthodes
| create |
Le service Batch prend en charge deux façons de contrôler le travail effectué dans le cadre d’un Job. Dans la première approche, l’utilisateur spécifie une tâche du gestionnaire de tâches. Le service Batch lance cette tâche lorsqu’il est prêt à démarrer le Job. La tâche du gestionnaire de tâches contrôle toutes les autres tâches qui s’exécutent sous ce travail, en utilisant les API des tâches. Dans la seconde approche, l’utilisateur contrôle directement l’exécution des tâches sous un travail actif, en utilisant les API de tâches. Notez également : lors du nommage des emplois, évitez d’inclure des informations sensibles telles que des noms d’utilisateur ou des noms secrets de projets. Ces informations peuvent apparaître dans les journaux de télémétrie accessibles aux ingénieurs du support technique Microsoft. |
| create |
Crée un planning de tâches pour le compte spécifié. |
| create |
Vous pouvez ajouter un compte utilisateur à un nœud de calcul uniquement lorsqu’il est en état d’inactivité ou en cours d’exécution. Avant de pouvoir vous connecter à distance à un nœud de calcul, vous devez configurer les ports d’accès pour SSH et RDP. Pour plus d’informations, consultez https://learn.microsoft.com/azure/batch/pool-endpoint-configuration |
| create |
Lorsque vous nommez des pools, évitez d’inclure des informations sensibles telles que des noms d’utilisateur ou des noms de projet secrets. Ces informations peuvent apparaître dans les journaux de télémétrie accessibles aux ingénieurs du support technique Microsoft. |
| create |
La durée de vie maximale d’une tâche, de l’ajout à l’achèvement, est de 180 jours. Si une tâche n’a pas été terminée dans les 180 jours suivant son ajout, elle sera terminée par le service Batch et laissée dans l’état où elle se trouvait à ce moment-là. |
| create |
Notez que chaque tâche doit avoir un ID unique. Le service Batch ne peut pas retourner les résultats de chaque Tâche dans le même ordre que celles soumises dans cette requête. Si le serveur expire ou si la connexion est fermée pendant la requête, la requête peut avoir été partiellement ou totalement traitée, ou pas du tout. Dans de tels cas, l’utilisateur doit réémettre la demande. Notez qu’il revient à l’utilisateur de gérer correctement les pannes lors de la réémission d’une requête. Par exemple, vous devriez utiliser les mêmes identifiants de tâche lors d’une réévaluation afin que, si l’opération précédente a réussi, la réévaluation ne crée pas de tâches supplémentaires de façon inattendue. Si la réponse contient des tâches qui n’ont pas été ajoutées, un client peut réessayer la requête. Lors d’une nouvelle tentative, il est plus efficace de soumettre à nouveau uniquement les tâches qui n’ont pas été ajoutées, et d’omettre les tâches ajoutées avec succès dès la première tentative. La durée de vie maximale d’une tâche, de l’ajout à l’achèvement, est de 180 jours. Si une tâche n’a pas été terminée dans les 180 jours suivant son ajout, elle sera terminée par le service Batch et laissée dans l’état où elle se trouvait à ce moment-là. |
| deallocate |
Vous pouvez libérer un nœud de calcul uniquement s’il est dans un état inactif ou en cours d’exécution. |
| delete |
Supprimer un poste supprime également toutes les tâches qui font partie de ce poste, ainsi que toutes les statistiques du poste. Cela supprime également la période de conservation des données de la tâche ; c’est-à-dire que si le Job contient des Tâches qui sont encore conservées sur les Nœuds de Calcul, les services Batch suppriment les répertoires de travail de ces Tâches et tout leur contenu. Lorsqu’une requête de Suppression de Job est reçue, le service Batch place la Job à l’état de suppression. Toutes les opérations de mise à jour sur un Job en état de suppression échoueront avec le code d’état 409 (Conflit), avec des informations supplémentaires indiquant que le Job est en train d’être supprimé. |
| delete |
Lorsque vous supprimez un planning de tâches, cela supprime aussi tous les emplois et tâches sous ce planning. Lorsque les tâches sont supprimées, tous les fichiers de leurs répertoires de travail sur les nœuds de calcul sont également supprimés (la période de conservation est ignorée). Les statistiques du planning de poste ne sont plus accessibles une fois le planning supprimé, bien qu’elles soient toujours prises en compte dans les statistiques de vie du compte. |
| delete |
Supprime le fichier spécifié du nœud de calcul. |
| delete |
Vous ne pouvez supprimer un compte utilisateur vers un nœud de calcul que lorsqu’il est en état d’inactivité ou en cours d’exécution. Avant de pouvoir vous connecter à distance à un nœud de calcul, vous devez configurer les ports d’accès pour SSH et RDP. Pour plus d’informations, consultez https://learn.microsoft.com/azure/batch/pool-endpoint-configuration |
| delete |
Lorsque vous demandez qu’un pool soit supprimé, les actions suivantes se produisent : l’état du pool est défini sur la suppression ; toute opération de redimensionnement en cours sur le pool est arrêtée ; le service Batch démarre le redimensionnement du pool sur zéro nœuds de calcul ; toutes les tâches exécutées sur des nœuds de calcul existants sont arrêtées et requeuées (comme si une opération de redimensionnement de pool avait été demandée avec l’option de mise en file d’attente par défaut) ; enfin, le pool est supprimé du système. Étant donné que les tâches en cours d’exécution sont requeuées, l’utilisateur peut réexécuter ces tâches en mettant à jour leur travail pour cibler un autre pool. Les tâches peuvent ensuite s’exécuter sur le nouveau pool. Si vous souhaitez remplacer le comportement de mise en file d’attente, vous devez appeler le pool de redimensionnement explicitement pour réduire la taille zéro du pool avant de supprimer le pool. Si vous appelez une API Update, Patch ou Delete sur un pool dans l’état de suppression, elle échoue avec le code d’état HTTP 409 avec le code d’erreur PoolBeingDeleted. |
| delete |
Lorsqu’une tâche est supprimée, tous les fichiers de son dossier sur le nœud de calcul où elle a été exécutée sont également supprimés (quel que soit le temps de rétention). Pour les tâches multi-instances, l’opération de suppression de la tâche s’applique de manière synchrone à la tâche principale ; les sous-tâches et leurs fichiers sont ensuite supprimés de manière asynchrone en arrière-plan. |
| delete |
Supprime le fichier Tâche spécifié du nœud de calcul où la tâche s’est exécutée. |
| disable |
Le service de traitement déplace immédiatement le poste en état de désactivation. Batch utilise ensuite le paramètre disableTasks pour déterminer quoi faire des tâches du travail en cours d’exécution. Le Job reste en état de désactivation jusqu’à ce que l’opération de désactivation soit terminée et que toutes les Tâches soient traitées selon l’option disableTasks ; le Job passe alors à l’État handicapé. Aucune nouvelle tâche n’est lancée sous le poste tant qu’il ne revient pas en état actif. Si vous essayez de désactiver un Job dans un état autre que actif, désactivé ou désactivé, la requête échoue avec le code de statut 409. |
| disable |
Aucun nouveau poste ne sera créé tant que le planning des emplois ne sera pas réactivé. |
| disable |
Vous pouvez désactiver la planification des tâches sur un nœud de calcul uniquement si son état de planification actuel est activé. |
| disable |
Désactive la mise à l’échelle automatique d’un pool. |
| enable |
Lorsque vous appelez cette API, le service Batch place un Job désactivé à l’état d’activation. Après l’achèvement de cette opération, le poste passe à l’état actif, et la planification des nouvelles tâches sous le poste reprend. Le service Batch ne permet pas à une tâche de rester en état actif plus de 180 jours. Par conséquent, si vous activez un Job contenant des Tâches actives ajoutées il y a plus de 180 jours, ces Tâches ne s’exécuteront pas. |
| enable |
Permet d’établir un planning de travail. |
| enable |
Vous pouvez activer la planification des tâches sur un nœud de calcul uniquement si son état de planification actuel est désactivé |
| enable |
Vous ne pouvez pas activer la mise à l’échelle automatique sur un pool si une opération de redimensionnement est en cours sur le pool. Si la mise à l’échelle automatique du pool est actuellement désactivée, vous devez spécifier une formule de mise à l’échelle automatique valide dans le cadre de la requête. Si la mise à l’échelle automatique du pool est déjà activée, vous pouvez spécifier une nouvelle formule de mise à l’échelle automatique et/ou un nouvel intervalle d’évaluation. Vous ne pouvez pas appeler cette API pour le même pool plusieurs fois toutes les 30 secondes. |
| evaluate |
Cette API est principalement destinée à valider une formule de mise à l’échelle automatique, car elle retourne simplement le résultat sans appliquer la formule au pool. Le pool doit avoir la mise à l’échelle automatique activée pour évaluer une formule. |
| get |
Cette opération ne retourne que les applications et versions disponibles pour une utilisation sur les nœuds de calcul ; c’est-à-dire qu’elle peut être utilisée dans une référence de paquet. Pour des informations d’administrateur sur les applications et versions qui ne sont pas encore disponibles pour les nœuds de calcul, utilisez le portail Azure ou l’API Azure Resource Manager. |
| get |
Obtient des informations sur le poste spécifié. |
| get |
Obtient des informations sur le planning de travail spécifié. |
| get |
Les comptes de tâches fournissent un compte des tâches par état actif, en cours ou terminé, ainsi qu’un compte des tâches qui ont réussi ou échoué. Les tâches dans l’état de préparation sont comptabilisées comme étant en cours d’exécution. Notez que les nombres retournés peuvent ne pas toujours être à jour. Si vous avez besoin d’un nombre exact de tâches, utilisez une requête par liste. |
| get |
Obtient des informations sur le nœud de calcul spécifié. |
| get |
Obtient des informations sur l’extension de nœud de calcul spécifiée. |
| get |
Retourne le contenu du fichier Compute Node spécifié. |
| get |
Obtient les propriétés du fichier Compute Node spécifié. |
| get |
Avant de pouvoir vous connecter à distance à un nœud de calcul en utilisant les paramètres de connexion à distance, vous devez créer un compte utilisateur sur le nœud de calcul et configurer les ports d’accès pour SSH et RDP. Pour plus d’informations, consultez https://learn.microsoft.com/azure/batch/pool-endpoint-configuration |
| get |
Obtient des informations sur le pool spécifié. |
| get |
Pour les tâches multi-instances, des informations telles qu’affinityId, executionInfo et nodeInfo font référence à la tâche principale. Utilisez l’API des sous-tâches de liste pour récupérer des informations sur les sous-tâches. |
| get |
Retourne le contenu du fichier Task spécifié. |
| get |
Obtient les propriétés du fichier Task spécifié. |
| job |
Vérifie que le planning de poste spécifié existe. |
| list |
Cette opération ne retourne que les applications et versions disponibles pour une utilisation sur les nœuds de calcul ; c’est-à-dire qu’elle peut être utilisée dans une référence de paquet. Pour des informations d’administrateur sur les applications et versions qui ne sont pas encore disponibles pour Compute Nodes, utilisez le portail Azure ou l’API Azure Resource Manager. |
| list |
Cette API renvoie le statut de la tâche de préparation de tâche et de publication de tâches sur tous les nœuds de calcul qui ont exécuté la tâche de préparation ou de libération de tâches. Cela inclut les nœuds de calcul qui ont depuis été retirés du pool. Si cette API est invoquée sur un Job qui n’a ni Job Preparation ni Job Release Task, le service Batch renvoie le code d’état HTTP 409 (Conflit) avec un code d’erreur JobPreparationTaskNotSpecified. |
| list |
Liste tous les emplois dans le compte spécifié. |
| list |
Liste tous les plannings de tâches dans le compte spécifié. |
| list |
Liste les emplois créés selon le calendrier des tâches spécifié. |
| list |
Liste les extensions des nœuds de calcul dans le pool spécifié. |
| list |
Liste tous les fichiers dans les répertoires des tâches sur le nœud de calcul spécifié. |
| list |
Liste les nœuds de calcul dans le pool spécifié. |
| list |
Obtient le nombre de nœuds de calcul dans chaque état, regroupés par pool. Notez que les nombres retournés peuvent ne pas toujours être à jour. Si vous avez besoin d’un nombre exact de nœuds, utilisez une requête de liste. |
| list |
Répertorie tous les pools dans le compte spécifié. |
| list |
Si vous ne spécifiez pas de clause $filter incluant un poolId, la réponse inclut tous les pools qui existaient dans le compte dans l’intervalle de temps des intervalles d’agrégation retournés. Si vous ne spécifiez pas de clause $filter incluant un startTime ou endTime, ces filtres sont par défaut les heures de début et de fin de la dernière intervalle d’agrégation actuellement disponible ; autrement dit, seul le dernier intervalle d’agrégation est retourné. |
| list |
Si la tâche n’est pas une tâche multi-instance, cela retourne une collection vide. |
| list |
Répertorie toutes les images de machine virtuelle prises en charge par le service Azure Batch. |
| list |
Liste les fichiers dans le répertoire d’une tâche sur son nœud de calcul. |
| list |
Pour les tâches multi-instances, des informations telles qu’affinityId, executionInfo et nodeInfo font référence à la tâche principale. Utilisez l’API des sous-tâches de liste pour récupérer des informations sur les sous-tâches. |
| pool |
Ça obtient les propriétés de base d’un pool. |
| reactivate |
La réactivation rend une tâche éligible à être reprise jusqu’à son maximum de réessays. L’état de la tâche est changé en actif. Comme la tâche n’est plus dans l’état terminé, tout code de sortie ou information de défaillance n’est plus disponible après la réactivation. Chaque fois qu’une Tâche est réactivée, son nombre de tentatives est réinitialisé à zéro. La réactivation échouera pour les tâches non terminées ou déjà terminées avec succès (avec un code de sortie de 0). De plus, il échouera si le travail est terminé (ou est en train de se terminer ou de le supprimer). |
| reboot |
Vous pouvez redémarrer un nœud de calcul uniquement s’il est dans un état inactif ou en cours d’exécution. |
| reimage |
Vous pouvez réinstaller le système d’exploitation sur un nœud de calcul uniquement s’il est dans un état inactif ou en cours d’exécution. Cette API ne peut être invoquée que sur les pools créés avec la propriété de configuration du service cloud. |
| remove |
Cette opération ne peut s’exécuter que lorsque l’état d’allocation du pool est stable. Lorsque cette opération s’exécute, l’état d’allocation passe du redimensionnement stable au redimensionnement. Chaque requête peut supprimer jusqu’à 100 nœuds. |
| replace |
Cela remplace entièrement toutes les propriétés actualisables du Job. Par exemple, si le Job a des contraintes associées et si cette contrainte n’est pas spécifiée avec cette requête, alors le service Batch supprimera les contraintes existantes. |
| replace |
Cela remplace entièrement toutes les propriétés de mise à jour de l’Emploi Planifié. Par exemple, si la propriété de l’annexe n’est pas spécifiée avec cette requête, alors le service Batch supprimera l’ordonnance existante. Les modifications d’un planning de tâches n’affectent que les emplois créés par le planning après la mise à jour ; Les emplois actuellement en cours ne sont pas affectés. |
| replace |
Cette opération remplace toutes les propriétés actualisables du Compte. Par exemple, si l’élément expiryTime n’est pas spécifié, la valeur actuelle est remplacée par la valeur par défaut, et non modifiée. Vous ne pouvez mettre à jour un compte utilisateur sur un nœud de calcul que lorsqu’il est en état d’inactivité ou en cours d’exécution. |
| replace |
Cela remplace entièrement toutes les propriétés actualisables de la piscine. Par exemple, si le pool a une StartTask associée et si StartTask n’est pas spécifié avec cette requête, alors le service Batch supprimera la StartTask existante. |
| replace |
Met à jour les propriétés de la tâche spécifiée. |
| resize |
Vous ne pouvez redimensionner un pool que lorsque son état d’allocation est stable. Si le redimensionnement du pool est déjà effectué, la demande échoue avec le code d’état 409. Lorsque vous redimensionnez un pool, l’état d’allocation du pool passe du redimensionnement stable au redimensionnement. Vous ne pouvez pas redimensionner les pools configurés pour la mise à l’échelle automatique. Si vous essayez de le faire, le service Batch retourne une erreur 409. Si vous redimensionnez un pool vers le bas, le service Batch choisit les nœuds de calcul à supprimer. Pour supprimer des nœuds de calcul spécifiques, utilisez plutôt l’API Nœuds de calcul. |
| start |
Vous ne pouvez lancer un nœud de calcul que s’il a été déalloué. |
| stop |
Cela ne restaure pas le Pool à son état précédent avant l’opération de redimensionnement : cela ne fait qu’empêcher toute modification ultérieure, et le Pool maintient son état actuel. Après l’arrêt, le pool se stabilise au nombre de nœuds de calcul où il se trouvait au moment de l’opération d’arrêt. Pendant l’opération d’arrêt, l’état d’allocation du pool passe d’abord à l’arrêt puis à l’état stable. Une opération de redimensionnement n’a pas besoin d’être une demande explicite de pool de redimensionnement ; cette API peut également être utilisée pour arrêter la dimension initiale du Pool lors de sa création. |
| terminate |
Lorsqu’une demande de Terminer la tâche est reçue, le service Batch place la tâche à l’état de terminaison. Le service Batch termine alors toutes les tâches en cours associées au Job et exécute toutes les tâches de libération de tâches requises. Ensuite, le Job passe à l’état de complété. S’il y a des tâches dans le poste en état actif, elles resteront en état actif. Une fois qu’un Job est terminé, de nouvelles Tâches ne peuvent plus être ajoutées et les Tâches restantes actives ne seront pas planifiées. |
| terminate |
Met fin à un planning de travail. |
| terminate |
Lorsque la tâche est terminée, elle passe à l’état terminé. Pour les tâches multi-instances, l’opération de terminer la tâche s’applique de manière synchrone à la tâche principale ; Les sous-tâches sont alors terminées de manière asynchrone en arrière-plan. |
| update |
Cela remplace uniquement les propriétés du Job spécifiées dans la requête. Par exemple, si le Job a des contraintes et qu’une requête ne spécifie pas l’élément de contrainte, alors le Job conserve les contraintes existantes. |
| update |
Cela remplace uniquement les propriétés de l’horaire de travail spécifiées dans la demande. Par exemple, si la propriété de l’ordonnance n’est pas spécifiée avec cette requête, alors le service Batch conservera l’ordonnance existante. Les modifications d’un planning de tâches n’affectent que les emplois créés par le planning après la mise à jour ; Les emplois actuellement en cours ne sont pas affectés. |
| update |
Cela ne remplace que les propriétés du Pool spécifiées dans la requête. Par exemple, si le Pool a une StartTask associée, et qu’une requête ne spécifie pas un élément StartTask, alors le Pool conserve la StartTask existante. |
| upload |
Ceci est destiné à collecter automatisément les fichiers journaux de service Azure Batch depuis les nœuds de calcul si vous rencontrez une erreur et souhaitez passer à l’aide Azure. Les fichiers journaux du service Azure Batch doivent être partagés avec la prise en charge d’Azure pour faciliter le débogage des problèmes avec le service Batch. |
Détails du constructeur
BatchClient(string, TokenCredential | AzureNamedKeyCredential, BatchClientOptionalParams)
new BatchClient(endpointParam: string, credential: TokenCredential | AzureNamedKeyCredential, options?: BatchClientOptionalParams)Paramètres
- endpointParam
-
string
- credential
- options
- BatchClientOptionalParams
Détails de la méthode
createJob(BatchJobCreateOptions, CreateJobOptionalParams)
Le service Batch prend en charge deux façons de contrôler le travail effectué dans le cadre d’un Job. Dans la première approche, l’utilisateur spécifie une tâche du gestionnaire de tâches. Le service Batch lance cette tâche lorsqu’il est prêt à démarrer le Job. La tâche du gestionnaire de tâches contrôle toutes les autres tâches qui s’exécutent sous ce travail, en utilisant les API des tâches. Dans la seconde approche, l’utilisateur contrôle directement l’exécution des tâches sous un travail actif, en utilisant les API de tâches. Notez également : lors du nommage des emplois, évitez d’inclure des informations sensibles telles que des noms d’utilisateur ou des noms secrets de projets. Ces informations peuvent apparaître dans les journaux de télémétrie accessibles aux ingénieurs du support technique Microsoft.
function createJob(job: BatchJobCreateOptions, options?: CreateJobOptionalParams): Promise<void>Paramètres
- options
- CreateJobOptionalParams
Retours
Promise<void>
createJobSchedule(BatchJobScheduleCreateOptions, CreateJobScheduleOptionalParams)
Crée un planning de tâches pour le compte spécifié.
function createJobSchedule(jobSchedule: BatchJobScheduleCreateOptions, options?: CreateJobScheduleOptionalParams): Promise<void>Paramètres
- jobSchedule
- BatchJobScheduleCreateOptions
- options
- CreateJobScheduleOptionalParams
Retours
Promise<void>
createNodeUser(string, string, BatchNodeUserCreateOptions, CreateNodeUserOptionalParams)
Vous pouvez ajouter un compte utilisateur à un nœud de calcul uniquement lorsqu’il est en état d’inactivité ou en cours d’exécution. Avant de pouvoir vous connecter à distance à un nœud de calcul, vous devez configurer les ports d’accès pour SSH et RDP. Pour plus d’informations, consultez https://learn.microsoft.com/azure/batch/pool-endpoint-configuration
function createNodeUser(poolId: string, nodeId: string, user: BatchNodeUserCreateOptions, options?: CreateNodeUserOptionalParams): Promise<void>Paramètres
- poolId
-
string
- nodeId
-
string
- options
- CreateNodeUserOptionalParams
Retours
Promise<void>
createPool(BatchPoolCreateOptions, CreatePoolOptionalParams)
Lorsque vous nommez des pools, évitez d’inclure des informations sensibles telles que des noms d’utilisateur ou des noms de projet secrets. Ces informations peuvent apparaître dans les journaux de télémétrie accessibles aux ingénieurs du support technique Microsoft.
function createPool(pool: BatchPoolCreateOptions, options?: CreatePoolOptionalParams): Promise<void>Paramètres
- options
- CreatePoolOptionalParams
Retours
Promise<void>
createTask(string, BatchTaskCreateOptions, CreateTaskOptionalParams)
La durée de vie maximale d’une tâche, de l’ajout à l’achèvement, est de 180 jours. Si une tâche n’a pas été terminée dans les 180 jours suivant son ajout, elle sera terminée par le service Batch et laissée dans l’état où elle se trouvait à ce moment-là.
function createTask(jobId: string, task: BatchTaskCreateOptions, options?: CreateTaskOptionalParams): Promise<void>Paramètres
- jobId
-
string
- options
- CreateTaskOptionalParams
Retours
Promise<void>
createTaskCollection(string, BatchTaskGroup, CreateTaskCollectionOptionalParams)
Notez que chaque tâche doit avoir un ID unique. Le service Batch ne peut pas retourner les résultats de chaque Tâche dans le même ordre que celles soumises dans cette requête. Si le serveur expire ou si la connexion est fermée pendant la requête, la requête peut avoir été partiellement ou totalement traitée, ou pas du tout. Dans de tels cas, l’utilisateur doit réémettre la demande. Notez qu’il revient à l’utilisateur de gérer correctement les pannes lors de la réémission d’une requête. Par exemple, vous devriez utiliser les mêmes identifiants de tâche lors d’une réévaluation afin que, si l’opération précédente a réussi, la réévaluation ne crée pas de tâches supplémentaires de façon inattendue. Si la réponse contient des tâches qui n’ont pas été ajoutées, un client peut réessayer la requête. Lors d’une nouvelle tentative, il est plus efficace de soumettre à nouveau uniquement les tâches qui n’ont pas été ajoutées, et d’omettre les tâches ajoutées avec succès dès la première tentative. La durée de vie maximale d’une tâche, de l’ajout à l’achèvement, est de 180 jours. Si une tâche n’a pas été terminée dans les 180 jours suivant son ajout, elle sera terminée par le service Batch et laissée dans l’état où elle se trouvait à ce moment-là.
function createTaskCollection(jobId: string, taskCollection: BatchTaskGroup, options?: CreateTaskCollectionOptionalParams): Promise<BatchCreateTaskCollectionResult>Paramètres
- jobId
-
string
- taskCollection
- BatchTaskGroup
Retours
Promise<BatchCreateTaskCollectionResult>
deallocateNode(string, string, DeallocateNodeOptionalParams)
Vous pouvez libérer un nœud de calcul uniquement s’il est dans un état inactif ou en cours d’exécution.
function deallocateNode(poolId: string, nodeId: string, options?: DeallocateNodeOptionalParams): PollerLike<OperationState<void>, void>Paramètres
- poolId
-
string
- nodeId
-
string
- options
- DeallocateNodeOptionalParams
Retours
PollerLike<OperationState<void>, void>
deleteJob(string, DeleteJobOptionalParams)
Supprimer un poste supprime également toutes les tâches qui font partie de ce poste, ainsi que toutes les statistiques du poste. Cela supprime également la période de conservation des données de la tâche ; c’est-à-dire que si le Job contient des Tâches qui sont encore conservées sur les Nœuds de Calcul, les services Batch suppriment les répertoires de travail de ces Tâches et tout leur contenu. Lorsqu’une requête de Suppression de Job est reçue, le service Batch place la Job à l’état de suppression. Toutes les opérations de mise à jour sur un Job en état de suppression échoueront avec le code d’état 409 (Conflit), avec des informations supplémentaires indiquant que le Job est en train d’être supprimé.
function deleteJob(jobId: string, options?: DeleteJobOptionalParams): PollerLike<OperationState<void>, void>Paramètres
- jobId
-
string
- options
- DeleteJobOptionalParams
Retours
PollerLike<OperationState<void>, void>
deleteJobSchedule(string, DeleteJobScheduleOptionalParams)
Lorsque vous supprimez un planning de tâches, cela supprime aussi tous les emplois et tâches sous ce planning. Lorsque les tâches sont supprimées, tous les fichiers de leurs répertoires de travail sur les nœuds de calcul sont également supprimés (la période de conservation est ignorée). Les statistiques du planning de poste ne sont plus accessibles une fois le planning supprimé, bien qu’elles soient toujours prises en compte dans les statistiques de vie du compte.
function deleteJobSchedule(jobScheduleId: string, options?: DeleteJobScheduleOptionalParams): PollerLike<OperationState<void>, void>Paramètres
- jobScheduleId
-
string
- options
- DeleteJobScheduleOptionalParams
Retours
PollerLike<OperationState<void>, void>
deleteNodeFile(string, string, string, DeleteNodeFileOptionalParams)
Supprime le fichier spécifié du nœud de calcul.
function deleteNodeFile(poolId: string, nodeId: string, filePath: string, options?: DeleteNodeFileOptionalParams): Promise<void>Paramètres
- poolId
-
string
- nodeId
-
string
- filePath
-
string
- options
- DeleteNodeFileOptionalParams
Retours
Promise<void>
deleteNodeUser(string, string, string, DeleteNodeUserOptionalParams)
Vous ne pouvez supprimer un compte utilisateur vers un nœud de calcul que lorsqu’il est en état d’inactivité ou en cours d’exécution. Avant de pouvoir vous connecter à distance à un nœud de calcul, vous devez configurer les ports d’accès pour SSH et RDP. Pour plus d’informations, consultez https://learn.microsoft.com/azure/batch/pool-endpoint-configuration
function deleteNodeUser(poolId: string, nodeId: string, userName: string, options?: DeleteNodeUserOptionalParams): Promise<void>Paramètres
- poolId
-
string
- nodeId
-
string
- userName
-
string
- options
- DeleteNodeUserOptionalParams
Retours
Promise<void>
deletePool(string, DeletePoolOptionalParams)
Lorsque vous demandez qu’un pool soit supprimé, les actions suivantes se produisent : l’état du pool est défini sur la suppression ; toute opération de redimensionnement en cours sur le pool est arrêtée ; le service Batch démarre le redimensionnement du pool sur zéro nœuds de calcul ; toutes les tâches exécutées sur des nœuds de calcul existants sont arrêtées et requeuées (comme si une opération de redimensionnement de pool avait été demandée avec l’option de mise en file d’attente par défaut) ; enfin, le pool est supprimé du système. Étant donné que les tâches en cours d’exécution sont requeuées, l’utilisateur peut réexécuter ces tâches en mettant à jour leur travail pour cibler un autre pool. Les tâches peuvent ensuite s’exécuter sur le nouveau pool. Si vous souhaitez remplacer le comportement de mise en file d’attente, vous devez appeler le pool de redimensionnement explicitement pour réduire la taille zéro du pool avant de supprimer le pool. Si vous appelez une API Update, Patch ou Delete sur un pool dans l’état de suppression, elle échoue avec le code d’état HTTP 409 avec le code d’erreur PoolBeingDeleted.
function deletePool(poolId: string, options?: DeletePoolOptionalParams): PollerLike<OperationState<void>, void>Paramètres
- poolId
-
string
- options
- DeletePoolOptionalParams
Retours
PollerLike<OperationState<void>, void>
deleteTask(string, string, DeleteTaskOptionalParams)
Lorsqu’une tâche est supprimée, tous les fichiers de son dossier sur le nœud de calcul où elle a été exécutée sont également supprimés (quel que soit le temps de rétention). Pour les tâches multi-instances, l’opération de suppression de la tâche s’applique de manière synchrone à la tâche principale ; les sous-tâches et leurs fichiers sont ensuite supprimés de manière asynchrone en arrière-plan.
function deleteTask(jobId: string, taskId: string, options?: DeleteTaskOptionalParams): Promise<void>Paramètres
- jobId
-
string
- taskId
-
string
- options
- DeleteTaskOptionalParams
Retours
Promise<void>
deleteTaskFile(string, string, string, DeleteTaskFileOptionalParams)
Supprime le fichier Tâche spécifié du nœud de calcul où la tâche s’est exécutée.
function deleteTaskFile(jobId: string, taskId: string, filePath: string, options?: DeleteTaskFileOptionalParams): Promise<void>Paramètres
- jobId
-
string
- taskId
-
string
- filePath
-
string
- options
- DeleteTaskFileOptionalParams
Retours
Promise<void>
disableJob(string, BatchJobDisableOptions, DisableJobOptionalParams)
Le service de traitement déplace immédiatement le poste en état de désactivation. Batch utilise ensuite le paramètre disableTasks pour déterminer quoi faire des tâches du travail en cours d’exécution. Le Job reste en état de désactivation jusqu’à ce que l’opération de désactivation soit terminée et que toutes les Tâches soient traitées selon l’option disableTasks ; le Job passe alors à l’État handicapé. Aucune nouvelle tâche n’est lancée sous le poste tant qu’il ne revient pas en état actif. Si vous essayez de désactiver un Job dans un état autre que actif, désactivé ou désactivé, la requête échoue avec le code de statut 409.
function disableJob(jobId: string, disableOptions: BatchJobDisableOptions, options?: DisableJobOptionalParams): PollerLike<OperationState<void>, void>Paramètres
- jobId
-
string
- disableOptions
- BatchJobDisableOptions
- options
- DisableJobOptionalParams
Retours
PollerLike<OperationState<void>, void>
disableJobSchedule(string, DisableJobScheduleOptionalParams)
Aucun nouveau poste ne sera créé tant que le planning des emplois ne sera pas réactivé.
function disableJobSchedule(jobScheduleId: string, options?: DisableJobScheduleOptionalParams): Promise<void>Paramètres
- jobScheduleId
-
string
- options
- DisableJobScheduleOptionalParams
Retours
Promise<void>
disableNodeScheduling(string, string, DisableNodeSchedulingOptionalParams)
Vous pouvez désactiver la planification des tâches sur un nœud de calcul uniquement si son état de planification actuel est activé.
function disableNodeScheduling(poolId: string, nodeId: string, options?: DisableNodeSchedulingOptionalParams): Promise<void>Paramètres
- poolId
-
string
- nodeId
-
string
Retours
Promise<void>
disablePoolAutoScale(string, DisablePoolAutoScaleOptionalParams)
Désactive la mise à l’échelle automatique d’un pool.
function disablePoolAutoScale(poolId: string, options?: DisablePoolAutoScaleOptionalParams): Promise<void>Paramètres
- poolId
-
string
Retours
Promise<void>
enableJob(string, EnableJobOptionalParams)
Lorsque vous appelez cette API, le service Batch place un Job désactivé à l’état d’activation. Après l’achèvement de cette opération, le poste passe à l’état actif, et la planification des nouvelles tâches sous le poste reprend. Le service Batch ne permet pas à une tâche de rester en état actif plus de 180 jours. Par conséquent, si vous activez un Job contenant des Tâches actives ajoutées il y a plus de 180 jours, ces Tâches ne s’exécuteront pas.
function enableJob(jobId: string, options?: EnableJobOptionalParams): PollerLike<OperationState<void>, void>Paramètres
- jobId
-
string
- options
- EnableJobOptionalParams
Retours
PollerLike<OperationState<void>, void>
enableJobSchedule(string, EnableJobScheduleOptionalParams)
Permet d’établir un planning de travail.
function enableJobSchedule(jobScheduleId: string, options?: EnableJobScheduleOptionalParams): Promise<void>Paramètres
- jobScheduleId
-
string
- options
- EnableJobScheduleOptionalParams
Retours
Promise<void>
enableNodeScheduling(string, string, EnableNodeSchedulingOptionalParams)
Vous pouvez activer la planification des tâches sur un nœud de calcul uniquement si son état de planification actuel est désactivé
function enableNodeScheduling(poolId: string, nodeId: string, options?: EnableNodeSchedulingOptionalParams): Promise<void>Paramètres
- poolId
-
string
- nodeId
-
string
Retours
Promise<void>
enablePoolAutoScale(string, BatchPoolEnableAutoScaleOptions, EnablePoolAutoScaleOptionalParams)
Vous ne pouvez pas activer la mise à l’échelle automatique sur un pool si une opération de redimensionnement est en cours sur le pool. Si la mise à l’échelle automatique du pool est actuellement désactivée, vous devez spécifier une formule de mise à l’échelle automatique valide dans le cadre de la requête. Si la mise à l’échelle automatique du pool est déjà activée, vous pouvez spécifier une nouvelle formule de mise à l’échelle automatique et/ou un nouvel intervalle d’évaluation. Vous ne pouvez pas appeler cette API pour le même pool plusieurs fois toutes les 30 secondes.
function enablePoolAutoScale(poolId: string, enableAutoScaleOptions: BatchPoolEnableAutoScaleOptions, options?: EnablePoolAutoScaleOptionalParams): Promise<void>Paramètres
- poolId
-
string
- enableAutoScaleOptions
- BatchPoolEnableAutoScaleOptions
Retours
Promise<void>
evaluatePoolAutoScale(string, BatchPoolEvaluateAutoScaleOptions, EvaluatePoolAutoScaleOptionalParams)
Cette API est principalement destinée à valider une formule de mise à l’échelle automatique, car elle retourne simplement le résultat sans appliquer la formule au pool. Le pool doit avoir la mise à l’échelle automatique activée pour évaluer une formule.
function evaluatePoolAutoScale(poolId: string, evaluateAutoScaleOptions: BatchPoolEvaluateAutoScaleOptions, options?: EvaluatePoolAutoScaleOptionalParams): Promise<AutoScaleRun>Paramètres
- poolId
-
string
- evaluateAutoScaleOptions
- BatchPoolEvaluateAutoScaleOptions
Retours
Promise<AutoScaleRun>
getApplication(string, GetApplicationOptionalParams)
Cette opération ne retourne que les applications et versions disponibles pour une utilisation sur les nœuds de calcul ; c’est-à-dire qu’elle peut être utilisée dans une référence de paquet. Pour des informations d’administrateur sur les applications et versions qui ne sont pas encore disponibles pour les nœuds de calcul, utilisez le portail Azure ou l’API Azure Resource Manager.
function getApplication(applicationId: string, options?: GetApplicationOptionalParams): Promise<BatchApplication>Paramètres
- applicationId
-
string
- options
- GetApplicationOptionalParams
Retours
Promise<BatchApplication>
getJob(string, GetJobOptionalParams)
Obtient des informations sur le poste spécifié.
function getJob(jobId: string, options?: GetJobOptionalParams): Promise<BatchJob>Paramètres
- jobId
-
string
- options
- GetJobOptionalParams
Retours
Promise<BatchJob>
getJobSchedule(string, GetJobScheduleOptionalParams)
Obtient des informations sur le planning de travail spécifié.
function getJobSchedule(jobScheduleId: string, options?: GetJobScheduleOptionalParams): Promise<BatchJobSchedule>Paramètres
- jobScheduleId
-
string
- options
- GetJobScheduleOptionalParams
Retours
Promise<BatchJobSchedule>
getJobTaskCounts(string, GetJobTaskCountsOptionalParams)
Les comptes de tâches fournissent un compte des tâches par état actif, en cours ou terminé, ainsi qu’un compte des tâches qui ont réussi ou échoué. Les tâches dans l’état de préparation sont comptabilisées comme étant en cours d’exécution. Notez que les nombres retournés peuvent ne pas toujours être à jour. Si vous avez besoin d’un nombre exact de tâches, utilisez une requête par liste.
function getJobTaskCounts(jobId: string, options?: GetJobTaskCountsOptionalParams): Promise<BatchTaskCountsResult>Paramètres
- jobId
-
string
- options
- GetJobTaskCountsOptionalParams
Retours
Promise<BatchTaskCountsResult>
getNode(string, string, GetNodeOptionalParams)
Obtient des informations sur le nœud de calcul spécifié.
function getNode(poolId: string, nodeId: string, options?: GetNodeOptionalParams): Promise<BatchNode>Paramètres
- poolId
-
string
- nodeId
-
string
- options
- GetNodeOptionalParams
Retours
Promise<BatchNode>
getNodeExtension(string, string, string, GetNodeExtensionOptionalParams)
Obtient des informations sur l’extension de nœud de calcul spécifiée.
function getNodeExtension(poolId: string, nodeId: string, extensionName: string, options?: GetNodeExtensionOptionalParams): Promise<BatchNodeVMExtension>Paramètres
- poolId
-
string
- nodeId
-
string
- extensionName
-
string
- options
- GetNodeExtensionOptionalParams
Retours
Promise<BatchNodeVMExtension>
getNodeFile(string, string, string, GetNodeFileOptionalParams)
Retourne le contenu du fichier Compute Node spécifié.
function getNodeFile(poolId: string, nodeId: string, filePath: string, options?: GetNodeFileOptionalParams): Promise<Uint8Array>Paramètres
- poolId
-
string
- nodeId
-
string
- filePath
-
string
- options
- GetNodeFileOptionalParams
Retours
Promise<Uint8Array>
getNodeFileProperties(string, string, string, GetNodeFilePropertiesOptionalParams)
Obtient les propriétés du fichier Compute Node spécifié.
function getNodeFileProperties(poolId: string, nodeId: string, filePath: string, options?: GetNodeFilePropertiesOptionalParams): Promise<BatchNodeFile>Paramètres
- poolId
-
string
- nodeId
-
string
- filePath
-
string
Retours
Promise<BatchNodeFile>
getNodeRemoteLoginSettings(string, string, GetNodeRemoteLoginSettingsOptionalParams)
Avant de pouvoir vous connecter à distance à un nœud de calcul en utilisant les paramètres de connexion à distance, vous devez créer un compte utilisateur sur le nœud de calcul et configurer les ports d’accès pour SSH et RDP. Pour plus d’informations, consultez https://learn.microsoft.com/azure/batch/pool-endpoint-configuration
function getNodeRemoteLoginSettings(poolId: string, nodeId: string, options?: GetNodeRemoteLoginSettingsOptionalParams): Promise<BatchNodeRemoteLoginSettings>Paramètres
- poolId
-
string
- nodeId
-
string
Retours
Promise<BatchNodeRemoteLoginSettings>
getPool(string, GetPoolOptionalParams)
Obtient des informations sur le pool spécifié.
function getPool(poolId: string, options?: GetPoolOptionalParams): Promise<BatchPool>Paramètres
- poolId
-
string
- options
- GetPoolOptionalParams
Retours
Promise<BatchPool>
getTask(string, string, GetTaskOptionalParams)
Pour les tâches multi-instances, des informations telles qu’affinityId, executionInfo et nodeInfo font référence à la tâche principale. Utilisez l’API des sous-tâches de liste pour récupérer des informations sur les sous-tâches.
function getTask(jobId: string, taskId: string, options?: GetTaskOptionalParams): Promise<BatchTask>Paramètres
- jobId
-
string
- taskId
-
string
- options
- GetTaskOptionalParams
Retours
Promise<BatchTask>
getTaskFile(string, string, string, GetTaskFileOptionalParams)
Retourne le contenu du fichier Task spécifié.
function getTaskFile(jobId: string, taskId: string, filePath: string, options?: GetTaskFileOptionalParams): Promise<Uint8Array>Paramètres
- jobId
-
string
- taskId
-
string
- filePath
-
string
- options
- GetTaskFileOptionalParams
Retours
Promise<Uint8Array>
getTaskFileProperties(string, string, string, GetTaskFilePropertiesOptionalParams)
Obtient les propriétés du fichier Task spécifié.
function getTaskFileProperties(jobId: string, taskId: string, filePath: string, options?: GetTaskFilePropertiesOptionalParams): Promise<BatchNodeFile>Paramètres
- jobId
-
string
- taskId
-
string
- filePath
-
string
Retours
Promise<BatchNodeFile>
jobScheduleExists(string, JobScheduleExistsOptionalParams)
Vérifie que le planning de poste spécifié existe.
function jobScheduleExists(jobScheduleId: string, options?: JobScheduleExistsOptionalParams): Promise<boolean>Paramètres
- jobScheduleId
-
string
- options
- JobScheduleExistsOptionalParams
Retours
Promise<boolean>
listApplications(ListApplicationsOptionalParams)
Cette opération ne retourne que les applications et versions disponibles pour une utilisation sur les nœuds de calcul ; c’est-à-dire qu’elle peut être utilisée dans une référence de paquet. Pour des informations d’administrateur sur les applications et versions qui ne sont pas encore disponibles pour Compute Nodes, utilisez le portail Azure ou l’API Azure Resource Manager.
function listApplications(options?: ListApplicationsOptionalParams): PagedAsyncIterableIterator<BatchApplication, BatchApplication[], PageSettings>Paramètres
- options
- ListApplicationsOptionalParams
Retours
listJobPreparationAndReleaseTaskStatus(string, ListJobPreparationAndReleaseTaskStatusOptionalParams)
Cette API renvoie le statut de la tâche de préparation de tâche et de publication de tâches sur tous les nœuds de calcul qui ont exécuté la tâche de préparation ou de libération de tâches. Cela inclut les nœuds de calcul qui ont depuis été retirés du pool. Si cette API est invoquée sur un Job qui n’a ni Job Preparation ni Job Release Task, le service Batch renvoie le code d’état HTTP 409 (Conflit) avec un code d’erreur JobPreparationTaskNotSpecified.
function listJobPreparationAndReleaseTaskStatus(jobId: string, options?: ListJobPreparationAndReleaseTaskStatusOptionalParams): PagedAsyncIterableIterator<BatchJobPreparationAndReleaseTaskStatus, BatchJobPreparationAndReleaseTaskStatus[], PageSettings>Paramètres
- jobId
-
string
Retours
listJobs(ListJobsOptionalParams)
Liste tous les emplois dans le compte spécifié.
function listJobs(options?: ListJobsOptionalParams): PagedAsyncIterableIterator<BatchJob, BatchJob[], PageSettings>Paramètres
- options
- ListJobsOptionalParams
Retours
listJobSchedules(ListJobSchedulesOptionalParams)
Liste tous les plannings de tâches dans le compte spécifié.
function listJobSchedules(options?: ListJobSchedulesOptionalParams): PagedAsyncIterableIterator<BatchJobSchedule, BatchJobSchedule[], PageSettings>Paramètres
- options
- ListJobSchedulesOptionalParams
Retours
listJobsFromSchedule(string, ListJobsFromScheduleOptionalParams)
Liste les emplois créés selon le calendrier des tâches spécifié.
function listJobsFromSchedule(jobScheduleId: string, options?: ListJobsFromScheduleOptionalParams): PagedAsyncIterableIterator<BatchJob, BatchJob[], PageSettings>Paramètres
- jobScheduleId
-
string
Retours
listNodeExtensions(string, string, ListNodeExtensionsOptionalParams)
Liste les extensions des nœuds de calcul dans le pool spécifié.
function listNodeExtensions(poolId: string, nodeId: string, options?: ListNodeExtensionsOptionalParams): PagedAsyncIterableIterator<BatchNodeVMExtension, BatchNodeVMExtension[], PageSettings>Paramètres
- poolId
-
string
- nodeId
-
string
- options
- ListNodeExtensionsOptionalParams
Retours
listNodeFiles(string, string, ListNodeFilesOptionalParams)
Liste tous les fichiers dans les répertoires des tâches sur le nœud de calcul spécifié.
function listNodeFiles(poolId: string, nodeId: string, options?: ListNodeFilesOptionalParams): PagedAsyncIterableIterator<BatchNodeFile, BatchNodeFile[], PageSettings>Paramètres
- poolId
-
string
- nodeId
-
string
- options
- ListNodeFilesOptionalParams
Retours
listNodes(string, ListNodesOptionalParams)
Liste les nœuds de calcul dans le pool spécifié.
function listNodes(poolId: string, options?: ListNodesOptionalParams): PagedAsyncIterableIterator<BatchNode, BatchNode[], PageSettings>Paramètres
- poolId
-
string
- options
- ListNodesOptionalParams
Retours
listPoolNodeCounts(ListPoolNodeCountsOptionalParams)
Obtient le nombre de nœuds de calcul dans chaque état, regroupés par pool. Notez que les nombres retournés peuvent ne pas toujours être à jour. Si vous avez besoin d’un nombre exact de nœuds, utilisez une requête de liste.
function listPoolNodeCounts(options?: ListPoolNodeCountsOptionalParams): PagedAsyncIterableIterator<BatchPoolNodeCounts, BatchPoolNodeCounts[], PageSettings>Paramètres
- options
- ListPoolNodeCountsOptionalParams
Retours
listPools(ListPoolsOptionalParams)
Répertorie tous les pools dans le compte spécifié.
function listPools(options?: ListPoolsOptionalParams): PagedAsyncIterableIterator<BatchPool, BatchPool[], PageSettings>Paramètres
- options
- ListPoolsOptionalParams
Retours
listPoolUsageMetrics(ListPoolUsageMetricsOptionalParams)
Si vous ne spécifiez pas de clause $filter incluant un poolId, la réponse inclut tous les pools qui existaient dans le compte dans l’intervalle de temps des intervalles d’agrégation retournés. Si vous ne spécifiez pas de clause $filter incluant un startTime ou endTime, ces filtres sont par défaut les heures de début et de fin de la dernière intervalle d’agrégation actuellement disponible ; autrement dit, seul le dernier intervalle d’agrégation est retourné.
function listPoolUsageMetrics(options?: ListPoolUsageMetricsOptionalParams): PagedAsyncIterableIterator<BatchPoolUsageMetrics, BatchPoolUsageMetrics[], PageSettings>Paramètres
Retours
listSubTasks(string, string, ListSubTasksOptionalParams)
Si la tâche n’est pas une tâche multi-instance, cela retourne une collection vide.
function listSubTasks(jobId: string, taskId: string, options?: ListSubTasksOptionalParams): PagedAsyncIterableIterator<BatchSubtask, BatchSubtask[], PageSettings>Paramètres
- jobId
-
string
- taskId
-
string
- options
- ListSubTasksOptionalParams
Retours
listSupportedImages(ListSupportedImagesOptionalParams)
Répertorie toutes les images de machine virtuelle prises en charge par le service Azure Batch.
function listSupportedImages(options?: ListSupportedImagesOptionalParams): PagedAsyncIterableIterator<BatchSupportedImage, BatchSupportedImage[], PageSettings>Paramètres
Retours
listTaskFiles(string, string, ListTaskFilesOptionalParams)
Liste les fichiers dans le répertoire d’une tâche sur son nœud de calcul.
function listTaskFiles(jobId: string, taskId: string, options?: ListTaskFilesOptionalParams): PagedAsyncIterableIterator<BatchNodeFile, BatchNodeFile[], PageSettings>Paramètres
- jobId
-
string
- taskId
-
string
- options
- ListTaskFilesOptionalParams
Retours
listTasks(string, ListTasksOptionalParams)
Pour les tâches multi-instances, des informations telles qu’affinityId, executionInfo et nodeInfo font référence à la tâche principale. Utilisez l’API des sous-tâches de liste pour récupérer des informations sur les sous-tâches.
function listTasks(jobId: string, options?: ListTasksOptionalParams): PagedAsyncIterableIterator<BatchTask, BatchTask[], PageSettings>Paramètres
- jobId
-
string
- options
- ListTasksOptionalParams
Retours
poolExists(string, PoolExistsOptionalParams)
Ça obtient les propriétés de base d’un pool.
function poolExists(poolId: string, options?: PoolExistsOptionalParams): Promise<boolean>Paramètres
- poolId
-
string
- options
- PoolExistsOptionalParams
Retours
Promise<boolean>
reactivateTask(string, string, ReactivateTaskOptionalParams)
La réactivation rend une tâche éligible à être reprise jusqu’à son maximum de réessays. L’état de la tâche est changé en actif. Comme la tâche n’est plus dans l’état terminé, tout code de sortie ou information de défaillance n’est plus disponible après la réactivation. Chaque fois qu’une Tâche est réactivée, son nombre de tentatives est réinitialisé à zéro. La réactivation échouera pour les tâches non terminées ou déjà terminées avec succès (avec un code de sortie de 0). De plus, il échouera si le travail est terminé (ou est en train de se terminer ou de le supprimer).
function reactivateTask(jobId: string, taskId: string, options?: ReactivateTaskOptionalParams): Promise<void>Paramètres
- jobId
-
string
- taskId
-
string
- options
- ReactivateTaskOptionalParams
Retours
Promise<void>
rebootNode(string, string, RebootNodeOptionalParams)
Vous pouvez redémarrer un nœud de calcul uniquement s’il est dans un état inactif ou en cours d’exécution.
function rebootNode(poolId: string, nodeId: string, options?: RebootNodeOptionalParams): PollerLike<OperationState<void>, void>Paramètres
- poolId
-
string
- nodeId
-
string
- options
- RebootNodeOptionalParams
Retours
PollerLike<OperationState<void>, void>
reimageNode(string, string, ReimageNodeOptionalParams)
Vous pouvez réinstaller le système d’exploitation sur un nœud de calcul uniquement s’il est dans un état inactif ou en cours d’exécution. Cette API ne peut être invoquée que sur les pools créés avec la propriété de configuration du service cloud.
function reimageNode(poolId: string, nodeId: string, options?: ReimageNodeOptionalParams): PollerLike<OperationState<void>, void>Paramètres
- poolId
-
string
- nodeId
-
string
- options
- ReimageNodeOptionalParams
Retours
PollerLike<OperationState<void>, void>
removeNodes(string, BatchNodeRemoveOptions, RemoveNodesOptionalParams)
Cette opération ne peut s’exécuter que lorsque l’état d’allocation du pool est stable. Lorsque cette opération s’exécute, l’état d’allocation passe du redimensionnement stable au redimensionnement. Chaque requête peut supprimer jusqu’à 100 nœuds.
function removeNodes(poolId: string, removeOptions: BatchNodeRemoveOptions, options?: RemoveNodesOptionalParams): PollerLike<OperationState<void>, void>Paramètres
- poolId
-
string
- removeOptions
- BatchNodeRemoveOptions
- options
- RemoveNodesOptionalParams
Retours
PollerLike<OperationState<void>, void>
replaceJob(string, BatchJob, ReplaceJobOptionalParams)
Cela remplace entièrement toutes les propriétés actualisables du Job. Par exemple, si le Job a des contraintes associées et si cette contrainte n’est pas spécifiée avec cette requête, alors le service Batch supprimera les contraintes existantes.
function replaceJob(jobId: string, job: BatchJob, options?: ReplaceJobOptionalParams): Promise<void>Paramètres
- jobId
-
string
- job
- BatchJob
- options
- ReplaceJobOptionalParams
Retours
Promise<void>
replaceJobSchedule(string, BatchJobSchedule, ReplaceJobScheduleOptionalParams)
Cela remplace entièrement toutes les propriétés de mise à jour de l’Emploi Planifié. Par exemple, si la propriété de l’annexe n’est pas spécifiée avec cette requête, alors le service Batch supprimera l’ordonnance existante. Les modifications d’un planning de tâches n’affectent que les emplois créés par le planning après la mise à jour ; Les emplois actuellement en cours ne sont pas affectés.
function replaceJobSchedule(jobScheduleId: string, jobSchedule: BatchJobSchedule, options?: ReplaceJobScheduleOptionalParams): Promise<void>Paramètres
- jobScheduleId
-
string
- jobSchedule
- BatchJobSchedule
- options
- ReplaceJobScheduleOptionalParams
Retours
Promise<void>
replaceNodeUser(string, string, string, BatchNodeUserUpdateOptions, ReplaceNodeUserOptionalParams)
Cette opération remplace toutes les propriétés actualisables du Compte. Par exemple, si l’élément expiryTime n’est pas spécifié, la valeur actuelle est remplacée par la valeur par défaut, et non modifiée. Vous ne pouvez mettre à jour un compte utilisateur sur un nœud de calcul que lorsqu’il est en état d’inactivité ou en cours d’exécution.
function replaceNodeUser(poolId: string, nodeId: string, userName: string, updateOptions: BatchNodeUserUpdateOptions, options?: ReplaceNodeUserOptionalParams): Promise<void>Paramètres
- poolId
-
string
- nodeId
-
string
- userName
-
string
- updateOptions
- BatchNodeUserUpdateOptions
- options
- ReplaceNodeUserOptionalParams
Retours
Promise<void>
replacePoolProperties(string, BatchPoolReplaceOptions, ReplacePoolPropertiesOptionalParams)
Cela remplace entièrement toutes les propriétés actualisables de la piscine. Par exemple, si le pool a une StartTask associée et si StartTask n’est pas spécifié avec cette requête, alors le service Batch supprimera la StartTask existante.
function replacePoolProperties(poolId: string, pool: BatchPoolReplaceOptions, options?: ReplacePoolPropertiesOptionalParams): Promise<void>Paramètres
- poolId
-
string
Retours
Promise<void>
replaceTask(string, string, BatchTask, ReplaceTaskOptionalParams)
Met à jour les propriétés de la tâche spécifiée.
function replaceTask(jobId: string, taskId: string, task: BatchTask, options?: ReplaceTaskOptionalParams): Promise<void>Paramètres
- jobId
-
string
- taskId
-
string
- task
- BatchTask
- options
- ReplaceTaskOptionalParams
Retours
Promise<void>
resizePool(string, BatchPoolResizeOptions, ResizePoolOptionalParams)
Vous ne pouvez redimensionner un pool que lorsque son état d’allocation est stable. Si le redimensionnement du pool est déjà effectué, la demande échoue avec le code d’état 409. Lorsque vous redimensionnez un pool, l’état d’allocation du pool passe du redimensionnement stable au redimensionnement. Vous ne pouvez pas redimensionner les pools configurés pour la mise à l’échelle automatique. Si vous essayez de le faire, le service Batch retourne une erreur 409. Si vous redimensionnez un pool vers le bas, le service Batch choisit les nœuds de calcul à supprimer. Pour supprimer des nœuds de calcul spécifiques, utilisez plutôt l’API Nœuds de calcul.
function resizePool(poolId: string, resizeOptions: BatchPoolResizeOptions, options?: ResizePoolOptionalParams): PollerLike<OperationState<void>, void>Paramètres
- poolId
-
string
- resizeOptions
- BatchPoolResizeOptions
- options
- ResizePoolOptionalParams
Retours
PollerLike<OperationState<void>, void>
startNode(string, string, StartNodeOptionalParams)
Vous ne pouvez lancer un nœud de calcul que s’il a été déalloué.
function startNode(poolId: string, nodeId: string, options?: StartNodeOptionalParams): PollerLike<OperationState<void>, void>Paramètres
- poolId
-
string
- nodeId
-
string
- options
- StartNodeOptionalParams
Retours
PollerLike<OperationState<void>, void>
stopPoolResize(string, StopPoolResizeOptionalParams)
Cela ne restaure pas le Pool à son état précédent avant l’opération de redimensionnement : cela ne fait qu’empêcher toute modification ultérieure, et le Pool maintient son état actuel. Après l’arrêt, le pool se stabilise au nombre de nœuds de calcul où il se trouvait au moment de l’opération d’arrêt. Pendant l’opération d’arrêt, l’état d’allocation du pool passe d’abord à l’arrêt puis à l’état stable. Une opération de redimensionnement n’a pas besoin d’être une demande explicite de pool de redimensionnement ; cette API peut également être utilisée pour arrêter la dimension initiale du Pool lors de sa création.
function stopPoolResize(poolId: string, options?: StopPoolResizeOptionalParams): PollerLike<OperationState<void>, void>Paramètres
- poolId
-
string
- options
- StopPoolResizeOptionalParams
Retours
PollerLike<OperationState<void>, void>
terminateJob(string, TerminateJobOptionalParams)
Lorsqu’une demande de Terminer la tâche est reçue, le service Batch place la tâche à l’état de terminaison. Le service Batch termine alors toutes les tâches en cours associées au Job et exécute toutes les tâches de libération de tâches requises. Ensuite, le Job passe à l’état de complété. S’il y a des tâches dans le poste en état actif, elles resteront en état actif. Une fois qu’un Job est terminé, de nouvelles Tâches ne peuvent plus être ajoutées et les Tâches restantes actives ne seront pas planifiées.
function terminateJob(jobId: string, options?: TerminateJobOptionalParams): PollerLike<OperationState<void>, void>Paramètres
- jobId
-
string
- options
- TerminateJobOptionalParams
Retours
PollerLike<OperationState<void>, void>
terminateJobSchedule(string, TerminateJobScheduleOptionalParams)
Met fin à un planning de travail.
function terminateJobSchedule(jobScheduleId: string, options?: TerminateJobScheduleOptionalParams): PollerLike<OperationState<void>, void>Paramètres
- jobScheduleId
-
string
Retours
PollerLike<OperationState<void>, void>
terminateTask(string, string, TerminateTaskOptionalParams)
Lorsque la tâche est terminée, elle passe à l’état terminé. Pour les tâches multi-instances, l’opération de terminer la tâche s’applique de manière synchrone à la tâche principale ; Les sous-tâches sont alors terminées de manière asynchrone en arrière-plan.
function terminateTask(jobId: string, taskId: string, options?: TerminateTaskOptionalParams): Promise<void>Paramètres
- jobId
-
string
- taskId
-
string
- options
- TerminateTaskOptionalParams
Retours
Promise<void>
updateJob(string, BatchJobUpdateOptions, UpdateJobOptionalParams)
Cela remplace uniquement les propriétés du Job spécifiées dans la requête. Par exemple, si le Job a des contraintes et qu’une requête ne spécifie pas l’élément de contrainte, alors le Job conserve les contraintes existantes.
function updateJob(jobId: string, job: BatchJobUpdateOptions, options?: UpdateJobOptionalParams): Promise<void>Paramètres
- jobId
-
string
- options
- UpdateJobOptionalParams
Retours
Promise<void>
updateJobSchedule(string, BatchJobScheduleUpdateOptions, UpdateJobScheduleOptionalParams)
Cela remplace uniquement les propriétés de l’horaire de travail spécifiées dans la demande. Par exemple, si la propriété de l’ordonnance n’est pas spécifiée avec cette requête, alors le service Batch conservera l’ordonnance existante. Les modifications d’un planning de tâches n’affectent que les emplois créés par le planning après la mise à jour ; Les emplois actuellement en cours ne sont pas affectés.
function updateJobSchedule(jobScheduleId: string, jobSchedule: BatchJobScheduleUpdateOptions, options?: UpdateJobScheduleOptionalParams): Promise<void>Paramètres
- jobScheduleId
-
string
- jobSchedule
- BatchJobScheduleUpdateOptions
- options
- UpdateJobScheduleOptionalParams
Retours
Promise<void>
updatePool(string, BatchPoolUpdateOptions, UpdatePoolOptionalParams)
Cela ne remplace que les propriétés du Pool spécifiées dans la requête. Par exemple, si le Pool a une StartTask associée, et qu’une requête ne spécifie pas un élément StartTask, alors le Pool conserve la StartTask existante.
function updatePool(poolId: string, pool: BatchPoolUpdateOptions, options?: UpdatePoolOptionalParams): Promise<void>Paramètres
- poolId
-
string
- options
- UpdatePoolOptionalParams
Retours
Promise<void>
uploadNodeLogs(string, string, UploadBatchServiceLogsOptions, UploadNodeLogsOptionalParams)
Ceci est destiné à collecter automatisément les fichiers journaux de service Azure Batch depuis les nœuds de calcul si vous rencontrez une erreur et souhaitez passer à l’aide Azure. Les fichiers journaux du service Azure Batch doivent être partagés avec la prise en charge d’Azure pour faciliter le débogage des problèmes avec le service Batch.
function uploadNodeLogs(poolId: string, nodeId: string, uploadOptions: UploadBatchServiceLogsOptions, options?: UploadNodeLogsOptionalParams): Promise<UploadBatchServiceLogsResult>Paramètres
- poolId
-
string
- nodeId
-
string
- uploadOptions
- UploadBatchServiceLogsOptions
- options
- UploadNodeLogsOptionalParams
Retours
Promise<UploadBatchServiceLogsResult>
