Partager via

az iot hub state

  • Expérimental

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 hub state commande. Apprenez-en davantage sur les extensions.

Ce groupe de commandes est expérimental et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Gérez l’état d’un Hub IoT.

Pour plus d’informations, consultez aka.ms/aziotcli-iot-hub-state.

Commandes

Nom Description Type État
az iot hub state export

Exportez l’état d’un Hub IoT vers un fichier.

 Extension Experimental
az iot hub state import

Importez un état hub à partir d’un fichier vers un hub IoT.

 Extension Experimental
az iot hub state migrate

Migrez l’état d’un hub vers un autre hub sans enregistrer dans un fichier.

 Extension Experimental

az iot hub state export

Expérimental

Le groupe de commandes « état du hub iot » est expérimental et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Exportez l’état d’un Hub IoT vers un fichier.

Par défaut, l’état exporté inclut : modèle arm pour hub, configurations hub (y compris les configurations ADM et les déploiements de périphérie), informations sur l’appareil (y compris les identites d’appareil, les jumeaux d’appareil, les identités de module et les jumeaux de module).

Pour plus d’informations, consultez aka.ms/aziotcli-iot-hub-state.

az iot hub state export --state-file
                        [--aspects {arm, configurations, devices}]
                        [--auth-type {key, login}]
                        [--hub-name]
                        [--login]
                        [--replace]
                        [--resource-group]

Exemples

Exportez l’état pris en charge du hub spécifié dans le fichier spécifié.

az iot hub state export -n {iothub_name} -f {state_filename}

Exportez l’état pris en charge du hub spécifié dans le fichier spécifié, en remplaçant le contenu du fichier.

az iot hub state export -n {iothub_name} -f {state_filename} -r

Exportez uniquement les appareils et les configurations du hub spécifié dans le fichier spécifié.

az iot hub state export -n {iothub_name} -f {state_filename} --aspects devices configurations

Paramètres obligatoires

--state-file -f

Chemin d’accès au fichier dans lequel les informations d’état seront stockées.

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.

--aspects

Aspects du hub (séparés par l’espace).

Propriété Valeur
Valeurs acceptées: arm, configurations, devices
--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 .

Propriété Valeur
Groupe de paramètres: Access Control Arguments
Valeur par défaut: key
Valeurs acceptées: key, login
--hub-name -n

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

Propriété Valeur
Groupe de paramètres: IoT Hub Identifier Arguments
--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.

Propriété Valeur
Groupe de paramètres: IoT Hub Identifier Arguments
--replace -r

Si cet indicateur est défini, la commande remplace le contenu du fichier de sortie.

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

az iot hub state import

Expérimental

Le groupe de commandes « état du hub iot » est expérimental et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Importez un état hub à partir d’un fichier vers un hub IoT.

Si l’aspect arm est spécifié, le hub est créé s’il n’existe pas.

Par défaut, l’état importé inclut : modèle arm pour hub, configurations hub (y compris les configurations ADM et les déploiements de périphérie), informations sur l’appareil (y compris les identites d’appareil, les jumeaux d’appareil, les identités de module et les jumeaux de module).

Pour les points de terminaison importés avec l’authentification d’identité affectée par le système, le hub spécifié doit disposer des autorisations appropriées. Sinon, la commande échoue.

Les points de terminaison privés sont ignorés dans le processus d’importation.

Pour plus d’informations, consultez aka.ms/aziotcli-iot-hub-state.

az iot hub state import --state-file
                        [--aspects {arm, configurations, devices}]
                        [--auth-type {key, login}]
                        [--hub-name]
                        [--login]
                        [--replace]
                        [--resource-group]

Exemples

Importez l’état pris en charge à partir du fichier spécifié dans le hub spécifié.

az iot hub state import -n {iothub_name} -f {state_filename}

Importez l’état pris en charge à partir du fichier spécifié dans le hub spécifié, en remplaçant l’état précédent du hub. Tous les certificats, configurations et appareils seront supprimés avant le chargement du nouvel état.

az iot hub state import -n {iothub_name} -f {state_filename} -r

Importez uniquement le modèle arm à partir du fichier spécifié dans le hub spécifié. Notez que cela crée un hub s’il n’existe pas. Le fichier peut contenir les appareils et les configurations, mais ceux-ci seront ignorés.

az iot hub state import -n {iothub_name} -g {resource_group} -f {state_filename} --aspects arm

Importez uniquement les appareils et les configurations du fichier spécifié dans le hub spécifié. Notez que cela ne crée pas de hub s’il n’existe pas et que la commande échoue. Le fichier peut contenir le modèle arm, mais qui sera ignoré.

az iot hub state import -n {iothub_name} -f {state_filename} --aspects devices configurations

Paramètres obligatoires

--state-file -f

Chemin d’accès au fichier dans lequel les informations d’état seront stockées.

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.

--aspects

Aspects du hub (séparés par l’espace).

Propriété Valeur
Valeurs acceptées: arm, configurations, devices
--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 .

Propriété Valeur
Groupe de paramètres: Access Control Arguments
Valeur par défaut: key
Valeurs acceptées: key, login
--hub-name -n

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

Propriété Valeur
Groupe de paramètres: IoT Hub Identifier Arguments
--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.

Propriété Valeur
Groupe de paramètres: IoT Hub Identifier Arguments
--replace -r

Si cet indicateur est défini, la commande supprime les appareils, configurations et certificats actuels du hub de destination.

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

az iot hub state migrate

Expérimental

Le groupe de commandes « état du hub iot » est expérimental et en cours de développement. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Migrez l’état d’un hub vers un autre hub sans enregistrer dans un fichier.

Si l’aspect arm est spécifié, le hub est créé s’il n’existe pas.

Par défaut, l’état migré inclut : modèle arm pour le hub, les configurations hub (y compris les configurations ADM et les déploiements de périphérie), les informations d’appareil (y compris les identites d’appareil, les jumeaux d’appareil, les identités de module et les jumeaux de module).

Pour les points de terminaison migrés avec l’authentification d’identité affectée par le système, le hub spécifié doit disposer des autorisations appropriées. Sinon, la commande échoue.

Les points de terminaison privés sont ignorés dans le processus de migration.

Si vous rencontrez des problèmes de migration, utilisez les commandes d’exportation et d’importation pour avoir un fichier en tant que sauvegarde.

Pour plus d’informations, consultez aka.ms/aziotcli-iot-hub-state.

az iot hub state migrate [--aspects {arm, configurations, devices}]
                         [--auth-type {key, login}]
                         [--destination-hub --dh]
                         [--destination-hub-login --dl]
                         [--destination-resource-group --dg]
                         [--og --origin-resource-group]
                         [--oh --origin-hub]
                         [--ol --origin-hub-login]
                         [--replace]

Exemples

Migrez l’état pris en charge du hub d’origine vers le hub de destination.

az iot hub state migrate --destination-hub {dest_hub_name} --origin-hub {orig_hub_name}

Migrez l’état pris en charge du hub d’origine vers le hub de destination, en remplaçant l’état précédent du hub. Tous les certificats, configurations et appareils du hub de destination sont supprimés avant le chargement du nouvel état.

az iot hub state migrate --destination-hub {dest_hub_name} --origin-hub {orig_hub_name} -r

Migrez uniquement le modèle arm du hub d’origine vers le hub de destination. Notez que cela crée un hub si le hub de destination n’existe pas. Le hub d’origine peut contenir les appareils et les configurations, mais ceux-ci seront ignorés.

az iot hub state migrate --destination-hub {dest_hub_name} --destination-resource-group {dest_hub_resource_group} --origin-hub {orig_hub_name} --aspects arm

Migrez uniquement les appareils et les configurations du hub d’origine vers le hub de destination. Notez que cela ne crée pas de hub si le hub de destination n’existe pas et que la commande échoue. Le modèle arm pour le hub d’origine est ignoré.

az iot hub state migrate --destination-hub {dest_hub_name} --origin-hub {orig_hub_name} --aspects devices configurations

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.

--aspects

Aspects du hub (séparés par l’espace).

Propriété Valeur
Valeurs acceptées: arm, configurations, devices
--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 .

Propriété Valeur
Groupe de paramètres: Access Control Arguments
Valeur par défaut: key
Valeurs acceptées: key, login
--destination-hub --dh

Nom d’IoT Hub vers lequel l’état du hub d’origine sera copié.

Propriété Valeur
Groupe de paramètres: IoT Hub Identifier Arguments
--destination-hub-login --dl

Cette commande prend en charge une chaîne de connexion d’entité avec des droits d’exécution sur le hub de destination. Permet d’éviter la connexion de session via az login pour cette instance IoT Hub. Si une entité chaîne de connexion et un nom sont fournis, le chaîne de connexion a la priorité. Obligatoire si --destination-hub n’est pas fourni.

Propriété Valeur
Groupe de paramètres: IoT Hub Identifier Arguments
--destination-resource-group --dg

Nom du groupe de ressources du hub IoT vers lequel l’état du hub d’origine sera copié. S’il n’est pas fourni, utilisez le groupe de ressources d’IoT Hub d’origine.

Propriété Valeur
Groupe de paramètres: IoT Hub Identifier Arguments
--og --origin-resource-group

Nom du groupe de ressources du hub IoT qui sera copié.

Propriété Valeur
Groupe de paramètres: IoT Hub Identifier Arguments
--oh --origin-hub

Nom d’IoT Hub qui sera copié.

Propriété Valeur
Groupe de paramètres: IoT Hub Identifier Arguments
--ol --origin-hub-login

Cette commande prend en charge une chaîne de connexion d’entité avec des droits d’exécution sur le hub d’origine. Permet d’éviter la connexion de session via az login pour cette instance IoT Hub. Si une entité chaîne de connexion et un nom sont fournis, le chaîne de connexion a la priorité. Obligatoire si --origin-hub n’est pas fourni.

Propriété Valeur
Groupe de paramètres: IoT Hub Identifier Arguments
--replace -r

Si cet indicateur est défini, la commande supprime les appareils, configurations et certificats actuels du hub de destination.

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