TaskOperations Classe

Opérations TaskOperations.

Vous ne devez pas instancier directement cette classe, mais créer un instance client qui la créera pour vous et l’attachera en tant qu’attribut.

Héritage

builtins.object

TaskOperations

Constructeur

TaskOperations(client, config, serializer, deserializer)

Paramètres

client

Obligatoire

Client pour les demandes de service.

config

Obligatoire

Configuration du client de service.

serializer

Obligatoire

Sérialiseur de modèle objet.

deserializer

Obligatoire

Désérialiseur de modèle objet.

Variables

api_version

Version de l’API à utiliser pour la requête. Valeur constante : « 2023-05-01.17.0 ».

Méthodes

add	Ajoute une tâche au travail spécifié. 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’est pas terminée dans les 180 jours suivant son ajout, elle est arrêtée par le service Batch et laissée dans l’état dans lequel elle se trouvait à ce moment-là.
add_collection	Ajoute une collection de tâches au travail spécifié. Notez que chaque tâche doit avoir un ID unique. Le service Batch peut ne pas retourner les résultats de chaque tâche dans le même ordre que celui envoyé dans cette demande. Si le serveur expire ou si la connexion est fermée pendant la demande, la demande peut avoir été partiellement ou entièrement traitée, ou pas du tout. Dans ce cas, l'utilisateur doit renouveler la demande. Notez qu’il appartient à 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. Lors d’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é ajoutées avec succès lors de 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’est pas terminée dans les 180 jours suivant son ajout, elle est arrêtée par le service Batch et laissée dans l’état dans lequel elle se trouvait à ce moment-là.
delete	Supprime une tâche du travail spécifié. Lorsqu’une tâche est supprimée, tous les fichiers de son répertoire sur le nœud de calcul sur lequel elle s’est exécutée sont également supprimés (quelle que soit la durée de conservation). Pour les tâches multi-instance, l’opération supprimer la tâche s’applique de manière synchrone à la tâche principale ; les tâches secondaires et leurs fichiers sont ensuite supprimés de manière asynchrone en arrière-plan.
get	Obtient des informations sur la tâche spécifiée. Pour les tâches multi-instance, les 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 secondaires.
list	Répertorie toutes les tâches associées au travail spécifié. Pour les tâches multi-instance, les 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 secondaires.
list_subtasks	Répertorie toutes les tâches secondaires associées à la tâche multi-instance spécifiée. Si la tâche n’est pas une tâche multi-instance, cela retourne une collection vide.
reactivate	Réactive une tâche, ce qui lui permet de s’exécuter à nouveau même si son nombre de nouvelles tentatives a été épuisé. La réactivation rend une tâche éligible pour être retentée à nouveau jusqu’à son nombre maximal de nouvelles tentatives. L’état de la tâche passe à actif. Comme la tâche n’est plus à l’état terminé, le code de sortie ou les informations d’échec précédents ne sont plus disponibles 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 avec succès (avec un code de sortie de 0). En outre, elle échoue si le travail est terminé (ou est en cours de fin ou de suppression).
terminate	Termine la tâche spécifiée. Une fois la tâche terminée, elle passe à l’état terminé. Pour les tâches multi-instance, l’opération terminer la tâche s’applique de manière synchrone à la tâche principale ; les tâches subordonnées sont ensuite terminées de manière asynchrone en arrière-plan.
update	Mises à jour les propriétés de la tâche spécifiée.

add

Ajoute une tâche au travail spécifié.

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’est pas terminée dans les 180 jours suivant son ajout, elle est arrêtée par le service Batch et laissée dans l’état dans lequel elle se trouvait à ce moment-là.

add(job_id, task, task_add_options=None, custom_headers=None, raw=False, **operation_config)

Paramètres

job_id

str

Obligatoire

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

task

TaskAddParameter

Obligatoire

Tâche à ajouter.

task_add_options

TaskAddOptions

valeur par défaut: None

Paramètres supplémentaires pour l’opération

custom_headers

dict

valeur par défaut: None

en-têtes qui seront ajoutés à la demande

raw

bool

valeur par défaut: False

retourne la réponse directe à côté de la réponse désérialisée

operation_config

Obligatoire

La configuration de l’opération remplace.

Retours

None ou ClientRawResponse si raw=true

Type de retour

None,

ClientRawResponse

Exceptions

BatchErrorException

add_collection

Ajoute une collection de tâches au travail spécifié.

