Azure Digital Twins CLI-kommandouppsättning

  • Artikel

Förutom att hantera din Azure Digital Twins-instans i Azure Portal har Azure Digital Twins även en kommandouppsättning för Azure CLI som du kan använda för att utföra de flesta större åtgärder med tjänsten. Den här artikeln beskriver Azure CLI-kommandouppsättningen för Azure Digital-tvillingar, inklusive dess användning, hur du hämtar den och kraven för att använda den.

Några av de åtgärder som du kan utföra med hjälp av kommandouppsättningen är:

  • Hantera en Azure Digital Twins-instans
  • Hantera modeller
  • Hantera digitala tvillingar
  • Hantera tvillingrelationer
  • Konfigurera slutpunkter
  • Hantera vägar
  • Konfigurera säkerhet via rollbaserad åtkomstkontroll i Azure (Azure RBAC)

Kommandouppsättningen heter az dt, och är en del av Azure IoT-tillägget för Azure CLI. Du kan visa den fullständiga listan över kommandon och deras användning som en del av referensdokumentationen för kommandouppsättningen az iot : az dt-kommandoreferens.

Använder (distribuera och verifiera)

Förutom att hantera din instans i allmänhet är CLI också ett användbart verktyg för distribution och validering.

  • Kontrollplanets kommandon kan användas för att göra distributionen av en ny instans repeterbar eller automatiserad.
  • Dataplanets kommandon kan användas för att snabbt kontrollera värden i din instans och verifiera att åtgärderna slutfördes som förväntat.

Hämta kommandouppsättningen

Azure Digital Twins-kommandona är en del av Azure IoT-tillägget för Azure CLI (azure-iot) så följ dessa steg för att se till att du har det senaste azure-iot tillägget med az dt kommandona.

KRAV för CLI-version

Om du använder Azure CLI med PowerShell bör din Azure CLI-version vara 2.3.1 eller senare som ett krav för tilläggspaketet.

Du kan kontrollera versionen av Azure CLI med det här CLI-kommandot:

az --version

Anvisningar om hur du installerar eller uppdaterar Azure CLI till en nyare version finns i Installera Azure CLI.

Hämta tillägget

Azure CLI uppmanar dig automatiskt att installera tillägget vid den första användningen av ett kommando som kräver det.

Annars kan du använda följande kommando för att installera tillägget själv när som helst (eller uppdatera det om det visar sig att du redan har en äldre version). Kommandot kan köras antingen i Azure Cloud Shell eller i en lokal Azure CLI.

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

Använda specialtecken i olika gränssnitt

Vissa az dt kommandon använder specialtecken som kan behöva undantagas för korrekt parsning i vissa gränssnittsmiljöer. Använd tipsen i det här avsnittet för att hjälpa dig att veta när du ska göra detta i ditt gränssnitt.

Bash

Använd de här specialteckentipsen för Bash-miljöer.

Frågor

I många tvillingfrågor $ används tecknet för att referera $dtId till egenskapen för en tvilling. När du använder kommandot az dt twin query för att fråga i Cloud Shell Bash-miljön kan du undvika $ tecknet med ett omvänt snedstreck (\).

Här är ett exempel på frågor för en tvilling med ett CLI-kommando i Cloud Shell Bash-miljön:

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

PowerShell

Använd de här specialteckentipsen för PowerShell-miljöer.

Infogad JSON

Med vissa kommandon, till exempel az dt twin create, kan du ange tvillinginformation i form av infogad JSON. När du anger infogad JSON i PowerShell-miljön kan du undvika dubbla citattecken (") i JSON med ett omvänt snedstreck (\).

Här är ett exempel på hur du skapar en tvilling med ett CLI-kommando i PowerShell:

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

Tips

Många av kommandona som stöder infogad JSON stöder också indata som en filsökväg, vilket kan hjälpa dig att undvika gränssnittsspecifika textkrav.

Frågor

I många tvillingfrågor $ används tecknet för att referera $dtId till egenskapen för en tvilling. När du använder kommandot az dt twin query för att fråga i en PowerShell-miljö kan du undvika $ tecknet med ett backtick-tecken.

Här är ett exempel på frågor för en tvilling med ett CLI-kommando i PowerShell:

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

Windows CMD

Använd de här specialteckentipsen för den lokala Windows-CMD:en.

Infogad JSON

Med vissa kommandon, till exempel az dt twin create, kan du ange tvillinginformation i form av infogad JSON. När du anger infogad JSON i ett lokalt Windows CMD-fönster omsluter du parametervärdet med dubbla citattecken (") i stället för enkla citattecken (') och undfly dubbla citattecken i JSON med ett omvänt snedstreck (\).

Här är ett exempel på hur du skapar en tvilling med ett CLI-kommando i den lokala Windows-CMD:en:

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

Tips

Många av kommandona som stöder infogad JSON stöder också indata som en filsökväg, vilket kan hjälpa dig att undvika gränssnittsspecifika textkrav.

Nästa steg

Utforska CLI och dess fullständiga uppsättning kommandon via referensdokumenten: