Condividi tramite

Set di comandi CLI di Azure Digital Twins

Oltre a gestire l'istanza di Gemelli digitali di Azure nel portale di Azure, Gemelli digitali di Azure include anche un set di comandi per l'interfaccia della riga di comando di Azure che è possibile usare per eseguire la maggior parte delle azioni principali con il servizio. Questo articolo illustra il set di comandi dell'interfaccia della riga di comando di Azure per Gemelli digitali di Azure, inclusi gli usi, come ottenerlo e i requisiti per usarlo.

Alcune delle azioni che è possibile eseguire usando il set di comandi includono:

  • Gestione di un'istanza di Gemelli digitali di Azure
  • Gestione dei modelli
  • Gestione di gemelli digitali
  • Gestione delle relazioni tra gemelli
  • Configurazione degli endpoint
  • Gestione delle route
  • Configurazione della sicurezza tramite il controllo degli accessi in base al ruolo di Azure

Il set di comandi è denominato az dte fa parte dell'estensione Azure IoT per l'interfaccia della riga di comando di Azure. È possibile visualizzare l'elenco completo dei comandi e il relativo utilizzo nella documentazione di riferimento per il set di comandi az iot: Riferimento ai comandi az dt.

Usi (distribuzione e convalida)

Oltre alla gestione generale dell'istanza, l'interfaccia della riga di comando è anche uno strumento utile per la distribuzione e la convalida.

  • I comandi del piano di controllo possono essere usati per rendere ripetibile o automatizzata la distribuzione di una nuova istanza.
  • I comandi del piano dati possono essere usati per controllare rapidamente i valori nell'istanza e verificare che le operazioni siano state completate come previsto.

Ottenere il set di comandi

I comandi di Gemelli digitali di Azure fanno parte dell'estensione Azure IoT per l'interfaccia della riga di comando di Azure (azure-iot), quindi seguire questa procedura per assicurarsi di avere l'estensione azure-iot più recente con i comandi az dt.

Requisiti della versione CLI

Se si usa l'interfaccia della riga di comando di Azure con PowerShell, la versione dell'interfaccia della riga di comando di Azure deve essere 2.3.1 o successiva come requisito del pacchetto di estensione.

Puoi controllare la versione della tua CLI di Azure con questo comando CLI:

az --version

Per istruzioni su come installare o aggiornare l'interfaccia della riga di comando di Azure a una versione più recente, vedere Come installare l'interfaccia della riga di comando di Azure.

Ottieni l'estensione

L'interfaccia della riga di comando di Azure richiede automaticamente di installare l'estensione al primo uso di un comando che lo richiede.

In caso contrario, è possibile usare il comando seguente per installare l'estensione manualmente in qualsiasi momento (o aggiornarla se risulta già disponibile una versione precedente). Il comando può essere eseguito in Azure Cloud Shell o in un'interfaccia della riga di comando di Azure locale.

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

Usare caratteri speciali in shell diverse

Alcuni comandi az dt usano caratteri speciali che devono essere probabilmente preceduti da caratteri di escape per l'analisi corretta in determinati ambienti della shell. Usare i suggerimenti in questa sezione per sapere quando eseguire l'escape di caratteri speciali nella shell preferita.

Bash

Usate questi suggerimenti sui caratteri speciali per gli ambienti Bash.

Interrogazioni

In molte query gemelle, il carattere $ viene usato per fare riferimento alla proprietà $dtId di un gemello. Quando si usa il comando az dt twin query per eseguire query nell'ambiente Bash di Cloud Shell, eseguire l'escape del carattere $ con una barra rovesciata (\).

Ecco un esempio di come eseguire una query per un gemello con un comando CLI nell'ambiente Bash di Cloud Shell:

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

PowerShell

Utilizza questi consigli sui caratteri speciali per gli ambienti PowerShell.

JSON inline

Alcuni comandi, ad esempio az dt twin create, consentono di immettere informazioni sul dispositivo gemello sotto forma di JSON inline. Quando si immette JSON inline nell'ambiente di PowerShell, eseguire l'escape dei caratteri di virgolette doppie (") all'interno del codice JSON con una barra rovesciata (\).

Ecco un esempio di creazione di un gemello con un comando dell'interfaccia della riga di comando 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}'

Suggerimento

Molti dei comandi che supportano JSON inline supportano anche l'input come percorso di file, che consente di evitare requisiti di testo specifici della shell.

Interrogazioni

In molte query gemelle, il carattere $ viene usato per fare riferimento alla proprietà $dtId di un gemello. Quando si usa il comando az dt twin query per eseguire query in un ambiente di PowerShell, eseguire l'escape del carattere $ con un carattere di apice inverso.

Ecco un esempio di esecuzione di queri per un gemello con un comando dell'interfaccia della riga di comando in PowerShell:

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

CMD di Windows

Usa questi consigli sui caratteri speciali per il CMD di Windows locale.

JSON inline

Alcuni comandi, ad esempio az dt twin create, consentono di immettere informazioni sul dispositivo gemello sotto forma di JSON inline. Quando si immette JSON inline in una finestra CMD di Windows locale, racchiudere il valore del parametro con virgolette doppie (") anziché virgolette singole ('), ed eseguire l'escape dei caratteri tra virgolette doppie all'interno del JSON con una barra rovesciata (\).

Ecco un esempio di creazione di un gemello con un comando CLI nel CMD Windows locale.

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

Suggerimento

Molti dei comandi che supportano JSON inline supportano anche l'input come percorso di file, che consente di evitare requisiti di testo specifici della shell.

Passaggi successivi

Esplora l'interfaccia della riga di comando e il set completo di comandi tramite la documentazione di riferimento.

  • Last updated on