Share via

Azure Sphere CLI

  • Articolo

Azure Sphere SDK fornisce l'interfaccia della riga di comando (CLI) azure sphere disponibile in PowerShell, prompt dei comandi di Windows o shell dei comandi di Linux. Azure Sphere CLI è un set di comandi usati per creare e gestire le risorse di Azure Sphere.

Azure Sphere CLI è installato insieme all'cli classico di Azure Sphere inWindows e Linux, quindi hai accesso a entrambe le interfacce. Per usare Azure Sphere CLI:

  • In Windows usare PowerShell o un prompt dei comandi di Windows standard.
  • Su Linux, usa qualsiasi shell dei comandi.

Eseguire azure sphere CLI

Ora puoi eseguire l'cli di Azure Sphere con il azsphere comando dal prompt dei comandi di Windows o da PowerShell. È consigliabile PowerShell perché offre la funzionalità di completamento delle schede , che non è disponibile nel prompt dei comandi di Windows.

Su Linux, puoi eseguire Azure Sphere CLI da qualsiasi interfaccia della riga di comando (CLI). Durante l'installazione, viene visualizzata una notifica che consente di impostare Azure Sphere CLI o Azure Sphere cli classico come versione cli predefinita preferita. Digitare Yes per scegliere Azure Sphere CLI o digitare No per usare la cli classica di Azure Sphere. Per altre informazioni, vedere Installare Azure Sphere SDK .

Nota

La forma breve per i comandi non è supportata nella versione Azure Sphere CLI. È consigliabile usare la funzionalità di completamento delle schede per visualizzare l'elenco dei comandi disponibili. In Windows, il collegamento al prompt dei comandi per sviluppatori azure sphere classico ritirato può essere usato solo con la cli classica di Azure Sphere.

Funzionalità di input CLI

In questa sezione vengono descritte le funzionalità di input disponibili nell'area cli di Azure Sphere:

Comandi

Tutti i comandi nell'interfaccia CLI di Azure Sphere iniziano con azsphere. Per esempio:

azsphere login
 ---------------------
 Name
 =====================
 bob@contoso.com
 ---------------------

Trovare i comandi

I comandi nell'interfaccia cli sono organizzati in gruppi. Puoi visualizzare le informazioni complete della Guida per i comandi e i parametri disponibili utilizzando --help la cli classica di Azure Sphere e la cli di Azure Sphere.

È possibile ottenere un elenco completo dei comandi eseguendo il comando azsphere --help.

Per esempio:

  • Per l'uso cli classico di Azure Sphere oppure azsphere --helpazsphere -?
  • Per l'uso di Azure Sphere CLI, azsphere --help oppure azsphere -h

Parametri

Il nome del parametro è preceduto da un segno meno doppio (--), che indica che la parola che segue il segno meno è un parametro. Usare uno spazio per separare il nome e il valore del parametro. I parametri che sono parole composte sono separati da un trattino (-) nella nuova CLI.

Ad esempio: --component-id o --application-update

Identificazione semplificata degli oggetti

Nell'azure sphere CLI viene usato un singolo parametro per identificare ogni tipo di oggetto. Ciò significa che è possibile specificare l'ID, il nome, l'INDIRIZZO IP o la posizione applicabile a tale parametro.

Ad esempio, è possibile usare l'ID tenant o il nome tenant nel comando seguente:

azsphere device list --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb

O

azsphere device list --tenant MyTenant

Questa operazione è stata implementata per i --deviceparametri , --tenant, --product, e --device-group .

Per esempio:

azsphere device-group update --device-group CoffeeMaker/Development
   ------------------------------------ ------------------------------------ ---------- ------------------------------------ --------- ---------------------- ---------------------------------------------------------- -------------------------
   Id                                   TenantId                             OsFeedType ProductId                            Name      Description            UpdatePolicy                                               AllowCrashDumpsCollection
   ===============================================================================================================================================================================================================================================
   7f860cc1-4949-4000-a541-9a988ba4c3cd 143adbc9-1bf0-4be2-84a2-084a331d81cb Retail     6f52bead-700d-4289-bdc2-2f11f774270e Marketing Marketing device group Accept all updates from the Azure Sphere Security Service. False
   ------------------------------------ ------------------------------------ ---------- ------------------------------------ --------- ---------------------- ---------------------------------------------------------- -------------------------

Più valori

Alcuni comandi consentono più valori per un singolo parametro, nel qual caso è possibile specificare un parametro con ogni valore o un singolo parametro seguito da un elenco di valori separati da spazi. Ad esempio, i due comandi seguenti sono equivalenti:

azsphere image-package pack-application --package-directory myDirectory --destination myImagePackage --executables filepath-1 --executables filepath-2

