Partager via


az batch job

Gérer les travaux Batch.

Commandes

Nom Description Type État
az batch job create

Ajoutez un travail à un compte Batch.

Noyau GA
az batch job delete

Supprime un travail d’un compte Batch.

Noyau GA
az batch job disable

Désactivez un travail Batch.

Noyau GA
az batch job enable

Activez un travail Batch.

Noyau GA
az batch job list

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

Noyau GA
az batch job prep-release-status

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

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

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

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

Noyau GA
az batch job show

Obtient des informations sur le travail Batch spécifié.

Noyau GA
az batch job stop

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

Noyau GA
az batch job task-counts

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

Noyau GA
az batch job task-counts show

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

Noyau 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-application-package-references]
                    [--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]
                    [--on-all-tasks-complete]
                    [--pool-id]
                    [--priority]
                    [--required-slots]
                    [--uses-task-dependencies]

Exemples

Créez un travail associé à un pool existant.

az batch job create --id job1 --pool-id pool1

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

Chaîne qui identifie de façon unique le travail dans le compte. L’ID peut contenir n’importe quelle combinaison de caractères alphanumériques, y compris des traits d’union et des traits de soulignement, et ne peut pas contenir plus de 64 caractères. L’ID est respectant la casse et ne respecte pas la casse (autrement dit, vous n’avez peut-être pas deux ID au sein d’un compte qui diffèrent uniquement par cas). Obligatoire.

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

Liste des packages d’application que le service Batch déploie sur le nœud de calcul avant d’exécuter la ligne de commande. 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

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

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

--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. 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, vous pouvez utiliser 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

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

--metadata

Liste des paires nom-valeur associées au travail en tant que métadonnées. Le service Batch n’affecte aucune signification aux métadonnées ; il s’agit uniquement de l’utilisation du code utilisateur. 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é. 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. Les valeurs connues sont : « noaction » et « terminatejob ».

--pool-id

ID d’un pool existant. Toutes les tâches du travail s’exécutent sur le pool spécifié. Vous devez vous assurer que le pool référencé par cette propriété existe. Si le pool n’existe pas au moment où le service Batch tente de planifier un travail, aucune tâche du travail ne s’exécute tant que vous n’avez pas créé un pool avec cet ID. Notez que le service Batch ne rejette pas la demande de travail ; il n’exécute simplement pas les tâches tant que le pool n’existe pas. Vous devez spécifier l’ID du pool ou la spécification du pool automatique, mais pas les deux.

--priority

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

--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 la détail de journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez-le.

--only-show-errors

Affiche 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ête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez la détail de journalisation. Utilisez --debug pour les journaux de débogage complets.

az batch job delete

Supprime un travail d’un compte Batch.

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

Exemples

Supprimez un travail à l’aide de l’ID de travail sans demander de confirmation.

az batch job delete --job-id job1 --yes

Paramètres obligatoires

--job-id

ID du travail à supprimer. Obligatoire.

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 a été modifiée depuis l’heure spécifiée.

--yes -y

N’invitez pas à confirmer.

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

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

--help -h

Affichez ce message d’aide et quittez-le.

--only-show-errors

Affiche 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ête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez la détail de journalisation. Utilisez --debug pour les journaux de débogage complets.

az batch job disable

Désactivez un travail Batch.

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]
                     [--json-file]

Exemples

Désactivez un travail et réinitialisation de la file d’attente des tâches en cours d’exécution.

az batch job disable --job-id job1 --disable-tasks requeue

Paramètres obligatoires

--job-id

ID du travail à désactiver. Obligatoire.

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

Que faire avec les tâches actives associées au travail. Obligatoire. Les valeurs connues sont : « requeue », « terminate » et « 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 a été modifiée depuis l’heure spécifiée.

--json-file

Fichier contenant la spécification de contenu 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 contenu » sont ignorés.

Paramètres globaux
--debug

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

--help -h

Affichez ce message d’aide et quittez-le.

--only-show-errors

Affiche 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ête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez la détail de journalisation. Utilisez --debug pour les journaux de débogage complets.

az batch job enable

Activez un travail Batch.

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

Exemples

Activez un travail.

az batch job enable --job-id job1

Paramètres obligatoires

--job-id

ID du travail à activer. Obligatoire.

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 a été modifiée depuis l’heure spécifiée.

Paramètres globaux
--debug

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

--help -h

Affichez ce message d’aide et quittez-le.

--only-show-errors

Affiche 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ête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez la détail de journalisation. Utilisez --debug pour les 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]

Exemples

Répertorier tous les travaux d’un compte Batch

az batch job list

Répertorier toutes les planifications de travaux dans un compte Batch

az batch job list --job-schedule-id jobschedule1

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. Uniquement nécessaire, défini 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://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch.

--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 la détail de journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez-le.

--only-show-errors

Affiche 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ête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez la détail de journalisation. Utilisez --debug pour les 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]
                   [--pool-id]
                   [--priority]

Exemples

Réinitialisez toutes les propriétés du travail à l’exception de la priorité.

az batch job reset --job-id job1 --priority 100

Paramètres obligatoires

--job-id

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

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

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

--metadata

Liste des paires nom-valeur associées au travail en tant que métadonnées. Le service Batch n’affecte aucune signification aux métadonnées ; il s’agit uniquement de l’utilisation du code utilisateur. 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é. La valeur par défaut est noaction. Les valeurs connues sont : « noaction » et « terminatejob ».

--pool-id

ID d’un pool existant. Toutes les tâches du travail s’exécutent sur le pool spécifié. Vous devez vous assurer que le pool référencé par cette propriété existe. Si le pool n’existe pas au moment où le service Batch tente de planifier un travail, aucune tâche du travail ne s’exécute tant que vous n’avez pas créé un pool avec cet ID. Notez que le service Batch ne rejette pas la demande de travail ; il n’exécute simplement pas les tâches tant que le pool n’existe pas. Vous devez spécifier l’ID du pool ou la spécification du pool automatique, mais pas les deux.

--priority

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

Paramètres globaux
--debug

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

--help -h

Affichez ce message d’aide et quittez-le.

--only-show-errors

Affiche 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ête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez la détail de journalisation. Utilisez --debug pour les 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]
                 [--pool-id]
                 [--priority]

Exemples

Mettre à jour la priorité du travail.

az batch job set --job-id job1 --priority 100

Paramètres obligatoires

--job-id

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

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

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

--metadata

Liste des paires nom-valeur associées au travail en tant que métadonnées. 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). Les valeurs connues sont : « noaction » et « terminatejob ».

--pool-id

ID d’un pool existant. Toutes les tâches du travail s’exécutent sur le pool spécifié. Vous devez vous assurer que le pool référencé par cette propriété existe. Si le pool n’existe pas au moment où le service Batch tente de planifier un travail, aucune tâche du travail ne s’exécute tant que vous n’avez pas créé un pool avec cet ID. Notez que le service Batch ne rejette pas la demande de travail ; il n’exécute simplement pas les tâches tant que le pool n’existe pas. Vous devez spécifier l’ID du pool ou la spécification du pool automatique, mais pas les deux.

--priority

Priorité du travail. Les valeurs de priorité peuvent aller de -1000 à 1 000, avec -1000 étant la priorité la plus basse et 1000 étant la priorité la plus élevée. S’il est omis, la priorité du travail reste inchangée.

Paramètres globaux
--debug

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

--help -h

Affichez ce message d’aide et quittez-le.

--only-show-errors

Affiche 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ête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez la détail de journalisation. Utilisez --debug pour les journaux de débogage complets.

az batch job show

Obtient des informations sur le travail Batch 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]

Exemples

Affiche des informations détaillées sur un travail.

az batch job show --job-id job1

Paramètres obligatoires

--job-id

ID du travail. Obligatoire.

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 a été modifiée depuis l’heure spécifiée.

--select

Clause OData $select.

Paramètres globaux
--debug

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

--help -h

Affichez ce message d’aide et quittez-le.

--only-show-errors

Affiche 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ête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez la détail de journalisation. Utilisez --debug pour les 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]

Exemples

Arrêter un travail et donner une raison d’arrêt

az batch job stop --job-id job1 --terminate-reason "Completed workflow"

Paramètres obligatoires

--job-id

ID du travail à terminer. Obligatoire.

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 a é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 la détail de journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez-le.

--only-show-errors

Affiche 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ête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

Augmentez la détail de journalisation. Utilisez --debug pour les journaux de débogage complets.