Ensemble de commandes CLI Azure Digital Twins
Outre la gestion de votre instance Azure Digital Twins dans le portail Azure, vous pouvez également utiliser le jeu de commandes pour Azure CLI d’Azure Digital Twins pour effectuer la plupart des actions principales dans le service. Cet article aborde la commande Azure CLI définie pour Azure Digital Twins, notamment son utilisation, comment l’obtenir et la configuration requise pour l’utiliser.
Voici quelques-unes des actions que vous pouvez effectuer à l’aide du jeu de commandes :
- Gestion d’une instance Azure Digital Twins
- Gestion des modèles
- Gestion des jumeaux numériques
- Gestion des relations entre les jumeaux
- Configuration de points de terminaison
- Gestion des routes
- Configuration de la sécurité via le contrôle d’accès en fonction du rôle Azure (Azure RBAC)
Le jeu de commandes se nomme az dt, et il fait partie de l’extension Azure IoT pour Azure CLI. Vous pouvez afficher la liste complète des commandes et leur utilisation dans le cadre de la documentation de référence pour l’ensemble de commandes az iot : az dt, informations de référence sur la commande.
Utilisations (déployer et valider)
Outre la gestion générale de votre instance, l’interface CLI vous permet également d’effectuer des déploiements et des validations.
- Les commandes de plan de contrôle peuvent être utilisées pour rendre le déploiement d’une nouvelle instance reproductible ou automatisé.
- Les commandes de plan de données peuvent être utilisées pour vérifier rapidement les valeurs de votre instance et vérifier que les opérations se sont terminées comme prévu.
Obtenir le jeu de commandes
Les commandes Azure Digital Twins font partie de l’extension Azure IoT pour Azure CLI (azure-iot) ; vous devez donc suivre ces étapes pour vous assurer que vous disposez de la dernière extension azure-iot avec les commandes az dt.
Version CLI requise
Si vous utilisez Azure CLI avec PowerShell, le package d’extension exige que votre version d’Azure CLI soit 2.3.1 ou une version ultérieure.
Vous pouvez vérifier votre version d’Azure CLI à l’aide de cette commande CLI :
az --version
Pour obtenir des instructions sur l’installation ou la mise à jour d’Azure CLI vers une version plus récente, consultez Installer Azure CLI.
Obtient l’extension
Azure CLI vous invite automatiquement à installer l’extension lors de la première utilisation d’une commande qui l’exige.
Sinon, vous pouvez utiliser la commande suivante pour installer vous-même l’extension à tout moment (ou la mettre à jour s’il s’avère que vous avez déjà une version antérieure). Vous pouvez exécuter la commande dans Azure Cloud Shell ou dans une interface de ligne de commande Azure locale.
az extension add --upgrade --name azure-iot
Utiliser des caractères spéciaux dans différents interpréteurs de commandes
Certaines commandes az dt utilisent des caractères spéciaux qui peuvent devoir être échappés pour une analyse correcte dans certains environnements d’interpréteur de commandes. Utilisez les conseils de cette section pour vous aider à savoir quand le faire dans l’interpréteur de commandes de votre choix.
Bash
Utilisez ces conseils sur les caractères spéciaux pour les environnements Bash.
Requêtes
Dans de nombreuses requêtes de jumeaux, le caractère $ est utilisé pour faire référence à la propriété $dtId d’un jumeau. Lorsque vous utilisez la commande az dt twin query pour interroger l’environnement Bash Cloud Shell, échappez le caractère $ avec une barre oblique inverse (\).
Voici un exemple d’interrogation d’un jumeau avec une commande CLI dans l’environnement Bash Cloud Shell :
az dt twin query --dt-name <instance-hostname-or-name> --query-command "SELECT * FROM DigitalTwins T Where T.\$dtId = 'room0'"
PowerShell
Utilisez ces conseils sur les caractères spéciaux pour les environnements PowerShell.
JSON inline
Certaines commandes, telles que az dt twin create, vous permettent d’entrer des informations sur le jumeau sous forme de données JSON inline. Lors de l’entrée du JSON inline dans l’environnement PowerShell, échappez les guillemets doubles (") à l’intérieur du JSON avec une barre oblique inverse (\).
Voici un exemple de création d’un jumeau avec une commande CLI dans PowerShell :
az dt twin create --dt-name <instance-hostname-or-name> --dtmi "dtmi:contosocom:DigitalTwins:Thermostat;1" --twin-id thermostat67 --properties '{\"Temperature\": 0.0}'
Conseil
La plupart des commandes qui prennent en charge JSON inline prennent également en charge l’entrée en tant que chemin d’accès de fichier, ce qui peut vous aider à éviter les exigences de texte spécifiques à l’interpréteur de commandes.
Requêtes
Dans de nombreuses requêtes de jumeaux, le caractère $ est utilisé pour faire référence à la propriété $dtId d’un jumeau. Lorsque vous utilisez la commande az dt twin query pour interroger un environnement PowerShell, échappez le caractère $ avec un guillemet oblique.
Voici un exemple d’interrogation d’un jumeau avec une commande CLI dans PowerShell :
az dt twin query --dt-name <instance-hostname-or-name> --query-command "SELECT * FROM DigitalTwins T Where T.`$dtId = 'room0'"
Windows CMD
Utilisez ces conseils sur ls caractères spéciaux pour la CMD Windows locale.
JSON inline
Certaines commandes, telles que az dt twin create, vous permettent d’entrer des informations sur le jumeau sous forme de données JSON inline. Lors de l’entrée du JSON inline dans une fenêtre CMD Windows locale, placez la valeur de paramètre entre guillemets doubles (") au lieu de guillemets simples ('), et utilisez des guillemets doubles dans le JSON avec une barre oblique inverse (\).
Voici un exemple de création d’un jumeau avec une commande CLI dans la CMD Windows locale :
az dt twin create --dt-name <instance-hostname-or-name> --dtmi "dtmi:contosocom:DigitalTwins:Thermostat;1" --twin-id thermostat67 --properties "{\"Temperature\": 0.0}"
Conseil
La plupart des commandes qui prennent en charge JSON inline prennent également en charge l’entrée en tant que chemin d’accès de fichier, ce qui peut vous aider à éviter les exigences de texte spécifiques à l’interpréteur de commandes.
Étapes suivantes
Explorez l’interface CLI et son ensemble complet de commandes via les documents de référence :