Task class

Paquet:

@azure/batch

Classe représentant une tâche.

Constructeurs

Task(BatchServiceClientContext)

Créez une tâche.

Méthodes

add(string, TaskAddParameter, ServiceCallback<void>)
add(string, TaskAddParameter, TaskAddOptionalParams)	La durée de vie maximale d’une tâche d’ajout à la fin est de 180 jours. Si une tâche n’est pas terminée dans les 180 jours suivant l’ajout, elle est arrêtée par le service Batch et reste dans l’état dans lequel elle se trouvait à ce moment-là.
add(string, TaskAddParameter, TaskAddOptionalParams, ServiceCallback<void>)
addCollection(string, TaskAddParameter[], ServiceCallback<TaskAddCollectionResult>)
addCollection(string, TaskAddParameter[], TaskAddCollectionOptionalParams)	Notez que chaque tâche doit avoir un ID unique. Le service Batch peut ne pas renvoyer les résultats de chaque tâche dans le même ordre dans lequel les tâches ont été envoyées dans cette demande. Si le serveur expire ou si la connexion est fermée pendant la demande, la demande a peut-être été partiellement ou entièrement traitée, ou pas du tout. Dans ce cas, l’utilisateur doit re-émettre la demande. Notez qu’il incombe à l’utilisateur de gérer correctement les échecs lors de la réécriture d’une demande. Par exemple, vous devez utiliser les mêmes ID de tâche pendant une nouvelle tentative afin que si l’opération précédente a réussi, la nouvelle tentative ne crée pas de tâches supplémentaires de manière inattendue. Si la réponse contient des tâches qui n’ont pas pu être ajoutées, un client peut réessayer la demande. Dans une nouvelle tentative, il est plus efficace de renvoyer uniquement les tâches qui n’ont pas pu être ajoutées et d’omettre les tâches qui ont été correctement ajoutées lors de la première tentative. La durée de vie maximale d’une tâche d’ajout à la fin est de 180 jours. Si une tâche n’est pas terminée dans les 180 jours suivant l’ajout, elle est arrêtée par le service Batch et reste dans l’état dans lequel elle se trouvait à ce moment-là.
addCollection(string, TaskAddParameter[], TaskAddCollectionOptionalParams, ServiceCallback<TaskAddCollectionResult>)
deleteMethod(string, string, ServiceCallback<void>)
deleteMethod(string, string, TaskDeleteMethodOptionalParams)	Lorsqu’une tâche est supprimée, tous les fichiers de son répertoire sur le nœud de calcul où il a été exécuté sont également supprimés (indépendamment de l’heure de rétention). Pour les tâches multi-instances, l’opération de suppression de tâche s’applique de manière synchrone à la tâche principale ; les tâches subordonnées et leurs fichiers sont ensuite supprimés de manière asynchrone en arrière-plan.
deleteMethod(string, string, TaskDeleteMethodOptionalParams, ServiceCallback<void>)
get(string, string, ServiceCallback<CloudTask>)
get(string, string, TaskGetOptionalParams)	Pour les tâches multi-instances, des informations telles que affinityId, executionInfo et nodeInfo font référence à la tâche principale. Utilisez l’API de sous-tâches de liste pour récupérer des informations sur les tâches subordonnées.
get(string, string, TaskGetOptionalParams, ServiceCallback<CloudTask>)
list(string, ServiceCallback<CloudTaskListResult>)
list(string, TaskListOptionalParams)	Pour les tâches multi-instances, des informations telles que affinityId, executionInfo et nodeInfo font référence à la tâche principale. Utilisez l’API de sous-tâches de liste pour récupérer des informations sur les tâches subordonnées.
list(string, TaskListOptionalParams, ServiceCallback<CloudTaskListResult>)
listNext(string, ServiceCallback<CloudTaskListResult>)
listNext(string, TaskListNextOptionalParams)	Pour les tâches multi-instances, des informations telles que affinityId, executionInfo et nodeInfo font référence à la tâche principale. Utilisez l’API de sous-tâches de liste pour récupérer des informations sur les tâches subordonnées.
listNext(string, TaskListNextOptionalParams, ServiceCallback<CloudTaskListResult>)
listSubtasks(string, string, ServiceCallback<CloudTaskListSubtasksResult>)
listSubtasks(string, string, TaskListSubtasksOptionalParams)	Si la tâche n’est pas une tâche multi-instance, elle retourne une collection vide.
listSubtasks(string, string, TaskListSubtasksOptionalParams, ServiceCallback<CloudTaskListSubtasksResult>)
reactivate(string, string, ServiceCallback<void>)
reactivate(string, string, TaskReactivateOptionalParams)	La réactivation rend une tâche éligible à une nouvelle tentative jusqu’au nombre maximal de nouvelles tentatives. L’état de la tâche est remplacé par actif. Comme la tâche n’est plus dans l’état terminé, tout code de sortie ou informations d’échec précédents n’est plus disponible après la réactivation. Chaque fois qu’une tâche est réactivée, son nombre de nouvelles tentatives est réinitialisé à 0. La réactivation échoue pour les tâches qui ne sont pas terminées ou qui se sont terminées précédemment (avec un code de sortie de 0). En outre, elle échoue si le travail est terminé (ou termine ou supprime).
reactivate(string, string, TaskReactivateOptionalParams, ServiceCallback<void>)
terminate(string, string, ServiceCallback<void>)
terminate(string, string, TaskTerminateOptionalParams)	Une fois la tâche terminée, elle passe à l’état terminé. Pour les tâches multi-instances, l’opération terminer la tâche s’applique de manière synchrone à la tâche principale ; Les tâches subordonnées sont ensuite arrêtées de manière asynchrone en arrière-plan.
terminate(string, string, TaskTerminateOptionalParams, ServiceCallback<void>)
update(string, string, ServiceCallback<void>)
update(string, string, TaskUpdateOptionalParams)	Met à jour les propriétés de la tâche spécifiée.
update(string, string, TaskUpdateOptionalParams, ServiceCallback<void>)

