az dt twin
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 commande az dt twin. Apprenez-en davantage sur les extensions.
Gérez et configurez les jumeaux numériques d’une instance Digital Twins.
Commandes
| Nom | Description | Type | État |
|---|---|---|---|
| az dt twin component |
Affichez et mettez à jour les composants de jumeau numérique d’une instance Digital Twins. |
Extension | GA |
| az dt twin component show |
Afficher les détails d’un composant de jumeau numérique. |
Extension | GA |
| az dt twin component update |
Mettez à jour un composant de jumeau numérique via la spécification de correctif JSON. |
Extension | GA |
| az dt twin create |
Créez un jumeau numérique sur une instance. |
Extension | GA |
| az dt twin delete |
Supprimez un jumeau numérique. Toutes les relations faisant référence à ce jumeau doivent déjà être supprimées. |
Extension | GA |
| az dt twin delete-all |
Supprime tous les jumeaux numériques au sein d’une instance Digital Twins, y compris toutes les relations pour ces jumeaux. |
Extension | GA |
| az dt twin query |
Interrogez les jumeaux numériques d’une instance. Permet de parcourir les relations et de filtrer par valeurs de propriété. |
Extension | GA |
| az dt twin relationship |
Gérez et configurez les relations de jumeau numérique d’une instance Digital Twins. |
Extension | GA |
| az dt twin relationship create |
Créez une relation entre les jumeaux numériques source et cible. |
Extension | GA |
| az dt twin relationship delete |
Supprimez une relation de jumeau numérique sur une instance Digital Twins. |
Extension | GA |
| az dt twin relationship delete-all |
Supprime toutes les relations de jumeaux numériques au sein d’une instance Digital Twins, y compris les relations entrantes. |
Extension | GA |
| az dt twin relationship list |
Répertorier les relations d’un jumeau numérique. |
Extension | GA |
| az dt twin relationship show |
Afficher les détails d’une relation de jumeau numérique. |
Extension | GA |
| az dt twin relationship update |
Met à jour les propriétés d’une relation entre deux jumeaux numériques via la spécification de correctif JSON. |
Extension | GA |
| az dt twin show |
Afficher les détails d’un jumeau numérique. |
Extension | GA |
| az dt twin telemetry |
Testez et validez les itinéraires d’événements et les points de terminaison d’une instance Digital Twins. |
Extension | GA |
| az dt twin telemetry send |
Envoie des données de télémétrie pour le compte d’un jumeau numérique. Si le chemin du composant est fourni, la télémétrie émise est au nom du composant. |
Extension | GA |
| az dt twin update |
Mettez à jour un jumeau numérique d’instance via la spécification des correctifs JSON. |
Extension | GA |
az dt twin create
Créez un jumeau numérique sur une instance.
--properties peut être inline JSON ou chemin d’accès de fichier. Remarque : --properties sont requises pour les jumeaux qui contiennent des composants.
az dt twin create --dt-name --dtn
--dtmi --model-id
--twin-id
[--if-none-match]
[--properties]
[--resource-group]
Exemples
Créez un jumeau numérique à partir d’un modèle existant (créé au préalable).
az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:Room;1" --twin-id {twin_id}
Créez un jumeau numérique à partir d’un modèle existant (créé précédemment) avec une balise if-none-match.
az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:Room;1" --twin-id {twin_id} --if-none-match
Créez un jumeau numérique à partir d’un modèle existant (créé au préalable). Instanciez avec des valeurs de propriété.
az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:DeviceInformation;1" --twin-id {twin_id} --properties '{"manufacturer": "Microsoft"}'
Créez un jumeau numérique avec un composant à partir de modèles existants (créés précédemment). Instancier un composant avec des propriétés minimales.
az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:TemperatureController;1" --twin-id {twin_id} --properties '{
"Thermostat": {
"$metadata": {},
}
}'
Créez un jumeau numérique avec un composant à partir de modèles existants (créés précédemment). Instanciez avec des valeurs de propriété.
az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:TemperatureController;1" --twin-id {twin_id} --properties '{
"Temperature": 10.2,
"Thermostat": {
"$metadata": {},
"setPointTemp": 23.12
}
}'
Paramètres obligatoires
Nom d’instance Digital Twins ou nom d’hôte. Si un nom d’instance est fourni, l’abonnement utilisateur est interrogé pour la première fois pour que l’instance cible récupère le nom d’hôte. Si un nom d’hôte est fourni, la requête d’abonnement est ignorée et la valeur fournie est utilisée pour une interaction ultérieure.
ID de modèle Digital Twins. Exemple : dtmi :com :example :Room ;2.
ID de jumeau numérique.
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.
Indique que l’opération de création doit échouer si un jumeau existant avec le même ID existe.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Valeurs de propriété initiales pour instancier un jumeau numérique ou des composants associés. Fournissez le chemin d’accès au fichier ou json inline. Les propriétés sont requises pour les jumeaux qui contiennent des composants, au minimum, vous devez fournir un objet $metadata vide pour chaque composant.
Groupe de ressources d’instance Digital Twins. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group={name}.
Paramètres globaux
Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Format de sortie.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | json |
| Valeurs acceptées: | json, jsonc, none, table, tsv, yaml, yamlc |
Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.
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 dt twin delete
Supprimez un jumeau numérique. Toutes les relations faisant référence à ce jumeau doivent déjà être supprimées.
az dt twin delete --dt-name --dtn
--twin-id
[--etag]
[--resource-group]
Exemples
Supprimez un jumeau numérique par ID.
az dt twin delete -n {instance_or_hostname} --twin-id {twin_id}
Supprimez un jumeau numérique par ID à l’aide de l’etag.
az dt twin delete -n {instance_or_hostname} --twin-id {twin_id} --etag {etag}
Paramètres obligatoires
Nom d’instance Digital Twins ou nom d’hôte. Si un nom d’instance est fourni, l’abonnement utilisateur est interrogé pour la première fois pour que l’instance cible récupère le nom d’hôte. Si un nom d’hôte est fourni, la requête d’abonnement est ignorée et la valeur fournie est utilisée pour une interaction ultérieure.
ID de jumeau numérique.
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.
Valeur de balise d’entité. La commande réussit si l’etag correspond à l’etag actuel de la ressource.
Groupe de ressources d’instance Digital Twins. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group={name}.
Paramètres globaux
Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Format de sortie.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | json |
| Valeurs acceptées: | json, jsonc, none, table, tsv, yaml, yamlc |
Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.
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 dt twin delete-all
Supprime tous les jumeaux numériques au sein d’une instance Digital Twins, y compris toutes les relations pour ces jumeaux.
az dt twin delete-all --dt-name --dtn
[--resource-group]
[--yes]
Exemples
Supprimez tous les jumeaux numériques. Toutes les relations référençant les jumeaux sont également supprimées.
az dt twin delete-all -n {instance_or_hostname}
Paramètres obligatoires
Nom d’instance Digital Twins ou nom d’hôte. Si un nom d’instance est fourni, l’abonnement utilisateur est interrogé pour la première fois pour que l’instance cible récupère le nom d’hôte. Si un nom d’hôte est fourni, la requête d’abonnement est ignorée et la valeur fournie est utilisée pour une interaction ultérieure.
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.
Groupe de ressources d’instance Digital Twins. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group={name}.
N’invitez pas à confirmer.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Paramètres globaux
Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Format de sortie.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | json |
| Valeurs acceptées: | json, jsonc, none, table, tsv, yaml, yamlc |
Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.
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 dt twin query
Interrogez les jumeaux numériques d’une instance. Permet de parcourir les relations et de filtrer par valeurs de propriété.
Dans de nombreuses requêtes de jumeaux, le caractère $ est utilisé pour référencer la propriété $dtId d’un jumeau. Dans des interpréteurs de commandes de type bash ou powershell, le caractère $ a une signification fonctionnelle et doit être placé dans l’échappement dans le cadre de l’entrée de requête. Pour plus d’informations, consultez le document sur les concepts de l’interface CLI Digital Twins https://learn.microsoft.com/en-us/azure/digital-twins/concepts-cli.
az dt twin query --dt-name --dtn
--query-command
[--cost --show-cost {false, true}]
[--resource-group]
Exemples
Interrogez toutes les jumeaux numériques dans l’instance cible et projetez tous les attributs. Affichez également les coûts en unités de requête.
az dt twin query -n {instance_or_hostname} -q "select * from digitaltwins" --show-cost
Interrogez par modèle et projetez tous les attributs.
az dt twin query -n {instance_or_hostname} -q "select * from digitaltwins T where IS_OF_MODEL(T, 'dtmi:com:example:Room;2')"
Requête tirant parti de « $dtId » avec la syntaxe compatible bash
az dt twin query -n {instance_or_hostname} --query-command "SELECT * FROM DigitalTwins T Where T.\$dtId = 'room0'"
Requête tirant parti de « $dtId » avec la syntaxe compatible powerShell
az dt twin query -n {instance_or_hostname} --query-command "SELECT * FROM DigitalTwins T Where T.`$dtId = 'room0'"
Paramètres obligatoires
Nom d’instance Digital Twins ou nom d’hôte. Si un nom d’instance est fourni, l’abonnement utilisateur est interrogé pour la première fois pour que l’instance cible récupère le nom d’hôte. Si un nom d’hôte est fourni, la requête d’abonnement est ignorée et la valeur fournie est utilisée pour une interaction ultérieure.
Requête utilisateur à exécuter.
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.
Calcule et affiche les frais de requête.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
| Valeurs acceptées: | false, true |
Groupe de ressources d’instance Digital Twins. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group={name}.
Paramètres globaux
Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Format de sortie.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | json |
| Valeurs acceptées: | json, jsonc, none, table, tsv, yaml, yamlc |
Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.
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 dt twin show
Afficher les détails d’un jumeau numérique.
az dt twin show --dt-name --dtn
--twin-id
[--resource-group]
Exemples
Afficher les détails d’un jumeau numérique.
az dt twin show -n {instance_or_hostname} --twin-id {twin_id}
Paramètres obligatoires
Nom d’instance Digital Twins ou nom d’hôte. Si un nom d’instance est fourni, l’abonnement utilisateur est interrogé pour la première fois pour que l’instance cible récupère le nom d’hôte. Si un nom d’hôte est fourni, la requête d’abonnement est ignorée et la valeur fournie est utilisée pour une interaction ultérieure.
ID de jumeau numérique.
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.
Groupe de ressources d’instance Digital Twins. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group={name}.
Paramètres globaux
Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Format de sortie.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | json |
| Valeurs acceptées: | json, jsonc, none, table, tsv, yaml, yamlc |
Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.
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 dt twin update
Mettez à jour un jumeau numérique d’instance via la spécification des correctifs JSON.
Les mises à jour apportées aux valeurs de propriété et $model éléments peuvent se produire dans la même requête. Les opérations sont limitées à l’ajout, au remplacement et à la suppression.
az dt twin update --dt-name --dtn
--json-patch --patch
--twin-id
[--etag]
[--resource-group]
Exemples
Mettez à jour un jumeau numérique via la spécification des correctifs JSON.
az dt twin update -n {instance_or_hostname} --twin-id {twin_id} --json-patch '{"op":"replace", "path":"/Temperature", "value": 20.5}'
Mettez à jour un jumeau numérique via la spécification des correctifs JSON et à l’aide d’etag.
az dt twin update -n {instance_or_hostname} --twin-id {twin_id} --etag {etag} --json-patch '{"op":"replace", "path":"/Temperature", "value": 20.5}'
Mettez à jour un jumeau numérique via la spécification des correctifs JSON.
az dt twin update -n {instance_or_hostname} --twin-id {twin_id} --json-patch '[
{"op":"replace", "path":"/Temperature", "value": 20.5},
{"op":"add", "path":"/Areas", "value": ["ControlSystem"]}
]'
Mettez à jour un jumeau numérique via la spécification de correctif JSON définie dans un fichier.
az dt twin update -n {instance_or_hostname} --twin-id {twin_id} --json-patch ./my/patch/document.json
Paramètres obligatoires
Nom d’instance Digital Twins ou nom d’hôte. Si un nom d’instance est fourni, l’abonnement utilisateur est interrogé pour la première fois pour que l’instance cible récupère le nom d’hôte. Si un nom d’hôte est fourni, la requête d’abonnement est ignorée et la valeur fournie est utilisée pour une interaction ultérieure.
Spécification de mise à jour décrite par JSON-patch. Les mises à jour apportées aux valeurs de propriété et $model éléments peuvent se produire dans la même requête. Les opérations sont limitées à l’ajout, au remplacement et à la suppression. Fournissez le chemin d’accès au fichier ou json inline.
ID de jumeau numérique.
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.
Valeur de balise d’entité. La commande réussit si l’etag correspond à l’etag actuel de la ressource.
Groupe de ressources d’instance Digital Twins. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group={name}.
Paramètres globaux
Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | False |
Format de sortie.
| Propriété | Valeur |
|---|---|
| Valeur par défaut: | json |
| Valeurs acceptées: | json, jsonc, none, table, tsv, yaml, yamlc |
Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.
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 |