az dt twin

Note

Diese Referenz ist Teil der Azure-iot-Erweiterung für die Azure CLI (Version 2.67.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie einen az dt twin Befehl zum ersten Mal ausführen. Erfahren Sie mehr über Erweiterungen.

Verwalten und Konfigurieren der digitalen Zwillinge einer Digital Twins-Instanz.

Befehle

Name	Beschreibung	Typ	Status
az dt twin component	Zeigen und aktualisieren Sie die digitalen Zwillingskomponenten einer Digital Twins-Instanz.	Extension	GA
az dt twin component show	Zeigen Sie Details einer digitalen Zwillingskomponente an.	Extension	GA
az dt twin component update	Aktualisieren Sie eine digitale Twin-Komponente über die JSON-Patchspezifikation.	Extension	GA
az dt twin create	Erstellen Sie einen digitalen Zwilling in einer Instanz.	Extension	GA
az dt twin delete	Entfernen Sie einen digitalen Zwilling. Alle Beziehungen, die auf diesen Zwilling verweisen, müssen bereits gelöscht werden.	Extension	GA
az dt twin delete-all	Löscht alle digitalen Zwillinge innerhalb einer Digital Twins-Instanz, einschließlich aller Beziehungen für diese Zwillinge.	Extension	GA
az dt twin query	Abfragen der digitalen Zwillinge einer Instanz. Ermöglicht das Durchlaufen von Beziehungen und Filtern nach Eigenschaftswerten.	Extension	GA
az dt twin relationship	Verwalten und konfigurieren Sie die digitalen Zwillingsbeziehungen einer Digital Twins-Instanz.	Extension	GA
az dt twin relationship create	Erstellen Sie eine Beziehung zwischen Quell- und Ziel-digitalen Zwillingen.	Extension	GA
az dt twin relationship delete	Löschen Einer digitalen Zwillingsbeziehung auf einer Digital Twins-Instanz.	Extension	GA
az dt twin relationship delete-all	Löscht alle digitalen Zwillingsbeziehungen innerhalb einer Digital Twins-Instanz, einschließlich eingehender Beziehungen.	Extension	GA
az dt twin relationship list	Auflisten der Beziehungen eines digitalen Zwillings.	Extension	GA
az dt twin relationship show	Zeigen Sie Details einer digitalen Zwillingsbeziehung an.	Extension	GA
az dt twin relationship update	Aktualisiert die Eigenschaften einer Beziehung zwischen zwei digitalen Zwillingen über die JSON-Patchspezifikation.	Extension	GA
az dt twin show	Zeigen Sie die Details eines digitalen Zwillings an.	Extension	GA
az dt twin telemetry	Testen und überprüfen Sie die Ereignisrouten und Endpunkte einer Digital Twins-Instanz.	Extension	GA
az dt twin telemetry send	Sendet Telemetrie im Auftrag eines digitalen Zwillings. Wenn der Komponentenpfad bereitgestellt wird, befindet sich die ausgegebene Telemetrie im Auftrag der Komponente.	Extension	GA
az dt twin update	Aktualisieren Sie einen digitalen Zwilling einer Instanz über die JSON-Patchspezifikation.	Extension	GA

az dt twin create

Erstellen Sie einen digitalen Zwilling in einer Instanz.

--properties can be inline JSON or file path. Hinweis: --Eigenschaften sind für Zwillinge erforderlich, die Komponenten enthalten.

az dt twin create --dt-name --dtn
                  --dtmi --model-id
                  --twin-id
                  [--if-none-match]
                  [--properties]
                  [--resource-group]

Beispiele

Erstellen eines digitalen Zwillings anhand eines vorhandenen (zuvor erstellten) Modells:

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:Room;1" --twin-id {twin_id}

Erstellen Sie einen digitalen Zwilling aus einem vorhandenen (zuvor erstellten) Modell mit if-none-match-Tag.

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:Room;1" --twin-id {twin_id} --if-none-match

Erstellen eines digitalen Zwillings anhand eines vorhandenen (zuvor erstellten) Modells: Instanziieren mit Eigenschaftswerten.

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:DeviceInformation;1" --twin-id {twin_id} --properties '{"manufacturer": "Microsoft"}'

Erstellen Sie einen digitalen Zwilling mit Komponente aus vorhandenen (zuvor erstellten) Modellen. Instanziieren Sie die Komponente mit minimalen Eigenschaften.

az dt twin create -n {instance_or_hostname} --dtmi "dtmi:com:example:TemperatureController;1" --twin-id {twin_id} --properties '{
    "Thermostat": {
        "$metadata": {},
    }
}'

Erstellen Sie einen digitalen Zwilling mit Komponente aus vorhandenen (zuvor erstellten) Modellen. Instanziieren mit Eigenschaftswerten.

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

Erforderliche Parameter

--dt-name --dtn -n

Name oder Hostname der Digital Twins-Instanz. Wenn ein Instanzname angegeben wird, wird das Benutzerabonnement zuerst für die Zielinstanz abgefragt, um den Hostnamen abzurufen. Wenn ein Hostname angegeben wird, wird die Abonnementabfrage übersprungen und der bereitgestellte Wert für nachfolgende Interaktionen verwendet.

--dtmi --model-id -m

Digital Twins Modell ID. Beispiel: dtmi:com:example:Room;2.

--twin-id -t

Die digitale Zwillings-ID.

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--if-none-match

Gibt an, dass der Erstellungsvorgang fehlschlägt, wenn ein vorhandener Zwilling mit derselben ID vorhanden ist.

Eigenschaft	Wert
Standardwert:	False

--properties -p

Anfängliche Eigenschaftswerte zum Instanziieren eines digitalen Zwillings oder verwandter Komponenten. Geben Sie dateipfad oder inline JSON an. Eigenschaften sind für Zwillinge erforderlich, die Komponenten enthalten, mindestens müssen Sie für jede Komponente ein leeres $metadata-Objekt angeben.

--resource-group -g

Ressourcengruppe der Digital Twins-Instanz. Sie können die Standardgruppe mit az configure --defaults group={name}konfigurieren.

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Ausgabeformat.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az dt twin delete

Entfernen Sie einen digitalen Zwilling. Alle Beziehungen, die auf diesen Zwilling verweisen, müssen bereits gelöscht werden.

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

Beispiele

Entfernen Sie einen digitalen Zwilling nach ID.

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

Entfernen Sie einen digitalen Zwilling per ID mithilfe des etags.

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

Erforderliche Parameter

--dt-name --dtn -n

Name oder Hostname der Digital Twins-Instanz. Wenn ein Instanzname angegeben wird, wird das Benutzerabonnement zuerst für die Zielinstanz abgefragt, um den Hostnamen abzurufen. Wenn ein Hostname angegeben wird, wird die Abonnementabfrage übersprungen und der bereitgestellte Wert für nachfolgende Interaktionen verwendet.

--twin-id -t

Die digitale Zwillings-ID.

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--etag -e

Entitätstag-Wert. Der Befehl wird erfolgreich ausgeführt, wenn das etag mit dem aktuellen Etag für die Ressource übereinstimmt.

--resource-group -g

Ressourcengruppe der Digital Twins-Instanz. Sie können die Standardgruppe mit az configure --defaults group={name}konfigurieren.

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Ausgabeformat.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az dt twin delete-all

Löscht alle digitalen Zwillinge innerhalb einer Digital Twins-Instanz, einschließlich aller Beziehungen für diese Zwillinge.

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

Beispiele

Löschen Sie alle digitalen Zwillinge. Alle Beziehungen, die auf die Zwillinge verweisen, werden ebenfalls gelöscht.

az dt twin delete-all -n {instance_or_hostname}

Erforderliche Parameter

--dt-name --dtn -n

Name oder Hostname der Digital Twins-Instanz. Wenn ein Instanzname angegeben wird, wird das Benutzerabonnement zuerst für die Zielinstanz abgefragt, um den Hostnamen abzurufen. Wenn ein Hostname angegeben wird, wird die Abonnementabfrage übersprungen und der bereitgestellte Wert für nachfolgende Interaktionen verwendet.

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--resource-group -g

Ressourcengruppe der Digital Twins-Instanz. Sie können die Standardgruppe mit az configure --defaults group={name}konfigurieren.

--yes -y

Zur Bestätigung nicht auffordern.

Eigenschaft	Wert
Standardwert:	False

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Ausgabeformat.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az dt twin query

Abfragen der digitalen Zwillinge einer Instanz. Ermöglicht das Durchlaufen von Beziehungen und Filtern nach Eigenschaftswerten.

In vielen Zwillingsabfragen wird das $ Zeichen verwendet, um auf die $dtId Eigenschaft eines Zwillings zu verweisen. In bash-ähnlichen Shells oder powershell hat das $ Zeichen funktionale Bedeutung und muss als Teil der Abfrageeingabe escapet werden. Weitere Informationen finden Sie im Dokument zu den Digital Twins CLI-Konzepten 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]

Beispiele

Abfragen aller digitalen Zwillinge in der Zielinstanz und Projizieren aller Attribute. Auch Zeigen von Kosten in Abfrageeinheiten.

az dt twin query -n {instance_or_hostname} -q "select * from digitaltwins" --show-cost

