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 durchführen können. In diesem Artikel wird der Azure CLI-Befehlssatz für Azure Digital Twins im Hinblick auf seine Verwendungsmöglichkeiten beschrieben. Außerdem wird erläutert, wie Sie die CLI erhalten und welche Anforderungen für ihre Verwendung bestehen.
Mit dem Befehlssatz können Sie u. a. folgende Aktionen durchführen:
- Verwalten einer Azure Digital Twins-Instanz
- Verwalten von Modellen
- Verwalten von digitalen Zwillingen
- Verwalten von Zwillingsbeziehungen
- Konfigurieren von Endpunkten
- Verwalten von Routen
- Konfigurieren der Sicherheit über die rollenbasierte Zugriffssteuerung in Azure (Role-Based Access Control, 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.
Verwendungen (bereitstellen und validieren)
Außer 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). Befolgen Sie also diese Schritte, 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 die Anforderung des Erweiterungspakets sein.
Mit diesem CLI-Befehl können Sie die Version Ihrer Azure CLI überprüfen:
az --version
Anweisungen zum Installieren oder Aktualisieren der Azure CLI auf eine neuere Version finden Sie unter Installieren der Azure CLI.
Erhalten der Erweiterung
Die Azure CLI fordert Sie automatisch zur Installation der Erweiterung auf, wenn Sie erstmals einen Befehl verwenden, der diese benötigt.
Alternativ können Sie jederzeit den folgenden Befehl verwenden, um die Erweiterung selbst zu installieren (oder zu aktualisieren, wenn Sie bereits über eine ältere Version verfügen). Der Befehl kann entweder in Azure Cloud Shell oder 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 dies in der Shell Ihrer Wahl tun sollten.
Bash
Verwenden Sie diese Tipps für Sonderzeichen für Bash-Umgebungen.
Abfragen
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 die Eingabe von Zwillingsinformationen in Form von Inline-JSON. 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}'
Tipp
Viele der Befehle, die JSON-Inlinecode unterstützen, unterstützen auch Dateipfade als Eingaben, mit denen Sie shellspezifische Textanforderungen vermeiden können.
Abfragen
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 Tipps für Sonderzeichen für die lokale Windows-EIngabeaufforderung.
Inline JSON
Einige Befehle, z. B. az dt twin create, ermöglichen die Eingabe von Zwillingsinformationen in Form von Inline-JSON. 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-Eingabeaufforderung:
az dt twin create --dt-name <instance-hostname-or-name> --dtmi "dtmi:contosocom:DigitalTwins:Thermostat;1" --twin-id thermostat67 --properties "{\"Temperature\": 0.0}"
Tipp
Viele der Befehle, die JSON-Inlinecode unterstützen, unterstützen auch Dateipfade als Eingaben, mit denen Sie shellspezifische Textanforderungen vermeiden können.
Nächste Schritte
Machen Sie sich anhand der Referenzdokumentation mit der Befehlszeilenschnittstelle und ihrem vollständigen Befehlssatz vertraut: