az batch job-schedule

  • Référence

Gérer les planifications de travaux Batch.

Commandes

Nom Description Type Statut
az batch job-schedule create

Ajoutez une planification de travail Batch à un compte.

 Core GA
az batch job-schedule delete

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

 Core GA
az batch job-schedule disable

Désactive une planification de travail.

 Core GA
az batch job-schedule enable

Active une planification de travail.

 Core GA
az batch job-schedule list

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

 Core GA
az batch job-schedule reset

Réinitialisez les propriétés d’une planification de travail. Une spécification de travail mise à jour s’applique uniquement aux nouveaux travaux.

 Core GA
az batch job-schedule set

Mettez à jour les propriétés d’une planification de travail.

 Core GA
az batch job-schedule show

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

 Core GA
az batch job-schedule stop

Met fin à une planification de travail.

 Core GA

az batch job-schedule create

Modifier

Ajoutez une planification de travail Batch à un compte.

az batch job-schedule create [--account-endpoint]
                             [--account-key]
                             [--account-name]
                             [--allow-task-preemption]
                             [--do-not-run-after]
                             [--do-not-run-until]
                             [--id]
                             [--job-manager-task-command-line]
                             [--job-manager-task-id]
                             [--job-manager-task-resource-files]
                             [--job-max-task-retry-count]
                             [--job-max-wall-clock-time]
                             [--json-file]
                             [--max-parallel-tasks]
                             [--metadata]
                             [--on-all-tasks-complete {noaction, terminatejob}]
                             [--pool-id]
                             [--priority]
                             [--recurrence-interval]
                             [--required-slots]
                             [--start-window]
                             [--uses-task-dependencies]

Paramètres facultatifs

--account-endpoint

Point de terminaison de service Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ENDPOINT.

--account-key

Clé de compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCESS_KEY.

--account-name

Nom du compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCOUNT.

--allow-task-preemption

Indique si les tâches de ce travail peuvent être préemptées par d’autres travaux à priorité élevée. Si la valeur est définie sur True, les autres travaux à priorité élevée soumis au système sont prioritaires et peuvent requeuler des tâches à partir de ce travail. 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. True si l’indicateur est présent.

--do-not-run-after

Si vous ne spécifiez pas d’heure doNotRunAfter et que vous créez une planification de travail périodique, la planification du travail reste active jusqu’à ce que vous l’arrêtiez explicitement. Le format attendu est un horodatage ISO-8601.

--do-not-run-until

Si vous ne spécifiez pas d’heure doNotRunUntil, la planification est prête à créer des travaux immédiatement. Le format attendu est un horodatage ISO-8601.

--id

Obligatoire. 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).

--job-manager-task-command-line

Obligatoire. La ligne de commande ne s’exécute pas sous un interpréteur de commandes et ne peut donc pas tirer parti des fonctionnalités de l’interpréteur de commandes telles que l’extension de variable d’environnement. Si vous souhaitez tirer parti de ces fonctionnalités, vous devez appeler l’interpréteur de commandes dans la ligne de commande, par exemple en utilisant « cmd /c MyCommand » dans Windows ou « /bin/sh -c MyCommand » dans Linux. Si la ligne de commande fait référence à des chemins de fichier, elle doit utiliser un chemin relatif (par rapport au répertoire de travail de tâche) ou utiliser la variable d’environnement fournie par Batch (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).

--job-manager-task-id

Obligatoire. 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.

--job-manager-task-resource-files

Les fichiers répertoriés sous cet élément se trouvent dans le répertoire de travail de la tâche. Il existe une taille maximale pour la liste des fichiers de ressources. Lorsque la taille maximale est dépassée, la requête échoue et le code d’erreur de réponse est RequestEntityTooLarge. Si cela se produit, la collection de ResourceFiles doit être réduite en taille. Pour ce faire, utilisez des fichiers .zip, des packages d’application ou des conteneurs Docker. Références de ressources séparées par l’espace au format filename=httpurl.

--job-max-task-retry-count

Le nombre maximal de fois où chaque tâche peut être retentée. Le service Batch retente une tâche si son code de sortie n’est pas différent de zéro. Notez que cette valeur contrôle spécifiquement le nombre de nouvelles tentatives. Le service Batch essaie chaque tâche une fois, puis peut réessayer jusqu’à cette limite. Par exemple, si le nombre maximal de nouvelles tentatives est égal à 3, Batch tente une tâche jusqu’à 4 fois (une tentative initiale et 3 nouvelles tentatives). Si le nombre maximal de nouvelles tentatives est égal à 0, le service Batch n’effectue pas de nouvelles tentatives. Si le nombre maximal de nouvelles tentatives est -1, le service Batch retente les tâches sans limite. La valeur par défaut est 0 (aucune nouvelle tentative).

--job-max-wall-clock-time

Si le travail ne se termine pas dans le délai imparti, le service Batch l’arrête et toutes les tâches qui sont toujours en cours d’exécution. Dans ce cas, la raison de l’arrêt est MaxWallClockTimeExpiry. Si cette propriété n’est pas spécifiée, il n’existe aucune limite de temps sur la durée pendant laquelle le travail peut s’exécuter. Le format attendu est une durée ISO-8601.

--json-file

Fichier contenant la spécification de planification de travaux cloud au format JSON (mis en forme pour correspondre au corps de l’API REST respective). Si ce paramètre est spécifié, tous les arguments de planification de travaux cloud sont ignorés.

--max-parallel-tasks

Nombre maximal de tâches qui peuvent être exécutées en parallèle pour le travail. 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. Valeur par défaut : -1 .

--metadata

Le service Batch n’affecte aucune signification aux métadonnées ; il s’agit uniquement de l’utilisation du code utilisateur. Valeurs séparées par l’espace au format « key=value ».

--on-all-tasks-complete

L’action que le service Batch doit effectuer lorsque toutes les tâches d’un travail créé sous cette planification 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 acceptées: noaction, terminatejob
--pool-id

ID d’un pool existant. Toutes les tâches du travail s’exécutent sur le pool spécifié.

--priority

Priorité des travaux créés sous cette planification. Les valeurs de priorité peuvent aller de -1000 à 1000, avec -1000 étant la priorité la plus basse et 1000 étant la priorité la plus élevée. La valeur par défaut est 0. Cette priorité est utilisée comme valeur par défaut pour tous les travaux sous la planification du travail. Vous pouvez mettre à jour la priorité d’un travail après sa création à l’aide de l’API de travail de mise à jour.

--recurrence-interval

Étant donné qu’une planification de travail peut avoir au plus un travail actif sous celui-ci à un moment donné, s’il est temps de créer un travail sous une planification de travail, mais que le travail précédent est toujours en cours d’exécution, le service Batch ne crée pas le nouveau travail tant que le travail précédent n’est pas terminé. Si le travail précédent ne se termine pas dans la période startWindow de la nouvelle périodicitéInterval, aucun nouveau travail n’est planifié pour cet intervalle. Pour les travaux récurrents, vous devez normalement spécifier un jobManagerTask dans jobSpecification. Si vous n’utilisez pas jobManagerTask, vous aurez besoin d’un processus externe pour surveiller le moment où les travaux sont créés, ajouter des tâches aux travaux et mettre fin aux travaux prêts pour la prochaine périodicité. La valeur par défaut est que la planification ne se répète pas : un travail est créé, dans le startWindow après l’heure doNotRunUntil, et la planification est terminée dès que ce travail se termine. La valeur minimale est de 1 minute. Si vous spécifiez une valeur inférieure, le service Batch rejette la planification avec une erreur ; si vous appelez directement l’API REST, le code d’état HTTP est 400 (requête incorrecte). Le format attendu est une durée ISO-8601.

--required-slots

Nombre d’emplacements de planification nécessaires à l’exécution de la tâche. La valeur par défaut est 1. Une tâche peut uniquement être planifiée pour s’exécuter sur un nœud de calcul si le nœud dispose de suffisamment d’emplacements de planification gratuits disponibles. Pour les tâches multi-instances, cette propriété n’est pas prise en charge et ne doit pas être spécifiée.

--start-window

Si un travail n’est pas créé dans l’intervalle startWindow, l'« opportunité » est perdue ; aucun travail n’est créé jusqu’à la prochaine périodicité de la planification. Si la planification est récurrente et que le startWindow est plus long que l’intervalle de périodicité, cela équivaut à un startWindow infini, car le travail « due » dans une périodicitéInterval n’est pas transféré dans l’intervalle de périodicité suivant. La valeur par défaut est infinie. La valeur minimale est de 1 minute. Si vous spécifiez une valeur inférieure, le service Batch rejette la planification avec une erreur ; si vous appelez directement l’API REST, le code d’état HTTP est 400 (requête incorrecte). Le format attendu est une durée ISO-8601.

