az iot hub configuration

  • 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 configuration az iot Hub. En savoir plus sur les extensions.

Gérer la configuration de la gestion automatique des appareils IoT à grande échelle.

Commandes

Nom Description Type État
az iot hub configuration create

Créez une configuration de gestion automatique des appareils IoT dans un hub IoT cible.

 Extension GA
az iot hub configuration delete

Supprimez une configuration d’appareil IoT.

 Extension GA
az iot hub configuration list

Répertoriez les configurations de gestion automatique des appareils IoT dans un IoT Hub.

 Extension GA
az iot hub configuration show

Obtenez les détails d’une configuration de gestion automatique des appareils IoT.

 Extension GA
az iot hub configuration show-metric

Évaluez une métrique système ou utilisateur cible définie dans une configuration d’appareil IoT.

 Extension GA
az iot hub configuration update

Mettez à jour les propriétés spécifiées d’une configuration de gestion automatique des appareils IoT.

 Extension GA

az iot hub configuration create

Créez une configuration de gestion automatique des appareils IoT dans un hub IoT cible.

Le contenu de configuration est json et légèrement varie en fonction de l’intention de l’appareil ou du module.

Les configurations d’appareil sont sous la forme de {"deviceContent » :{...}} ou {"content » :{"deviceContent » :{...}}}

Les configurations de module sont sous la forme de {"moduleContent » :{...}} ou {"content » :{"moduleContent » :{...}}}

Les configurations peuvent être définies avec des métriques fournies par l’utilisateur pour l’évaluation à la demande. Les métriques utilisateur sont json et sous la forme de {"requêtes » :{...}} ou {"metrics » :{"queries » :{...}}}.

Remarque : La condition cible pour les modules doit commencer par « from devices.modules where ».

az iot hub configuration create --config-id
                                --content
                                [--auth-type {key, login}]
                                [--cl]
                                [--cmq]
                                [--hub-name]
                                [--lab]
                                [--login]
                                [--metrics]
                                [--pri]
                                [--resource-group]
                                [--target-condition]

Exemples

Créez une configuration d’appareil avec une priorité de 3 qui s’applique à condition qu’un appareil soit marqué dans la génération 9 et que l’environnement est « test ».

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "tags.building=9 and tags.environment='test'" --priority 3

Créez une configuration d’appareil avec des étiquettes et fournissez des métriques utilisateur inline (exemple de syntaxe bash).

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "tags.building=9" --labels '{"key0":"value0", "key1":"value1"}' --priority 10 --metrics '{"metrics": {"queries": {"mymetric": "select deviceId from devices where tags.location='US'"}}}'

Créer une configuration de module avec des étiquettes et fournir des métriques utilisateur inline (exemple de syntaxe cmd)

az iot hub configuration create -c {config_name} -n {iothub_name} --content module_content.json --target-condition "from devices.modules where tags.building=9" --labels "{\"key0\":\"value0\", \"key1\":\"value1\"}" --metrics "{\"metrics\": {\"queries\": {\"mymetric\": \"select moduleId from devices.modules where tags.location='US'\"}}}"

Créez une configuration de module avec du contenu et des métriques utilisateur inline (exemple de syntaxe PowerShell).

az iot hub configuration create -c {config_name} -n {iothub_name} --content '{\"moduleContent\": {\"properties.desired.chillerWaterSettings\": {\"temperature\": 38, \"pressure\": 78}}}' --target-condition "from devices.modules where tags.building=9" --priority 1 --metrics '{\"metrics\": {\"queries\": {\"mymetric\":\"select moduleId from devices.modules where tags.location=''US''\"}}}'

Créez une configuration d’appareil avec un autre style d’entrée d’étiquettes et de métriques (indépendant de l’interpréteur de commandes).

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "from devices.modules where tags.building=9" --custom-labels key0="value0" key1="value1" --priority 10 --custom-metric-queries mymetric1="select deviceId from devices where tags.location='US'" mymetric2="select *"

Paramètres obligatoires

--config-id -c

Nom de configuration de l’appareil cible. Les minuscules et les caractères spéciaux suivants sont autorisés : [-+%_* !'].

--content -k

Contenu de configuration de l’appareil. Fournissez le chemin d’accès au fichier ou json brut.

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
--cl --custom-labels

Un autre style d’entrée (paires clé=valeur séparées par espace) pour --labels et destiné à le remplacer ultérieurement. Exemple de format : key1=value1 key2="this is my value ».

--cmq --custom-metric-queries

Style d’entrée alternatif (paires clé=valeur séparées par espace) pour --metrics et destiné à le remplacer ultérieurement. Exemple de format : metric1="select deviceId from devices where tags.location='US' » metric2="select * ».

--hub-name -n

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

--lab --labels

Mappage des étiquettes à appliquer à la configuration cible. L’utilisation de --custom-labels au lieu de --labels est recommandée. Exemple de format : {"key0 » :"value0 », « key1 » :"value1"}.

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

--metrics -m

Définitions de métriques de configuration de l’appareil. Fournissez le chemin d’accès au fichier ou json brut. L’utilisation de requêtes --custom-metric-au lieu de --metrics est recommandée.

--pri --priority

Poids de la configuration de l’appareil en cas de règles concurrentes (victoires les plus élevées).

Valeur par défaut: 0
--resource-group -g

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

--target-condition --tc -t

Condition cible dans laquelle une configuration d’appareil ou de module s’applique. Les configurations sans condition cible cible ne ciblent aucun appareil ou module. Utilisez le format suivant : « tags.environment='test ».

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 configuration delete

Supprimez une configuration d’appareil IoT.

az iot hub configuration delete --config-id
                                [--auth-type {key, login}]
                                [--etag]
                                [--hub-name]
                                [--login]
                                [--resource-group]

Paramètres obligatoires

--config-id -c

Nom de configuration de l’appareil cible. Les minuscules et les caractères spéciaux suivants sont autorisés : [-+%_* !'].

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
--etag -e

Étiquette d’entité ou etag correspondant au dernier état de la ressource. Si aucun etag n’est fourni, la valeur '*' est utilisée.

--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 configuration list

Répertoriez les configurations de gestion automatique des appareils IoT dans un IoT Hub.

az iot hub configuration list [--auth-type {key, login}]
                              [--hub-name]
                              [--login]
                              [--resource-group]
                              [--top]

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

--top

Nombre maximal de configurations à retourner. Par défaut, toutes les configurations sont retournées.

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 configuration show

Obtenez les détails d’une configuration de gestion automatique des appareils IoT.

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

Paramètres obligatoires

--config-id -c

Nom de configuration de l’appareil cible. Les minuscules et les caractères spéciaux suivants sont autorisés : [-+%_* !'].

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 configuration show-metric

Évaluez une métrique système ou utilisateur cible définie dans une configuration d’appareil IoT.

az iot hub configuration show-metric --config-id
                                     --metric-id
                                     [--auth-type {key, login}]
                                     [--hub-name]
                                     [--login]
                                     [--metric-type {system, user}]
                                     [--resource-group]

Exemples

Évaluer la métrique « warningLimit » définie par l’utilisateur

az iot hub configuration show-metric -m warningLimit -c {configuration_name} -n {iothub_name}

Évaluer la métrique « appliedCount » du système

az iot hub configuration show-metric --metric-id appliedCount -c {configuration_name} -n {iothub_name} --metric-type system

Paramètres obligatoires

--config-id -c

Nom de configuration de l’appareil cible. Les minuscules et les caractères spéciaux suivants sont autorisés : [-+%_* !'].

--metric-id -m

Métrique cible pour l’évaluation.

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.

--metric-type --mt

Indique la collection de métriques à utiliser pour rechercher une métrique.

Valeurs acceptées: system, user
Valeur par défaut: user
--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 configuration update

Mettez à jour les propriétés spécifiées d’une configuration de gestion automatique des appareils IoT.

Utilisez --set suivi des affectations de propriétés pour mettre à jour une configuration.

Remarque : le contenu de configuration est immuable. Les propriétés de configuration qui peuvent être mises à jour sont « étiquettes », « métriques », « priority » et « targetCondition ».

az iot hub configuration update --config-id
                                [--add]
                                [--auth-type {key, login}]
                                [--etag]
                                [--force-string]
                                [--hub-name]
                                [--login]
                                [--remove]
                                [--resource-group]
                                [--set]

Exemples

Modifier la priorité d’une configuration d’appareil et mettre à jour sa condition cible

az iot hub configuration update -c {configuration_name} -n {iothub_name} --set priority=10 targetCondition="tags.building=43 and tags.environment='dev'"

Paramètres obligatoires

--config-id -c

Nom de configuration de l’appareil cible. Les minuscules et les caractères spéciaux suivants sont autorisés : [-+%_* !'].

Paramètres facultatifs

--add

Ajoutez un objet à une liste d’objets en spécifiant un chemin d’accès et des paires clé-valeur. Exemple : --add property.listProperty <key=value, string or JSON string>.

Valeur par défaut: []
--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
--etag -e

Étiquette d’entité ou etag correspondant au dernier état de la ressource. Si aucun etag n’est fourni, la valeur '*' est utilisée.

--force-string

Lorsque vous utilisez « set » ou « add », conservez les littéraux de chaîne au lieu de tenter de convertir en JSON.

Valeur par défaut: False
--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.

--remove

Supprimez une propriété ou un élément d’une liste. Exemple : --remove property.list <indexToRemove> OR --remove propertyToRemove.

Valeur par défaut: []
--resource-group -g

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

--set

Mettez à jour un objet en spécifiant un chemin d’accès et une valeur de propriété à définir. Exemple : --set property1.property2=<value>.

Valeur par défaut: []
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.