Détails du constructeur

Task(BatchServiceClientContext)

Créez une tâche.

new Task(client: BatchServiceClientContext)

Paramètres

client

BatchServiceClientContext

Référence au client de service.

Détails de la méthode

add(string, TaskAddParameter, ServiceCallback<void>)

function add(jobId: string, task: TaskAddParameter, callback: ServiceCallback<void>)

Paramètres

jobId

string

ID du travail auquel la tâche doit être ajoutée.

task

TaskAddParameter

Tâche à ajouter.

callback

ServiceCallback<void>

Rappel

add(string, TaskAddParameter, TaskAddOptionalParams)

La durée de vie maximale d’une tâche d’ajout à la fin est de 180 jours. Si une tâche n’est pas terminée dans les 180 jours suivant l’ajout, elle est arrêtée par le service Batch et reste dans l’état dans lequel elle se trouvait à ce moment-là.

function add(jobId: string, task: TaskAddParameter, options?: TaskAddOptionalParams): Promise<TaskAddResponse>

Paramètres

jobId

string

ID du travail auquel la tâche doit être ajoutée.

task

TaskAddParameter

Tâche à ajouter.

options

TaskAddOptionalParams

Paramètres facultatifs

Retours

Promise<TaskAddResponse>

Promise<Models.TaskAddResponse>

add(string, TaskAddParameter, TaskAddOptionalParams, ServiceCallback<void>)

function add(jobId: string, task: TaskAddParameter, options: TaskAddOptionalParams, callback: ServiceCallback<void>)

Paramètres

jobId

string

ID du travail auquel la tâche doit être ajoutée.

task

TaskAddParameter

Tâche à ajouter.

options

TaskAddOptionalParams

Paramètres facultatifs

callback

ServiceCallback<void>

Rappel

addCollection(string, TaskAddParameter[], ServiceCallback<TaskAddCollectionResult>)

function addCollection(jobId: string, value: TaskAddParameter[], callback: ServiceCallback<TaskAddCollectionResult>)

Paramètres

jobId

string

ID du travail auquel la collection de tâches doit être ajoutée.

value

TaskAddParameter[]

Collection de Tâches à ajouter. Le nombre maximal de tâches est de 100. La taille sérialisée totale de cette collection doit être inférieure à 1 Mo. S’il est supérieur à 1 Mo (par exemple, si chaque tâche a 100 fichiers de ressources ou variables d’environnement), la requête échoue avec le code « RequestBodyTooLarge » et doit être retentée à nouveau avec moins de tâches.

callback

ServiceCallback<TaskAddCollectionResult>

Rappel

addCollection(string, TaskAddParameter[], TaskAddCollectionOptionalParams)

Notez que chaque tâche doit avoir un ID unique. Le service Batch peut ne pas renvoyer les résultats de chaque tâche dans le même ordre dans lequel les tâches ont été envoyées dans cette demande. Si le serveur expire ou si la connexion est fermée pendant la demande, la demande a peut-être été partiellement ou entièrement traitée, ou pas du tout. Dans ce cas, l’utilisateur doit re-émettre la demande. Notez qu’il incombe à l’utilisateur de gérer correctement les échecs lors de la réécriture d’une demande. Par exemple, vous devez utiliser les mêmes ID de tâche pendant une nouvelle tentative afin que si l’opération précédente a réussi, la nouvelle tentative ne crée pas de tâches supplémentaires de manière inattendue. Si la réponse contient des tâches qui n’ont pas pu être ajoutées, un client peut réessayer la demande. Dans une nouvelle tentative, il est plus efficace de renvoyer uniquement les tâches qui n’ont pas pu être ajoutées et d’omettre les tâches qui ont été correctement ajoutées lors de la première tentative. La durée de vie maximale d’une tâche d’ajout à la fin est de 180 jours. Si une tâche n’est pas terminée dans les 180 jours suivant l’ajout, elle est arrêtée par le service Batch et reste dans l’état dans lequel elle se trouvait à ce moment-là.

function addCollection(jobId: string, value: TaskAddParameter[], options?: TaskAddCollectionOptionalParams): Promise<TaskAddCollectionResponse>

Paramètres

jobId

string

ID du travail auquel la collection de tâches doit être ajoutée.

value

TaskAddParameter[]

Collection de Tâches à ajouter. Le nombre maximal de tâches est de 100. La taille sérialisée totale de cette collection doit être inférieure à 1 Mo. S’il est supérieur à 1 Mo (par exemple, si chaque tâche a 100 fichiers de ressources ou variables d’environnement), la requête échoue avec le code « RequestBodyTooLarge » et doit être retentée à nouveau avec moins de tâches.

options

TaskAddCollectionOptionalParams

Paramètres facultatifs

Retours

Promise<TaskAddCollectionResponse>

Promise<Models.TaskAddCollectionResponse>

addCollection(string, TaskAddParameter[], TaskAddCollectionOptionalParams, ServiceCallback<TaskAddCollectionResult>)

function addCollection(jobId: string, value: TaskAddParameter[], options: TaskAddCollectionOptionalParams, callback: ServiceCallback<TaskAddCollectionResult>)

Paramètres

jobId

string

ID du travail auquel la collection de tâches doit être ajoutée.

value

TaskAddParameter[]

Collection de Tâches à ajouter. Le nombre maximal de tâches est de 100. La taille sérialisée totale de cette collection doit être inférieure à 1 Mo. S’il est supérieur à 1 Mo (par exemple, si chaque tâche a 100 fichiers de ressources ou variables d’environnement), la requête échoue avec le code « RequestBodyTooLarge » et doit être retentée à nouveau avec moins de tâches.

options

TaskAddCollectionOptionalParams

Paramètres facultatifs

callback

ServiceCallback<TaskAddCollectionResult>

Rappel

deleteMethod(string, string, ServiceCallback<void>)

function deleteMethod(jobId: string, taskId: string, callback: ServiceCallback<void>)

Paramètres

jobId

string

ID du travail à partir duquel supprimer la tâche.

taskId

string

ID de la tâche à supprimer.

callback

ServiceCallback<void>

Rappel

deleteMethod(string, string, TaskDeleteMethodOptionalParams)

Lorsqu’une tâche est supprimée, tous les fichiers de son répertoire sur le nœud de calcul où il a été exécuté sont également supprimés (indépendamment de l’heure de rétention). Pour les tâches multi-instances, l’opération de suppression de tâche s’applique de manière synchrone à la tâche principale ; les tâches subordonnées et leurs fichiers sont ensuite supprimés de manière asynchrone en arrière-plan.

function deleteMethod(jobId: string, taskId: string, options?: TaskDeleteMethodOptionalParams): Promise<TaskDeleteResponse>

Paramètres

jobId

string

ID du travail à partir duquel supprimer la tâche.

taskId

string

ID de la tâche à supprimer.

options

TaskDeleteMethodOptionalParams

Paramètres facultatifs

Retours

Promise<TaskDeleteResponse>

Promise<Models.TaskDeleteResponse>

deleteMethod(string, string, TaskDeleteMethodOptionalParams, ServiceCallback<void>)

function deleteMethod(jobId: string, taskId: string, options: TaskDeleteMethodOptionalParams, callback: ServiceCallback<void>)

Paramètres

jobId

string

ID du travail à partir duquel supprimer la tâche.

taskId

string

ID de la tâche à supprimer.

options

TaskDeleteMethodOptionalParams

Paramètres facultatifs

callback

ServiceCallback<void>

Rappel

get(string, string, ServiceCallback<CloudTask>)

function get(jobId: string, taskId: string, callback: ServiceCallback<CloudTask>)

Paramètres

jobId

string

ID du travail qui contient la tâche.

taskId

string

ID de la tâche à obtenir des informations.

callback

ServiceCallback<CloudTask>

Rappel

get(string, string, TaskGetOptionalParams)

Pour les tâches multi-instances, des informations telles que affinityId, executionInfo et nodeInfo font référence à la tâche principale. Utilisez l’API de sous-tâches de liste pour récupérer des informations sur les tâches subordonnées.

function get(jobId: string, taskId: string, options?: TaskGetOptionalParams): Promise<TaskGetResponse>

Paramètres

jobId

string

ID du travail qui contient la tâche.

taskId

string

ID de la tâche à obtenir des informations.

options

TaskGetOptionalParams

Paramètres facultatifs

Retours

Promise<TaskGetResponse>

Promise<Models.TaskGetResponse>

get(string, string, TaskGetOptionalParams, ServiceCallback<CloudTask>)

function get(jobId: string, taskId: string, options: TaskGetOptionalParams, callback: ServiceCallback<CloudTask>)

Paramètres

jobId

string

ID du travail qui contient la tâche.

taskId

string

ID de la tâche à obtenir des informations.

options

TaskGetOptionalParams

Paramètres facultatifs

callback

ServiceCallback<CloudTask>

Rappel

list(string, ServiceCallback<CloudTaskListResult>)

function list(jobId: string, callback: ServiceCallback<CloudTaskListResult>)

Paramètres

jobId

string

ID du travail.

callback

ServiceCallback<CloudTaskListResult>

Rappel

list(string, TaskListOptionalParams)

Pour les tâches multi-instances, des informations telles que affinityId, executionInfo et nodeInfo font référence à la tâche principale. Utilisez l’API de sous-tâches de liste pour récupérer des informations sur les tâches subordonnées.

function list(jobId: string, options?: TaskListOptionalParams): Promise<TaskListResponse>

Paramètres

jobId

string

ID du travail.

options

TaskListOptionalParams

Paramètres facultatifs

Retours