--uses-task-dependencies

Indique si les tâches du travail peuvent définir des dépendances entre elles. La valeur par défaut est false. True si l’indicateur est présent.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az batch job-schedule delete

Modifier

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 les 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.

az batch job-schedule delete --job-schedule-id
                             [--account-endpoint]
                             [--account-key]
                             [--account-name]
                             [--if-match]
                             [--if-modified-since]
                             [--if-none-match]
                             [--if-unmodified-since]
                             [--yes]

Paramètres obligatoires

--job-schedule-id

ID de la planification du travail à supprimer.

Paramètres facultatifs

--account-endpoint

Point de terminaison de service Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ENDPOINT.

--account-key

Clé de compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCESS_KEY.

--account-name

Nom du compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCOUNT.

--if-match

Valeur ETag associée à la version de la ressource connue du client. L’opération n’est effectuée que si l’ETag actuel de la ressource sur le service correspond exactement à la valeur spécifiée par le client.

--if-modified-since

Horodatage indiquant l’heure de dernière modification de la ressource connue du client. L’opération n’est effectuée que si la ressource sur le service a été modifiée depuis l’heure spécifiée.

--if-none-match

Valeur ETag associée à la version de la ressource connue du client. L’opération n’est effectuée que si l’ETag actuel de la ressource sur le service ne correspond pas à la valeur spécifiée par le client.

--if-unmodified-since

Horodatage indiquant l’heure de dernière modification de la ressource connue du client. L’opération n’est effectuée que si la ressource sur le service n’a pas été modifiée depuis l’heure spécifiée.

--yes -y

Ne pas demander de confirmation.

valeur par défaut: False
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az batch job-schedule disable

Modifier

Désactive une planification de travail.

Aucun nouveau travail ne sera créé tant que la planification du travail n’est pas à nouveau activée.

az batch job-schedule disable --job-schedule-id
                              [--account-endpoint]
                              [--account-key]
                              [--account-name]
                              [--if-match]
                              [--if-modified-since]
                              [--if-none-match]
                              [--if-unmodified-since]

Paramètres obligatoires

--job-schedule-id

ID de la planification du travail à désactiver.

Paramètres facultatifs

--account-endpoint

Point de terminaison de service Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ENDPOINT.

--account-key

Clé de compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCESS_KEY.

--account-name

Nom du compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCOUNT.

--if-match

Valeur ETag associée à la version de la ressource connue du client. L’opération n’est effectuée que si l’ETag actuel de la ressource sur le service correspond exactement à la valeur spécifiée par le client.

--if-modified-since

Horodatage indiquant l’heure de dernière modification de la ressource connue du client. L’opération n’est effectuée que si la ressource sur le service a été modifiée depuis l’heure spécifiée.

--if-none-match

Valeur ETag associée à la version de la ressource connue du client. L’opération n’est effectuée que si l’ETag actuel de la ressource sur le service ne correspond pas à la valeur spécifiée par le client.

--if-unmodified-since

Horodatage indiquant l’heure de dernière modification de la ressource connue du client. L’opération n’est effectuée que si la ressource sur le service n’a pas été modifiée depuis l’heure spécifiée.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az batch job-schedule enable

Modifier

Active une planification de travail.

az batch job-schedule enable --job-schedule-id
                             [--account-endpoint]
                             [--account-key]
                             [--account-name]
                             [--if-match]
                             [--if-modified-since]
                             [--if-none-match]
                             [--if-unmodified-since]

Paramètres obligatoires

--job-schedule-id

ID de la planification du travail à activer.

Paramètres facultatifs

--account-endpoint

Point de terminaison de service Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ENDPOINT.

--account-key

Clé de compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCESS_KEY.

--account-name

Nom du compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCOUNT.

--if-match

Valeur ETag associée à la version de la ressource connue du client. L’opération n’est effectuée que si l’ETag actuel de la ressource sur le service correspond exactement à la valeur spécifiée par le client.

--if-modified-since

Horodatage indiquant l’heure de dernière modification de la ressource connue du client. L’opération n’est effectuée que si la ressource sur le service a été modifiée depuis l’heure spécifiée.

--if-none-match

