Partager via


az batch job

Remarque

Ce groupe de commandes a des commandes définies dans Azure CLI et au moins une extension. Installez chaque extension pour bénéficier de ses fonctionnalités étendues. En savoir plus sur les extensions.

Gérer les travaux Batch.

Commandes

Nom Description Type Statut
az batch job create

Ajoutez un travail à un compte Batch.

Core GA
az batch job create (azure-batch-cli-extensions extension)

Ajoutez un travail et des tâches associées à un compte Batch.

Extension GA
az batch job delete

Supprime un travail.

Core GA
az batch job disable

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

Core GA
az batch job enable

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

Core GA
az batch job list

Répertoriez tous les travaux ou planifications de travaux dans un compte Batch.

Core GA
az batch job prep-release-status

Affichez l’état des tâches de préparation et de mise en production du travail Batch.

Core GA
az batch job prep-release-status list

Répertorie l’état 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 où le travail est exécuté.

Core GA
az batch job reset

Mettez à jour les propriétés d’un travail Batch. Les propriétés non spécifiées qui peuvent être mises à jour sont réinitialisées à leurs valeurs par défaut.

Core GA
az batch job set

Mettez à jour les propriétés d’un travail Batch. La mise à jour d’une propriété dans un sous-groupe réinitialise les propriétés non spécifiées de ce groupe.

Core GA
az batch job show

Obtient des informations sur le travail spécifié.

Core GA
az batch job stop

Arrêtez un travail Batch en cours d’exécution.

Core GA
az batch job task-counts

Affichez le nombre de tâches et d’emplacements dans un travail Batch et leurs états.

Core GA
az batch job task-counts show

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

Core GA

az batch job create

Ajoutez un travail à un compte Batch.

az batch job create [--account-endpoint]
                    [--account-key]
                    [--account-name]
                    [--allow-task-preemption]
                    [--id]
                    [--job-manager-task-command-line]
                    [--job-manager-task-environment-settings]
                    [--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]
                    [--pool-id]
                    [--priority]
                    [--required-slots]
                    [--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.

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

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

--pool-id

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

--priority

Priorité du travail. 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.

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

--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 create (azure-batch-cli-extensions extension)

Ajoutez un travail et des tâches associées à un compte Batch.

az batch job create [--account-endpoint]
                    [--account-key]
                    [--account-name]
                    [--allow-task-preemption]
                    [--id]
                    [--job-manager-task-command-line]
                    [--job-manager-task-environment-settings]
                    [--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]
                    [--parameters]
                    [--pool-id]
                    [--priority]
                    [--required-slots]
                    [--resource-group]
                    [--template]
                    [--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.

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

Ligne de commande de la tâche du Gestionnaire de travaux. 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.

--job-manager-task-environment-settings

Liste des paramètres de variable d’environnement pour la tâche Du Gestionnaire de travaux. Valeurs séparées par espace au format « key=value ».

--job-manager-task-id

Chaîne qui identifie de façon unique la tâche du Gestionnaire de travaux dans le travail. 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

Liste des fichiers que le service Batch télécharge sur le nœud de calcul avant d’exécuter la ligne de commande. Les fichiers répertoriés sous cet élément se trouvent dans le répertoire de travail de la tâche. Références de ressources séparées par 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 le code de sortie de celle-ci diffère 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 3, le service Batch peut tenter d’exécuter la tâche jusqu’à 4 fois (tentative initiale + 3 tentatives supplémentaires). Si le nombre maximal de tentatives est 0, le service Batch ne réessaye pas d’exécuter des tâches. Si le nombre maximal de nouvelles tentatives est -1, le service Batch réessaie d’exécuter les tâches sans limite. La valeur par défaut est 0 (aucune nouvelle tentative).

--job-max-wall-clock-time

Temps écoulé maximal pendant lequel le travail peut s’exécuter, mesuré à partir du moment où le travail est créé. 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 quant à 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 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 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

Le service Batch n’affecte aucune signification aux métadonnées ; il s’agit uniquement de l’utilisation du code utilisateur.

--parameters

Valeurs de paramètre pour un fichier de modèle JSON de travail Batch. Peut être utilisé uniquement avec --template.

--pool-id

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

--priority

Priorité du travail. 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.

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

--resource-group

Groupe de ressources du compte Batch.

--template

Fichier de modèle JSON de travail Batch. Si ce paramètre est spécifié, tous les autres paramètres sont ignorés.

--uses-task-dependencies

Indicateur qui détermine si ce travail utilisera des tâches avec des dépendances. True si l’indicateur est présent.

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 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 des 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 sur l’état de suppression. Toutes les opérations de mise à jour sur un travail en cours de suppression échouent avec le code d’état 409 (conflit), avec des informations supplémentaires indiquant que le travail est supprimé.

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

Paramètres obligatoires

--job-id

ID 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 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 vers 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 dans l’état de désactivation jusqu’à ce que l’opération de désactivation soit terminée et toutes les tâches ont été traitées en fonction de l’option disableTasks ; le travail passe ensuite à l’état désactivé. Aucune nouvelle tâche n’est démarrée sous le travail jusqu’à ce qu’elle revient à l’état actif. Si vous essayez de désactiver un travail dans un état autre que actif, désactivant ou désactivé, la demande échoue avec le code d’état 409.

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

Paramètres obligatoires

--job-id

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

--disable-tasks

Les valeurs possibles sont les suivantes : « requeue », « terminate », « wait ».

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

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

Lorsque vous appelez cette API, le service Batch définit un travail désactivé sur 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 ne permet pas à une tâche de rester dans 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.

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

Paramètres obligatoires

--job-id

ID 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 list

Répertoriez tous les travaux ou planifications de travaux dans un compte Batch.

az batch job list [--account-endpoint]
                  [--account-key]
                  [--account-name]
                  [--expand]
                  [--filter]
                  [--job-schedule-id]
                  [--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.

--job-schedule-id

ID de la planification du travail à partir de laquelle vous souhaitez obtenir la liste des travaux. S’il est omis, répertorie tous les travaux du compte.

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

Mettez à jour les propriétés d’un travail Batch. Les propriétés non spécifiées qui peuvent être mises à jour sont réinitialisées à leurs valeurs par défaut.

az batch job reset --job-id
                   [--account-endpoint]
                   [--account-key]
                   [--account-name]
                   [--allow-task-preemption]
                   [--if-match]
                   [--if-modified-since]
                   [--if-none-match]
                   [--if-unmodified-since]
                   [--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]

Paramètres obligatoires

--job-id

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

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.

--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-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 des paramètres de mise à jour 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 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

S’il est omis, 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

Action que le service Batch doit effectuer lorsque toutes les tâches du travail sont dans l’état terminé. En cas d’omission, le comportement d’achèvement est défini sur noaction. Si la valeur actuelle est terminatejob, il s’agit d’une erreur, car le comportement d’achèvement d’un travail peut ne pas être changé de terminatejob à noaction. Il est possible que vous ne changez pas la valeur de terminatejob en aucune action, c’est-à-dire une fois que vous avez engagé l’arrêt automatique du travail, vous ne pouvez pas le désactiver à nouveau. Si vous essayez de le faire, la requête échoue et Batch retourne le code d’état 400 (Requête incorrecte) et une réponse d’erreur « valeur de propriété non valide ». Si vous ne spécifiez pas cet élément dans une requête PUT, il équivaut à passer une action sans action. Il s’agit d’une erreur si la valeur actuelle est terminatejob.

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é du travail. 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. S’il est omis, il est défini sur la valeur par défaut 0.

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 set

Mettez à jour les propriétés d’un travail Batch. La mise à jour d’une propriété dans un sous-groupe réinitialise les propriétés non spécifiées de ce groupe.

az batch job set --job-id
                 [--account-endpoint]
                 [--account-key]
                 [--account-name]
                 [--allow-task-preemption]
                 [--if-match]
                 [--if-modified-since]
                 [--if-none-match]
                 [--if-unmodified-since]
                 [--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]

Paramètres obligatoires

--job-id

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

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

--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-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 du paramètre de correctif de 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 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.

--metadata

S’il est omis, les métadonnées de travail existantes restent inchangées. Valeurs séparées par l’espace au format « key=value ».

--on-all-tasks-complete

Action que le service Batch doit effectuer lorsque toutes les tâches du travail sont dans l’état terminé. S’il est omis, le comportement d’achèvement reste inchangé. Il est possible que vous ne changez pas la valeur de terminatejob en aucune action, c’est-à-dire une fois que vous avez engagé l’arrêt automatique du travail, vous ne pouvez pas le désactiver à nouveau. Si vous essayez de le faire, la requête échoue avec une réponse d’erreur « valeur de propriété non valide » ; si vous appelez directement l’API REST, le code d’état HTTP est 400 (requête incorrecte).

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é du travail. 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. S’il est omis, la priorité du travail reste inchangé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 show

Obtient des informations sur le travail spécifié.

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

Paramètres obligatoires

--job-id

ID du travail.

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 stop

Arrêtez un travail Batch en cours d’exécution.

Terminez le travail spécifié, en le marquant comme terminé. Lorsqu’une demande de travail d’arrêt est reçue, le service Batch définit le travail sur 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 dans l’état actif, elles restent dans l’état actif. Une fois qu’un travail est terminé, les nouvelles tâches ne peuvent pas être ajoutées et les tâches actives restantes ne seront pas planifiées.

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

Paramètres obligatoires

--job-id

ID du travail à terminer.

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.

--terminate-reason

Motif d’arrêt.

Texte à afficher comme TerminateReason du travail. La valeur par défaut est « UserTerminate ».

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.