Notez que chaque tâche doit avoir un ID unique. Le service Batch peut ne pas retourner les résultats de chaque tâche dans le même ordre que celui envoyé dans cette demande. Si le serveur expire ou si la connexion est fermée pendant la demande, la demande peut avoir été partiellement ou entièrement traitée, ou pas du tout. Dans ce cas, l'utilisateur doit renouveler la demande. Notez qu’il appartient à 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. Lors d’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é ajoutées avec succès lors de 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’est pas terminée dans les 180 jours suivant son ajout, elle est arrêtée par le service Batch et laissée dans l’état dans lequel elle se trouvait à ce moment-là.

add_collection(job_id, value, task_add_collection_options=None, custom_headers=None, raw=False, threads=0, **operation_config)

Paramètres

job_id

str

Obligatoire

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

value

list of TaskAddParameter

Obligatoire

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

task_add_collection_options

TaskAddCollectionOptions

valeur par défaut: None

Paramètres supplémentaires pour l’opération

custom_headers

dict

valeur par défaut: None

en-têtes qui seront ajoutés à la demande

raw

bool

valeur par défaut: False

retourne la réponse directe à côté de la réponse désérialisée

threads

int

valeur par défaut: 0

nombre de threads à utiliser en parallèle lors de l’ajout de tâches. Si spécifié et supérieur à 0, démarre des threads supplémentaires pour envoyer des demandes et attendre qu’elles se terminent. Dans le cas contraire, add_collection demandes sont envoyées séquentiellement sur main thread

Retours

TaskAddCollectionResult ou ClientRawResponse si raw=true

Type de retour

TaskAddCollectionResult,

ClientRawResponse

Exceptions

azure.batch.custom.CreateTasksErrorException

delete

Supprime une tâche du travail spécifié.

Lorsqu’une tâche est supprimée, tous les fichiers de son répertoire sur le nœud de calcul sur lequel elle s’est exécutée sont également supprimés (quelle que soit la durée de conservation). Pour les tâches multi-instance, l’opération supprimer la tâche s’applique de manière synchrone à la tâche principale ; les tâches secondaires et leurs fichiers sont ensuite supprimés de manière asynchrone en arrière-plan.

delete(job_id, task_id, task_delete_options=None, custom_headers=None, raw=False, **operation_config)

Paramètres

job_id

str

Obligatoire

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

task_id

str

Obligatoire

ID de la tâche à supprimer.

task_delete_options

TaskDeleteOptions

valeur par défaut: None

Paramètres supplémentaires pour l’opération

custom_headers

dict

valeur par défaut: None

en-têtes qui seront ajoutés à la demande

raw

bool

valeur par défaut: False

retourne la réponse directe à côté de la réponse désérialisée

operation_config

Obligatoire

La configuration de l’opération remplace.

Retours

None ou ClientRawResponse si raw=true

Type de retour

None,

ClientRawResponse

Exceptions

BatchErrorException

get

Obtient des informations sur la tâche spécifiée.

Pour les tâches multi-instance, les 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 secondaires.

get(job_id, task_id, task_get_options=None, custom_headers=None, raw=False, **operation_config)

Paramètres

job_id

str

Obligatoire

ID du travail qui contient la tâche.

task_id

str

Obligatoire

ID de la tâche sur laquelle obtenir des informations.

task_get_options

TaskGetOptions

valeur par défaut: None

Paramètres supplémentaires pour l’opération

custom_headers

dict

valeur par défaut: None

en-têtes qui seront ajoutés à la demande

raw

bool

valeur par défaut: False

retourne la réponse directe à côté de la réponse désérialisée

operation_config

Obligatoire

La configuration de l’opération remplace.

Retours

CloudTask ou ClientRawResponse si raw=true

Type de retour

CloudTask,

ClientRawResponse

Exceptions

BatchErrorException

list

Répertorie toutes les tâches associées au travail spécifié.

Pour les tâches multi-instance, les 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 secondaires.

list(job_id, task_list_options=None, custom_headers=None, raw=False, **operation_config)

Paramètres

job_id

str

Obligatoire

ID du travail.

task_list_options

TaskListOptions

valeur par défaut: None

Paramètres supplémentaires pour l’opération

custom_headers

dict

valeur par défaut: None

en-têtes qui seront ajoutés à la demande

raw

bool

valeur par défaut: False

retourne la réponse directe à côté de la réponse désérialisée

operation_config

Obligatoire