Promise<TaskListResponse>

Promise<Models.TaskListResponse>

list(string, TaskListOptionalParams, ServiceCallback<CloudTaskListResult>)

function list(jobId: string, options: TaskListOptionalParams, callback: ServiceCallback<CloudTaskListResult>)

Paramètres

jobId

string

ID du travail.

options

TaskListOptionalParams

Paramètres facultatifs

callback

ServiceCallback<CloudTaskListResult>

Rappel

listNext(string, ServiceCallback<CloudTaskListResult>)

function listNext(nextPageLink: string, callback: ServiceCallback<CloudTaskListResult>)

Paramètres

nextPageLink

string

NextLink de l’appel réussi précédent à l’opération De liste.

callback

ServiceCallback<CloudTaskListResult>

Rappel

listNext(string, TaskListNextOptionalParams)

Pour les tâches multi-instances, des informations telles que affinityId, executionInfo et nodeInfo font référence à la tâche principale. Utilisez l’API de sous-tâches de liste pour récupérer des informations sur les tâches subordonnées.

function listNext(nextPageLink: string, options?: TaskListNextOptionalParams): Promise<TaskListResponse>

Paramètres

nextPageLink

string

NextLink de l’appel réussi précédent à l’opération De liste.

options

TaskListNextOptionalParams

Paramètres facultatifs

Retours

Promise<TaskListResponse>

Promise<Models.TaskListResponse>

listNext(string, TaskListNextOptionalParams, ServiceCallback<CloudTaskListResult>)

function listNext(nextPageLink: string, options: TaskListNextOptionalParams, callback: ServiceCallback<CloudTaskListResult>)

Paramètres

nextPageLink

string

NextLink de l’appel réussi précédent à l’opération De liste.

options

TaskListNextOptionalParams

Paramètres facultatifs

callback

ServiceCallback<CloudTaskListResult>

Rappel

listSubtasks(string, string, ServiceCallback<CloudTaskListSubtasksResult>)

function listSubtasks(jobId: string, taskId: string, callback: ServiceCallback<CloudTaskListSubtasksResult>)

Paramètres

jobId

string

ID du travail.

taskId

string

ID de la tâche.

callback

ServiceCallback<CloudTaskListSubtasksResult>

Rappel

listSubtasks(string, string, TaskListSubtasksOptionalParams)

Si la tâche n’est pas une tâche multi-instance, elle retourne une collection vide.

function listSubtasks(jobId: string, taskId: string, options?: TaskListSubtasksOptionalParams): Promise<TaskListSubtasksResponse>

Paramètres

jobId

string

ID du travail.

taskId

string

ID de la tâche.

options

TaskListSubtasksOptionalParams

Paramètres facultatifs

Retours

Promise<TaskListSubtasksResponse>

Promise<Models.TaskListSubtasksResponse>

listSubtasks(string, string, TaskListSubtasksOptionalParams, ServiceCallback<CloudTaskListSubtasksResult>)

function listSubtasks(jobId: string, taskId: string, options: TaskListSubtasksOptionalParams, callback: ServiceCallback<CloudTaskListSubtasksResult>)

Paramètres

jobId

string

ID du travail.

taskId

string

ID de la tâche.

options

TaskListSubtasksOptionalParams

Paramètres facultatifs

callback

ServiceCallback<CloudTaskListSubtasksResult>

Rappel

reactivate(string, string, ServiceCallback<void>)

function reactivate(jobId: string, taskId: string, callback: ServiceCallback<void>)

Paramètres

jobId

string

ID du travail contenant la tâche.

taskId

string

ID de la tâche à réactiver.

callback

ServiceCallback<void>

Rappel

reactivate(string, string, TaskReactivateOptionalParams)

