Zestaw poleceń interfejsu wiersza polecenia usługi Azure Digital Twins

  • Artykuł

Oprócz zarządzania wystąpieniem usługi Azure Digital Twins w Azure Portal usługa Azure Digital Twins ma również zestaw poleceń dla interfejsu wiersza polecenia platformy Azure, którego można użyć do wykonywania większości głównych akcji w usłudze. W tym artykule opisano zestaw poleceń interfejsu wiersza polecenia platformy Azure dla usługi Azure Digital Twins, w tym jego zastosowania, sposób jego pobierania i wymagania dotyczące korzystania z niego.

Oto niektóre akcje, które można wykonać przy użyciu zestawu poleceń:

  • Zarządzanie wystąpieniem usługi Azure Digital Twins
  • Zarządzanie modelami
  • Zarządzanie cyfrowymi reprezentacjami bliźniaczymi
  • Zarządzanie relacjami bliźniaczych reprezentacji
  • Konfigurowanie punktów końcowych
  • Zarządzanie trasami
  • Konfigurowanie zabezpieczeń za pośrednictwem kontroli dostępu opartej na rolach platformy Azure (Azure RBAC)

Zestaw poleceń nosi nazwę az dti jest częścią rozszerzenia usługi Azure IoT dla interfejsu wiersza polecenia platformy Azure. Pełną listę poleceń i ich użycia można wyświetlić w dokumentacji referencyjnej az iot zestawu poleceń: az dt command reference.

Używa (wdrażanie i weryfikowanie)

Oprócz ogólnego zarządzania wystąpieniem interfejs wiersza polecenia jest również przydatnym narzędziem do wdrażania i walidacji.

  • Polecenia płaszczyzny sterowania mogą służyć do powtarzalnego lub zautomatyzowanego wdrażania nowego wystąpienia.
  • Polecenia płaszczyzny danych mogą służyć do szybkiego sprawdzania wartości w wystąpieniu i sprawdzania, czy operacje zostały wykonane zgodnie z oczekiwaniami.

Pobieranie zestawu poleceń

Polecenia usługi Azure Digital Twins są częścią rozszerzenia usługi Azure IoT dla interfejsu wiersza polecenia platformy Azure (azure-iot), więc wykonaj następujące kroki, aby upewnić się, że masz najnowsze azure-iot rozszerzenie za az dt pomocą poleceń.

Wymagania dotyczące wersji interfejsu wiersza polecenia

Jeśli używasz interfejsu wiersza polecenia platformy Azure z programem PowerShell, wersja interfejsu wiersza polecenia platformy Azure powinna mieć wersję 2.3.1 lub nowszą jako wymaganie pakietu rozszerzenia.

Możesz sprawdzić wersję interfejsu wiersza polecenia platformy Azure za pomocą tego polecenia interfejsu wiersza polecenia:

az --version

Aby uzyskać instrukcje dotyczące sposobu instalowania lub aktualizowania interfejsu wiersza polecenia platformy Azure do nowszej wersji, zobacz Instalowanie interfejsu wiersza polecenia platformy Azure.

Pobieranie rozszerzenia

Interfejs wiersza polecenia platformy Azure automatycznie wyświetli monit o zainstalowanie rozszerzenia przy pierwszym użyciu polecenia, które go wymaga.

W przeciwnym razie możesz użyć następującego polecenia, aby zainstalować rozszerzenie samodzielnie w dowolnym momencie (lub zaktualizować je, jeśli okaże się, że masz już starszą wersję). Polecenie można uruchomić w usłudze Azure Cloud Shell lub lokalnym interfejsie wiersza polecenia platformy Azure.

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

Używanie znaków specjalnych w różnych powłokach

Niektóre az dt polecenia używają znaków specjalnych, które mogą wymagać ucieczki w celu prawidłowego analizowania w niektórych środowiskach powłoki. Skorzystaj z porad w tej sekcji, aby dowiedzieć się, kiedy to zrobić w wybranej powłoce.

Bash

Użyj tych specjalnych wskazówek dotyczących znaków dla środowisk powłoki Bash.

Zapytania

W wielu zapytaniach $ bliźniaczych znak jest używany do odwoływanie się $dtId do właściwości bliźniaczej reprezentacji. W przypadku używania polecenia az dt twin query do wykonywania zapytań w środowisku Cloud Shell powłoki Bash należy użyć znaku z $ ukośnikiem odwrotnym (\).

Oto przykład wykonywania zapytań dotyczących bliźniaczej reprezentacji za pomocą polecenia interfejsu wiersza polecenia w środowisku powłoki Bash Cloud Shell:

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

PowerShell

Użyj tych specjalnych wskazówek dotyczących znaków dla środowisk programu PowerShell.

Wbudowany kod JSON

Niektóre polecenia, takie jak az dt twin create, umożliwiają wprowadzanie informacji o bliźniaczej reprezentacji w postaci wbudowanego kodu JSON. Podczas wprowadzania śródliniowego kodu JSON w środowisku programu PowerShell znaki ucieczki podwójnego cudzysłowu (") wewnątrz kodu JSON z ukośnikiem odwrotnym (\).

Oto przykład tworzenia bliźniaczej reprezentacji za pomocą polecenia interfejsu wiersza polecenia w programie PowerShell:

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

Porada

Wiele poleceń obsługujących wbudowany kod JSON obsługuje również dane wejściowe jako ścieżkę pliku, co może pomóc uniknąć wymagań dotyczących tekstu specyficznego dla powłoki.

Zapytania

W wielu zapytaniach $ bliźniaczych znak jest używany do odwoływanie się $dtId do właściwości bliźniaczej reprezentacji. W przypadku używania polecenia az dt twin query do wykonywania zapytań w środowisku programu PowerShell należy użyć znaku ucieczki $ z znakiem backtick.

Oto przykład wykonywania zapytań dotyczących bliźniaczej reprezentacji za pomocą polecenia interfejsu wiersza polecenia w programie PowerShell:

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

Windows CMD

Użyj tych specjalnych wskazówek dotyczących znaków dla lokalnego cmD systemu Windows.

Wbudowany kod JSON

Niektóre polecenia, takie jak az dt twin create, umożliwiają wprowadzanie informacji o bliźniaczej reprezentacji w postaci wbudowanego kodu JSON. W przypadku wprowadzania śródliniowego kodu JSON w lokalnym oknie CMD systemu Windows należy ująć wartość parametru za pomocą cudzysłowów (") zamiast cudzysłowów pojedynczych (') oraz znaki podwójnego cudzysłowu wewnątrz kodu JSON z ukośnikiem odwrotnym (\).

Oto przykład tworzenia bliźniaczej reprezentacji za pomocą polecenia interfejsu wiersza polecenia w lokalnym cmD systemu Windows:

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

Porada

Wiele poleceń obsługujących wbudowany kod JSON obsługuje również dane wejściowe jako ścieżkę pliku, co może pomóc uniknąć wymagań dotyczących tekstu specyficznego dla powłoki.

Następne kroki

Zapoznaj się z interfejsem wiersza polecenia i pełnym zestawem poleceń za pomocą dokumentacji referencyjnej: