Ensemble de commandes CLI Azure Digital Twins

Outre la gestion de votre instance Azure Digital Twins dans le portail Azure, Azure Digital Twins dispose également d’un ensemble de commandes pour Azure CLI que vous pouvez utiliser pour effectuer la plupart des actions majeures avec le service. Cet article décrit l’ensemble de commandes Azure CLI pour Azure Digital Twins, notamment ses utilisations, la façon de l’obtenir et les conditions requises 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 jumeaux
• Configuration de points de terminaison
• Gestion des itinéraires
• Configuration de la sécurité via le contrôle d’accès en fonction du rôle Azure (Azure RBAC)

Le jeu de commandes est appelé az dtet 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 est également un outil utile pour le déploiement et la validation.

• 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), procédez comme suit pour vous assurer que vous disposez de la dernière azure-iot extension avec les az dt commandes.

Exigences de version de CLI

Si vous utilisez Azure CLI avec PowerShell, votre version d’Azure CLI doit être 2.3.1 ou supérieure en tant qu’exigence du package d’extension.

Vous pouvez vérifier la version de votre interface de ligne de commande Azure avec 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 Comment installer Azure CLI.

Obtenir 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 l’extension vous-même à tout moment (ou la mettre à jour si elle s’avère que vous disposez déjà d’une version antérieure). La commande peut être exécutée dans Azure Cloud Shell ou dans Azure CLI local.

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 shell. Utilisez les conseils de cette section pour vous aider à savoir quand échapper les caractères spéciaux dans le shell de votre choix.

Bafouer

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 référencer 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 de requête pour un jumeau avec une commande CLI dans l'environnement Cloud Shell Bash :

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}'

Requêtes

Dans de nombreuses requêtes de jumeaux, le caractère $ est utilisé pour référencer 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 de requête pour 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 le CMD Windows local :

az dt twin create --dt-name <instance-hostname-or-name> --dtmi "dtmi:contosocom:DigitalTwins:Thermostat;1" --twin-id thermostat67 --properties "{\"Temperature\": 0.0}"

Étapes suivantes

Explorez l’interface CLI et son ensemble complet de commandes via la documentation de référence :

• az dt, informations de référence sur les commandes