az dt twin relationship

  • Référence

Remarque

Cette référence fait partie de l’extension azure-iot pour Azure CLI (version 2.46.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une commande de relation de jumeau az dt. En savoir plus sur les extensions.

Gérez et configurez les relations de jumeau numérique d’une instance Digital Twins.

Commandes

Nom Description Type Statut
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 relationship create

Créez une relation entre les jumeaux numériques source et cible.

Les --properties peuvent être du JSON intégré ou le chemin d’accès au fichier.

az dt twin relationship create --dt-name
                               --kind
                               --relationship-id
                               --source
                               --target
                               [--if-none-match]
                               [--properties]
                               [--resource-group]

Exemples

Créez une relation entre deux jumeaux numériques.

az dt twin relationship create -n {instance_or_hostname} --relationship-id {relationship_id} --relationship contains --twin-id {source_twin_id} --target {target_twin_id}

Créer une relation entre deux jumeaux numériques avec une balise if-none-match

az dt twin relationship create -n {instance_or_hostname} --relationship-id {relationship_id} --relationship contains --twin-id {source_twin_id} --target {target_twin_id} --if-none-match

Créez une relation avec des propriétés initialisées entre deux jumeaux numériques.

az dt twin relationship create -n {instance_or_hostname} --relationship-id {relationship_id} --relationship contains --twin-id {source_twin_id} --target {target_twin_id} --properties '{"ownershipUser": "me", "ownershipDepartment": "Computer Science"}'

Paramètres obligatoires

--dt-name --dtn -n

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.

--kind --relationship

Nom ou type de relation. Par exemple : « contains ».

--relationship-id -r

ID de relation.

--source --twin-id -t

ID de jumeau source pour une relation.

--target --target-twin-id

ID de jumeau cible pour une relation.

Paramètres facultatifs

--if-none-match

Indique que l’opération de création doit échouer si un jumeau existant avec le même ID existe.

valeur par défaut: False
--properties -p

Valeurs de propriété initiales pour instancier une relation de jumeau numérique. Fournissez le chemin d’accès au fichier ou json inline.

--resource-group -g

Groupe de ressources d’instance Digital Twins. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az dt twin relationship delete

Supprimez une relation de jumeau numérique sur une instance Digital Twins.

az dt twin relationship delete --dt-name
                               --relationship-id
                               --source
                               [--etag]
                               [--resource-group]

Exemples

Supprimez une relation de jumeau numérique.

az dt twin relationship delete -n {instance_or_hostname} --twin-id {twin_id} --relationship-id {relationship_id}

Supprimez une relation de jumeau numérique à l’aide de l’etag.

az dt twin relationship delete -n {instance_or_hostname} --twin-id {twin_id} --relationship-id {relationship_id} --etag {etag}

Paramètres obligatoires

--dt-name --dtn -n

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.

--relationship-id -r

ID de relation.

--source --twin-id -t

ID de jumeau source pour une relation.

Paramètres facultatifs

--etag -e

Valeur de balise d’entité. La commande réussit si l’etag correspond à l’etag actuel de la ressource.

--resource-group -g

Groupe de ressources d’instance Digital Twins. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

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.

az dt twin relationship delete-all --dt-name
                                   [--resource-group]
                                   [--source]
                                   [--yes]

Exemples

Supprimez toutes les relations de jumeau numérique associées au jumeau.

az dt twin relationship delete-all -n {instance_or_hostname} --twin-id {twin_id}

Supprimez toutes les relations de jumeaux numériques dans l’instace Digital Twins.

az dt twin relationship delete-all -n {instance_or_hostname}

Paramètres obligatoires

--dt-name --dtn -n

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

--resource-group -g

Groupe de ressources d’instance Digital Twins. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--source --twin-id -t

ID de jumeau source pour une relation.

--yes -y

Ne pas demander de confirmation.

valeur par défaut: False
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az dt twin relationship list

Répertorier les relations d’un jumeau numérique.

az dt twin relationship list --dt-name
                             --source
                             [--incoming {false, true}]
                             [--kind]
                             [--resource-group]

Exemples

Répertorier les relations sortantes d’un jumeau numérique.

az dt twin relationship list -n {instance_or_hostname} --twin-id {twin_id}

Répertorier les relations sortantes d’un jumeau numérique et filtrer sur la relation « contains »

az dt twin relationship list -n {instance_or_hostname} --twin-id {twin_id} --relationship contains

Répertorier les relations entrantes d’un jumeau numérique.

az dt twin relationship list -n {instance_or_hostname} --twin-id {twin_id} --incoming

Répertorier les relations entrantes d’un jumeau numérique et filtrer sur la relation « contains ».

az dt twin relationship list -n {instance_or_hostname} --twin-id {twin_id} --relationship contains --incoming

Paramètres obligatoires

--dt-name --dtn -n

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.

--source --twin-id -t

ID de jumeau source pour une relation.

Paramètres facultatifs

--incoming

Récupère toutes les relations entrantes pour un jumeau numérique.

valeurs acceptées: false, true
valeur par défaut: False
--kind --relationship

Filtrez le résultat en fonction du type de relation.

--resource-group -g

Groupe de ressources d’instance Digital Twins. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az dt twin relationship show

Afficher les détails d’une relation de jumeau numérique.

az dt twin relationship show --dt-name
                             --relationship-id
                             --source
                             [--resource-group]

Exemples

Afficher les détails d’une relation de jumeau numérique.

az dt twin relationship show -n {instance_or_hostname} --twin-id {twin_id} --relationship-id {relationship_id}

Paramètres obligatoires

--dt-name --dtn -n

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.

--relationship-id -r

ID de relation.

--source --twin-id -t

ID de jumeau source pour une relation.

Paramètres facultatifs

--resource-group -g

Groupe de ressources d’instance Digital Twins. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

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.

Les opérations sont limitées à l’ajout, au remplacement et à la suppression.

az dt twin relationship update --dt-name
                               --json-patch
                               --relationship-id
                               --source
                               [--etag]
                               [--resource-group]

Exemples

Mettez à jour une relation de jumeau numérique via la spécification de correctif JSON.

az dt twin relationship update -n {instance_or_hostname} --twin-id {twin_id} --relationship-id {relationship_id} --relationship contains --json-patch '{"op":"replace", "path":"/Temperature", "value": 20.5}'

Mettez à jour une relation de jumeau numérique via la spécification de correctif JSON et à l’aide d’etag.

az dt twin relationship update -n {instance_or_hostname} --twin-id {twin_id} --relationship-id {relationship_id} --relationship contains --json-patch '{"op":"replace", "path":"/Temperature", "value": 20.5}' --etag {etag}

Mettez à jour une relation de jumeau numérique via la spécification de correctif JSON.

az dt twin relationship update -n {instance_or_hostname} --twin-id {twin_id} --relationship-id {relationship_id} --relationship contains --json-patch '[
  {"op":"replace", "path":"/Temperature", "value": 20.5},
  {"op":"add", "path":"/Areas", "value": ["ControlSystem"]}
]'

Mettez à jour une relation de jumeau numérique via la spécification de correctif JSON définie dans un fichier.

az dt twin relationship update -n {instance_or_hostname} --twin-id {twin_id} --relationship-id {relationship_id} --relationship contains --json-patch ./my/patch/document.json

Paramètres obligatoires

--dt-name --dtn -n

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.

--json-patch --patch

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.

--relationship-id -r

ID de relation.

--source --twin-id -t

ID de jumeau source pour une relation.

Paramètres facultatifs

--etag -e

Valeur de balise d’entité. La commande réussit si l’etag correspond à l’etag actuel de la ressource.

--resource-group -g

Groupe de ressources d’instance Digital Twins. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes 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 en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.