az iot central device

  • 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 d’appareil central az iot. En savoir plus sur les extensions.

Gérez et configurez des appareils IoT Central.

Commandes

Nom Description Type État
az iot central device attestation

Gérez et configurez l’attestation d’appareil IoT Central.

 Extension GA
az iot central device attestation create

Créez une attestation d’appareil individuelle.

 Extension GA
az iot central device attestation delete

Supprimez une attestation d’appareil individuelle.

 Extension GA
az iot central device attestation show

Obtenez l’attestation de l’appareil.

 Extension GA
az iot central device attestation update

Mettez à jour une attestation d’appareil individuelle via un correctif.

 Extension GA
az iot central device c2d-message

Exécutez des commandes de messagerie cloud à appareil.

 Extension GA
az iot central device c2d-message purge

Vide la file d’attente de messages cloud-à-appareil pour l’appareil cible.

 Extension GA
az iot central device command

Exécutez des commandes d’appareil.

 Extension GA
az iot central device command history

Obtenez les détails de la dernière demande de commande et de la réponse envoyées à l’appareil.

 Extension GA
az iot central device command run

Exécutez une commande sur un appareil et affichez la réponse associée. Ne surveille pas les mises à jour des propriétés que la commande peut effectuer.

 Extension GA
az iot central device compute-device-key

Générez une clé SAP d’appareil dérivée.

 Extension GA
az iot central device create

Créez un appareil dans IoT Central.

 Extension GA
az iot central device delete

Supprimez un appareil d’IoT Central.

 Extension GA
az iot central device edge

Gérez et configurez des appareils IoT Central Edge.

 Extension GA
az iot central device edge children

Gérer les appareils enfants d’appareils IoT Edge.

 Extension GA
az iot central device edge children add

Ajoutez des appareils en tant qu’enfants à un appareil de périphérie cible.

 Extension Aperçu
az iot central device edge children list

Obtenez la liste des enfants d’un appareil IoT Edge.

 Extension GA
az iot central device edge children remove

Supprimez les appareils enfants d’un appareil de périphérie cible.

 Extension Aperçu
az iot central device edge manifest

Gérer les manifestes d’appareil IoT Edge.

 Extension Aperçu
az iot central device edge manifest show

Obtenez le manifeste de déploiement associé à l’appareil IoT Edge spécifié.

 Extension Aperçu
az iot central device edge module

Gérer les modules d’appareil IoT Edge.

 Extension Aperçu
az iot central device edge module list

Obtenez la liste des modules dans un appareil IoT Edge.

 Extension Aperçu
az iot central device edge module restart

Redémarrez un module dans un appareil IoT Edge.

 Extension Aperçu
az iot central device edge module show

Obtenir un module dans un appareil IoT Edge.

 Extension Aperçu
az iot central device list

Obtenez la liste des appareils pour une application IoT Central.

 Extension GA
az iot central device list-components

Répertorier les composants présents dans un appareil.

 Extension GA
az iot central device list-modules

Répertoriez les modules présents dans un appareil.

 Extension GA
az iot central device manual-failback

Rétablit la commande de basculement précédemment exécutée en déplaçant l’appareil vers son ioT Hub d’origine.

 Extension GA
az iot central device manual-failover

Exécutez un basculement manuel de l’appareil sur plusieurs IoT Hubs pour valider la capacité du microprogramme d’appareil à se reconnecter à l’aide de DPS à un autre IoT Hub.

 Extension GA
az iot central device registration-info

Obtenez des informations d’inscription sur les appareils à partir d’IoT Central.

 Extension GA
az iot central device show

Obtenir un appareil à partir d’IoT Central.

 Extension GA
az iot central device show-credentials

Obtenez les informations d’identification de l’appareil à partir d’IoT Central.

 Extension GA
az iot central device telemetry

Interroger la dernière valeur de télémétrie de l’appareil IoT Central.

 Extension GA
az iot central device telemetry show

Obtenez la dernière valeur de télémétrie d’un appareil.

 Extension GA