Abfragen nach Modell und Projizieren aller Attribute.

az dt twin query -n {instance_or_hostname} -q "select * from digitaltwins T where IS_OF_MODEL(T, 'dtmi:com:example:Room;2')"

Abfrage, die "$dtId" mit bashkompatibler Syntax nutzt

az dt twin query -n {instance_or_hostname} --query-command "SELECT * FROM DigitalTwins T Where T.\$dtId = 'room0'"

Abfrage, die "$dtId" mit einer powershell-kompatiblen Syntax nutzt

az dt twin query -n {instance_or_hostname} --query-command "SELECT * FROM DigitalTwins T Where T.`$dtId = 'room0'"

Erforderliche Parameter

--dt-name --dtn -n

Name oder Hostname der Digital Twins-Instanz. Wenn ein Instanzname angegeben wird, wird das Benutzerabonnement zuerst für die Zielinstanz abgefragt, um den Hostnamen abzurufen. Wenn ein Hostname angegeben wird, wird die Abonnementabfrage übersprungen und der bereitgestellte Wert für nachfolgende Interaktionen verwendet.

--query-command -q

Auszuführende Benutzerabfrage.

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--cost --show-cost

Berechnet und zeigt die Abfragegebühr an.

Eigenschaft	Wert
Standardwert:	False
Zulässige Werte:	false, true

--resource-group -g

Ressourcengruppe der Digital Twins-Instanz. Sie können die Standardgruppe mit az configure --defaults group={name}konfigurieren.

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Ausgabeformat.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az dt twin show

Zeigen Sie die Details eines digitalen Zwillings an.

az dt twin show --dt-name --dtn
                --twin-id
                [--resource-group]

Beispiele

Zeigen Sie die Details eines digitalen Zwillings an.

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

Erforderliche Parameter

--dt-name --dtn -n

Name oder Hostname der Digital Twins-Instanz. Wenn ein Instanzname angegeben wird, wird das Benutzerabonnement zuerst für die Zielinstanz abgefragt, um den Hostnamen abzurufen. Wenn ein Hostname angegeben wird, wird die Abonnementabfrage übersprungen und der bereitgestellte Wert für nachfolgende Interaktionen verwendet.

--twin-id -t

Die digitale Zwillings-ID.

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--resource-group -g

Ressourcengruppe der Digital Twins-Instanz. Sie können die Standardgruppe mit az configure --defaults group={name}konfigurieren.

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Ausgabeformat.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False

az dt twin update

Aktualisieren Sie einen digitalen Zwilling einer Instanz über die JSON-Patchspezifikation.

Aktualisierungen von Eigenschaftswerten und $model Elementen können in derselben Anforderung auftreten. Vorgänge sind auf das Hinzufügen, Ersetzen und Entfernen beschränkt.

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

Beispiele

Aktualisieren Sie einen digitalen Zwilling über die JSON-Patchspezifikation.

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

Aktualisieren Sie einen digitalen Zwilling über die JSON-Patchspezifikation und die Verwendung von etag.

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

Aktualisieren Sie einen digitalen Zwilling über die JSON-Patchspezifikation.

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

Aktualisieren Sie einen digitalen Zwilling über die JSON-Patchspezifikation, die in einer Datei definiert ist.

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

Erforderliche Parameter

--dt-name --dtn -n

Name oder Hostname der Digital Twins-Instanz. Wenn ein Instanzname angegeben wird, wird das Benutzerabonnement zuerst für die Zielinstanz abgefragt, um den Hostnamen abzurufen. Wenn ein Hostname angegeben wird, wird die Abonnementabfrage übersprungen und der bereitgestellte Wert für nachfolgende Interaktionen verwendet.

--json-patch --patch

Eine vom JSON-Patch beschriebene Updatespezifikation. Aktualisierungen von Eigenschaftswerten und $model Elementen können in derselben Anforderung auftreten. Vorgänge sind auf das Hinzufügen, Ersetzen und Entfernen beschränkt. Geben Sie dateipfad oder inline JSON an.

--twin-id -t

Die digitale Zwillings-ID.

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--etag -e

Entitätstag-Wert. Der Befehl wird erfolgreich ausgeführt, wenn das etag mit dem aktuellen Etag für die Ressource übereinstimmt.

--resource-group -g

Ressourcengruppe der Digital Twins-Instanz. Sie können die Standardgruppe mit az configure --defaults group={name}konfigurieren.

Globale Parameter

--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft	Wert
Standardwert:	False

--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft	Wert
Standardwert:	False

--output -o

Ausgabeformat.

Eigenschaft	Wert
Standardwert:	json
Zulässige Werte:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft	Wert
Standardwert:	False