az iot ops
Remarque
Cette référence fait partie de l’extension azure-iot-ops pour Azure CLI (version 2.46.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une commande az iot ops . En savoir plus sur les extensions.
Ce groupe de commandes est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus
Gérer les opérations Azure IoT.
Azure IoT Operations est un ensemble de services Kubernetes hautement alignés, mais faiblement couplés, qui vous permettent d’agréger des données à partir de ressources locales dans un répartiteur MQTT de niveau industriel, d’ajouter un calcul de périphérie et de configurer un flux de données bidirectionnel avec un large éventail de services dans le cloud.
Par défaut, les commandes IOT Operations CLI case activée régulièrement pour voir si une nouvelle version d’extension est disponible.
Ce comportement peut être désactivé avec az config set iotops.check_latest=false
.
Commandes
Nom | Description | Type | Statut |
---|---|---|---|
az iot ops asset |
Gérer les ressources. |
Extension | Aperçu |
az iot ops asset create |
Créez un élément multimédia. |
Extension | Aperçu |
az iot ops asset data-point |
Gérer les points de données dans une ressource. |
Extension | Aperçu |
az iot ops asset data-point add |
Ajoutez un point de données à une ressource. |
Extension | Aperçu |
az iot ops asset data-point list |
Répertorier les points de données d’une ressource. |
Extension | Aperçu |
az iot ops asset data-point remove |
Supprimez un point de données dans une ressource. |
Extension | Aperçu |
az iot ops asset delete |
Supprimez une ressource. |
Extension | Aperçu |
az iot ops asset endpoint |
Gérer les profils de point de terminaison de ressource. |
Extension | Aperçu |
az iot ops asset endpoint certificate |
Gérer les certificats détenus dans un point de terminaison de ressource. |
Extension | Aperçu |
az iot ops asset endpoint certificate add |
Ajoutez un certificat appartenant à un point de terminaison de ressource. |
Extension | Aperçu |
az iot ops asset endpoint certificate list |
Répertoriez les certificats détenus dans un point de terminaison de ressource. |
Extension | Aperçu |
az iot ops asset endpoint certificate remove |
Supprimez un certificat appartenant à un point de terminaison de ressource. |
Extension | Aperçu |
az iot ops asset endpoint create |
Créez un point de terminaison de ressource. |
Extension | Aperçu |
az iot ops asset endpoint delete |
Supprimez un point de terminaison de ressource. |
Extension | Aperçu |
az iot ops asset endpoint query |
Interrogez Resource Graph pour les points de terminaison de ressources. |
Extension | Aperçu |
az iot ops asset endpoint show |
Afficher un point de terminaison de ressource. |
Extension | Aperçu |
az iot ops asset endpoint update |
Mettez à jour un point de terminaison de ressource. |
Extension | Aperçu |
az iot ops asset event |
Gérer les événements dans une ressource. |
Extension | Aperçu |
az iot ops asset event add |
Ajoutez un événement à une ressource. |
Extension | Aperçu |
az iot ops asset event list |
Répertorier les événements d’une ressource. |
Extension | Aperçu |
az iot ops asset event remove |
Supprimez un événement dans une ressource. |
Extension | Aperçu |
az iot ops asset query |
Interrogez Resource Graph pour les ressources. |
Extension | Aperçu |
az iot ops asset show |
Afficher une ressource. |
Extension | Aperçu |
az iot ops asset update |
Mettez à jour une ressource. |
Extension | Aperçu |
az iot ops check |
Évaluez l’intégrité du runtime côté cluster des services IoT Operations déployés. |
Extension | Aperçu |
az iot ops init |
Démarrez, configurez et déployez des opérations IoT sur le cluster avec arc cible. |
Extension | Aperçu |
az iot ops mq |
Outils spécifiques À MQ. |
Extension | Aperçu |
az iot ops mq get-password-hash |
Génère un hachage PBKDF2 de la phrase secrète appliquant PBKDF2-HMAC-SHA512. Un sel 128 bits est utilisé à partir de os.urandom. |
Extension | Aperçu |
az iot ops mq stats |
Afficher les statistiques dmqtt en cours d’exécution. |
Extension | Aperçu |
az iot ops support |
Les opérations IoT prennent en charge l’espace de commande. |
Extension | Aperçu |
az iot ops support create-bundle |
Crée une archive zip de prise en charge standard pour une utilisation dans la résolution des problèmes et les diagnostics. |
Extension | Aperçu |
az iot ops verify-host |
Exécute un ensemble de vérifications de l’hôte de cluster pour la compatibilité du déploiement d’IoT Operations. |
Extension | Aperçu |
az iot ops check
Le groupe de commandes « iot ops » est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus
Évaluez l’intégrité du runtime côté cluster des services IoT Operations déployés.
La commande affiche par défaut une vue récapitulative conviviale du service sélectionné.
Plus de détails peuvent être demandés via --detail-level
.
{API de service prises en charge}
- akri.sh/[v0]
- dataprocessor.iotoperations.azure.com/[v1]
- deviceregistry.microsoft.com/[v1beta1]
- layerednetworkmgmt.iotoperations.azure.com/[v1beta1]
- mq.iotoperations.azure.com/[v1beta1]
- opcuabroker.iotoperations.azure.com/[v1beta1].
az iot ops check [--as-object {false, true}]
[--context]
[--detail-level {0, 1, 2}]
[--ops-service {akri, dataprocessor, deviceregistry, lnm, mq, opcua}]
[--post {false, true}]
[--pre {false, true}]
[--resource-name]
[--resources {asset, assetendpointprofile, assettype, broker, brokerlistener, configuration, datalakeconnector, dataset, diagnosticservice, instance, kafkaconnector, lnm, mqttbridgeconnector, pipeline}]
Exemples
Utilisation de base. Vérifie l’intégrité de « mq » avec la sortie récapitulative.
az iot ops check
Évalue « mq » comme exemple précédent, mais la sortie est optimisée pour l’intégration continue.
az iot ops check --as-object
Vérifie l’intégrité et la configuration de « dataprocessor » avec une sortie détaillée.
az iot ops check --svc dataprocessor --detail-level 1
Identique à l’exemple précédent, à l’exception de la limitation des résultats à la ressource « pipeline ».
az iot ops check --svc dataprocessor --detail-level 1 --resources pipeline
Utilisez le nom de ressource pour limiter les résultats à la ressource « pipeline » correspondant exactement au nom « pipeline ».
az iot ops check --svc dataprocessor --resources pipeline --resource-name pipeline
Utilisez le nom de la ressource pour limiter les résultats aux noms de ressources qui commencent par « pipeline-name ».
az iot ops check --svc dataprocessor --detail-level 1 --resource-name pipeline-name*
Utilisez le modèle glob « ? » pour limiter les résultats aux noms de ressources qui contiennent « pipeline » et se terminent par un caractère unique.
az iot ops check --svc dataprocessor --detail-level 1 --resource-name pipeline?
Paramètres facultatifs
Sortie case activée contenu et validations dans une structure de données conviviale CI.
Nom de contexte Kubeconfig à utiliser pour la communication de cluster k8s. Si aucun contexte n’est fourni current_context est utilisé.
Contrôle le niveau de détail affiché dans la sortie case activée. Choisissez 0 pour une vue récapitulative (sortie minimale), 1 pour une vue détaillée (informations plus complètes) ou 2 pour une vue détaillée (toutes les informations disponibles).
Déploiement du service IoT Operations qui sera évalué.
Exécutez des case activée post-déploiement.
Exécutez des case activée préalables pour déterminer si les exigences minimales d’un déploiement de service sont remplies.
Exécutez uniquement des case activée pour le nom de ressource spécifique. Le nom ne respecte pas la casse. Les modèles Glob '' et ' ?' sont pris en charge. Remarque : Seuls les caractères alphanumériques, les traits d’union, « ? » et « » sont autorisés.
Exécutez uniquement des case activée sur des types de ressources spécifiques. Utilisez des valeurs séparées par des espaces.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az iot ops init
Le groupe de commandes « iot ops » est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus
Démarrez, configurez et déployez des opérations IoT sur le cluster avec arc cible.
Pour obtenir des ressources supplémentaires, notamment comment activer un cluster arc, consultez https://learn.microsoft.com/en-us/azure/iot-operations/deploy-iot-ops/howto-prepare-cluster.
az iot ops init --cluster
--resource-group
[--ca-dir]
[--ca-file]
[--ca-key-file]
[--ca-valid-days]
[--cluster-namespace]
[--context]
[--custom-location]
[--disable-rotation {false, true}]
[--disable-rsync-rules {false, true}]
[--dp-instance]
[--ensure-latest {false, true}]
[--kubernetes-distro {k3s, k8s, microk8s}]
[--kv-id]
[--kv-sat-secret-name]
[--location]
[--mq-authn]
[--mq-backend-part]
[--mq-backend-rf]
[--mq-backend-workers]
[--mq-broker]
[--mq-frontend-replicas]
[--mq-frontend-server]
[--mq-frontend-workers]
[--mq-insecure {false, true}]
[--mq-instance]
[--mq-listener]
[--mq-mem-profile {high, low, medium, tiny}]
[--mq-mode {auto, distributed}]
[--mq-service-type {clusterIp, loadBalancer, nodePort}]
[--no-block {false, true}]
[--no-deploy {false, true}]
[--no-preflight {false, true}]
[--no-progress {false, true}]
[--no-tls {false, true}]
[--opcua-discovery-url]
[--rotation-int]
[--runtime-socket]
[--show-template {false, true}]
[--simulate-plc {false, true}]
[--sp-app-id]
[--sp-object-id]
[--sp-secret]
[--sp-secret-valid-days]
[--target]
Exemples
Entrée minimale pour la configuration complète. Cela inclut la configuration key Vault, le déploiement du pilote CSI, la configuration TLS et le déploiement des opérations IoT.
az iot ops init --cluster mycluster -g myresourcegroup --kv-id /subscriptions/2cb3a427-1abc-48d0-9d03-dd240819742a/resourceGroups/myresourcegroup/providers/Microsoft.KeyVault/vaults/mykeyvault
Même configuration que l’exemple précédent, à l’exception de l’utilisation d’un ID d’application existant et d’un indicateur pour inclure un serveur PLC simulé dans le cadre du déploiement. L’inclusion de l’ID d’application empêche « init » de créer une inscription d’application.
az iot ops init --cluster mycluster -g myresourcegroup --kv-id $KEYVAULT_ID --sp-app-id a14e216b-6802-4e9c-a6ac-844f9ffd230d --simulate-plc
Pour ignorer le déploiement et vous concentrer uniquement sur le pilote CSI Key Vault et les flux de travail de configuration TLS, passez simplement « --no-deploy ». Cela peut être utile lorsque vous souhaitez déployer à partir d’un autre outil tel que Portail.
az iot ops init --cluster mycluster -g myresourcegroup --kv-id $KEYVAULT_ID --sp-app-id a14e216b-6802-4e9c-a6ac-844f9ffd230d --no-deploy
Pour déployer uniquement des opérations IoT sur un cluster qui a déjà été prédéfini, omettez simplement « --kv-id » et incluez « --no-tls ».
az iot ops init --cluster mycluster -g myresourcegroup --no-tls
Utilisez « --no-block » pour effectuer d’autres tâches pendant que le déploiement est en cours et en attente de la fin du déploiement avant de commencer l’autre travail.
az iot ops init --cluster mycluster -g myresourcegroup --kv-id $KEYVAULT_ID --sp-app-id a14e216b-6802-4e9c-a6ac-844f9ffd230d --no-block
Pour éviter d’appeler MS Graph comme pour les scénarios CI où les autorisations de principal de service az cli sont limitées ou qu’un principal de service existant doit être réutilisé, fournissez l’ensemble de « --sp-app-id », « --sp-object-id » et « --sp-secret ». Ces valeurs doivent refléter le principal de service souhaité qui sera utilisé pour la configuration du pilote CSI Key Vault.
az iot ops init --cluster mycluster -g myresourcegroup --kv-id $KEYVAULT_ID --sp-app-id a14e216b-6802-4e9c-a6ac-844f9ffd230d --sp-object-id 224a7a3f-c63d-4923-8950-c4a85f0d2f29 --sp-secret $SP_SECRET
Paramètres obligatoires
Nom du cluster cible pour le déploiement d’Opérations IoT.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Paramètres facultatifs
Le répertoire local dans lequel l’autorité de certification de test générée et la clé privée sont placées. Si aucun répertoire n’est fourni, le répertoire actif est utilisé. Applicable quand aucun fichier --ca-file et --ca-key-file sont fournis.
Chemin d’accès au fichier d’autorité de certification souhaité au format PEM.
Chemin d’accès au fichier de clé privée de l’autorité de certification au format PEM. ! Obligatoire! quand --ca-file est fourni.
Option permettant de contrôler la durée en jours de l’autorité de certification x509 générée par l’init. Applicable si --ca-file et --ca-key-file ne sont pas fournis.
L’infrastructure IoT Operations de l’espace de noms du cluster sera déployée. Il doit être en minuscules.
Nom de contexte Kubeconfig à utiliser pour la communication de cluster k8s. Si aucun contexte n’est fourni current_context est utilisé.
Nom d’emplacement personnalisé correspondant au déploiement des opérations IoT. La valeur par défaut est « {cluster_name}-ops-init-cl ».
Indicateur pour désactiver la rotation des secrets.
Les règles de synchronisation des ressources ne seront pas incluses dans le déploiement.
Nom de l’instance pour le processeur de données. La valeur par défaut est « {cluster_name}-ops-init-processor ».
Vérifiez que la dernière interface CLI IoT Ops est installée, ce qui génère une erreur si une mise à niveau est disponible.
Distribution Kubernetes à utiliser pour la configuration Akri. La distribution sélectionnée implique le chemin du socket d’exécution du conteneur par défaut quand aucune valeur --runtime-socket n’est fournie.
ID de ressource ARM Key Vault. La fourniture de cet ID de ressource permet au client de configurer toutes les ressources nécessaires et la configuration côté cluster pour activer le pilote CSI Key Vault pour les opérations IoT.
Nom du secret Key Vault à utiliser pour le compte de service Des opérations IoT (SAT). Si le secret n’existe pas, il est créé avec une valeur d’espace réservé sécurisée par chiffrement.
Emplacement ARM qui sera utilisé pour les garanties RPSaaS approvisionnées. Si l’emplacement du cluster connecté n’est pas fourni, il est utilisé.
Nom de l’authentification mq. La valeur par défaut est « authn ».
Partitions principales MQ.
Facteur de redondance du back-end MQ.
Workers back-end MQ.
Nom du répartiteur mq. La valeur par défaut est « broker ».
Réplicas frontend MQ.
Nom du serveur frontal mq. La valeur par défaut est « mq-dmqtt-frontend ».
Travailleurs frontaux MQ.
Lorsque le déploiement mq est activé, il inclut un écouteur lié au port 1883 sans authentification ni authentification. Le paramètre broker encryptInternalTraffic est défini sur false. Pour les charges de travail hors production uniquement.
Nom de l’instance mq. La valeur par défaut se présente sous la forme « init-{hash}-mq-instance ».
Nom de l’écouteur mq. La valeur par défaut est « écouteur ».
Profil de mémoire MQ.
Mode MQ de l’opération.
Type de service MQ.
Retournez immédiatement après le démarrage du déploiement des opérations IoT.
Le flux de travail de déploiement Des opérations IoT est ignoré.
Le flux de travail de préversion est ignoré.
Désactivez la barre de progression d’init.
Le flux de travail de configuration TLS est ignoré.
Configure un point de terminaison de serveur OPC-UA pour les gestionnaires de découverte Akri. Si elle n’est pas fournie et que --simulate-plc est définie, cette valeur devient ' opc.tcp ://opcplc-0000000. {cluster_namespace} :50000'.
Intervalle de sondage de rotation.
Chemin du nœud par défaut du socket d’exécution du conteneur. S’il n’est pas fourni (valeur par défaut), le chemin du socket est déterminé par --kubernetes-distro.
Indicateur lorsqu’il est défini, génère le modèle destiné au déploiement.
Indicateur quand il est défini, configure le programme d’installation du répartiteur OPC-UA pour faire tourner un serveur PLC.
ID d’application du principal de service. S’il est fourni, il sera utilisé pour la configuration du pilote CSI. Sinon, une inscription d’application est créée. ! Obligatoire! si le principal connecté n’a pas les autorisations nécessaires pour interroger le graphe.
ID d’objet du principal de service. S’il est fourni, il sera utilisé pour la configuration du pilote CSI. Dans le cas contraire, un principal de service sera interrogé et, dans le cas contraire, sera créé. ! Obligatoire! si le principal connecté n’a pas les autorisations nécessaires pour interroger le graphe.
Secret correspondant à l’ID d’application du principal de service fourni. S’il est fourni, il sera utilisé pour la configuration du pilote CSI. Sinon, un nouveau secret sera demandé à partir du graphe MS. ! Obligatoire! si le principal connecté n’a pas les autorisations nécessaires pour interroger le graphe.
Option permettant de contrôler la durée en jours du secret du principal de service généré par l’init. Applicable si --sp-secret n’est pas fourni.
Nom cible de l’orchestrateur d’opérations. La valeur par défaut est « {cluster_name}-ops-init-target ».
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az iot ops verify-host
Le groupe de commandes « iot ops » est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus
Exécute un ensemble de vérifications de l’hôte de cluster pour la compatibilité du déploiement d’IoT Operations.
Destiné à être exécuté directement sur un hôte de cluster cible. La commande peut inviter à appliquer un ensemble d’actions privilégiées telles que l’installation d’une dépendance. Dans ce cas, l’interface CLI doit être exécutée avec des autorisations élevées. Par exemple, sudo AZURE_EXTENSION_DIR=~/.azure/cliextensions az iot ops verify-host
.
az iot ops verify-host [--no-progress {false, true}]
Paramètres facultatifs
Désactivez la représentation visuelle du travail.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour