BatchJobCreateOptions interface

Paquet:

@azure-rest/batch

Paramètres de création d’un travail Azure Batch.

Propriétés

allowTaskPreemption	Indique si les tâches de ce travail peuvent être préemptées par d’autres travaux à priorité élevée. (Cette propriété n’est pas disponible par défaut. Pour plus d’informations, contactez le support technique) Si la valeur est définie sur True, les autres tâches de haute priorité soumises au système seront prioritaires et pourront remettre en file d’attente les tâches de cette tâche. Vous pouvez mettre à jour l’autorisation allowTaskPreemption d’un travail après sa création à l’aide de l’API de travail de mise à jour.
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.
displayName	Nom complet du travail. Le nom complet n’a pas besoin d’être unique et peut contenir des caractères Unicode pouvant atteindre une longueur maximale de 1024.
id	Chaîne qui identifie de façon unique le travail dans le compte. L’ID peut contenir n’importe quelle combinaison de caractères alphanumériques, y compris des traits d’union et des traits de soulignement, et ne peut pas contenir plus de 64 caractères. 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. Si le travail ne spécifie pas de tâche du Gestionnaire de travaux, l’utilisateur doit ajouter explicitement des tâches au travail. Si le travail spécifie une tâche du Gestionnaire de travaux, le service Batch crée la tâche du Gestionnaire de travaux lors de la création du travail et tente de planifier la tâche du Gestionnaire de travaux avant de planifier d’autres tâches dans le travail. L’objectif classique de la tâche du Gestionnaire de travaux est de contrôler et/ou de surveiller l’exécution du travail, par exemple en choisissant les tâches supplémentaires à exécuter, en déterminant quand le travail est terminé, etc. (Toutefois, une tâche du Gestionnaire de travaux n’est pas limitée à ces activités - il s’agit d’une tâche à part entière dans le système et d’effectuer les actions requises pour le travail.) Par exemple, une tâche du Gestionnaire de travaux peut télécharger un fichier spécifié en tant que paramètre, analyser le contenu de ce fichier et envoyer des tâches supplémentaires en fonction de ce contenu.
jobPreparationTask	Tâche de préparation du travail. Si un travail a une tâche de préparation du travail, le service Batch exécute la tâche de préparation du travail sur un nœud avant de démarrer les tâches de ce travail sur ce nœud de calcul.
jobReleaseTask	Tâche de mise en production du travail. Impossible de spécifier une tâche de mise en production du travail sans spécifier également une tâche de préparation du travail. Le service Batch exécute la tâche de mise en production du travail sur les nœuds qui ont exécuté la tâche de préparation du travail. L’objectif principal de la tâche de mise en production du travail consiste à annuler les modifications apportées aux nœuds de calcul effectués par la tâche de préparation du travail. Les exemples d’activités incluent la suppression de fichiers locaux ou l’arrêt des services qui ont été démarrés dans le cadre de la préparation du travail.
maxParallelTasks	Nombre maximal de tâches qui peuvent être exécutées en parallèle pour le travail. (Cette propriété n’est pas disponible par défaut. Veuillez contacter le support pour plus d’informations) La valeur de maxParallelTasks doit être -1 ou supérieure à 0 si spécifiée. Si elle n’est pas spécifiée, la valeur par défaut est -1, ce qui signifie qu’il n’existe aucune limite au nombre de tâches qui peuvent être exécutées simultanément. Vous pouvez mettre à jour maxParallelTasks d’un travail après sa création à l’aide de l’API de travail de mise à jour.
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	(Cette propriété n’est pas disponible par défaut. Veuillez contacter le support pour plus d’informations) La configuration réseau du Job.
onAllTasksComplete	Action que le service Batch doit effectuer lorsque toutes les tâches du travail sont dans l’état terminé. Notez que si un travail ne contient aucune tâche, toutes les tâches sont considérées comme terminées. Cette option est donc la plus couramment utilisée avec une tâche du Gestionnaire de travaux ; si vous souhaitez utiliser l’arrêt automatique du travail sans gestionnaire de travaux, vous devez initialement définir onAllTasksComplete sur noaction et mettre à jour les propriétés de travail pour définir onAllTasksComplete pour terminer la tâche une fois que vous avez terminé d’ajouter des tâches. La valeur par défaut est noaction. Valeurs possibles : « 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. Valeurs possibles : « noaction », « performexitoptionsjobaction »
poolInfo	Pool sur lequel le service Batch exécute les tâches du travail.
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.
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é

allowTaskPreemption

Indique si les tâches de ce travail peuvent être préemptées par d’autres travaux à priorité élevée. (Cette propriété n’est pas disponible par défaut. Pour plus d’informations, contactez le support technique) Si la valeur est définie sur True, les autres tâches de haute priorité soumises au système seront prioritaires et pourront remettre en file d’attente les tâches de cette tâche. Vous pouvez mettre à jour l’autorisation allowTaskPreemption d’un travail après sa création à l’aide de l’API de travail de mise à jour.

allowTaskPreemption?: boolean

Valeur de propriété

boolean

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?: BatchJobConstraints

Valeur de propriété

BatchJobConstraints

displayName

Nom complet du travail. Le nom complet n’a pas besoin d’être unique et peut contenir des caractères Unicode pouvant atteindre une longueur maximale de 1024.

displayName?: string

Valeur de propriété

string

id

Chaîne qui identifie de façon unique le travail dans le compte. L’ID peut contenir n’importe quelle combinaison de caractères alphanumériques, y compris des traits d’union et des traits de soulignement, et ne peut pas contenir plus de 64 caractères. 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. Si le travail ne spécifie pas de tâche du Gestionnaire de travaux, l’utilisateur doit ajouter explicitement des tâches au travail. Si le travail spécifie une tâche du Gestionnaire de travaux, le service Batch crée la tâche du Gestionnaire de travaux lors de la création du travail et tente de planifier la tâche du Gestionnaire de travaux avant de planifier d’autres tâches dans le travail. L’objectif classique de la tâche du Gestionnaire de travaux est de contrôler et/ou de surveiller l’exécution du travail, par exemple en choisissant les tâches supplémentaires à exécuter, en déterminant quand le travail est terminé, etc. (Toutefois, une tâche du Gestionnaire de travaux n’est pas limitée à ces activités - il s’agit d’une tâche à part entière dans le système et d’effectuer les actions requises pour le travail.) Par exemple, une tâche du Gestionnaire de travaux peut télécharger un fichier spécifié en tant que paramètre, analyser le contenu de ce fichier et envoyer des tâches supplémentaires en fonction de ce contenu.

jobManagerTask?: BatchJobManagerTask

Valeur de propriété

BatchJobManagerTask

jobPreparationTask

Tâche de préparation du travail. Si un travail a une tâche de préparation du travail, le service Batch exécute la tâche de préparation du travail sur un nœud avant de démarrer les tâches de ce travail sur ce nœud de calcul.

jobPreparationTask?: BatchJobPreparationTask

Valeur de propriété

BatchJobPreparationTask

jobReleaseTask

Tâche de mise en production du travail. Impossible de spécifier une tâche de mise en production du travail sans spécifier également une tâche de préparation du travail. Le service Batch exécute la tâche de mise en production du travail sur les nœuds qui ont exécuté la tâche de préparation du travail. L’objectif principal de la tâche de mise en production du travail consiste à annuler les modifications apportées aux nœuds de calcul effectués par la tâche de préparation du travail. Les exemples d’activités incluent la suppression de fichiers locaux ou l’arrêt des services qui ont été démarrés dans le cadre de la préparation du travail.

jobReleaseTask?: BatchJobReleaseTask

Valeur de propriété

BatchJobReleaseTask

maxParallelTasks

Nombre maximal de tâches qui peuvent être exécutées en parallèle pour le travail. (Cette propriété n’est pas disponible par défaut. Veuillez contacter le support pour plus d’informations) La valeur de maxParallelTasks doit être -1 ou supérieure à 0 si spécifiée. Si elle n’est pas spécifiée, la valeur par défaut est -1, ce qui signifie qu’il n’existe aucune limite au nombre de tâches qui peuvent être exécutées simultanément. Vous pouvez mettre à jour maxParallelTasks d’un travail après sa création à l’aide de l’API de travail de mise à jour.

maxParallelTasks?: number

Valeur de propriété

number

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?: BatchMetadataItem[]

Valeur de propriété

BatchMetadataItem[]

networkConfiguration

(Cette propriété n’est pas disponible par défaut. Veuillez contacter le support pour plus d’informations) La configuration réseau du Job.

networkConfiguration?: BatchJobNetworkConfiguration

Valeur de propriété

BatchJobNetworkConfiguration

onAllTasksComplete

Action que le service Batch doit effectuer lorsque toutes les tâches du travail sont dans l’état terminé. Notez que si un travail ne contient aucune tâche, toutes les tâches sont considérées comme terminées. Cette option est donc la plus couramment utilisée avec une tâche du Gestionnaire de travaux ; si vous souhaitez utiliser l’arrêt automatique du travail sans gestionnaire de travaux, vous devez initialement définir onAllTasksComplete sur noaction et mettre à jour les propriétés de travail pour définir onAllTasksComplete pour terminer la tâche une fois que vous avez terminé d’ajouter des tâches. La valeur par défaut est noaction.

Valeurs possibles : « noaction », « terminatejob »

onAllTasksComplete?: string

Valeur de propriété

string

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.

Valeurs possibles : « noaction », « performexitoptionsjobaction »

onTaskFailure?: string

Valeur de propriété

string

poolInfo

Pool sur lequel le service Batch exécute les tâches du travail.

poolInfo: BatchPoolInfo

Valeur de propriété

BatchPoolInfo

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

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