CloudJob interface

Paquet:

@azure/batch

Interface représentant CloudJob.

Propriétés

commonEnvironmentSettings	Liste des paramètres courants des variables d’environnement. Ces variables d’environnement sont définies pour toutes les tâches du travail (y compris le Gestionnaire de travaux, la préparation du travail et les tâches de mise en production du travail). Les tâches individuelles peuvent remplacer un paramètre d’environnement spécifié ici en spécifiant le même nom de paramètre avec une valeur différente.
constraints	Contraintes d’exécution pour le travail.
creationTime	Heure de création du travail.
displayName	Nom complet du travail.
eTag	ETag du travail. Il s’agit d’une chaîne opaque. Vous pouvez l’utiliser pour détecter si le travail a changé entre les demandes. En particulier, vous pouvez passer l’ETag lors de la mise à jour d’un travail pour spécifier que vos modifications doivent prendre effet uniquement si personne d’autre n’a modifié le travail en attendant.
executionInfo	Informations d’exécution pour le travail.
id	Chaîne qui identifie de façon unique le travail dans le compte. L’ID est respectant la casse et ne respecte pas la casse (autrement dit, vous n’avez peut-être pas deux ID au sein d’un compte qui diffèrent uniquement par cas).
jobManagerTask	Détails d’une tâche du Gestionnaire de travaux à lancer au démarrage du travail.
jobPreparationTask	Tâche de préparation du travail. La tâche de préparation du travail est une tâche spéciale exécutée sur chaque nœud de calcul avant toute autre tâche du travail.
jobReleaseTask	Tâche de mise en production du travail. La tâche de mise en production du travail est une tâche spéciale exécutée à la fin du travail sur chaque nœud de calcul qui a exécuté toute autre tâche du travail.
lastModified	Heure de dernière modification du travail. Il s’agit de la dernière fois où les données au niveau du travail, telles que l’état ou la priorité du travail, ont changé. Elle ne prend pas en compte les modifications au niveau des tâches, telles que l’ajout de nouvelles tâches ou le changement d’état des tâches.
metadata	Liste des paires nom-valeur associées au travail en tant que métadonnées. Le service Batch n’affecte aucune signification aux métadonnées ; il s’agit uniquement de l’utilisation du code utilisateur.
networkConfiguration	Configuration réseau du travail.
onAllTasksComplete	Action que le service Batch doit effectuer lorsque toutes les tâches du travail sont dans l’état terminé. La valeur par défaut est noaction. Les valeurs possibles sont les suivantes : 'noAction', 'terminateJob'
onTaskFailure	Action que le service Batch doit effectuer quand une tâche dans le travail échoue. Une tâche est considérée comme ayant échoué en cas d’échec. Un failureInfo est défini si la tâche se termine avec un code de sortie autre que zéro après avoir épuisé son nombre de nouvelles tentatives, ou s’il y a eu une erreur lors du démarrage de la tâche, par exemple en raison d’une erreur de téléchargement de fichier de ressources. La valeur par défaut est noaction. Les valeurs possibles sont les suivantes : « noAction », « performExitOptionsJobAction »
poolInfo	Paramètres du pool associés au travail.
previousState	État précédent du travail. Cette propriété n’est pas définie si le travail est dans son état actif initial. Les valeurs possibles sont les suivantes : « active », « disabled », « disabled », « enabling », « terminateting », « completed », « deleting »
previousStateTransitionTime	Heure à laquelle le travail a entré son état précédent. Cette propriété n’est pas définie si le travail est dans son état actif initial.
priority	Priorité du travail. Les valeurs de priorité peuvent aller de -1000 à 1 000, avec -1000 étant la priorité la plus basse et 1000 étant la priorité la plus élevée. La valeur par défaut est 0.
state	État actuel du travail. Les valeurs possibles sont les suivantes : « active », « disabled », « disabled », « enabling », « terminateting », « completed », « deleting »
stateTransitionTime	Heure à laquelle le travail a entré son état actuel.
stats	Statistiques d’utilisation des ressources pour toute la durée de vie du travail. Cette propriété est remplie uniquement si CloudJob a été récupéré avec une clause expand incluant l’attribut « stats » ; sinon, il s’agit de null. Les statistiques peuvent ne pas être immédiatement disponibles. Le service Batch effectue un cumul périodique des statistiques. Le délai classique est d’environ 30 minutes.
url	URL du travail.
usesTaskDependencies	Indique si les tâches du travail peuvent définir des dépendances entre elles. La valeur par défaut est false.

Détails de la propriété

commonEnvironmentSettings

Liste des paramètres courants des variables d’environnement. Ces variables d’environnement sont définies pour toutes les tâches du travail (y compris le Gestionnaire de travaux, la préparation du travail et les tâches de mise en production du travail). Les tâches individuelles peuvent remplacer un paramètre d’environnement spécifié ici en spécifiant le même nom de paramètre avec une valeur différente.

commonEnvironmentSettings?: EnvironmentSetting[]

Valeur de propriété

EnvironmentSetting[]

constraints

Contraintes d’exécution pour le travail.

constraints?: JobConstraints

Valeur de propriété

JobConstraints

creationTime

Heure de création du travail.

creationTime?: Date

Valeur de propriété

Date

displayName

Nom complet du travail.

displayName?: string

Valeur de propriété

string

eTag

ETag du travail. Il s’agit d’une chaîne opaque. Vous pouvez l’utiliser pour détecter si le travail a changé entre les demandes. En particulier, vous pouvez passer l’ETag lors de la mise à jour d’un travail pour spécifier que vos modifications doivent prendre effet uniquement si personne d’autre n’a modifié le travail en attendant.

eTag?: string

Valeur de propriété

string

executionInfo

Informations d’exécution pour le travail.

executionInfo?: JobExecutionInformation

Valeur de propriété

JobExecutionInformation

id

Chaîne qui identifie de façon unique le travail dans le compte. L’ID est respectant la casse et ne respecte pas la casse (autrement dit, vous n’avez peut-être pas deux ID au sein d’un compte qui diffèrent uniquement par cas).

id?: string

Valeur de propriété

string

jobManagerTask

Détails d’une tâche du Gestionnaire de travaux à lancer au démarrage du travail.

jobManagerTask?: JobManagerTask

Valeur de propriété

JobManagerTask

jobPreparationTask

Tâche de préparation du travail. La tâche de préparation du travail est une tâche spéciale exécutée sur chaque nœud de calcul avant toute autre tâche du travail.

jobPreparationTask?: JobPreparationTask

Valeur de propriété

JobPreparationTask

jobReleaseTask

Tâche de mise en production du travail. La tâche de mise en production du travail est une tâche spéciale exécutée à la fin du travail sur chaque nœud de calcul qui a exécuté toute autre tâche du travail.

jobReleaseTask?: JobReleaseTask

Valeur de propriété

JobReleaseTask

lastModified

Heure de dernière modification du travail. Il s’agit de la dernière fois où les données au niveau du travail, telles que l’état ou la priorité du travail, ont changé. Elle ne prend pas en compte les modifications au niveau des tâches, telles que l’ajout de nouvelles tâches ou le changement d’état des tâches.

lastModified?: Date

Valeur de propriété

Date

metadata

Liste des paires nom-valeur associées au travail en tant que métadonnées. Le service Batch n’affecte aucune signification aux métadonnées ; il s’agit uniquement de l’utilisation du code utilisateur.

metadata?: MetadataItem[]

Valeur de propriété

MetadataItem[]

networkConfiguration

Configuration réseau du travail.

networkConfiguration?: JobNetworkConfiguration

Valeur de propriété

JobNetworkConfiguration

onAllTasksComplete

Action que le service Batch doit effectuer lorsque toutes les tâches du travail sont dans l’état terminé. La valeur par défaut est noaction. Les valeurs possibles sont les suivantes : 'noAction', 'terminateJob'

onAllTasksComplete?: OnAllTasksComplete

Valeur de propriété

OnAllTasksComplete

onTaskFailure

Action que le service Batch doit effectuer quand une tâche dans le travail échoue. Une tâche est considérée comme ayant échoué en cas d’échec. Un failureInfo est défini si la tâche se termine avec un code de sortie autre que zéro après avoir épuisé son nombre de nouvelles tentatives, ou s’il y a eu une erreur lors du démarrage de la tâche, par exemple en raison d’une erreur de téléchargement de fichier de ressources. La valeur par défaut est noaction. Les valeurs possibles sont les suivantes : « noAction », « performExitOptionsJobAction »

onTaskFailure?: OnTaskFailure

Valeur de propriété

OnTaskFailure

poolInfo

Paramètres du pool associés au travail.

poolInfo?: PoolInformation

Valeur de propriété

PoolInformation

previousState

État précédent du travail. Cette propriété n’est pas définie si le travail est dans son état actif initial. Les valeurs possibles sont les suivantes : « active », « disabled », « disabled », « enabling », « terminateting », « completed », « deleting »

previousState?: JobState

Valeur de propriété

JobState

previousStateTransitionTime

Heure à laquelle le travail a entré son état précédent. Cette propriété n’est pas définie si le travail est dans son état actif initial.

previousStateTransitionTime?: Date

Valeur de propriété

Date

priority

Priorité du travail. Les valeurs de priorité peuvent aller de -1000 à 1 000, avec -1000 étant la priorité la plus basse et 1000 étant la priorité la plus élevée. La valeur par défaut est 0.

priority?: number

Valeur de propriété

number

state

État actuel du travail. Les valeurs possibles sont les suivantes : « active », « disabled », « disabled », « enabling », « terminateting », « completed », « deleting »

state?: JobState

Valeur de propriété

JobState

stateTransitionTime

Heure à laquelle le travail a entré son état actuel.

stateTransitionTime?: Date

Valeur de propriété

Date

stats

Statistiques d’utilisation des ressources pour toute la durée de vie du travail. Cette propriété est remplie uniquement si CloudJob a été récupéré avec une clause expand incluant l’attribut « stats » ; sinon, il s’agit de null. Les statistiques peuvent ne pas être immédiatement disponibles. Le service Batch effectue un cumul périodique des statistiques. Le délai classique est d’environ 30 minutes.

stats?: JobStatistics

Valeur de propriété

JobStatistics

url

URL du travail.

url?: string

Valeur de propriété

string

usesTaskDependencies

Indique si les tâches du travail peuvent définir des dépendances entre elles. La valeur par défaut est false.

usesTaskDependencies?: boolean

Valeur de propriété

boolean