az iot hub connection-string

Note

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

Gérer IoT Hub chaînes de connexion.

Commandes

Nom Description Type État
az iot hub connection-string show

Affichez les chaîne de connexion pour les hubs IoT spécifiés à l’aide du nom et de la clé de stratégie donnés.

 Extension GA

az iot hub connection-string show

Affichez les chaîne de connexion pour les hubs IoT spécifiés à l’aide du nom et de la clé de stratégie donnés.

az iot hub connection-string show [--all --show-all]
                                  [--default-eventhub --eh {false, true}]
                                  [--hostname-type --ht {auto, classic, device, service}]
                                  [--hub-name]
                                  [--key-type --kt {primary, secondary}]
                                  [--pn --policy-name]
                                  [--resource-group]

Exemples

Affichez les chaînes de connexion pour tous les hubs IoT d’état actif dans un abonnement à l’aide de la stratégie par défaut et de la clé primaire.

az iot hub connection-string show

Affichez les chaînes de connexion pour tous les hubs IoT d’état actif dans un groupe de ressources à l’aide de la stratégie par défaut et de la clé primaire.

az iot hub connection-string show --resource-group MyResourceGroup

Afficher toutes les chaînes de connexion de la IoT Hub donnée à l’aide de la clé primaire.

az iot hub connection-string show -n MyIotHub --all

Affichez la chaîne de connexion de la IoT Hub donnée à l’aide de la stratégie par défaut et de la clé primaire.

az iot hub connection-string show -n MyIotHub

Affichez la chaîne de connexion de la IoT Hub donnée à l'aide de la stratégie « service » et de la clé secondaire.

az iot hub connection-string show -n MyIotHub --policy-name service --key-type secondary

Affichez le chaîne de connexion compatible eventhub du hub d'événements par défaut de la IoT Hub donnée.

az iot hub connection-string show -n MyIotHub --default-eventhub

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.

--all --show-all

Affichez toutes les stratégies d’accès partagé pour les IoT Hub respectives.

Propriété Valeur
Valeur par défaut: False
--default-eventhub --eh

Indicateur indiquant que le chaîne de connexion retourné correspond au point de terminaison EventHub par défaut. Valeur par défaut : false.

Propriété Valeur
Valeur par défaut: False
Valeurs acceptées: false, true
--hostname-type --ht
Préversion

Type de nom d’hôte à utiliser dans le chaîne de connexion. « auto » utilise le nom d’hôte d’appareil TLS 1.3 sur les hubs GWv2, sinon classique. 'classic' utilise toujours le nom d’hôte par défaut. « device » utilise le nom d’hôte de l’appareil TLS 1.3 (erreurs s’il n’est pas GWv2). 'service' utilise le nom d’hôte du service TLS 1.3 (erreurs si pas GWv2).

Propriété Valeur
Valeur par défaut: auto
Valeurs acceptées: auto, classic, device, service
--hub-name -n

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

Propriété Valeur
Groupe de paramètres: IoT Hub Identifier Arguments
--key-type --kt

Type de clé de stratégie d’accès partagé pour l’authentification.

Propriété Valeur
Valeur par défaut: primary
Valeurs acceptées: primary, secondary
--pn --policy-name

Stratégie d’accès partagé avec autorisations d’opération pour l’entité IoT Hub cible.

Propriété Valeur
Valeur par défaut: iothubowner
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

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