Partager via

az iot central device twin

  • 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 az iot central device twin . En savoir plus sur les extensions.

Gérer les jumeaux d’appareil IoT Central.

Commandes

Nom Description Type État
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 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.

Fourniture de --component-name, --module-name ou les deux pour remplacer les propriétés du composant d’appareil, les propriétés du module d’appareil ou les propriétés du composant de module d’appareil.

az iot central device twin replace --app-id
                                   --content
                                   --device-id
                                   [--api-version {2022-06-30-preview, 2022-07-31}]
                                   [--central-api-uri]
                                   [--co]
                                   [--mn]
                                   [--token]

Exemples

Remplacer les propriétés de l’appareil

az iot central device twin replace --app-id {appid} --device-id {deviceid} -k {content}

Remplacer les propriétés du composant d’appareil

az iot central device twin replace --app-id {appid} --device-id {deviceid} --co {componentname} -k {content}

Remplacer les propriétés du composant de module d’appareil

az iot central device twin replace --app-id {appid} --device-id {deviceid} --mn {modulename} --co {componentname} -k {content}

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.

--content -k

Configuration de la demande. Fournissez le chemin d’accès au fichier JSON ou au fichier JSON brut en chaîne. [Exemple de chemin de fichier : ./path/to/file.json] [Exemple JSON stringified : {'a' : 'b'}].

--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
--co --component-name

Nom du composant d’appareil.

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

Fourniture de --component-name, --module-name ou les deux pour obtenir les propriétés du composant d’appareil, les propriétés du module d’appareil ou les propriétés du composant de module d’appareil.

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

Exemples

Obtenir les propriétés de l’appareil

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

Obtenir les propriétés du composant d’appareil

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

Obtenir les propriétés du composant module d’appareil

az iot central device twin show --app-id {appid} --device-id {deviceid} --mn {modulename} --co {componentname}

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
--co --component-name

Nom du composant d’appareil.

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

Fourniture de --component-name, --module-name ou les deux pour mettre à jour les propriétés du composant d’appareil, les propriétés du module d’appareil ou les propriétés du composant de module d’appareil.

az iot central device twin update --app-id
                                  --content
                                  --device-id
                                  [--api-version {2022-06-30-preview, 2022-07-31}]
                                  [--central-api-uri]
                                  [--co]
                                  [--mn]
                                  [--token]

Exemples

Mettre à jour les propriétés de l’appareil

az iot central device twin update --app-id {appid} --device-id {deviceid} -k {content}

Mettre à jour les propriétés du composant d’appareil

az iot central device twin update --app-id {appid} --device-id {deviceid} --co {componentname} -k {content}

Mettre à jour les propriétés du composant de module d’appareil

az iot central device twin update --app-id {appid} --device-id {deviceid} --mn {modulename} --co {componentname} -k {content}

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.

--content -k

Configuration de la demande. Fournissez le chemin d’accès au fichier JSON ou au fichier JSON brut en chaîne. [Exemple de chemin de fichier : ./path/to/file.json] [Exemple JSON stringified : {'a' : 'b'}].

--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
--co --component-name

Nom du composant d’appareil.

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