Zestaw poleceń CLI usługi Azure Digital Twins

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

Niektóre akcje, które można wykonać za pomocą zestawu poleceń, obejmują:

• Zarządzanie wystąpieniem usługi Azure Digital Twins
• Zarządzanie modelami
• Zarządzanie cyfrowymi bliźniakami
• Zarządzanie relacjami bliźniaczymi
• 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 dt i jest częścią rozszerzenia Azure IoT dla Azure CLI. Pełną listę poleceń i ich użycia można wyświetlić w dokumentacji referencyjnej az iot zestawu poleceń: az dt command reference.

Użycie (wdrażanie i weryfikowanie)

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

• Polecenia płaszczyzny sterowania mogą służyć do powtarzania lub automatycznego 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 Azure Digital Twins są częścią rozszerzenia Azure IoT dla Azure CLI (azure-iot). Wykonaj poniższe kroki, aby upewnić się, że masz zainstalowane najnowsze azure-iot rozszerzenie zawierające az dt polecenia.

Wymagania dotyczące wersji CLI

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

Możesz sprawdzić wersję Azure CLI za pomocą tego polecenia CLI:

az --version

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

Pobieranie rozszerzenia

Interfejs wiersza polecenia platformy Azure automatycznie wyświetla 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ą być konieczne w celu prawidłowego analizowania w niektórych środowiskach powłoki. Skorzystaj z porad w tej sekcji, aby dowiedzieć się, kiedy należy unikać znaków specjalnych w wybranej powłoce.

Bash

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

Kwerendy

W wielu zapytaniach dotyczących bliźniaków, znak $ jest używany do odwoływania się do właściwości $dtId bliźniaka. W przypadku używania polecenia az dt twin query w środowisku powłoki Bash usługi Cloud Shell, należy poprzedzić znak $ ukośnikiem odwrotnym (\).

Oto przykład wykonywania zapytania dotyczącego bliźniaka za pomocą polecenia CLI w środowisku Bash Cloud Shell:

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

PowerShell

Skorzystaj z 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 kodu JSON bezpośrednio w środowisku PowerShell, znaki podwójnego cudzysłowu (") wewnątrz JSON-u należy poprzedzać ukośnikiem odwrotnym (\).

Oto przykład tworzenia bliźniaka za pomocą polecenia CLI w PowerShell:

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

Kwerendy

W wielu zapytaniach dotyczących bliźniaków, znak $ jest używany do odwoływania się do właściwości $dtId bliźniaka. W przypadku używania polecenia az dt twin query do wykonywania zapytań w środowisku programu PowerShell, znak $ należy poprzedzić znakiem backtick.

Oto przykład wykonywania zapytania dotyczącego bliźniaka za pomocą polecenia CLI 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. Podczas wprowadzania wbudowanego kodu JSON w lokalnym oknie CMD systemu Windows umieść wartość parametru w podwójnych cudzysłowach (") zamiast pojedynczych cudzysłowów (') i unikaj znaków podwójnego cudzysłowu wewnątrz JSON przez ukośnik odwrotny (\).

Oto przykład tworzenia bliźniaka za pomocą polecenia CLI 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}"

Następne kroki

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

• az dt dokumentacja poleceń