azsphere image-package pack-application --package-directory myDirectory --destination myImagePackage --executables filepath-1 filepath-2

Parametri obbligatori e facoltativi

Quando si esegue azsphere <command> <sub-command> --help un elenco di parametri applicabili a tale comando viene visualizzato. L'impostazione [Obbligatorio] indica se il parametro è obbligatorio per eseguire correttamente il comando. Tutti gli altri parametri sono facoltativi.

Se il parametro richiesto non è presente, viene richiesto di immettere un valore per il parametro.

Per esempio:

azsphere role delete --help

Command
    azsphere role delete : Deletes a role from a user in the current Azure Sphere tenant.

Arguments
    --role -r [Required] : Role to be deleted. Values from: azsphere role show-types.
    --user -u [Required] : The user from whom the role is being deleted. Specify user e-mail.
                           Values from: azsphere role list.

Tenant Selection Arguments
    --tenant -t          : The tenant to perform this operation in. Overrides the default selected
                           tenant. Specify tenant ID or tenant name. Values from: azsphere tenant
                           list.

Global Arguments
    --debug              : Increase logging verbosity to show all debug logs.
    --help -h            : Show this help message and exit.
    --only-show-errors   : Only show errors, suppressing warnings.
    --output -o          : Output format. Allowed values: json, jsonc, none, table, tsv, yaml,
                           yamlc. Default: table.
    --query              : JMESPath query string. See http://jmespath.org/ for more information and
                           examples.
    --verbose            : Increase logging verbosity. Use --debug for full debug logs.

Percorsi di input e output

In Azure Sphere CLI, i nomi dei parametri usati per specificare un percorso e il nome file sono stati aggiornati in modo che siano rilevanti per il contesto del comando.

Per esempio:

azsphere image-package pack-application --package-directory C:\AppSamples\LocalSamples\HelloWorld\HelloWorld_HighLevelApp\out\ARM-Debug\approotHelloWorld_HighLevelApp --destination myimage.imagepackage

Qui, --package-directory specifica la directory di input per il pacchetto e --destination il parametro specifica il percorso e il nome file per il pacchetto di immagini risultante.

Completamento tabulazione

Il completamento della tabulazione fornisce assistenza per il completamento automatico di una voce di comando nell'interfaccia della riga di comando. Il completamento della scheda CLI di Azure Sphere è supportato per gruppi, comandi, nomi di parametri e valori di parametro. Digitare alcuni caratteri di un comando e quindi premere TAB per selezionare il testo di completamento desiderato. Se più elementi iniziano con il testo inizialmente digitato, continuare a premere TAB finché non viene visualizzato l'elemento desiderato.

In Windows PowerShell 7.1 offre la funzionalità di completamento delle schede, che non è disponibile nel prompt dei comandi di Windows.

Per abilitare il completamento delle schede in Windows PowerShell, eseguire Import-Module -name AzsphereCli. Questo comando consente il completamento delle schede solo per la sessione. È possibile aggiungere uno script al profilo di PowerShell per personalizzare l'ambiente e abilitare il completamento delle schede per ogni sessione di PowerShell avviata.

Su Linux, Azure Sphere CLI supporta la funzionalità di completamento delle schede per i comandi sotto la shell Bash.

Inoltre, il completamento automatico consente di individuare i comandi, i parametri e i valori dei parametri disponibili per l'uso. Questa funzionalità è disponibile usando CTRL+BARRA SPAZIATRICE in Windows PowerShell o premere TAB due volte nella shell Linux Bash.

Ad esempio, digitare il comando di aggiornamento del prodotto azsfera e usare il completamento automatico per visualizzare un elenco di parametri disponibili.

Parametri di completamento automatico di PowerShell

Analogamente, l'aggiornamento del prodotto di tipo azsfera, ovvero il prodotto e il completamento automatico, consente di visualizzare un elenco dei prodotti disponibili nel tenant.

Prodotti di completamento automatico di PowerShell

Modalità interattiva (anteprima)

Importante

Questa funzionalità è in anteprima. Potrebbe essere modificato o rimosso in una versione futura.

La nuova CLI offre una modalità interattiva che visualizza automaticamente le informazioni della Guida e semplifica la selezione di comandi, sotto comandi, valori di parametri e parametri. Entra nella modalità interattiva con il comando interattivo azsfera . Il prompt dei comandi cambia per azsphere>> indicare che ora sono in esecuzione comandi nella shell interattiva. Per altre informazioni, vedere modalità interattiva CLI di Azure Sphere.

Modalità interattiva Azure Sphere

Funzionalità di output CLI

In questa sezione vengono illustrate le funzionalità di output disponibili in Azure Sphere CLI:

