Befehlssatz der Azure Digital Twins-Befehlszeilenschnittstelle

Neben der Verwaltung Ihrer Azure Digital Twins-Instanz im Azure-Portal verfügt Azure Digital Twins auch über einen Befehlssatz für die Azure CLI , mit dem Sie die meisten wichtigen Aktionen mit dem Dienst ausführen können. In diesem Artikel wird die Azure CLI-Befehlszeilenschnittstelle für Azure Digital Twins behandelt, einschließlich ihrer Verwendung, wie man sie erhält, und der Anforderungen für ihre Nutzung.

Einige der Aktionen, die Sie mit dem Befehlssatz ausführen können, umfassen:

• Verwalten einer Azure Digital Twins-Instanz
• Verwalten von Modellen
• Verwalten digitaler Zwillinge
• Zwillingsbeziehungen verwalten
• Konfigurieren von Endpunkten
• Verwalten von Routen
• Konfigurieren der Sicherheit über die rollenbasierte Azure-Zugriffssteuerung (Azure RBAC)

Der Befehlssatz heißt az dt und ist Teil der Azure IoT-Erweiterung für Azure CLI. Die vollständige Liste der Befehle und deren Verwendung finden Sie in der Referenzdokumentation für den az iot-Befehlssatz: az dt-Befehlsreferenz.

Verwendung (Bereitstellen und Überprüfen)

Abgesehen von der allgemeinen Verwaltung Ihrer Instanz ist die CLI auch ein nützliches Tool für die Bereitstellung und Validierung.

• Mithilfe der Befehle auf Steuerungsebene kann die Bereitstellung einer neuen Instanz wiederholbar oder automatisiert werden.
• Mit den Befehlen auf Datenebene können Sie schnell Werte in Ihrer Instanz und den erwartungsgemäßen Abschluss von Vorgängen überprüfen.

Abrufen des Befehlssatzes

Die Azure Digital Twins-Befehle sind Teil der Azure IoT-Erweiterung für Azure CLI (azure-iot). Führen Sie daher die folgenden Schritte aus, um sicherzustellen, dass Sie über die neueste azure-iot Erweiterung mit den az dt Befehlen verfügen.

CLI-Versionsanforderungen

Wenn Sie die Azure CLI mit PowerShell verwenden, sollte Ihre Azure CLI-Version 2.3.1 oder höher als Anforderung des Erweiterungspakets sein.

Sie können die Version Ihrer Azure CLI mit diesem CLI-Befehl überprüfen:

az --version

Anweisungen zum Installieren oder Aktualisieren der Azure CLI auf eine neuere Version finden Sie unter Installieren der Azure CLI.

Erweiterung herunterladen

Die Azure CLI fordert Sie automatisch auf, die Erweiterung bei der ersten Verwendung eines Befehls zu installieren, für den sie erforderlich ist.

Andernfalls können Sie den folgenden Befehl verwenden, um die Erweiterung jederzeit selbst zu installieren (oder zu aktualisieren, wenn sich herausstellt, dass Sie bereits über eine ältere Version verfügen). Der Befehl kann entweder in der Azure Cloud Shell oder in einer lokalen Azure CLI ausgeführt werden.

az extension add --upgrade --name azure-iot

Verwenden von Sonderzeichen in verschiedenen Shells

Einige az dt-Befehle verwenden Sonderzeichen, die für die richtige Analyse in bestimmten Shellumgebungen mit Escapezeichen versehen werden müssen. Verwenden Sie die Tipps in diesem Abschnitt, um zu erfahren, wann Sie Sonderzeichen in der Shell Ihrer Wahl escapen sollten.

Schlagen

Verwenden Sie diese Sonderzeichentipps für Bash-Umgebungen.

Fragen

In vielen Zwillingsabfragen wird das $ Zeichen verwendet, um auf die $dtId Eigenschaft eines Zwillings zu verweisen. Wenn Sie den Befehl az dt twin query zum Abfragen in der Cloud Shell Bash-Umgebung verwenden, versehen Sie das $-Zeichen mit einem umgekehrten Schrägstrich (\).

Hier ist ein Beispiel für das Abfragen eines Zwillings mit einem CLI-Befehl in der Cloud Shell Bash-Umgebung:

az dt twin query --dt-name <instance-hostname-or-name> --query-command "SELECT * FROM DigitalTwins T Where T.\$dtId = 'room0'"

PowerShell

Verwenden Sie diese Tipps für Sonderzeichen für PowerShell-Umgebungen.

Inline-JSON

Einige Befehle, z. B. az dt twin create, ermöglichen es Ihnen, Zwillingsinformationen in Form von Inline-JSON einzugeben. Wenn Sie Inline-JSON in der PowerShell-Umgebung eingeben, verwenden Sie doppelte Anführungszeichen (") innerhalb des JSON-Codes und einen umgekehrten Schrägstrich (\).

Hier ist ein Beispiel für das Erstellen eines Zwillings mit einem CLI-Befehl in PowerShell:

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

Fragen

In vielen Zwillingsabfragen wird das $ Zeichen verwendet, um auf die $dtId Eigenschaft eines Zwillings zu verweisen. Wenn Sie den Befehl az dt twin query zum Abfragen in einer PowerShell-Umgebung verwenden, versehen Sie das $-Zeichen mit einem Graviszeichen.

Hier ist ein Beispiel für das Erstellen eines Zwillings mit einem CLI-Befehl in PowerShell:

az dt twin query --dt-name <instance-hostname-or-name> --query-command "SELECT * FROM DigitalTwins T Where T.`$dtId = 'room0'"

Windows-Eingabeaufforderung

Verwenden Sie diese Sonderzeichentipps für die lokale Windows-CMD.

Inline-JSON

Einige Befehle, z. B. az dt twin create, ermöglichen es Ihnen, Zwillingsinformationen in Form von Inline-JSON einzugeben. Wenn Sie JSON inline in ein lokales Fenster der Windows-Eingabeaufforderung eingeben, schließen Sie den Parameterwert in doppelte Anführungszeichen (") anstelle von einfachen Anführungszeichen (') ein, und verwenden Sie doppelte Anführungszeichen innerhalb des JSON-Codes sowie einen umgekehrten Schrägstrich (\).

Hier ist ein Beispiel für das Erstellen eines Zwillings mit einem CLI-Befehl in der lokalen Windows-CMD:

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

Nächste Schritte

Erkunden Sie die CLI und den vollständigen Satz von Befehlen über die Referenzdokumente:

• az dt-Befehlsreferenz