az iot central device twin

Gérer les jumeaux d’appareil IoT Central.

 Extension GA
az iot central device twin replace

Remplacez les valeurs de propriété accessible en écriture d’un appareil, d’un composant d’appareil ou d’un module d’appareil ou d’un composant de module d’appareil.

 Extension GA
az iot central device twin show

Obtenez toutes les valeurs de propriété d’un appareil, d’un composant d’appareil, d’un module d’appareil ou d’un composant de module d’appareil.

 Extension GA
az iot central device twin update

Mettez à jour les valeurs de propriété accessible en écriture d’un appareil, d’un composant d’appareil, d’un module d’appareil ou d’un composant de module d’appareil.

 Extension GA
az iot central device update

Mettez à jour un appareil dans IoT Central.

 Extension GA

az iot central device compute-device-key

Générez une clé SAP d’appareil dérivée.

Générez une clé d’appareil dérivée à partir d’une clé SAP au niveau du groupe.

az iot central device compute-device-key --device-id
                                         --pk

Exemples

Utilisation de base

az iot central device compute-device-key --pk {primaryKey} --device-id {deviceid}

Paramètres obligatoires

--device-id -d

ID d’appareil de l’appareil cible. Vous trouverez l’ID de l’appareil en cliquant sur le bouton Se connecter dans la page Détails de l’appareil.

--pk --primary-key

Clé d’accès partagé symétrique primaire stockée au format base64.

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 central device create

Créez un appareil dans IoT Central.

az iot central device create --app-id
                             --device-id
                             [--api-version {2022-06-30-preview, 2022-07-31}]
                             [--central-api-uri]
                             [--device-name]
                             [--organizations]
                             [--simulated {false, true}]
                             [--template]
                             [--token]

Exemples

Créer un appareil

az iot central device create --app-id {appid} --device-id {deviceid}

Créez un appareil simulé.

az iot central device create --app-id {appid} --device-id {deviceid} --template {devicetemplateid} --simulated

Paramètres obligatoires

--app-id -n

ID d’application de l’application IoT Central que vous souhaitez gérer. Vous trouverez l’ID d’application dans la page « À propos » de votre application sous le menu d’aide.

--device-id -d

Identificateur unique de l’appareil. Chaîne sensible à la casse (128 caractères maximum) de caractères alphanumériques 7 bits ASCII, plus certains caractères spéciaux : - . + % _ # * ? ! ( ) , : = @ $ '.

Paramètres facultatifs

--api-version --av
Déprécié

L’argument 'api_version' a été déconseillé et sera supprimé dans une prochaine version.

Ce paramètre de commande a été déconseillé et sera ignoré. Dans la prochaine version, nous allons uniquement prendre en charge les API IoT Central à partir de la dernière version en disponibilité générale. Si une API n’est pas encore en disponibilité générale, nous appelons la dernière version préliminaire.

Valeurs acceptées: 2022-06-30-preview, 2022-07-31
Valeur par défaut: 2022-07-31
--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Valeur par défaut: azureiotcentral.com
--device-name

Nom de l’appareil lisible par l’homme. Exemple : Réfrigérateur.

--organizations --orgs

Affectez l’appareil aux organisations spécifiées. Liste séparée par des virgules des ID d’organisation. Version minimale prise en charge : 1.1-preview.

--simulated

Ajoutez cet indicateur si vous souhaitez qu’IoT Central configure ce paramètre en tant qu’appareil simulé. --template est requis si c’est vrai.

Valeurs acceptées: false, true
Valeur par défaut: False
--template

ID de modèle central. Exemple : dtmi :ojpkindbz :modelDefinition :iild3tm_uo.

--token

Si vous préférez envoyer votre demande sans vous authentifier auprès d’Azure CLI, vous pouvez spécifier un jeton d’utilisateur valide pour authentifier votre demande. Vous devez spécifier le type de clé dans le cadre de la requête. Pour en savoir plus, rendez-vous sur https://aka.ms/iotcentraldocsapi.

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 central device delete