Le sezioni seguenti descrivono le funzionalità di output disponibili nella nuova CLI:

Formati di output supportati

I formati di output disponibili nel nuovo CLI sono json, jsonc (JSON colorato), tsv (Valori separati da tabulazione), table (tabelle ASCII leggibili dall'uomo) e yaml. Per impostazione predefinita, l'output CLI .table Per ulteriori informazioni sui formati di output disponibili, vedi Formati di output supportati per Azure Sphere CLI.

Reindirizzamento e impaginazione

Azure Sphere CLI non supporta l'impaginazione interattiva. È tuttavia possibile reindirizzare l'output standard di un comando a un file. Nell'esempio seguente, per prompt dei comandi di Windows, Windows PowerShell e shell Linux Bash, l'output standard viene inviato a output.txt e l'errore standard viene inviato a logs.txt.

azsphere device list --verbose > output.txt 2> logs.txt

È anche possibile impaginare l'output sullo schermo eseguendo il piping su strumenti di impaginazione esistenti.

Per esempio:

  • In PowerShell (Windows): azsphere device list | Out-Host –Paging
  • Al prompt dei comandi (Windows): azsphere device list | more
  • Shell In Bash (Linux): azsphere device list | less

Nota

Questa operazione può essere lenta a seconda della quantità di dati restituiti.

Per altre informazioni sull'impaginazione per la cli classica di Azure Azure Sphere, vedere Paging e reindirizzamento dei risultati.

Output del comando CLI query

Il CLI Azure Sphere usa l'argomento --query per eseguire una query JMESPath sui risultati dei comandi. JMESPath è un linguaggio di query per JSON, che consente di selezionare e modificare i dati dall'output CLI. Le query vengono eseguite nell'output JSON prima di qualsiasi formattazione di visualizzazione.

L'argomento --query è supportato da tutti i comandi di Azure Sphere CLI. Per altre informazioni ed esempi, vedere l'esercitazione su JMESPath e l'output del comando CLI di Azure query.

Compatibilità

Cli supporta la compatibilità con le versioni precedenti. In ogni versione, l'obiettivo è mantenere la compatibilità con le versioni precedenti sia per l'input (nomi dei comandi, nomi dei parametri, valori dei parametri) che per il relativo output in JSON e YAML. Nei casi in cui tale compatibilità non sia possibile, Microsoft invierà un preavviso di almeno 6 mesi prima di apportare modifiche. Per altre informazioni, vedere Modifiche importanti (funzionalità di ritiro) nell'ambito CLI di Azure Sphere.

Codici di uscita

Un comando che ha esito positivo restituisce uno zero. Qualsiasi valore diverso da zero può essere interpretato come un codice di errore. Dopo il successo, le uscite JSON e YAML hanno una garanzia contrattuale compatibile con le versioni precedenti.

Fornisci feedback

Se trovi un bug in Azure Sphere, invia un problema su GitHub. Per inviare feedback dalla riga di comando, usa il comando feedback.

Usare azure sphere CLI in modo efficace

Azure Sphere CLI può essere usato da Bash, PowerShell o da una finestra del prompt dei comandi. Ecco alcuni suggerimenti per l'uso di CLI:

  • Uso delle virgolette nei valori: se si specifica un parametro con un valore che include spazi, racchiuderlo tra virgolette. In Bash o PowerShell, le virgolette singole e doppie vengono interpretate. Nel prompt dei comandi di Windows vengono interpretate solo le virgolette doppie. Le virgolette singole vengono interpretate come parte del valore. Ad esempio, azsphere product create --name "My Fridge Product". Per altre informazioni, vedere Virgolette e caratteri escape.
  • Molti comandi di Azure Sphere mostrano le informazioni nella console nel formato predefinito table . Ad esempio, azsphere product device-group list --product DW100. A volte le informazioni visualizzate non si adattano correttamente alla console. Questo può causare problemi se si desidera copiare e incollare le informazioni. È consigliabile provare le opzioni seguenti:
    • Ridimensiona la console ed esegui di nuovo il comando.
    • Usare l'output JSON per scopi di output e script conciso. Ad esempio, azsphere product device-group list --product DW100 --output json.
    • Usa il completamento delle schede nella shell Windows PowerShell o Bash per completare automaticamente una voce di comando.
    • Usare la modalità interattiva che fornisce un ambiente interattivo per visualizzare automaticamente le informazioni e semplifica la selezione di comandi e sotto comandi. Entra nella modalità interattiva con il comando interattivo azsfera . Il prompt dei comandi diventa azsfera>> per indicare che sono in esecuzione comandi nella shell interattiva.

Vedere anche