Azure Digital Twins CLI-opdrachtenset

  • Artikel

Naast het beheren van uw Azure Digital Twins-exemplaar in de Azure Portal, heeft Azure Digital Twins ook een opdrachtenset voor de Azure CLI die u kunt gebruiken om de meeste belangrijke acties met de service uit te voeren. In dit artikel wordt de Azure CLI-opdrachtenset voor Azure Digital Twins beschreven, inclusief het gebruik ervan, hoe u deze kunt verkrijgen en de vereisten voor het gebruik ervan.

Enkele van de acties die u kunt uitvoeren met behulp van de opdrachtenset zijn:

  • Een Azure Digital Twins-exemplaar beheren
  • Modellen beheren
  • Digitale dubbels beheren
  • Dubbelrelaties beheren
  • Eindpunten configureren
  • Routes beheren
  • Beveiliging configureren via op rollen gebaseerd toegangsbeheer van Azure (Azure RBAC)

De opdrachtenset wordt genoemd az dten maakt deel uit van de Azure IoT-extensie voor Azure CLI. U kunt de volledige lijst met opdrachten en hun gebruik bekijken als onderdeel van de referentiedocumentatie voor de az iot opdrachtenset: az dt command reference.

Gebruikt (implementeren en valideren)

Naast het algemeen beheren van uw exemplaar, is de CLI ook een handig hulpprogramma voor implementatie en validatie.

  • De besturingsvlakopdrachten kunnen worden gebruikt om de implementatie van een nieuw exemplaar herhaalbaar of geautomatiseerd te maken.
  • De gegevensvlakopdrachten kunnen worden gebruikt om snel waarden in uw exemplaar te controleren en te controleren of bewerkingen zijn voltooid zoals verwacht.

De opdrachtenset ophalen

De Azure Digital Twins-opdrachten maken deel uit van de Azure IoT-extensie voor Azure CLI (azure-iot), dus volg deze stappen om ervoor te zorgen dat u de meest recente azure-iot extensie met de az dt opdrachten hebt.

VEREISTEN VOOR CLI-versie

Als u de Azure CLI met PowerShell gebruikt, moet uw Azure CLI-versie 2.3.1 of hoger zijn als vereiste voor het uitbreidingspakket.

U kunt de versie van uw Azure CLI controleren met deze CLI-opdracht:

az --version

Zie De Azure CLI installeren voor instructies over het installeren of bijwerken van de Azure CLI naar een nieuwere versie.

De extensie ophalen

De Azure CLI vraagt u automatisch om de extensie te installeren bij het eerste gebruik van een opdracht waarvoor deze is vereist.

Anders kunt u de volgende opdracht op elk gewenst moment gebruiken om de extensie zelf te installeren (of deze bij te werken als blijkt dat u al een oudere versie hebt). De opdracht kan worden uitgevoerd in de Azure Cloud Shell of in een lokale Azure CLI.

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

Speciale tekens gebruiken in verschillende shells

Sommige az dt opdrachten maken gebruik van speciale tekens die mogelijk moeten worden geparseerd voor de juiste parsering in bepaalde shell-omgevingen. Gebruik de tips in deze sectie om te weten wanneer u dit moet doen in de shell van uw keuze.

Bash

Gebruik deze speciale tekentips voor Bash-omgevingen.

Query's

In veel dubbelquery's wordt het $ teken gebruikt om te verwijzen naar de $dtId eigenschap van een tweeling. Wanneer u de opdracht az dt twin query gebruikt om een query uit te voeren in de Cloud Shell Bash-omgeving, escapet u het $ teken met een backslash (\).

Hier volgt een voorbeeld van het uitvoeren van query's op een dubbel met een CLI-opdracht in de Cloud Shell Bash-omgeving:

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

PowerShell

Gebruik deze speciale tekentips voor PowerShell-omgevingen.

Inline JSON

Met sommige opdrachten, zoals az dt twin create, kunt u dubbelgegevens invoeren in de vorm van inline-JSON. Wanneer u inline JSON invoert in de PowerShell-omgeving, moet u dubbele aanhalingstekens (") in de JSON met een backslash () gebruiken.\

Hier volgt een voorbeeld van het maken van een dubbel met een CLI-opdracht 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}'

Tip

Veel van de opdrachten die ondersteuning bieden voor inline JSON ondersteunen ook invoer als bestandspad, waardoor u shell-specifieke tekstvereisten kunt voorkomen.

Query's

In veel dubbelquery's wordt het $ teken gebruikt om te verwijzen naar de $dtId eigenschap van een tweeling. Wanneer u de opdracht az dt twin query gebruikt om een query uit te voeren in een PowerShell-omgeving, moet u het $ teken met een backtick-teken gebruiken.

Hier volgt een voorbeeld van het uitvoeren van query's op een dubbel met een CLI-opdracht in PowerShell:

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

Windows CMD

Gebruik deze speciale tekentips voor de lokale Windows-CMD.

Inline JSON

Met sommige opdrachten, zoals az dt twin create, kunt u dubbelgegevens invoeren in de vorm van inline-JSON. Wanneer u inline JSON invoert in een lokaal Windows CMD-venster, plaatst u de parameterwaarde tussen dubbele aanhalingstekens (") in plaats van enkele aanhalingstekens (') en escape-tekens voor dubbele aanhalingstekens in de JSON met een backslash (\).

Hier volgt een voorbeeld van het maken van een dubbel met een CLI-opdracht in de lokale 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}"

Tip

Veel van de opdrachten die ondersteuning bieden voor inline JSON ondersteunen ook invoer als bestandspad, waardoor u shell-specifieke tekstvereisten kunt voorkomen.

Volgende stappen

Verken de CLI en de volledige set opdrachten via de referentiedocumenten: