Partager via

az iot hub job

  • Référence

Remarque

Cette référence fait partie de l’extension azure-iot pour Azure CLI (version 2.46.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une commande de travail az iot Hub. En savoir plus sur les extensions.

Gérer les travaux IoT Hub (v2).

Commandes

Nom Description Type Statut
az iot hub job cancel

Annulez un travail IoT Hub.

 Extension GA
az iot hub job create

Créez et planifiez un travail IoT Hub pour l’exécution.

 Extension GA
az iot hub job list

Répertoriez les travaux historiques d’un Hub IoT.

 Extension GA
az iot hub job show

Afficher les détails d’un travail IoT Hub existant.

 Extension GA

az iot hub job cancel

Annulez un travail IoT Hub.

az iot hub job cancel --job-id
                      [--auth-type {key, login}]
                      [--hub-name]
                      [--login]
                      [--resource-group]

Exemples

Annulez un travail IoT Hub.

az iot hub job cancel --hub-name {iothub_name} --job-id {job_id}

Paramètres obligatoires

--job-id

ID de travail IoT Hub.

Paramètres facultatifs

--auth-type

Indique si l’opération doit dériver automatiquement une clé de stratégie ou utiliser la session Azure AD actuelle. Si le type d’authentification est login et que le nom d’hôte de ressource est fourni, la recherche de ressources est ignorée, sauf si nécessaire. Vous pouvez configurer la valeur par défaut à l’aide az configure --defaults iothub-data-auth-type=<auth-type-value>de .

valeurs acceptées: key, login
valeur par défaut: key
--hub-name -n

Nom ou nom d’hôte IoT Hub. Obligatoire si --login n’est pas fourni.

--login -l

Cette commande prend en charge une entité chaîne de connexion avec des droits d’exécution d’action. Permet d’éviter la connexion de session via « az login ». Si une entité chaîne de connexion et un nom sont fournis, le chaîne de connexion a la priorité. Obligatoire si --hub-name n’est pas fourni.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

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 iot hub job create

Créez et planifiez un travail IoT Hub pour l’exécution.

Lors de la planification d’un travail de mise à jour de jumeau, le correctif de jumeau est un argument obligatoire. Lors de la planification d’un travail de méthode d’appareil, le nom de la méthode et la charge utile sont des arguments obligatoires. REMARQUE : L’utilisation d’une heure de début personnalisée dans le passé peut entraîner l’échec de l’opération.

az iot hub job create --job-id
                      --job-type {scheduleDeviceMethod, scheduleUpdateTwin}
                      [--auth-type {key, login}]
                      [--duration]
                      [--hub-name]
                      [--interval]
                      [--login]
                      [--mct]
                      [--method-name]
                      [--method-payload]
                      [--method-response-timeout]
                      [--patch]
                      [--query-condition]
                      [--resource-group]
                      [--start]
                      [--ttl]
                      [--wait {false, true}]

Exemples

Créez et planifiez un travail pour mettre à jour les balises de jumeau de tous les appareils.

az iot hub job create --job-id {job_id} --job-type scheduleUpdateTwin -n {iothub_name} -q "*" --twin-patch '{"tags": {"deviceType": "Type1, Type2, Type3"}}'

Planifiez le travail et le bloc pour le résultat « terminé », « échec » ou « annulé ». Spécifiez l’intervalle d’interrogation en secondes.

az iot hub job create --job-id {job_id} --job-type scheduleUpdateTwin -n {iothub_name} -q "*" --twin-patch '{"tags": {"deviceType": "Type1, Type2, Type3"}}' --wait --poll-interval 30

Créez un travail pour mettre à jour une propriété de jumeau souhaitée sur un sous-ensemble d’appareils, planifiée pour s’exécuter à un moment ultérieur arbitraire.

az iot hub job create --job-id {job_name} --job-type scheduleUpdateTwin -n {iothub_name} --twin-patch '{"properties":{"desired": {"temperatureF": 65}}}' --start-time "2050-01-08T12:19:56.868Z" --query-condition "deviceId IN ['MyDevice1', 'MyDevice2', 'MyDevice3']"

Créez et planifiez un travail pour appeler une méthode d’appareil pour un ensemble d’appareils répondant à une condition de requête.

az iot hub job create --job-id {job_name} --job-type scheduleDeviceMethod -n {iothub_name} --method-name setSyncIntervalSec --method-payload 30 --query-condition "properties.reported.settings.syncIntervalSec != 30"

Créez et planifiez un travail pour appeler une méthode d’appareil pour tous les appareils.

az iot hub job create --job-id {job_name} --job-type scheduleDeviceMethod -q "*" -n {iothub_name} --method-name setSyncIntervalSec --method-payload '{"version":"1.0"}'

Paramètres obligatoires

--job-id

ID de travail IoT Hub.

--job-type --jt

Type de travail planifié.

valeurs acceptées: scheduleDeviceMethod, scheduleUpdateTwin

Paramètres facultatifs

--auth-type

Indique si l’opération doit dériver automatiquement une clé de stratégie ou utiliser la session Azure AD actuelle. Si le type d’authentification est login et que le nom d’hôte de ressource est fourni, la recherche de ressources est ignorée, sauf si nécessaire. Vous pouvez configurer la valeur par défaut à l’aide az configure --defaults iothub-data-auth-type=<auth-type-value>de .

valeurs acceptées: key, login
valeur par défaut: key
--duration --poll-duration

Durée totale en secondes où l’état du travail est vérifié si l’indicateur --wait est transmis.

valeur par défaut: 600
--hub-name -n

Nom ou nom d’hôte IoT Hub. Obligatoire si --login n’est pas fourni.

--interval --poll-interval

Intervalle en secondes pendant lequel l’état du travail est vérifié si l’indicateur --wait est transmis.

valeur par défaut: 10
--login -l

Cette commande prend en charge une entité chaîne de connexion avec des droits d’exécution d’action. Permet d’éviter la connexion de session via « az login ». Si une entité chaîne de connexion et un nom sont fournis, le chaîne de connexion a la priorité. Obligatoire si --hub-name n’est pas fourni.

--mct --method-connect-timeout

Nombre maximal de secondes à attendre sur la connexion de l’appareil.

valeur par défaut: 30
--method-name --mn

Méthode cible pour l’appel.

--method-payload --mp

Charge utile Json à passer à la méthode. Doit être le chemin d’accès au fichier ou json brut.

--method-response-timeout --mrt

Nombre maximal de secondes pour attendre le résultat de la méthode d’appareil.

valeur par défaut: 30
--patch --twin-patch

Correctif de jumeau souhaité. Fournissez le chemin d’accès au fichier ou json brut.

--query-condition -q

Condition pour que la requête de l’appareil obtienne des appareils sur utilisant le travail. Obligatoire si le type de travail est scheduleDeviceMethod ou scheduleUpdateTwin. Remarque : le service préfixe « SELECT * FROM devices WHERE » à l’entrée.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--start --start-time

Début planifié du travail au format d’heure de date ISO 8601. Si aucune heure de début n’est fournie, le travail est mis en file d’attente pour l’exécution d’asap. L’utilisation d’une heure de début personnalisée qui se trouve dans le passé peut entraîner l’échec de l’opération.

--ttl

Durée d’exécution maximale en secondes, avant la fin du travail.

valeur par défaut: 3600
--wait -w

Bloquer jusqu’à ce que le travail créé soit dans un état terminé, ayant échoué ou annulé. Interroge régulièrement l’intervalle spécifié par --poll-interval.

valeurs acceptées: false, true
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 iot hub job list

Répertoriez les travaux historiques d’un Hub IoT.

az iot hub job list [--auth-type {key, login}]
                    [--hub-name]
                    [--job-status {cancelled, completed, enqueued, failed, queued, running, scheduled, unknown}]
                    [--job-type {export, import, scheduleDeviceMethod, scheduleUpdateTwin}]
                    [--login]
                    [--resource-group]
                    [--top]

Exemples

Répertorier tous les travaux archivés au cours de la période de rétention (maximum de 30 jours).

az iot hub job list --hub-name {iothub_name}

Répertorier tous les travaux archivés projetant des propriétés spécifiques

az iot hub job list --hub-name {iothub_name} --query "[*].[jobId,type,status,startTime,endTime]"

Répertorier uniquement les travaux de type de jumeau de mise à jour

az iot hub job list --hub-name {iothub_name} --job-type scheduleDeviceMethod

Répertorier les travaux de méthode d’appareil qui ont l’état « planifié »

az iot hub job list --hub-name {iothub_name} --job-type scheduleDeviceMethod --job-status scheduled

Répertorier les travaux d’exportation d’appareil qui ont l’état « terminé »

az iot hub job list --hub-name {iothub_name} --job-type export --job-status completed

Paramètres facultatifs

--auth-type

Indique si l’opération doit dériver automatiquement une clé de stratégie ou utiliser la session Azure AD actuelle. Si le type d’authentification est login et que le nom d’hôte de ressource est fourni, la recherche de ressources est ignorée, sauf si nécessaire. Vous pouvez configurer la valeur par défaut à l’aide az configure --defaults iothub-data-auth-type=<auth-type-value>de .

valeurs acceptées: key, login
valeur par défaut: key
--hub-name -n

Nom ou nom d’hôte IoT Hub. Obligatoire si --login n’est pas fourni.

--job-status --js

État d’un travail planifié.

valeurs acceptées: cancelled, completed, enqueued, failed, queued, running, scheduled, unknown
--job-type --jt

Type de travail planifié.

valeurs acceptées: export, import, scheduleDeviceMethod, scheduleUpdateTwin
--login -l

Cette commande prend en charge une entité chaîne de connexion avec des droits d’exécution d’action. Permet d’éviter la connexion de session via « az login ». Si une entité chaîne de connexion et un nom sont fournis, le chaîne de connexion a la priorité. Obligatoire si --hub-name n’est pas fourni.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--top

Nombre maximal d’éléments à retourner. Utilisez -1 pour illimité.

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 iot hub job show

Afficher les détails d’un travail IoT Hub existant.

az iot hub job show --job-id
                    [--auth-type {key, login}]
                    [--hub-name]
                    [--login]
                    [--resource-group]

Exemples

Affichez les détails d’un travail créé.

az iot hub job show --hub-name {iothub_name} --job-id {job_id}

Paramètres obligatoires

--job-id

ID de travail IoT Hub.

Paramètres facultatifs

--auth-type

Indique si l’opération doit dériver automatiquement une clé de stratégie ou utiliser la session Azure AD actuelle. Si le type d’authentification est login et que le nom d’hôte de ressource est fourni, la recherche de ressources est ignorée, sauf si nécessaire. Vous pouvez configurer la valeur par défaut à l’aide az configure --defaults iothub-data-auth-type=<auth-type-value>de .

valeurs acceptées: key, login
valeur par défaut: key
--hub-name -n

Nom ou nom d’hôte IoT Hub. Obligatoire si --login n’est pas fourni.

--login -l

Cette commande prend en charge une entité chaîne de connexion avec des droits d’exécution d’action. Permet d’éviter la connexion de session via « az login ». Si une entité chaîne de connexion et un nom sont fournis, le chaîne de connexion a la priorité. Obligatoire si --hub-name n’est pas fourni.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

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.