Valeur ETag associée à la version de la ressource connue du client. L’opération n’est effectuée que si l’ETag actuel de la ressource sur le service ne correspond pas à la valeur spécifiée par le client.

--if-unmodified-since

Horodatage indiquant l’heure de dernière modification de la ressource connue du client. L’opération n’est effectuée que si la ressource sur le service n’a pas été modifiée depuis l’heure spécifiée.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az batch job-schedule list

Modifier

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

az batch job-schedule list [--account-endpoint]
                           [--account-key]
                           [--account-name]
                           [--expand]
                           [--filter]
                           [--select]

Paramètres facultatifs

--account-endpoint

Point de terminaison de service Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ENDPOINT.

--account-key

Clé de compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCESS_KEY.

--account-name

Nom du compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCOUNT.

--expand

Clause $expand OData.

--filter

Clause OData $filter. Pour plus d’informations sur la construction de ce filtre, consultez https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-schedules.

--select

Clause OData $select.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az batch job-schedule reset

Modifier

Réinitialisez les propriétés d’une planification de travail. Une spécification de travail mise à jour s’applique uniquement aux nouveaux travaux.

az batch job-schedule reset --job-schedule-id
                            [--account-endpoint]
                            [--account-key]
                            [--account-name]
                            [--allow-task-preemption]
                            [--do-not-run-after]
                            [--do-not-run-until]
                            [--if-match]
                            [--if-modified-since]
                            [--if-none-match]
                            [--if-unmodified-since]
                            [--job-manager-task-application-package-references]
                            [--job-manager-task-command-line]
                            [--job-manager-task-environment-settings]
                            [--job-manager-task-id]
                            [--job-manager-task-resource-files]
                            [--job-metadata]
                            [--json-file]
                            [--max-parallel-tasks]
                            [--metadata]
                            [--on-all-tasks-complete {noaction, terminatejob}]
                            [--pool-id]
                            [--priority]
                            [--recurrence-interval]
                            [--required-slots]
                            [--start-window]
                            [--uses-task-dependencies]

Paramètres obligatoires

--job-schedule-id

ID de la planification du travail à mettre à jour.

Paramètres facultatifs

--account-endpoint

Point de terminaison de service Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ENDPOINT.

--account-key

Clé de compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCESS_KEY.

--account-name

Nom du compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCOUNT.

--allow-task-preemption

Indique si les tâches de ce travail peuvent être préemptées par d’autres travaux à priorité élevée. Si la valeur est définie sur True, les autres travaux à priorité élevée soumis au système sont prioritaires et peuvent requeuler des tâches à partir de ce travail. 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. True si l’indicateur est présent.

--do-not-run-after

Si vous ne spécifiez pas d’heure doNotRunAfter et que vous créez une planification de travail périodique, la planification du travail reste active jusqu’à ce que vous l’arrêtiez explicitement. Le format attendu est un horodatage ISO-8601.

--do-not-run-until

Si vous ne spécifiez pas d’heure doNotRunUntil, la planification est prête à créer des travaux immédiatement. Le format attendu est un horodatage ISO-8601.

--if-match

Valeur ETag associée à la version de la ressource connue du client. L’opération n’est effectuée que si l’ETag actuel de la ressource sur le service correspond exactement à la valeur spécifiée par le client.

--if-modified-since

Horodatage indiquant l’heure de dernière modification de la ressource connue du client. L’opération n’est effectuée que si la ressource sur le service a été modifiée depuis l’heure spécifiée.

--if-none-match

Valeur ETag associée à la version de la ressource connue du client. L’opération n’est effectuée que si l’ETag actuel de la ressource sur le service ne correspond pas à la valeur spécifiée par le client.

--if-unmodified-since

Horodatage indiquant l’heure de dernière modification de la ressource connue du client. L’opération n’est effectuée que si la ressource sur le service n’a pas été modifiée depuis l’heure spécifiée.

--job-manager-task-application-package-references

