az iot hub device-identity

  • Référence

Remarque

Cette référence fait partie de l’extension azure-iot pour Azure CLI (version 2.37.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une commande az iot hub device-identity . En savoir plus sur les extensions.

Gérer les appareils IoT.

Commandes

Nom Description Type Statut
az iot hub device-identity children

Gérez les relations des appareils enfants pour les appareils IoT Edge.

 Extension GA
az iot hub device-identity children add

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

 Extension GA
az iot hub device-identity children list

Génère la collection d’appareils enfants affectés.

 Extension GA
az iot hub device-identity children remove

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

 Extension GA
az iot hub device-identity connection-string

Gérez les chaîne de connexion de l’appareil IoT.

 Extension GA
az iot hub device-identity connection-string show

Afficher un appareil IoT Hub donné chaîne de connexion.

 Extension GA
az iot hub device-identity create

Créez un appareil dans un hub IoT.

 Extension GA
az iot hub device-identity delete

Supprimez un appareil IoT Hub.

 Extension GA
az iot hub device-identity export

Exportez toutes les identités d’appareil à partir d’un Hub IoT vers un conteneur d’objets blob Stockage Azure.

 Extension GA
az iot hub device-identity import

Importez des identités d’appareil dans un hub IoT à partir d’un objet blob de conteneur de stockage.

 Extension GA
az iot hub device-identity list

Répertorier les appareils dans un IoT Hub.

 Extension GA
az iot hub device-identity parent

Gérer les relations des appareils parents pour les appareils IoT.

 Extension GA
az iot hub device-identity parent set

Définissez l’appareil parent d’un appareil cible.

 Extension GA
az iot hub device-identity parent show

Obtenir l’appareil parent d’un appareil cible.

 Extension GA
az iot hub device-identity renew-key

Renouvelez les clés cibles d’un appareil IoT Hub avec l’authentification sas.

 Extension GA
az iot hub device-identity show

Obtenez les détails d’un appareil IoT Hub.

 Extension GA
az iot hub device-identity update

Mettez à jour un appareil IoT Hub.

 Extension GA

az iot hub device-identity create

Créez un appareil dans un hub IoT.

Lorsque vous utilisez la méthode d’authentification de shared_private_key (également appelées clés symétriques), si aucune clé personnalisée n’est fournie, le service les génère pour l’appareil.

Si une étendue d’appareil est fournie pour un appareil de périphérie, la valeur est automatiquement convertie en étendue parente.

az iot hub device-identity create --device-id
                                  [--am {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--device-scope]
                                  [--edge-enabled {false, true}]
                                  [--hub-name]
                                  [--login]
                                  [--od]
                                  [--pk]
                                  [--primary-thumbprint]
                                  [--resource-group]
                                  [--secondary-key]
                                  [--secondary-thumbprint]
                                  [--sta {disabled, enabled}]
                                  [--star]
                                  [--valid-days]

Exemples

Créez un appareil IoT avec edge avec l’autorisation par défaut (clé privée partagée).

az iot hub device-identity create -n {iothub_name} -d {device_id} --ee

Créez un appareil IoT avec une autorisation de certificat auto-signé, générez un certificat valide pendant 10 jours, puis utilisez son empreinte numérique.

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --valid-days 10

Créez un appareil IoT avec une autorisation de certificat auto-signé, générez un certificat d’expiration par défaut (365 jours) et une sortie vers le répertoire cible.

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --output-dir /path/to/output

Créez un appareil IoT avec une autorisation de certificat auto-signé et fournissez explicitement des empreintes numériques primaires et secondaires.

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_thumbprint --ptp {thumbprint_1} --stp {thumbprint_2}

Créez un appareil IoT avec une autorisation d’autorité de certification racine avec l’état et la raison désactivés.

az iot hub device-identity create -n {iothub_name} -d {device_id} --am x509_ca --status disabled --status-reason 'for reasons'

Créez un appareil IoT avec une étendue d’appareil.

az iot hub device-identity create -n {iothub_name} -d {device_id} --device-scope 'ms-azure-iot-edge://edge0-123456789123456789'

Paramètres obligatoires

--device-id -d

ID d’appareil cible.

Paramètres facultatifs

--am --auth-method

La méthode d’autorisation avec qui une entité doit être créée.

valeurs acceptées: shared_private_key, x509_ca, x509_thumbprint
valeur par défaut: shared_private_key
--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
--device-scope

Portée de l’appareil. Pour les appareils de périphérie, il s’agit d’une génération automatique et immuable. Pour les appareils feuilles, définissez cette option pour créer une relation enfant/parent.

--edge-enabled --ee

Indicateur indiquant l’activation de périphérie.

valeurs acceptées: false, true
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.

--od --output-dir

Générez un certificat auto-signé et utilisez son empreinte numérique. Sortie vers le répertoire cible spécifié.

--pk --primary-key

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

--primary-thumbprint --ptp

Empreinte numérique du certificat auto-signé à utiliser pour l’empreinte numérique principale.

--resource-group -g

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

--secondary-key --sk

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

--secondary-thumbprint --stp

Empreinte numérique du certificat auto-signé à utiliser pour l’empreinte numérique secondaire.

--sta --status

Définissez l’état de l’appareil lors de la création.

valeurs acceptées: disabled, enabled
valeur par défaut: enabled
--star --status-reason

Description de l’état de l’appareil.

--valid-days --vd

Générez un certificat auto-signé et utilisez son empreinte numérique. Valide pour le nombre de jours spécifié. Valeur par défaut : 365.

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

Supprimez un appareil IoT Hub.

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

Paramètres obligatoires

--device-id -d

ID d’appareil cible.

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 device-identity export

Exportez toutes les identités d’appareil à partir d’un Hub IoT vers un conteneur d’objets blob Stockage Azure.

L’objet blob de sortie contenant des identités d’appareil est un fichier texte nommé « devices.txt ».

Autorisations requises : la stratégie d’accès partagé IoT Hub prenant en charge « Registre en lecture et écriture du Registre » ou un principal avec le rôle « Contributeur de données IoT Hub » sur IoT Hub.

Stockage nom de compte et les paramètres de nom de conteneur d’objets blob ne peuvent être utilisés que lorsque le compte de stockage se trouve dans le même abonnement que l’IoT Hub d’entrée. Pour obtenir une entrée d’URI SAP du conteneur d’objets blob inline, consultez les règles d’entrée de votre environnement.

Pour plus d’informations, consultez https://aka.ms/iothub-device-exportimport.

az iot hub device-identity export [--auth-type {key, login}]
                                  [--bc]
                                  [--bcu]
                                  [--hub-name]
                                  [--identity]
                                  [--ik {false, true}]
                                  [--login]
                                  [--resource-group]
                                  [--sa]

Exemples

Exportez toutes les identités d’appareil vers un conteneur d’objets blob configuré et incluez des clés d’appareil. Le nom du conteneur d’objets blob et le nom du compte de stockage sont fournis en tant que paramètres de la commande.

az iot hub device-identity export -n {iothub_name} --ik --bc {blob_container_name} --sa {storage_account_name}

Exportez toutes les identités d’appareil vers un conteneur d’objets blob configuré et incluez des clés d’appareil. Utilise un exemple d’URI SAS inline.

az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices?sv=2019-02-02&st=2020-08-23T22%3A35%3A00Z&se=2020-08-24T22%3A35%3A00Z&sr=c&sp=rwd&sig=VrmJ5sQtW3kLzYg10VqmALGCp4vtYKSLNjZDDJBSh9s%3D'

Exportez toutes les identités d’appareil vers un conteneur d’objets blob configuré à l’aide d’un chemin d’accès de fichier qui contient l’URI SAP.

az iot hub device-identity export -n {iothub_name} --bcu {sas_uri_filepath}

Exportez toutes les identités d’appareil vers un conteneur d’objets blob configuré et incluez des clés d’appareil. Utilise l’identité affectée par le système qui a Stockage rôles Contributeur aux données Blob pour le compte de stockage. Le nom du conteneur d’objets blob et le nom du compte de stockage sont fournis en tant que paramètres de la commande.

az iot hub device-identity export -n {iothub_name} --ik --bc {blob_container_name} --sa {storage_account_name} --identity [system]

Exportez toutes les identités d’appareil vers un conteneur d’objets blob configuré et incluez des clés d’appareil. Utilise l’identité affectée par le système qui a Stockage rôles Contributeur aux données Blob pour le compte de stockage. L’URI du conteneur d’objets blob n’a pas besoin du jeton SAP d’objet blob.

az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices' --identity [system]

Exportez toutes les identités d’appareil vers un conteneur d’objets blob configuré et incluez des clés d’appareil. Utilise l’identité managée affectée par l’utilisateur qui a Stockage rôle Contributeur aux données Blob pour le compte de stockage. Le nom du conteneur d’objets blob et le nom du compte de stockage sont fournis en tant que paramètres de la commande.

az iot hub device-identity export -n {iothub_name} --ik --bc {blob_container_name} --sa {storage_account_name} --identity {managed_identity_resource_id}

Exportez toutes les identités d’appareil vers un conteneur d’objets blob configuré et incluez des clés d’appareil. Utilise l’identité managée affectée par l’utilisateur qui a Stockage rôle Contributeur aux données Blob pour le compte de stockage. L’URI du conteneur d’objets blob n’a pas besoin du jeton SAP d’objet blob.

az iot hub device-identity export -n {iothub_name} --ik --bcu 'https://mystorageaccount.blob.core.windows.net/devices' --identity {managed_identity_resource_id}

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
--bc --blob-container

Ce conteneur d’objets blob est utilisé pour générer l’état du travail d’importation de l’identité de l’appareil et les résultats. Le paramètre est ignoré lorsque blob_container_uri est fourni. L’accès en écriture, lecture et suppression est requis pour ce conteneur d’objets blob.

--bcu --blob-container-uri

URI de signature d’accès partagé d’objet blob avec un accès en écriture, en lecture et suppression à un conteneur d’objets blob. Il est utilisé pour générer l’état du travail et les résultats. Remarque : lors de l’utilisation de l’authentification basée sur l’identité, un URI https:// est toujours nécessaire, mais aucun jeton SAP n’est nécessaire. L’entrée de cet argument peut être inline ou à partir d’un chemin d’accès au fichier.

--hub-name -n

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

--identity

Type d’identité managée pour déterminer si l’identité managée affectée par le système ou l’identité managée affectée par l’utilisateur est utilisée. Pour l’identité managée affectée par le système, utilisez [système]. Pour l’identité managée affectée par l’utilisateur, fournissez l’ID de ressource d’identité managée affectée par l’utilisateur. Cette identité nécessite un rôle contributeur de données blob Stockage pour le compte Stockage.

--ik --include-keys

Si elles sont définies, les clés sont exportées normalement. Sinon, les clés sont définies sur Null dans la sortie d’exportation.

valeurs acceptées: false, true
valeur par défaut: False
--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>.

--sa --storage-account

Nom du compte Stockage Azure contenant le conteneur d’objets blob de sortie. Le paramètre est ignoré lorsque blob_container_uri est fourni. L’accès en écriture, lecture et suppression est requis.

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 device-identity import

Importez des identités d’appareil dans un hub IoT à partir d’un objet blob de conteneur de stockage.

Le fichier d’entrée attendu contenant des identités d’appareil doit être nommé « devices.txt ». Le fichier journal de sortie « importErrors.log » est vide lorsque l’importation réussit et contient des journaux d’erreurs en cas d’échec de l’importation.

Autorisations requises : la stratégie d’accès partagé IoT Hub prenant en charge « Registre en lecture et écriture du Registre » ou un principal avec le rôle « Contributeur de données IoT Hub » sur IoT Hub.

Stockage nom de compte et les paramètres de nom de conteneur d’objets blob ne peuvent être utilisés que lorsque le compte de stockage se trouve dans le même abonnement que l’IoT Hub d’entrée. Pour obtenir une entrée d’URI SAP du conteneur d’objets blob inline, consultez les règles d’entrée de votre environnement.

Pour plus d’informations, consultez https://aka.ms/iothub-device-exportimport.

az iot hub device-identity import [--auth-type {key, login}]
                                  [--hub-name]
                                  [--ibc]
                                  [--ibcu]
                                  [--identity]
                                  [--input-storage-account]
                                  [--login]
                                  [--obc]
                                  [--obcu]
                                  [--osa]
                                  [--resource-group]

Exemples

Importez toutes les identités d’appareil à partir d’un objet blob en fournissant des paramètres de commande pour le conteneur d’objets blob d’entrée et le compte de stockage, ainsi que le conteneur d’objets blob de sortie et le compte de stockage.

az iot hub device-identity import -n {iothub_name} --ibc {input_blob_container_name} --isa {input_storage_account_name} --obc {output_blob_container_name} --osa {output_storage_account_name}

Importez toutes les identités d’appareil à partir d’un objet blob à l’aide d’un URI SAS inline.

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri}

Importez toutes les identités d’appareil à partir d’un objet blob à l’aide d’un chemin d’accès de fichier qui contient l’URI SAP.

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri_filepath} --obcu {output_sas_uri_filepath}

Importez toutes les identités d’appareil à partir d’un objet blob à l’aide d’une identité affectée par le système qui a Stockage rôles Contributeur aux données Blob pour les deux comptes de stockage. Le conteneur d’objets blob d’entrée et le compte de stockage ainsi que le conteneur d’objets blob de sortie et le compte de stockage sont fournis en tant que paramètres pour la commande

az iot hub device-identity import -n {iothub_name} --ibc {input_blob_container_name} --isa {input_storage_account_name} --obc {output_blob_container_name} --osa {output_storage_account_name} --identity [system]

Importez toutes les identités d’appareil à partir d’un objet blob à l’aide d’une identité affectée par le système qui a Stockage rôles Contributeur aux données Blob pour les deux comptes de stockage. L’URI du conteneur d’objets blob n’a pas besoin du jeton SAP d’objet blob.

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri} --identity [system]

Importez toutes les identités d’appareil à partir d’un objet blob à l’aide d’une identité managée affectée par l’utilisateur qui a Stockage rôles Contributeur aux données Blob pour les deux comptes de stockage. Le conteneur d’objets blob d’entrée et le compte de stockage ainsi que le conteneur d’objets blob de sortie et le compte de stockage sont fournis en tant que paramètres pour la commande

az iot hub device-identity import -n {iothub_name} --ibc {input_blob_container_name} --isa {input_storage_account_name} --obc {output_blob_container_name} --osa {output_storage_account_name} --identity {managed_identity_resource_id}

