Partager via

az iot central device-template

Note

Cette référence fait partie de l’extension azure-iot pour Azure CLI (version 2.67.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une az iot central device-template commande. Apprenez-en davantage sur les extensions.

Gérer et configurer des modèles d’appareil IoT Central.

Commandes

Nom Description Type État
az iot central device-template create

Créez un modèle d’appareil dans IoT Central.

 Extension GA
az iot central device-template delete

Supprimez un modèle d’appareil d’IoT Central.

 Extension GA
az iot central device-template list

Obtenez la liste des modèles d’appareil pour une application IoT Central.

 Extension GA
az iot central device-template show

Obtenir un modèle d’appareil à partir d’IoT Central.

 Extension GA
az iot central device-template update

Mettez à jour un modèle d’appareil dans IoT Central.

 Extension GA

az iot central device-template create

Créez un modèle d’appareil dans IoT Central.

az iot central device-template create --app-id
                                      --content
                                      --device-template-id --dtid
                                      [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri --central-dns-suffix]
                                      [--token]

Exemples

Créer un modèle d’appareil avec une charge utile lue à partir d’un fichier

az iot central device-template create --app-id {appid} --content {pathtofile} --device-template-id {devicetemplateid}

Créer un modèle d’appareil avec une charge utile lue à partir de json brut

az iot central device-template create --app-id {appid} --content {json} --device-template-id {devicetemplateid}

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

Définition du modèle d’appareil. 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 de JSON stringified : {Device Template JSON}]. Le corps de la requête doit contenir CapabilityModel.

--device-template-id --dtid

Identificateur de modèle de jumeau numérique du modèle d’appareil. En savoir plus sur https://aka.ms/iotcentraldtmi.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

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

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

Suffixe DNS IoT Central associé à votre application.

Propriété Valeur
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. En savoir plus sur https://aka.ms/iotcentraldocsapi.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--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 le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az iot central device-template delete

Supprimez un modèle d’appareil d’IoT Central.

Remarque : cette opération est censée échouer si des appareils sont toujours associés à ce modèle.

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

Exemples

Supprimer un modèle d’appareil d’IoT Central

az iot central device-template delete --app-id {appid} --device-template-id {devicetemplateid}

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-template-id --dtid

ID du modèle d’appareil cible. Exemple : somedevicetemplate.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

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

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

Suffixe DNS IoT Central associé à votre application.

Propriété Valeur
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. En savoir plus sur https://aka.ms/iotcentraldocsapi.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--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 le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az iot central device-template list

Obtenez la liste des modèles d’appareil pour une application IoT Central.

az iot central device-template list --app-id
                                    [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                    [--central-api-uri --central-dns-suffix]
                                    [--compact]
                                    [--token]

Exemples

Répertorier tous les modèles d’appareil dans une application, triés par ID de modèle (par défaut)

az iot central device-template 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

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

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

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

Suffixe DNS IoT Central associé à votre application.

Propriété Valeur
Valeur par défaut: azureiotcentral.com
--compact -c

Afficher les modèles en mode compact. Pour chaque modèle, l’ID, le nom et les types de modèle s’affichent uniquement.

Propriété Valeur
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. En savoir plus sur https://aka.ms/iotcentraldocsapi.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--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 le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az iot central device-template show

Obtenir un modèle d’appareil à partir d’IoT Central.

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

Exemples

Obtenir un modèle d’appareil

az iot central device-template show --app-id {appid} --device-template-id {devicetemplateid}

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-template-id --dtid

ID du modèle d’appareil cible. Exemple : somedevicetemplate.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

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

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

Suffixe DNS IoT Central associé à votre application.

Propriété Valeur
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. En savoir plus sur https://aka.ms/iotcentraldocsapi.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--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 le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False

az iot central device-template update

Mettez à jour un modèle d’appareil dans IoT Central.

az iot central device-template update --app-id
                                      --content
                                      --device-template-id --dtid
                                      [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri --central-dns-suffix]
                                      [--token]

Exemples

Mettre à jour un modèle d’appareil avec une charge utile lue à partir d’un fichier

az iot central device-template update --app-id {appid} --content {pathtofile} --device-template-id {devicetemplateid}

Mettre à jour un modèle d’appareil avec une charge utile lue à partir de json brut

az iot central device-template update --app-id {appid} --content {json} --device-template-id {devicetemplateid}

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

Définition du modèle d’appareil. 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 de JSON stringified : {Device Template JSON}]. Le corps de la requête doit contenir CapabilityModel.

--device-template-id --dtid

ID du modèle d’appareil cible. Exemple : somedevicetemplate.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

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

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

Suffixe DNS IoT Central associé à votre application.

Propriété Valeur
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. En savoir plus sur https://aka.ms/iotcentraldocsapi.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--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 le niveau de verbosité de la journalisation. Utilisez --debug pour les journaux de débogage complets.

Propriété Valeur
Valeur par défaut: False