La réactivation rend une tâche éligible à une nouvelle tentative jusqu’au nombre maximal de nouvelles tentatives. L’état de la tâche est remplacé par actif. Comme la tâche n’est plus dans l’état terminé, tout code de sortie ou informations d’échec précédents n’est plus disponible après la réactivation. Chaque fois qu’une tâche est réactivée, son nombre de nouvelles tentatives est réinitialisé à 0. La réactivation échoue pour les tâches qui ne sont pas terminées ou qui se sont terminées précédemment (avec un code de sortie de 0). En outre, elle échoue si le travail est terminé (ou termine ou supprime).

function reactivate(jobId: string, taskId: string, options?: TaskReactivateOptionalParams): Promise<TaskReactivateResponse>

Paramètres

jobId

string

ID du travail contenant la tâche.

taskId

string

ID de la tâche à réactiver.

options

TaskReactivateOptionalParams

Paramètres facultatifs

Retours

Promise<TaskReactivateResponse>

Modèles de promesse.TâcheRéactiverRéponse<>

reactivate(string, string, TaskReactivateOptionalParams, ServiceCallback<void>)

function reactivate(jobId: string, taskId: string, options: TaskReactivateOptionalParams, callback: ServiceCallback<void>)

Paramètres

jobId

string

ID du travail contenant la tâche.

taskId

string

ID de la tâche à réactiver.

options

TaskReactivateOptionalParams

Paramètres facultatifs

callback

ServiceCallback<void>

Rappel

terminate(string, string, ServiceCallback<void>)

function terminate(jobId: string, taskId: string, callback: ServiceCallback<void>)

Paramètres

jobId

string

ID du travail contenant la tâche.

taskId

string

ID de la tâche à terminer.

callback

ServiceCallback<void>

Rappel

terminate(string, string, TaskTerminateOptionalParams)

Une fois la tâche terminée, elle passe à l’état terminé. Pour les tâches multi-instances, l’opération terminer la tâche s’applique de manière synchrone à la tâche principale ; Les tâches subordonnées sont ensuite arrêtées de manière asynchrone en arrière-plan.

function terminate(jobId: string, taskId: string, options?: TaskTerminateOptionalParams): Promise<TaskTerminateResponse>

Paramètres

jobId

string

ID du travail contenant la tâche.

taskId

string

ID de la tâche à terminer.

options

TaskTerminateOptionalParams

Paramètres facultatifs

Retours

Promise<TaskTerminateResponse>

Promise<Models.TaskTerminateResponse>

terminate(string, string, TaskTerminateOptionalParams, ServiceCallback<void>)

function terminate(jobId: string, taskId: string, options: TaskTerminateOptionalParams, callback: ServiceCallback<void>)

Paramètres

jobId

string

ID du travail contenant la tâche.

taskId

string

ID de la tâche à terminer.

options

TaskTerminateOptionalParams

Paramètres facultatifs

callback

ServiceCallback<void>

Rappel

update(string, string, ServiceCallback<void>)

function update(jobId: string, taskId: string, callback: ServiceCallback<void>)

Paramètres

jobId

string

ID du travail contenant la tâche.

taskId

string

ID de la tâche à mettre à jour.

callback

ServiceCallback<void>

Rappel

update(string, string, TaskUpdateOptionalParams)

Met à jour les propriétés de la tâche spécifiée.

function update(jobId: string, taskId: string, options?: TaskUpdateOptionalParams): Promise<TaskUpdateResponse>

Paramètres

jobId

string

ID du travail contenant la tâche.

taskId

string

ID de la tâche à mettre à jour.

options

TaskUpdateOptionalParams

Paramètres facultatifs

Retours

Promise<TaskUpdateResponse>

Promise<Models.TaskUpdateResponse>

update(string, string, TaskUpdateOptionalParams, ServiceCallback<void>)

function update(jobId: string, taskId: string, options: TaskUpdateOptionalParams, callback: ServiceCallback<void>)

Paramètres

jobId

string

ID du travail contenant la tâche.

taskId

string

ID de la tâche à mettre à jour.

options

TaskUpdateOptionalParams

Paramètres facultatifs

callback

ServiceCallback<void>

Rappel