Importez toutes les identités d’appareil à partir d’un objet blob à l’aide d’une identité managée affectée par l’utilisateur qui a Stockage rôles Contributeur aux données Blob pour les deux comptes de stockage. L’URI du conteneur d’objets blob n’a pas besoin du jeton SAP d’objet blob.

az iot hub device-identity import -n {iothub_name} --ibcu {input_sas_uri} --obcu {output_sas_uri} --identity {managed_identity_resource_id}

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.

--ibc --input-blob-container

Ce conteneur d’objets blob stocke le fichier qui définit les opérations à effectuer sur le registre d’identités. Le paramètre est ignoré lorsque input_blob_container_uri est fourni. L’accès en lecture est requis pour ce conteneur d’objets blob.

--ibcu --input-blob-container-uri

URI de signature d’accès partagé d’objet blob avec accès en lecture à un conteneur d’objets blob. Cet objet blob contient les opérations à effectuer sur le registre d’identités. Remarque : lors de l’utilisation de l’authentification basée sur l’identité, un URI https:// est toujours nécessaire, mais aucun jeton SAP n’est nécessaire. L’entrée de cet argument peut être inline ou à partir d’un chemin d’accès au fichier.

--identity

Type d’identité managée pour déterminer si l’identité managée affectée par le système ou l’identité managée affectée par l’utilisateur est utilisée. Pour l’identité managée affectée par le système, utilisez [système]. Pour l’identité managée affectée par l’utilisateur, fournissez l’ID de ressource d’identité managée affectée par l’utilisateur. Cette identité nécessite un rôle contributeur de données blob Stockage pour le rôle de Stockage compte et contributeur cible pour ioT Hub.

--input-storage-account --isa

Nom de Stockage Azure compte contenant le conteneur d’objets blob d’entrée. Obligatoire uniquement lorsque input_blob_container_uri n’est pas fourni. L’accès en lecture est requis.

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

--obc --output-blob-container

Ce conteneur d’objets blob est utilisé pour générer l’état du travail d’importation de l’identité de l’appareil et les résultats. Obligatoire uniquement lorsque input_blob_container_uri n’est pas fourni. L’accès en écriture est requis pour ce conteneur d’objets blob.

--obcu --output-blob-container-uri

URI de signature d’accès partagé d’objet blob avec accès en écriture à un conteneur d’objets blob. Il est utilisé pour générer l’état du travail et les résultats. Remarque : lors de l’utilisation de l’authentification basée sur l’identité, un URI https:// sans le jeton SAP est toujours requis. L’entrée de cet argument peut être inline ou à partir d’un chemin d’accès au fichier.

--osa --output-storage-account

Nom du compte Stockage Azure contenant le conteneur d’objets blob de sortie. Le paramètre est ignoré lorsque output_blob_container_uri est fourni. L’accès en écriture est requis.

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

Répertorier les appareils dans un IoT Hub.

Cette commande est un alias pour az iot hub device-twin list, qui est fortement recommandé sur cette commande. À l’avenir, cette az iot hub device-identity list commande peut être modifiée ou déconseillée.