Supprimez un appareil d’IoT Central.

az iot central device delete --app-id
                             --device-id
                             [--api-version {2022-06-30-preview, 2022-07-31}]
                             [--central-api-uri]
                             [--token]

Exemples

Supprimer une unité

az iot central device delete --app-id {appid} --device-id {deviceid}

Paramètres obligatoires

--app-id -n

ID d’application de l’application IoT Central que vous souhaitez gérer. Vous trouverez l’ID d’application dans la page « À propos » de votre application sous le menu d’aide.

--device-id -d

ID d’appareil de l’appareil cible. Vous trouverez l’ID de l’appareil en cliquant sur le bouton Se connecter dans la page Détails de l’appareil.

Paramètres facultatifs

--api-version --av
Déprécié

L’argument 'api_version' a été déconseillé et sera supprimé dans une prochaine version.

Ce paramètre de commande a été déconseillé et sera ignoré. Dans la prochaine version, nous allons uniquement prendre en charge les API IoT Central à partir de la dernière version en disponibilité générale. Si une API n’est pas encore en disponibilité générale, nous appelons la dernière version préliminaire.

Valeurs acceptées: 2022-06-30-preview, 2022-07-31
Valeur par défaut: 2022-07-31
--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Valeur par défaut: azureiotcentral.com
--token

Si vous préférez envoyer votre demande sans vous authentifier auprès d’Azure CLI, vous pouvez spécifier un jeton d’utilisateur valide pour authentifier votre demande. Vous devez spécifier le type de clé dans le cadre de la requête. Pour en savoir plus, rendez-vous sur https://aka.ms/iotcentraldocsapi.

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 central device list

Obtenez la liste des appareils pour une application IoT Central.

az iot central device list --app-id
                           [--api-version {2022-06-30-preview, 2022-07-31}]
                           [--central-api-uri]
                           [--edge-only]
                           [--token]

Exemples

Répertorier tous les appareils d’une application, triés par ID d’appareil (par défaut)

az iot central device list --app-id {appid}

Paramètres obligatoires

--app-id -n

ID d’application de l’application IoT Central que vous souhaitez gérer. Vous trouverez l’ID d’application dans la page « À propos » de votre application sous le menu d’aide.

Paramètres facultatifs

--api-version --av
Déprécié

L’argument 'api_version' a été déconseillé et sera supprimé dans une prochaine version.

Ce paramètre de commande a été déconseillé et sera ignoré. Dans la prochaine version, nous allons uniquement prendre en charge les API IoT Central à partir de la dernière version en disponibilité générale. Si une API n’est pas encore en disponibilité générale, nous appelons la dernière version préliminaire.

Valeurs acceptées: 2022-06-30-preview, 2022-07-31
Valeur par défaut: 2022-07-31
--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Valeur par défaut: azureiotcentral.com
--edge-only -e

Répertorier uniquement les appareils IoT Edge.

Valeur par défaut: False
--token

Si vous préférez envoyer votre demande sans vous authentifier auprès d’Azure CLI, vous pouvez spécifier un jeton d’utilisateur valide pour authentifier votre demande. Vous devez spécifier le type de clé dans le cadre de la requête. Pour en savoir plus, rendez-vous sur https://aka.ms/iotcentraldocsapi.

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 central device list-components

Répertorier les composants présents dans un appareil.

