Partager via


JobScheduleOperations Classe

Opérations JobScheduleOperations.

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
JobScheduleOperations

Constructeur

JobScheduleOperations(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 planification de travail au compte spécifié.

delete

Supprime une planification de travail du compte spécifié.

Lorsque vous supprimez une planification de travail, cela supprime également tous les travaux et tâches sous cette planification. Lorsque des 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 rétention est ignorée). Les statistiques de planification des travaux ne sont plus accessibles une fois la planification du travail supprimée, bien qu’elles soient toujours comptabilisées dans les statistiques de durée de vie du compte.

disable

Désactive une planification de travail.

Aucun travail n’est créé tant que la planification des travaux n’est pas réactivé.

enable

Active une planification de travail.

exists

Vérifie l’existence de la planification de travail spécifiée.

get

Obtient des informations sur la planification de travail spécifiée.

list

Répertorie toutes les planifications de travaux dans le compte spécifié.

patch

Mises à jour les propriétés de la planification de travail spécifiée.

Cela remplace uniquement les propriétés de planification de travail spécifiées dans la demande. Par exemple, si la propriété schedule n’est pas spécifiée avec cette requête, le service Batch conserve la planification existante. Les modifications apportées à une planification de travail ont uniquement un impact sur les travaux créés par la planification après la mise à jour . Les travaux en cours d’exécution ne sont pas affectés.

terminate

Met fin à une planification de travail.

update

Mises à jour les propriétés de la planification de travail spécifiée.

Cela remplace entièrement toutes les propriétés pouvant être mises à jour de la planification du travail. Par exemple, si la propriété schedule n’est pas spécifiée avec cette requête, le service Batch supprime la planification existante. Les modifications apportées à une planification de travail ont uniquement un impact sur les travaux créés par la planification après la mise à jour . Les travaux en cours d’exécution ne sont pas affectés.

add

Ajoute une planification de travail au compte spécifié.

add(cloud_job_schedule, job_schedule_add_options=None, custom_headers=None, raw=False, **operation_config)

Paramètres

cloud_job_schedule
JobScheduleAddParameter
Obligatoire

Planification du travail à ajouter.

job_schedule_add_options
JobScheduleAddOptions
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,

Exceptions

delete

Supprime une planification de travail du compte spécifié.

Lorsque vous supprimez une planification de travail, cela supprime également tous les travaux et tâches sous cette planification. Lorsque des 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 rétention est ignorée). Les statistiques de planification des travaux ne sont plus accessibles une fois la planification du travail supprimée, bien qu’elles soient toujours comptabilisées dans les statistiques de durée de vie du compte.

delete(job_schedule_id, job_schedule_delete_options=None, custom_headers=None, raw=False, **operation_config)

Paramètres

job_schedule_id
str
Obligatoire

ID de la planification du travail à supprimer.

job_schedule_delete_options
JobScheduleDeleteOptions
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,

Exceptions

disable

Désactive une planification de travail.

Aucun travail n’est créé tant que la planification des travaux n’est pas réactivé.

disable(job_schedule_id, job_schedule_disable_options=None, custom_headers=None, raw=False, **operation_config)

Paramètres

job_schedule_id
str
Obligatoire

ID de la planification du travail à désactiver.

job_schedule_disable_options
JobScheduleDisableOptions
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,

Exceptions

enable

Active une planification de travail.

enable(job_schedule_id, job_schedule_enable_options=None, custom_headers=None, raw=False, **operation_config)

Paramètres

job_schedule_id
str
Obligatoire

ID de la planification du travail à activer.

job_schedule_enable_options
JobScheduleEnableOptions
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,

Exceptions

exists

Vérifie l’existence de la planification de travail spécifiée.

exists(job_schedule_id, job_schedule_exists_options=None, custom_headers=None, raw=False, **operation_config)

Paramètres

job_schedule_id
str
Obligatoire

ID de la planification du travail que vous souhaitez case activée.

job_schedule_exists_options
JobScheduleExistsOptions
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

bool ou ClientRawResponse si raw=true

Type de retour

bool,

Exceptions

get

Obtient des informations sur la planification de travail spécifiée.

get(job_schedule_id, job_schedule_get_options=None, custom_headers=None, raw=False, **operation_config)

Paramètres

job_schedule_id
str
Obligatoire

ID de la planification du travail à obtenir.

job_schedule_get_options
JobScheduleGetOptions
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

CloudJobSchedule ou ClientRawResponse si raw=true

Type de retour

Exceptions

list

Répertorie toutes les planifications de travaux dans le compte spécifié.

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

Paramètres

job_schedule_list_options
JobScheduleListOptions
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

Un itérateur comme instance de CloudJobSchedule

Type de retour

Exceptions

patch

Mises à jour les propriétés de la planification de travail spécifiée.

Cela remplace uniquement les propriétés de planification de travail spécifiées dans la demande. Par exemple, si la propriété schedule n’est pas spécifiée avec cette requête, le service Batch conserve la planification existante. Les modifications apportées à une planification de travail ont uniquement un impact sur les travaux créés par la planification après la mise à jour . Les travaux en cours d’exécution ne sont pas affectés.

patch(job_schedule_id, job_schedule_patch_parameter, job_schedule_patch_options=None, custom_headers=None, raw=False, **operation_config)

Paramètres

job_schedule_id
str
Obligatoire

ID de la planification du travail à mettre à jour.

job_schedule_patch_parameter
JobSchedulePatchParameter
Obligatoire

Paramètres de la requête.

job_schedule_patch_options
JobSchedulePatchOptions
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,

Exceptions

terminate

Met fin à une planification de travail.

terminate(job_schedule_id, job_schedule_terminate_options=None, custom_headers=None, raw=False, **operation_config)

Paramètres

job_schedule_id
str
Obligatoire

ID de la planification du travail à terminer.

job_schedule_terminate_options
JobScheduleTerminateOptions
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,

Exceptions

update

Mises à jour les propriétés de la planification de travail spécifiée.

Cela remplace entièrement toutes les propriétés pouvant être mises à jour de la planification du travail. Par exemple, si la propriété schedule n’est pas spécifiée avec cette requête, le service Batch supprime la planification existante. Les modifications apportées à une planification de travail ont uniquement un impact sur les travaux créés par la planification après la mise à jour . Les travaux en cours d’exécution ne sont pas affectés.

update(job_schedule_id, job_schedule_update_parameter, job_schedule_update_options=None, custom_headers=None, raw=False, **operation_config)

Paramètres

job_schedule_id
str
Obligatoire

ID de la planification du travail à mettre à jour.

job_schedule_update_parameter
JobScheduleUpdateParameter
Obligatoire

Paramètres de la requête.

job_schedule_update_options
JobScheduleUpdateOptions
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,

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'>