az iot hub device-identity list [--auth-type {key, login}]
                                [--edge-enabled {false, true}]
                                [--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
--edge-enabled --ee

Indicateur indiquant l’activation de périphérie.

valeurs acceptées: false, true
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.

--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 d’éléments à retourner. Utilisez -1 pour illimité.

valeur par défaut: 1000
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 device-identity renew-key

Renouvelez les clés cibles d’un appareil IoT Hub avec l’authentification sas.

az iot hub device-identity renew-key --device-id
                                     --hub-name
                                     --key-type {primary, secondary, swap}
                                     [--auth-type {key, login}]
                                     [--etag]
                                     [--login]
                                     [--resource-group]

Exemples

Renouvelez la clé primaire.

az iot hub device-identity renew-key -d {device_id} -n {iothub_name} --kt primary

Échangez les clés primaires et secondaires.

az iot hub device-identity renew-key -d {device_id} -n {iothub_name} --kt swap

Paramètres obligatoires

--device-id -d

ID d’appareil cible.

--hub-name -n

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

--key-type --kt

Type de clé cible à régénérer.

valeurs acceptées: primary, secondary, swap

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.

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

Obtenez les détails d’un appareil IoT Hub.

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

Paramètres obligatoires

--device-id -d

ID d’appareil cible.

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

Mettez à jour un appareil IoT Hub.

Utilisez --set suivi des affectations de propriétés pour la mise à jour d’un appareil. Tirez parti des paramètres retournés par « iot hub device-identity show ».

az iot hub device-identity update --device-id
                                  [--add]
                                  [--am {shared_private_key, x509_ca, x509_thumbprint}]
                                  [--auth-type {key, login}]
                                  [--edge-enabled {false, true}]
                                  [--etag]
                                  [--force-string]
                                  [--hub-name]
                                  [--login]
                                  [--pk]
                                  [--primary-thumbprint]
                                  [--remove]
                                  [--resource-group]
                                  [--secondary-key]
                                  [--secondary-thumbprint]
                                  [--set]
                                  [--sta {disabled, enabled}]
                                  [--star]

Exemples

Activer les fonctionnalités de périphérie pour l’appareil

az iot hub device-identity update -d {device_id} -n {iothub_name} --set capabilities.iotEdge=true

Activez les fonctionnalités de périphérie pour l’appareil à l’aide d’un argument pratique.

az iot hub device-identity update -d {device_id} -n {iothub_name} --ee

Désactiver l’état de l’appareil

az iot hub device-identity update -d {device_id} -n {iothub_name} --set status=disabled

Désactivez l’état de l’appareil à l’aide de l’argument pratique.

az iot hub device-identity update -d {device_id} -n {iothub_name} --status disabled

Dans une commande

az iot hub device-identity update -d {device_id} -n {iothub_name} --set status=disabled capabilities.iotEdge=true

Paramètres obligatoires

--device-id -d

ID d’appareil cible.

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: []
--am --auth-method

La méthode d’autorisation avec qui une entité doit être créée.

valeurs acceptées: shared_private_key, x509_ca, x509_thumbprint
--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
--edge-enabled --ee

Indicateur indiquant l’activation de périphérie.

valeurs acceptées: false, true
--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.

--pk --primary-key

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

--primary-thumbprint --ptp

Empreinte numérique du certificat auto-signé à utiliser pour l’empreinte numérique principale.

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

--secondary-key --sk

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

--secondary-thumbprint --stp

Empreinte numérique du certificat auto-signé à utiliser pour l’empreinte numérique secondaire.

--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: []
--sta --status

Définissez l’état de l’appareil lors de la création.

valeurs acceptées: disabled, enabled
--star --status-reason

Description de l’état de l’appareil.

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.