La configuration de l’opération remplace.

Retours

Un itérateur comme instance de CloudTask

Type de retour

CloudTaskPaged[CloudTask]

Exceptions

BatchErrorException

list_subtasks

Répertorie toutes les tâches secondaires associées à la tâche multi-instance spécifiée.

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

list_subtasks(job_id, task_id, task_list_subtasks_options=None, custom_headers=None, raw=False, **operation_config)

Paramètres

job_id

str

Obligatoire

ID du travail.

task_id

str

Obligatoire

ID de la tâche.

task_list_subtasks_options

TaskListSubtasksOptions

valeur par défaut: None

Paramètres supplémentaires pour l’opération

custom_headers

dict

valeur par défaut: None

en-têtes qui seront ajoutés à la demande

raw

bool

valeur par défaut: False

retourne la réponse directe à côté de la réponse désérialisée

operation_config

Obligatoire

La configuration de l’opération remplace.

Retours

CloudTaskListSubtasksResult ou ClientRawResponse si raw=true

Type de retour

CloudTaskListSubtasksResult,

ClientRawResponse

Exceptions

BatchErrorException

reactivate

Réactive une tâche, ce qui lui permet de s’exécuter à nouveau même si son nombre de nouvelles tentatives a été épuisé.

La réactivation rend une tâche éligible pour être retentée à nouveau jusqu’à son nombre maximal de nouvelles tentatives. L’état de la tâche passe à actif. Comme la tâche n’est plus à l’état terminé, le code de sortie ou les informations d’échec précédents ne sont plus disponibles 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 avec succès (avec un code de sortie de 0). En outre, elle échoue si le travail est terminé (ou est en cours de fin ou de suppression).

reactivate(job_id, task_id, task_reactivate_options=None, custom_headers=None, raw=False, **operation_config)

Paramètres

job_id

str

Obligatoire

ID du travail contenant la tâche.

task_id

str

Obligatoire

ID de la tâche à réactiver.

task_reactivate_options

TaskReactivateOptions

valeur par défaut: None

Paramètres supplémentaires pour l’opération

custom_headers

dict

valeur par défaut: None

en-têtes qui seront ajoutés à la demande

raw

bool

valeur par défaut: False

retourne la réponse directe à côté de la réponse désérialisée

operation_config

Obligatoire

La configuration de l’opération remplace.

Retours

None ou ClientRawResponse si raw=true

Type de retour

None,

ClientRawResponse

Exceptions

BatchErrorException

terminate

Termine la tâche spécifiée.

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

terminate(job_id, task_id, task_terminate_options=None, custom_headers=None, raw=False, **operation_config)

Paramètres

job_id

str

Obligatoire

ID du travail contenant la tâche.

task_id

str

Obligatoire

ID de la tâche à terminer.

task_terminate_options

TaskTerminateOptions

valeur par défaut: None

Paramètres supplémentaires pour l’opération

custom_headers

dict

valeur par défaut: None

en-têtes qui seront ajoutés à la demande

raw

bool

valeur par défaut: False

retourne la réponse directe à côté de la réponse désérialisée

operation_config

Obligatoire

La configuration de l’opération remplace.

Retours

None ou ClientRawResponse si raw=true

Type de retour

None,

ClientRawResponse

Exceptions

BatchErrorException

update

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

update(job_id, task_id, constraints=None, task_update_options=None, custom_headers=None, raw=False, **operation_config)

Paramètres

job_id

str

Obligatoire

ID du travail contenant la tâche.

task_id

str

Obligatoire

ID de la tâche à mettre à jour.

constraints

TaskConstraints

valeur par défaut: None

Contraintes qui s’appliquent à cette tâche. En cas d’omission, la tâche reçoit les contraintes par défaut. Pour les tâches multi instance, la mise à jour du temps de rétention s’applique uniquement à la tâche principale et non aux tâches subordonnées.

task_update_options

TaskUpdateOptions

valeur par défaut: None

Paramètres supplémentaires pour l’opération

custom_headers

dict

valeur par défaut: None

en-têtes qui seront ajoutés à la demande

raw

bool

valeur par défaut: False

retourne la réponse directe en même temps que la réponse désérialisée

operation_config

Obligatoire

Remplacements de configuration d’opération.

Retours

None ou ClientRawResponse si raw=true

Type de retour

None,

ClientRawResponse

Exceptions

BatchErrorException

Attributs

models

models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\batch\\models\\__init__.py'>