Partager via


JobOperations Classe

Opérations JobOperations.

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

Héritage
builtins.object
JobOperations

Constructeur

JobOperations(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 un travail au compte spécifié.

Le service Batch prend en charge deux façons de contrôler le travail effectué dans le cadre d’un travail. Dans la première approche, l’utilisateur spécifie une tâche du Gestionnaire de travaux. Le service Batch lance cette tâche lorsqu’il est prêt à démarrer le travail. La tâche gestionnaire de tâches contrôle toutes les autres tâches qui s’exécutent sous ce travail, à l’aide des API de tâche. Dans la deuxième approche, l’utilisateur contrôle directement l’exécution des tâches sous un travail actif, à l’aide des API de tâche. Notez également : lorsque vous nommez des travaux, é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 Microsoft.

delete

Supprime un travail.

La suppression d’un travail supprime également toutes les tâches qui font partie de ce travail et toutes les statistiques de travail. Cela remplace également la période de rétention pour les données de tâche ; autrement dit, si le travail contient des tâches qui sont toujours 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 demande de suppression de travail est reçue, le service Batch définit le travail à l’état de suppression. Toutes les opérations de mise à jour sur un travail dont l’état est supprimé échouent avec status code 409 (Conflit), avec des informations supplémentaires indiquant que le travail est en cours de suppression.

disable

Désactive le travail spécifié, empêchant l’exécution de nouvelles tâches.

Le service Batch déplace immédiatement le travail à l’état de désactivation. Batch utilise ensuite le paramètre disableTasks pour déterminer ce qu’il faut faire avec les tâches en cours d’exécution du travail. Le travail reste à l’état de désactivation jusqu’à ce que l’opération de désactivation soit terminée et que toutes les tâches aient été traitées conformément à l’option disableTasks ; Le travail passe ensuite à l’état désactivé. Aucune nouvelle tâche n’est démarrée sous le travail tant qu’il ne revient pas à l’état actif. Si vous essayez de désactiver un travail qui est dans un autre état que actif, désactivé ou désactivé, la demande échoue avec status code 409.

enable

Active le travail spécifié, ce qui autorise l’exécution de nouvelles tâches.

Lorsque vous appelez cette API, le service Batch définit un travail désactivé à l’état d’activation. Une fois cette opération terminée, le travail passe à l’état actif et la planification des nouvelles tâches sous le travail reprend. Le service Batch n’autorise pas une tâche à rester à l’état actif pendant plus de 180 jours. Par conséquent, si vous activez un travail contenant des tâches actives qui ont été ajoutées il y a plus de 180 jours, ces tâches ne s’exécuteront pas.

get

Obtient des informations sur le travail spécifié.

get_task_counts

Obtient le nombre de tâches pour le travail spécifié.

Le nombre de tâches fournit un nombre de tâches par état de tâche actif, en cours d’exécution ou terminé, ainsi qu’un nombre de tâches qui ont réussi ou échoué. Les tâches à l’état de préparation sont comptabilisées comme 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 de liste.

list

Répertorie tous les travaux dans le compte spécifié.

list_from_job_schedule

Répertorie les travaux qui ont été créés sous la planification des travaux spécifiée.

list_preparation_and_release_task_status

Répertorie les status d’exécution de la tâche de préparation et de mise en production du travail pour le travail spécifié sur les nœuds de calcul sur lesquels le travail s’est exécuté.

Cette API retourne les status de la tâche de préparation et de mise en production du travail sur tous les nœuds de calcul qui ont exécuté la tâche de préparation du travail ou de mise en production du travail. Cela inclut les nœuds de calcul qui ont depuis été supprimés du pool. Si cette API est appelée sur un travail qui n’a pas de tâche de préparation ou de mise en production de travail, le service Batch retourne le code HTTP status 409 (Conflit) avec un code d’erreur JobPreparationTaskNotSpecified.

patch

Mises à jour les propriétés du travail spécifié.

Cela remplace uniquement les propriétés de travail spécifiées dans la demande. Par exemple, si le travail a des contraintes et qu’une requête ne spécifie pas l’élément de contraintes, le travail conserve les contraintes existantes.

terminate

Met fin au travail spécifié, en le marquant comme terminé.

Lorsqu’une demande d’arrêt de travail est reçue, le service Batch définit le travail à l’état de fin. Le service Batch met ensuite fin à toutes les tâches en cours d’exécution associées au travail et exécute toutes les tâches de mise en production de travaux requises. Ensuite, le travail passe à l’état terminé. S’il existe des tâches dans le travail à l’état actif, elles restent à l’état actif. Une fois qu’un travail est terminé, de nouvelles tâches ne peuvent pas être ajoutées et toutes les tâches actives restantes ne sont pas planifiées.

update

Mises à jour les propriétés du travail spécifié.

Cela remplace entièrement toutes les propriétés pouvant être mises à jour du travail. Par exemple, si le travail a des contraintes associées et si les contraintes ne sont pas spécifiées avec cette demande, le service Batch supprime les contraintes existantes.

add

Ajoute un travail au compte spécifié.

Le service Batch prend en charge deux façons de contrôler le travail effectué dans le cadre d’un travail. Dans la première approche, l’utilisateur spécifie une tâche du Gestionnaire de travaux. Le service Batch lance cette tâche lorsqu’il est prêt à démarrer le travail. La tâche gestionnaire de tâches contrôle toutes les autres tâches qui s’exécutent sous ce travail, à l’aide des API de tâche. Dans la deuxième approche, l’utilisateur contrôle directement l’exécution des tâches sous un travail actif, à l’aide des API de tâche. Notez également : lorsque vous nommez des travaux, é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 Microsoft.

add(job, job_add_options=None, custom_headers=None, raw=False, **operation_config)

Paramètres

job
JobAddParameter
Obligatoire

Tâche à ajouter.

job_add_options
JobAddOptions
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,

Exceptions

delete

Supprime un travail.

La suppression d’un travail supprime également toutes les tâches qui font partie de ce travail et toutes les statistiques de travail. Cela remplace également la période de rétention pour les données de tâche ; autrement dit, si le travail contient des tâches qui sont toujours 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 demande de suppression de travail est reçue, le service Batch définit le travail à l’état de suppression. Toutes les opérations de mise à jour sur un travail dont l’état est supprimé échouent avec status code 409 (Conflit), avec des informations supplémentaires indiquant que le travail est en cours de suppression.

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

Paramètres

job_id
str
Obligatoire

ID du travail à supprimer.

job_delete_options
JobDeleteOptions
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,

Exceptions

disable

Désactive le travail spécifié, empêchant l’exécution de nouvelles tâches.

Le service Batch déplace immédiatement le travail à l’état de désactivation. Batch utilise ensuite le paramètre disableTasks pour déterminer ce qu’il faut faire avec les tâches en cours d’exécution du travail. Le travail reste à l’état de désactivation jusqu’à ce que l’opération de désactivation soit terminée et que toutes les tâches aient été traitées conformément à l’option disableTasks ; Le travail passe ensuite à l’état désactivé. Aucune nouvelle tâche n’est démarrée sous le travail tant qu’il ne revient pas à l’état actif. Si vous essayez de désactiver un travail qui est dans un autre état que actif, désactivé ou désactivé, la demande échoue avec status code 409.

disable(job_id, disable_tasks, job_disable_options=None, custom_headers=None, raw=False, **operation_config)

Paramètres

job_id
str
Obligatoire

ID du travail à désactiver.

disable_tasks
str ou DisableJobOption
Obligatoire

Les valeurs possibles sont les suivantes : 'requeue', 'terminate', 'wait'

job_disable_options
JobDisableOptions
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,

Exceptions

enable

Active le travail spécifié, ce qui autorise l’exécution de nouvelles tâches.

Lorsque vous appelez cette API, le service Batch définit un travail désactivé à l’état d’activation. Une fois cette opération terminée, le travail passe à l’état actif et la planification des nouvelles tâches sous le travail reprend. Le service Batch n’autorise pas une tâche à rester à l’état actif pendant plus de 180 jours. Par conséquent, si vous activez un travail contenant des tâches actives qui ont été ajoutées il y a plus de 180 jours, ces tâches ne s’exécuteront pas.

enable(job_id, job_enable_options=None, custom_headers=None, raw=False, **operation_config)

Paramètres

job_id
str
Obligatoire

ID du travail à activer.

job_enable_options
JobEnableOptions
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,

Exceptions

get

Obtient des informations sur le travail spécifié.

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

Paramètres

job_id
str
Obligatoire

ID du travail.

job_get_options
JobGetOptions
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

CloudJob ou ClientRawResponse si raw=true

Type de retour

Exceptions

get_task_counts

Obtient le nombre de tâches pour le travail spécifié.

Le nombre de tâches fournit un nombre de tâches par état de tâche actif, en cours d’exécution ou terminé, ainsi qu’un nombre de tâches qui ont réussi ou échoué. Les tâches à l’état de préparation sont comptabilisées comme 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 de liste.

get_task_counts(job_id, job_get_task_counts_options=None, custom_headers=None, raw=False, **operation_config)

Paramètres

job_id
str
Obligatoire

ID du travail.

job_get_task_counts_options
JobGetTaskCountsOptions
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

TaskCountsResult ou ClientRawResponse si raw=true

Type de retour

Exceptions

list

Répertorie tous les travaux dans le compte spécifié.

list(job_list_options=None, custom_headers=None, raw=False, **operation_config)

Paramètres

job_list_options
JobListOptions
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 CloudJob

Type de retour

Exceptions

list_from_job_schedule

Répertorie les travaux qui ont été créés sous la planification des travaux spécifiée.

list_from_job_schedule(job_schedule_id, job_list_from_job_schedule_options=None, custom_headers=None, raw=False, **operation_config)

Paramètres

job_schedule_id
str
Obligatoire

ID de la planification des travaux à partir de laquelle vous souhaitez obtenir la liste des travaux.

job_list_from_job_schedule_options
JobListFromJobScheduleOptions
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 CloudJob

Type de retour

Exceptions

list_preparation_and_release_task_status

Répertorie les status d’exécution de la tâche de préparation et de mise en production du travail pour le travail spécifié sur les nœuds de calcul sur lesquels le travail s’est exécuté.

Cette API retourne les status de la tâche de préparation et de mise en production du travail sur tous les nœuds de calcul qui ont exécuté la tâche de préparation du travail ou de mise en production du travail. Cela inclut les nœuds de calcul qui ont depuis été supprimés du pool. Si cette API est appelée sur un travail qui n’a pas de tâche de préparation ou de mise en production de travail, le service Batch retourne le code HTTP status 409 (Conflit) avec un code d’erreur JobPreparationTaskNotSpecified.

list_preparation_and_release_task_status(job_id, job_list_preparation_and_release_task_status_options=None, custom_headers=None, raw=False, **operation_config)

Paramètres

job_id
str
Obligatoire

ID du travail.

job_list_preparation_and_release_task_status_options
JobListPreparationAndReleaseTaskStatusOptions
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 JobPreparationAndReleaseTaskExecutionInformation

Type de retour

Exceptions

patch

Mises à jour les propriétés du travail spécifié.

Cela remplace uniquement les propriétés de travail spécifiées dans la demande. Par exemple, si le travail a des contraintes et qu’une requête ne spécifie pas l’élément de contraintes, le travail conserve les contraintes existantes.

patch(job_id, job_patch_parameter, job_patch_options=None, custom_headers=None, raw=False, **operation_config)

Paramètres

job_id
str
Obligatoire

ID du travail dont vous souhaitez mettre à jour les propriétés.

job_patch_parameter
JobPatchParameter
Obligatoire

Paramètres de la demande.

job_patch_options
JobPatchOptions
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,

Exceptions

terminate

Met fin au travail spécifié, en le marquant comme terminé.

Lorsqu’une demande d’arrêt de travail est reçue, le service Batch définit le travail à l’état de fin. Le service Batch met ensuite fin à toutes les tâches en cours d’exécution associées au travail et exécute toutes les tâches de mise en production de travaux requises. Ensuite, le travail passe à l’état terminé. S’il existe des tâches dans le travail à l’état actif, elles restent à l’état actif. Une fois qu’un travail est terminé, de nouvelles tâches ne peuvent pas être ajoutées et toutes les tâches actives restantes ne sont pas planifiées.

terminate(job_id, terminate_reason=None, job_terminate_options=None, custom_headers=None, raw=False, **operation_config)

Paramètres

job_id
str
Obligatoire

ID du travail à terminer.

terminate_reason
str
valeur par défaut: None
job_terminate_options
JobTerminateOptions
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,

Exceptions

update

Mises à jour les propriétés du travail spécifié.

Cela remplace entièrement toutes les propriétés pouvant être mises à jour du travail. Par exemple, si le travail a des contraintes associées et si les contraintes ne sont pas spécifiées avec cette demande, le service Batch supprime les contraintes existantes.

update(job_id, job_update_parameter, job_update_options=None, custom_headers=None, raw=False, **operation_config)

Paramètres

job_id
str
Obligatoire

ID du travail dont vous souhaitez mettre à jour les propriétés.

job_update_parameter
JobUpdateParameter
Obligatoire

Paramètres de la demande.

job_update_options
JobUpdateOptions
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,

Exceptions

Attributs

models

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