Les packages d’application sont téléchargés et déployés dans un répertoire partagé, et non dans le répertoire de travail des tâches. Par conséquent, si un package d’application référencé est déjà sur le nœud de calcul et qu’il est à jour, il n’est pas redéployé ; la copie existante sur le nœud de calcul est utilisée. Si un package d’application référencé ne peut pas être installé, par exemple parce que le package a été supprimé ou parce que le téléchargement a échoué, la tâche échoue. ID d’application séparés par espace avec version facultative au format « id[#version] ».

--job-manager-task-command-line

Obligatoire. La ligne de commande ne s’exécute pas sous un interpréteur de commandes et ne peut donc pas tirer parti des fonctionnalités de l’interpréteur de commandes telles que l’extension de variable d’environnement. Si vous souhaitez tirer parti de ces fonctionnalités, vous devez appeler l’interpréteur de commandes dans la ligne de commande, par exemple en utilisant « cmd /c MyCommand » dans Windows ou « /bin/sh -c MyCommand » dans Linux. Si la ligne de commande fait référence à des chemins de fichier, elle doit utiliser un chemin relatif (par rapport au répertoire de travail de tâche) ou utiliser la variable d’environnement fournie par Batch (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).

--job-manager-task-environment-settings

Valeurs séparées par l’espace au format « key=value ».

--job-manager-task-id

Obligatoire. 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.

--job-manager-task-resource-files

Les fichiers répertoriés sous cet élément se trouvent dans le répertoire de travail de la tâche. Il existe une taille maximale pour la liste des fichiers de ressources. Lorsque la taille maximale est dépassée, la requête échoue et le code d’erreur de réponse est RequestEntityTooLarge. Si cela se produit, la collection de ResourceFiles doit être réduite en taille. Pour ce faire, utilisez des fichiers .zip, des packages d’application ou des conteneurs Docker. Références de ressources séparées par l’espace au format filename=httpurl.

--job-metadata

Le service Batch n’affecte aucune signification aux métadonnées ; il s’agit uniquement de l’utilisation du code utilisateur. Valeurs séparées par l’espace au format « key=value ».

--json-file

Fichier contenant la spécification des paramètres de mise à jour de planification du travail au format JSON (mis en forme pour correspondre au corps de l’API REST respective). Si ce paramètre est spécifié, tous les « arguments de planification du travail » sont ignorés.

--max-parallel-tasks

Nombre maximal de tâches qui peuvent être exécutées en parallèle pour le travail. 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. Valeur par défaut : -1 .

--metadata

Si vous ne spécifiez pas cet élément, il prend la valeur par défaut d’une liste vide ; en effet, toutes les métadonnées existantes sont supprimées. Valeurs séparées par l’espace au format « key=value ».

--on-all-tasks-complete

L’action que le service Batch doit effectuer lorsque toutes les tâches d’un travail créé sous cette planification 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 acceptées: noaction, terminatejob
--pool-id

ID d’un pool existant. Toutes les tâches du travail s’exécutent sur le pool spécifié.

--priority

Priorité des travaux créés sous cette planification. Les valeurs de priorité peuvent aller de -1000 à 1000, avec -1000 étant la priorité la plus basse et 1000 étant la priorité la plus élevée. La valeur par défaut est 0. Cette priorité est utilisée comme valeur par défaut pour tous les travaux sous la planification du travail. Vous pouvez mettre à jour la priorité d’un travail après sa création à l’aide de l’API de travail de mise à jour.

--recurrence-interval

Étant donné qu’une planification de travail peut avoir au plus un travail actif sous celui-ci à un moment donné, s’il est temps de créer un travail sous une planification de travail, mais que le travail précédent est toujours en cours d’exécution, le service Batch ne crée pas le nouveau travail tant que le travail précédent n’est pas terminé. Si le travail précédent ne se termine pas dans la période startWindow de la nouvelle périodicitéInterval, aucun nouveau travail n’est planifié pour cet intervalle. Pour les travaux récurrents, vous devez normalement spécifier un jobManagerTask dans jobSpecification. Si vous n’utilisez pas jobManagerTask, vous aurez besoin d’un processus externe pour surveiller le moment où les travaux sont créés, ajouter des tâches aux travaux et mettre fin aux travaux prêts pour la prochaine périodicité. La valeur par défaut est que la planification ne se répète pas : un travail est créé, dans le startWindow après l’heure doNotRunUntil, et la planification est terminée dès que ce travail se termine. La valeur minimale est de 1 minute. Si vous spécifiez une valeur inférieure, le service Batch rejette la planification avec une erreur ; si vous appelez directement l’API REST, le code d’état HTTP est 400 (requête incorrecte). Le format attendu est une durée ISO-8601.

--required-slots

Nombre d’emplacements de planification nécessaires à l’exécution de la tâche. La valeur par défaut est 1. Une tâche peut uniquement être planifiée pour s’exécuter sur un nœud de calcul si le nœud dispose de suffisamment d’emplacements de planification gratuits disponibles. Pour les tâches multi-instances, cette propriété n’est pas prise en charge et ne doit pas être spécifiée.

--start-window

Si un travail n’est pas créé dans l’intervalle startWindow, l'« opportunité » est perdue ; aucun travail n’est créé jusqu’à la prochaine périodicité de la planification. Si la planification est récurrente et que le startWindow est plus long que l’intervalle de périodicité, cela équivaut à un startWindow infini, car le travail « due » dans une périodicitéInterval n’est pas transféré dans l’intervalle de périodicité suivant. La valeur par défaut est infinie. La valeur minimale est de 1 minute. Si vous spécifiez une valeur inférieure, le service Batch rejette la planification avec une erreur ; si vous appelez directement l’API REST, le code d’état HTTP est 400 (requête incorrecte). Le format attendu est une durée ISO-8601.

--uses-task-dependencies

Indique si les tâches du travail peuvent définir des dépendances entre elles. La valeur par défaut est false. True si l’indicateur est présent.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az batch job-schedule set

Modifier

Mettez à jour les propriétés d’une planification de travail.

Vous pouvez mettre à jour indépendamment la planification et la spécification du travail, mais toute modification apportée à l’une de ces entités réinitialise toutes les propriétés de cette entité.

az batch job-schedule set --job-schedule-id
                          [--account-endpoint]
                          [--account-key]
                          [--account-name]
                          [--allow-task-preemption]
                          [--do-not-run-after]
                          [--do-not-run-until]
                          [--if-match]
                          [--if-modified-since]
                          [--if-none-match]
                          [--if-unmodified-since]
                          [--job-manager-task-application-package-references]
                          [--job-manager-task-command-line]
                          [--job-manager-task-environment-settings]
                          [--job-manager-task-id]
                          [--job-manager-task-resource-files]
                          [--job-metadata]
                          [--json-file]
                          [--max-parallel-tasks]
                          [--metadata]
                          [--on-all-tasks-complete {noaction, terminatejob}]
                          [--pool-id]
                          [--priority]
                          [--recurrence-interval]
                          [--required-slots]
                          [--start-window]
                          [--uses-task-dependencies]

Paramètres obligatoires

--job-schedule-id

ID de la planification du travail à mettre à jour.

Paramètres facultatifs

--account-endpoint

Point de terminaison de service Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ENDPOINT.

--account-key

Clé de compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCESS_KEY.

--account-name

Nom du compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCOUNT.

--allow-task-preemption

Indique si les tâches de ce travail peuvent être préemptées par d’autres travaux à priorité élevée. Si la valeur est définie sur True, les autres travaux à priorité élevée soumis au système sont prioritaires et peuvent requeuler des tâches à partir de ce travail. 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. Spécifiez « true » ou « false » pour mettre à jour la propriété.

--do-not-run-after

Si vous ne spécifiez pas d’heure doNotRunAfter et que vous créez une planification de travail périodique, la planification du travail reste active jusqu’à ce que vous l’arrêtiez explicitement. Le format attendu est un horodatage ISO-8601.

--do-not-run-until

Si vous ne spécifiez pas d’heure doNotRunUntil, la planification est prête à créer des travaux immédiatement. Le format attendu est un horodatage ISO-8601.

--if-match

Valeur ETag associée à la version de la ressource connue du client. L’opération n’est effectuée que si l’ETag actuel de la ressource sur le service correspond exactement à la valeur spécifiée par le client.

--if-modified-since

Horodatage indiquant l’heure de dernière modification de la ressource connue du client. L’opération n’est effectuée que si la ressource sur le service a été modifiée depuis l’heure spécifiée.

--if-none-match

Valeur ETag associée à la version de la ressource connue du client. L’opération n’est effectuée que si l’ETag actuel de la ressource sur le service ne correspond pas à la valeur spécifiée par le client.

--if-unmodified-since

Horodatage indiquant l’heure de dernière modification de la ressource connue du client. L’opération n’est effectuée que si la ressource sur le service n’a pas été modifiée depuis l’heure spécifiée.

--job-manager-task-application-package-references

Les packages d’application sont téléchargés et déployés dans un répertoire partagé, et non dans le répertoire de travail des tâches. Par conséquent, si un package d’application référencé est déjà sur le nœud de calcul et qu’il est à jour, il n’est pas redéployé ; la copie existante sur le nœud de calcul est utilisée. Si un package d’application référencé ne peut pas être installé, par exemple parce que le package a été supprimé ou parce que le téléchargement a échoué, la tâche échoue. ID d’application séparés par espace avec version facultative au format « id[#version] ».

--job-manager-task-command-line

Obligatoire. La ligne de commande ne s’exécute pas sous un interpréteur de commandes et ne peut donc pas tirer parti des fonctionnalités de l’interpréteur de commandes telles que l’extension de variable d’environnement. Si vous souhaitez tirer parti de ces fonctionnalités, vous devez appeler l’interpréteur de commandes dans la ligne de commande, par exemple en utilisant « cmd /c MyCommand » dans Windows ou « /bin/sh -c MyCommand » dans Linux. Si la ligne de commande fait référence à des chemins de fichier, elle doit utiliser un chemin relatif (par rapport au répertoire de travail de tâche) ou utiliser la variable d’environnement fournie par Batch (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).

--job-manager-task-environment-settings

Valeurs séparées par l’espace au format « key=value ».

--job-manager-task-id

Obligatoire. 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.

--job-manager-task-resource-files

Les fichiers répertoriés sous cet élément se trouvent dans le répertoire de travail de la tâche. Il existe une taille maximale pour la liste des fichiers de ressources. Lorsque la taille maximale est dépassée, la requête échoue et le code d’erreur de réponse est RequestEntityTooLarge. Si cela se produit, la collection de ResourceFiles doit être réduite en taille. Pour ce faire, utilisez des fichiers .zip, des packages d’application ou des conteneurs Docker. Références de ressources séparées par l’espace au format filename=httpurl.

--job-metadata

Le service Batch n’affecte aucune signification aux métadonnées ; il s’agit uniquement de l’utilisation du code utilisateur. Valeurs séparées par l’espace au format « key=value ».

--json-file

Fichier contenant la spécification des paramètres de correctif de planification du travail dans JSON (mis en forme pour correspondre au corps de l’API REST respective). Si ce paramètre est spécifié, tous les « arguments de planification du travail » sont ignorés.

--max-parallel-tasks

Nombre maximal de tâches qui peuvent être exécutées en parallèle pour le travail. 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. Valeur par défaut : -1 .

--metadata

Si vous ne spécifiez pas cet élément, les métadonnées existantes restent inchangées. Valeurs séparées par l’espace au format « key=value ».

--on-all-tasks-complete

L’action que le service Batch doit effectuer lorsque toutes les tâches d’un travail créé sous cette planification 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 acceptées: noaction, terminatejob
--pool-id

ID d’un pool existant. Toutes les tâches du travail s’exécutent sur le pool spécifié.

--priority

Priorité des travaux créés sous cette planification. Les valeurs de priorité peuvent aller de -1000 à 1000, avec -1000 étant la priorité la plus basse et 1000 étant la priorité la plus élevée. La valeur par défaut est 0. Cette priorité est utilisée comme valeur par défaut pour tous les travaux sous la planification du travail. Vous pouvez mettre à jour la priorité d’un travail après sa création à l’aide de l’API de travail de mise à jour.

--recurrence-interval

Étant donné qu’une planification de travail peut avoir au plus un travail actif sous celui-ci à un moment donné, s’il est temps de créer un travail sous une planification de travail, mais que le travail précédent est toujours en cours d’exécution, le service Batch ne crée pas le nouveau travail tant que le travail précédent n’est pas terminé. Si le travail précédent ne se termine pas dans la période startWindow de la nouvelle périodicitéInterval, aucun nouveau travail n’est planifié pour cet intervalle. Pour les travaux récurrents, vous devez normalement spécifier un jobManagerTask dans jobSpecification. Si vous n’utilisez pas jobManagerTask, vous aurez besoin d’un processus externe pour surveiller le moment où les travaux sont créés, ajouter des tâches aux travaux et mettre fin aux travaux prêts pour la prochaine périodicité. La valeur par défaut est que la planification ne se répète pas : un travail est créé, dans le startWindow après l’heure doNotRunUntil, et la planification est terminée dès que ce travail se termine. La valeur minimale est de 1 minute. Si vous spécifiez une valeur inférieure, le service Batch rejette la planification avec une erreur ; si vous appelez directement l’API REST, le code d’état HTTP est 400 (requête incorrecte). Le format attendu est une durée ISO-8601.

--required-slots

Nombre d’emplacements de planification nécessaires à l’exécution de la tâche. La valeur par défaut est 1. Une tâche peut uniquement être planifiée pour s’exécuter sur un nœud de calcul si le nœud dispose de suffisamment d’emplacements de planification gratuits disponibles. Pour les tâches multi-instances, cette propriété n’est pas prise en charge et ne doit pas être spécifiée.

--start-window

Si un travail n’est pas créé dans l’intervalle startWindow, l'« opportunité » est perdue ; aucun travail n’est créé jusqu’à la prochaine périodicité de la planification. Si la planification est récurrente et que le startWindow est plus long que l’intervalle de périodicité, cela équivaut à un startWindow infini, car le travail « due » dans une périodicitéInterval n’est pas transféré dans l’intervalle de périodicité suivant. La valeur par défaut est infinie. La valeur minimale est de 1 minute. Si vous spécifiez une valeur inférieure, le service Batch rejette la planification avec une erreur ; si vous appelez directement l’API REST, le code d’état HTTP est 400 (requête incorrecte). Le format attendu est une durée ISO-8601.

--uses-task-dependencies

Indique si les tâches du travail peuvent définir des dépendances entre elles. La valeur par défaut est false. Spécifiez « true » ou « false » pour mettre à jour la propriété.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az batch job-schedule show

Modifier

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

az batch job-schedule show --job-schedule-id
                           [--account-endpoint]
                           [--account-key]
                           [--account-name]
                           [--expand]
                           [--if-match]
                           [--if-modified-since]
                           [--if-none-match]
                           [--if-unmodified-since]
                           [--select]

Paramètres obligatoires

--job-schedule-id

ID de la planification du travail à obtenir.

Paramètres facultatifs

--account-endpoint

Point de terminaison de service Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ENDPOINT.

--account-key

Clé de compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCESS_KEY.

--account-name

Nom du compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCOUNT.

--expand

Clause $expand OData.

--if-match

Valeur ETag associée à la version de la ressource connue du client. L’opération n’est effectuée que si l’ETag actuel de la ressource sur le service correspond exactement à la valeur spécifiée par le client.

--if-modified-since

Horodatage indiquant l’heure de dernière modification de la ressource connue du client. L’opération n’est effectuée que si la ressource sur le service a été modifiée depuis l’heure spécifiée.

--if-none-match

Valeur ETag associée à la version de la ressource connue du client. L’opération n’est effectuée que si l’ETag actuel de la ressource sur le service ne correspond pas à la valeur spécifiée par le client.

--if-unmodified-since

Horodatage indiquant l’heure de dernière modification de la ressource connue du client. L’opération n’est effectuée que si la ressource sur le service n’a pas été modifiée depuis l’heure spécifiée.

--select

Clause OData $select.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az batch job-schedule stop

Modifier

Met fin à une planification de travail.

az batch job-schedule stop --job-schedule-id
                           [--account-endpoint]
                           [--account-key]
                           [--account-name]
                           [--if-match]
                           [--if-modified-since]
                           [--if-none-match]
                           [--if-unmodified-since]

Paramètres obligatoires

--job-schedule-id

ID de la planification du travail à arrêter.

Paramètres facultatifs

--account-endpoint

Point de terminaison de service Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ENDPOINT.

--account-key

Clé de compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCESS_KEY.

--account-name

Nom du compte Batch. Vous pouvez également définir par variable d’environnement : AZURE_BATCH_ACCOUNT.

--if-match

Valeur ETag associée à la version de la ressource connue du client. L’opération n’est effectuée que si l’ETag actuel de la ressource sur le service correspond exactement à la valeur spécifiée par le client.

--if-modified-since

Horodatage indiquant l’heure de dernière modification de la ressource connue du client. L’opération n’est effectuée que si la ressource sur le service a été modifiée depuis l’heure spécifiée.

--if-none-match

Valeur ETag associée à la version de la ressource connue du client. L’opération n’est effectuée que si l’ETag actuel de la ressource sur le service ne correspond pas à la valeur spécifiée par le client.

--if-unmodified-since

Horodatage indiquant l’heure de dernière modification de la ressource connue du client. L’opération n’est effectuée que si la ressource sur le service n’a pas été modifiée depuis l’heure spécifiée.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.