az iot central device list-components --app-id
                                      --device-id
                                      [--api-version {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri]
                                      [--mn]
                                      [--token]

Exemples

Répertorier les composants présents dans un appareil

az iot central device list-components --app-id {appid} --device-id {deviceid}

Répertorier les composants présents dans un module d’appareil

az iot central device list-components --app-id {appid} --module-name {modulename} --device-id {deviceid}

Paramètres obligatoires

--app-id -n

ID d’application de l’application IoT Central que vous souhaitez gérer. Vous trouverez l’ID d’application dans la page « À propos » de votre application sous le menu d’aide.

--device-id -d

ID d’appareil de l’appareil cible. Vous trouverez l’ID de l’appareil en cliquant sur le bouton Se connecter dans la page Détails de l’appareil.

Paramètres facultatifs

--api-version --av
Déprécié

L’argument 'api_version' a été déconseillé et sera supprimé dans une prochaine version.

Ce paramètre de commande a été déconseillé et sera ignoré. Dans la prochaine version, nous allons uniquement prendre en charge les API IoT Central à partir de la dernière version en disponibilité générale. Si une API n’est pas encore en disponibilité générale, nous appelons la dernière version préliminaire.

Valeurs acceptées: 2022-06-30-preview, 2022-07-31
Valeur par défaut: 2022-07-31
--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Valeur par défaut: azureiotcentral.com
--mn --module-name

Nom du module d’appareil.

--token

Si vous préférez envoyer votre demande sans vous authentifier auprès d’Azure CLI, vous pouvez spécifier un jeton d’utilisateur valide pour authentifier votre demande. Vous devez spécifier le type de clé dans le cadre de la requête. Pour en savoir plus, rendez-vous sur https://aka.ms/iotcentraldocsapi.

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 central device list-modules

Répertoriez les modules présents dans un appareil.

az iot central device list-modules --app-id
                                   --device-id
                                   [--api-version {2022-06-30-preview, 2022-07-31}]
                                   [--central-api-uri]
                                   [--token]

Exemples

Répertorier les modules présents dans un appareil

az iot central device list-modules --app-id {appid} --device-id {deviceid}

Paramètres obligatoires

--app-id -n

ID d’application de l’application IoT Central que vous souhaitez gérer. Vous trouverez l’ID d’application dans la page « À propos » de votre application sous le menu d’aide.

--device-id -d

ID d’appareil de l’appareil cible. Vous trouverez l’ID de l’appareil en cliquant sur le bouton Se connecter dans la page Détails de l’appareil.

Paramètres facultatifs

--api-version --av
Déprécié

L’argument 'api_version' a été déconseillé et sera supprimé dans une prochaine version.

Ce paramètre de commande a été déconseillé et sera ignoré. Dans la prochaine version, nous allons uniquement prendre en charge les API IoT Central à partir de la dernière version en disponibilité générale. Si une API n’est pas encore en disponibilité générale, nous appelons la dernière version préliminaire.

Valeurs acceptées: 2022-06-30-preview, 2022-07-31
Valeur par défaut: 2022-07-31
--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Valeur par défaut: azureiotcentral.com
--token

Si vous préférez envoyer votre demande sans vous authentifier auprès d’Azure CLI, vous pouvez spécifier un jeton d’utilisateur valide pour authentifier votre demande. Vous devez spécifier le type de clé dans le cadre de la requête. Pour en savoir plus, rendez-vous sur https://aka.ms/iotcentraldocsapi.

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 central device manual-failback

Rétablit la commande de basculement précédemment exécutée en déplaçant l’appareil vers son ioT Hub d’origine.

Pour plus d’informations sur la haute disponibilité, visitez https://github.com/iot-for-all/iot-central-high-availability-clients#readme.

az iot central device manual-failback --app-id
                                      --device-id
                                      [--api-version {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri]
                                      [--token]

Exemples

Rétablit la commande de basculement précédemment exécutée en déplaçant l’appareil vers son hub IoT d’origine

az iot central device manual-failback --app-id {appid} --device-id {deviceid}

Paramètres obligatoires

--app-id -n

ID d’application de l’application IoT Central que vous souhaitez gérer. Vous trouverez l’ID d’application dans la page « À propos » de votre application sous le menu d’aide.

--device-id -d

ID d’appareil de l’appareil cible. Vous trouverez l’ID de l’appareil en cliquant sur le bouton Se connecter dans la page Détails de l’appareil.

Paramètres facultatifs

--api-version --av
Déprécié

L’argument 'api_version' a été déconseillé et sera supprimé dans une prochaine version.

Ce paramètre de commande a été déconseillé et sera ignoré. Dans la prochaine version, nous allons uniquement prendre en charge les API IoT Central à partir de la dernière version en disponibilité générale. Si une API n’est pas encore en disponibilité générale, nous appelons la dernière version préliminaire.

Valeurs acceptées: 2022-06-30-preview, 2022-07-31
Valeur par défaut: 2022-07-31
--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Valeur par défaut: azureiotcentral.com
--token

Si vous préférez envoyer votre demande sans vous authentifier auprès d’Azure CLI, vous pouvez spécifier un jeton d’utilisateur valide pour authentifier votre demande. Vous devez spécifier le type de clé dans le cadre de la requête. Pour en savoir plus, rendez-vous sur https://aka.ms/iotcentraldocsapi.

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 central device manual-failover

Exécutez un basculement manuel de l’appareil sur plusieurs IoT Hubs pour valider la capacité du microprogramme d’appareil à se reconnecter à l’aide de DPS à un autre IoT Hub.

Pour plus d’informations sur la haute disponibilité et la valeur par défaut pour la visite https://github.com/iot-for-all/iot-central-high-availability-clients#readmede ttl-minutes.

az iot central device manual-failover --app-id
                                      --device-id
                                      [--api-version {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri]
                                      [--token]
                                      [--ttl]

Exemples

Exécutez un basculement manuel de l’appareil sur plusieurs IoT Hubs pour valider la capacité du microprogramme d’appareil à se reconnecter à l’aide de DPS à un autre IoT Hub.

az iot central device manual-failover --app-id {appid} --device-id {deviceid} --ttl-minutes {ttl_minutes}

Paramètres obligatoires

--app-id -n

ID d’application de l’application IoT Central que vous souhaitez gérer. Vous trouverez l’ID d’application dans la page « À propos » de votre application sous le menu d’aide.

--device-id -d

ID d’appareil de l’appareil cible. Vous trouverez l’ID de l’appareil en cliquant sur le bouton Se connecter dans la page Détails de l’appareil.

Paramètres facultatifs

--api-version --av
Déprécié

L’argument 'api_version' a été déconseillé et sera supprimé dans une prochaine version.

Ce paramètre de commande a été déconseillé et sera ignoré. Dans la prochaine version, nous allons uniquement prendre en charge les API IoT Central à partir de la dernière version en disponibilité générale. Si une API n’est pas encore en disponibilité générale, nous appelons la dernière version préliminaire.

Valeurs acceptées: 2022-06-30-preview, 2022-07-31
Valeur par défaut: 2022-07-31
--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Valeur par défaut: azureiotcentral.com
--token

Si vous préférez envoyer votre demande sans vous authentifier auprès d’Azure CLI, vous pouvez spécifier un jeton d’utilisateur valide pour authentifier votre demande. Vous devez spécifier le type de clé dans le cadre de la requête. Pour en savoir plus, rendez-vous sur https://aka.ms/iotcentraldocsapi.

--ttl --ttl-minutes

Entier positif. Durée de vie en minutes pour ramener l’appareil au hub d’origine. A la valeur par défaut dans le back-end. Consultez la documentation sur ce que la dernière heure par défaut du back-end pour la durée de vie en visite https://github.com/iot-for-all/iot-central-high-availability-clients#readme.

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 central device registration-info

Obtenez des informations d’inscription sur les appareils à partir d’IoT Central.

Remarque : cette commande peut prendre beaucoup de temps pour retourner si aucun ID d’appareil n’est spécifié et que votre application contient beaucoup d’appareils.

az iot central device registration-info --app-id
                                        --device-id
                                        [--api-version {2022-06-30-preview, 2022-07-31}]
                                        [--central-api-uri]
                                        [--token]

Exemples

Obtenir des informations d’inscription sur l’appareil spécifié

az iot central device registration-info --app-id {appid} --device-id {deviceid}

Paramètres obligatoires

--app-id -n

ID d’application de l’application IoT Central que vous souhaitez gérer. Vous trouverez l’ID d’application dans la page « À propos » de votre application sous le menu d’aide.

--device-id -d

ID d’appareil de l’appareil cible. Vous trouverez l’ID de l’appareil en cliquant sur le bouton Se connecter dans la page Détails de l’appareil.

Paramètres facultatifs

--api-version --av
Déprécié

L’argument 'api_version' a été déconseillé et sera supprimé dans une prochaine version.

Ce paramètre de commande a été déconseillé et sera ignoré. Dans la prochaine version, nous allons uniquement prendre en charge les API IoT Central à partir de la dernière version en disponibilité générale. Si une API n’est pas encore en disponibilité générale, nous appelons la dernière version préliminaire.

Valeurs acceptées: 2022-06-30-preview, 2022-07-31
Valeur par défaut: 2022-07-31
--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Valeur par défaut: azureiotcentral.com
--token

Si vous préférez envoyer votre demande sans vous authentifier auprès d’Azure CLI, vous pouvez spécifier un jeton d’utilisateur valide pour authentifier votre demande. Vous devez spécifier le type de clé dans le cadre de la requête. Pour en savoir plus, rendez-vous sur https://aka.ms/iotcentraldocsapi.

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 central device show

Obtenir un appareil à partir d’IoT Central.

az iot central device show --app-id
                           --device-id
                           [--api-version {2022-06-30-preview, 2022-07-31}]
                           [--central-api-uri]
                           [--token]

Exemples

Obtenir un appareil

az iot central device show --app-id {appid} --device-id {deviceid}

Paramètres obligatoires

--app-id -n

ID d’application de l’application IoT Central que vous souhaitez gérer. Vous trouverez l’ID d’application dans la page « À propos » de votre application sous le menu d’aide.

--device-id -d

ID d’appareil de l’appareil cible. Vous trouverez l’ID de l’appareil en cliquant sur le bouton Se connecter dans la page Détails de l’appareil.

Paramètres facultatifs

--api-version --av
Déprécié

L’argument 'api_version' a été déconseillé et sera supprimé dans une prochaine version.

Ce paramètre de commande a été déconseillé et sera ignoré. Dans la prochaine version, nous allons uniquement prendre en charge les API IoT Central à partir de la dernière version en disponibilité générale. Si une API n’est pas encore en disponibilité générale, nous appelons la dernière version préliminaire.

Valeurs acceptées: 2022-06-30-preview, 2022-07-31
Valeur par défaut: 2022-07-31
--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Valeur par défaut: azureiotcentral.com
--token

Si vous préférez envoyer votre demande sans vous authentifier auprès d’Azure CLI, vous pouvez spécifier un jeton d’utilisateur valide pour authentifier votre demande. Vous devez spécifier le type de clé dans le cadre de la requête. Pour en savoir plus, rendez-vous sur https://aka.ms/iotcentraldocsapi.

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 central device show-credentials

Obtenez les informations d’identification de l’appareil à partir d’IoT Central.

az iot central device show-credentials --app-id
                                       --device-id
                                       [--api-version {2022-06-30-preview, 2022-07-31}]
                                       [--central-api-uri]
                                       [--token]

Exemples

Obtenir les informations d’identification de l’appareil pour un appareil

az iot central device show-credentials --app-id {appid} --device-id {deviceid}

Paramètres obligatoires

--app-id -n

ID d’application de l’application IoT Central que vous souhaitez gérer. Vous trouverez l’ID d’application dans la page « À propos » de votre application sous le menu d’aide.

--device-id -d

ID d’appareil de l’appareil cible. Vous trouverez l’ID de l’appareil en cliquant sur le bouton Se connecter dans la page Détails de l’appareil.

Paramètres facultatifs

--api-version --av
Déprécié

L’argument 'api_version' a été déconseillé et sera supprimé dans une prochaine version.

Ce paramètre de commande a été déconseillé et sera ignoré. Dans la prochaine version, nous allons uniquement prendre en charge les API IoT Central à partir de la dernière version en disponibilité générale. Si une API n’est pas encore en disponibilité générale, nous appelons la dernière version préliminaire.

Valeurs acceptées: 2022-06-30-preview, 2022-07-31
Valeur par défaut: 2022-07-31
--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Valeur par défaut: azureiotcentral.com
--token

Si vous préférez envoyer votre demande sans vous authentifier auprès d’Azure CLI, vous pouvez spécifier un jeton d’utilisateur valide pour authentifier votre demande. Vous devez spécifier le type de clé dans le cadre de la requête. Pour en savoir plus, rendez-vous sur https://aka.ms/iotcentraldocsapi.

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 central device update

Mettez à jour un appareil dans IoT Central.

Permet de modifier les propriétés suivantes d’un appareil : « displayName », « template », « simulated », « enabled » et « organizations ». L’ID d’appareil ne peut pas être modifié.

az iot central device update --app-id
                             --device-id
                             [--api-version {2022-06-30-preview, 2022-07-31}]
                             [--central-api-uri]
                             [--device-name]
                             [--enable {false, true}]
                             [--organizations]
                             [--simulated {false, true}]
                             [--template]
                             [--token]

Exemples

Mettre à jour un nom d’affichage d’appareil

az iot central device update --app-id {appid} --device-id {deviceid} --device-name {deviceName}

Transformer un appareil simulé en un appareil réel

az iot central device update --app-id {appid} --device-id {deviceid} --simulated false

Mettre à jour les organisations pour l’appareil

az iot central device update --app-id {appid} --device-id {deviceid} --organizations {organizations}

Désactiver un appareil

az iot central device update --app-id {appid} --device-id {deviceid} --enable false

Paramètres obligatoires

--app-id -n

ID d’application de l’application IoT Central que vous souhaitez gérer. Vous trouverez l’ID d’application dans la page « À propos » de votre application sous le menu d’aide.

--device-id -d

ID d’appareil de l’appareil cible. Vous trouverez l’ID de l’appareil en cliquant sur le bouton Se connecter dans la page Détails de l’appareil.

Paramètres facultatifs

--api-version --av
Déprécié

L’argument 'api_version' a été déconseillé et sera supprimé dans une prochaine version.

Ce paramètre de commande a été déconseillé et sera ignoré. Dans la prochaine version, nous allons uniquement prendre en charge les API IoT Central à partir de la dernière version en disponibilité générale. Si une API n’est pas encore en disponibilité générale, nous appelons la dernière version préliminaire.

Valeurs acceptées: 2022-06-30-preview, 2022-07-31
Valeur par défaut: 2022-07-31
--central-api-uri --central-dns-suffix

Suffixe DNS IoT Central associé à votre application.

Valeur par défaut: azureiotcentral.com
--device-name

Nom de l’appareil lisible par l’homme. Exemple : Réfrigérateur.

--enable

Ajoutez cet indicateur si vous souhaitez qu’IoT Central active ou désactive l’appareil.

Valeurs acceptées: false, true
--organizations --orgs

Affectez l’appareil aux organisations spécifiées. Liste séparée par des virgules des ID d’organisation. Version minimale prise en charge : 1.1-preview.

--simulated

Ajoutez cet indicateur si vous souhaitez qu’IoT Central configure ce paramètre en tant qu’appareil simulé. --template est requis si c’est vrai.

Valeurs acceptées: false, true
--template

ID de modèle central. Exemple : dtmi :ojpkindbz :modelDefinition :iild3tm_uo.

--token

Si vous préférez envoyer votre demande sans vous authentifier auprès d’Azure CLI, vous pouvez spécifier un jeton d’utilisateur valide pour authentifier votre demande. Vous devez spécifier le type de clé dans le cadre de la requête. Pour en savoir plus, rendez-vous sur https://aka.ms/iotcentraldocsapi.

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.