Azure Sphere CLI
Azure Sphere SDK tillhandahåller Azure Sphere-kommandoradsgränssnittet (CLI) som är tillgängligt i PowerShell, Windows Kommandotolken eller Linux-kommandogränssnittet. Azure Sphere CLI är en uppsättning kommandon som används för att skapa och hantera Azure Sphere-resurser.
Azure Sphere CLI installeras tillsammans med den gamla Azure Sphere-klassiska CLI på både Windows och Linux, så du har tillgång till båda gränssnitten. Så här använder du Azure Sphere CLI:
- I Windows använder du PowerShell eller en vanlig Kommandotolk i Windows.
- Använd valfritt kommandogränssnitt i Linux.
Kör Azure Sphere CLI
Nu kan du köra Azure Sphere CLI med azsphere kommandot från antingen Windows Kommandotolken eller PowerShell. Vi rekommenderar PowerShell eftersom det erbjuder funktionen för flikslutförande som inte är tillgänglig från Windows kommandotolk.
På Linux kan du köra Azure Sphere CLI från vilket kommandoradsgränssnitt som helst (CLI). Under installationen visas ett meddelande som gör att du kan ange Azure Sphere CLI eller Azure Sphere klassisk CLI som standardversion av CLI.
Skriv Yes för att välja Azure Sphere CLI eller typ No för att använda Azure Sphere klassiska CLI. Mer information finns i Installera Azure Sphere SDK .
Observera
Det korta formuläret för kommandon stöds inte i Azure Sphere CLI-versionen. Vi rekommenderar att du använder funktionen för att slutföra flikar för att visa listan över tillgängliga kommandon. I Windows kan den gamla Azure Sphere Classic Developer Command Prompt-genvägen endast användas med Azure Sphere-klassiska CLI.
CLI-inmatningsfunktioner
I det här avsnittet beskrivs indatafunktionerna som är tillgängliga i Azure Sphere CLI:
Kommandon
Alla kommandon i Azure Sphere CLI börjar med azsphere. Till exempel:
azsphere login
---------------------
Name
=====================
bob@contoso.com
---------------------
Hitta kommandon
Kommandon i CLI är ordnade i grupper. Du kan visa fullständig hjälpinformation för tillgängliga kommandon och parametrar med hjälp --help av azure sphere klassiska CLI och Azure Sphere CLI.
Du kan få en fullständig lista med kommandon genom att köra kommandot azsphere --help.
Till exempel:
- För azure sphere klassisk CLI-användning,
azsphere --helpellerazsphere -? - För Användning av Azure Sphere CLI,
azsphere --helpellerazsphere -h
Parametrar
Parameterns namn föregås av dubbla bindestreck (--), som indikerar att ordet efter bindestrecket är en parameter. Använd ett blanksteg för att avgränsa parameterns namn och värde. Parametrarna som är sammansatta ord avgränsas med ett bindestreck (-) i nya CLI.
Till exempel: --component-id eller --application-update
Förenklad objektidentifiering
I Azure Sphere CLI används en enskild parameter för att identifiera varje objekttyp. Det innebär att du kan ange antingen det ID, namn, IP eller den plats som gäller för parametern.
Du kan till exempel använda antingen klientorganisations-ID eller klientorganisationsnamn i följande kommando:
azsphere device list --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
Eller
azsphere device list --tenant MyTenant
Detta har implementerats för parametrarna --device, --tenant, --productoch --device-group .
Till exempel:
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
------------------------------------ ------------------------------------ ---------- ------------------------------------ --------- ---------------------- ---------------------------------------------------------- -------------------------
Flera värden
Vissa kommandon tillåter flera värden för en enskild parameter, vilket betyder att du antingen kan ange en parameter med varje värde eller en enskild parameter följt av en lista med värden avgränsade med blanksteg. Följande två kommandon är till exempel likvärdiga:
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
Obligatoriska och valfria parametrar
När du kör azsphere <command> <sub-command> --help en lista med parametrar som gäller för det kommandot visas. Inställningen [Obligatoriskt] anger om parametern är obligatorisk för att kommandot ska kunna köras. Alla andra parametrar är valfria.
Om den obligatoriska parametern saknas uppmanas du att ange ett värde för parametern.
Till exempel:
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.
Indata- och utdatasökvägar
I Azure Sphere CLI har parameternamnen som används för att ange en sökväg och filnamnet uppdaterats för att vara relevanta för kommandots sammanhang.
Till exempel:
azsphere image-package pack-application --package-directory C:\AppSamples\LocalSamples\HelloWorld\HelloWorld_HighLevelApp\out\ARM-Debug\approotHelloWorld_HighLevelApp --destination myimage.imagepackage
--package-directory Här anger indatakatalogen för paketet och --destination parametern sökvägen och filnamnet för det resulterande avbildningspaketet.
Tabbslut
Med tabbslutningen får du hjälp med att automatiskt slutföra en kommandopost i kommandoradsgränssnittet. I azure sphere cli-fliken stöds för grupper, kommandon, parametrarnamn och parametervärden. Skriv några tecken i ett kommando och tryck sedan på TABB för att markera önskad text. Om flera objekt börjar med texten som du ursprungligen skrev fortsätter du att trycka på TABB tills det objekt du vill använda visas.
I Windows erbjuder PowerShell 7.1 en kompletteringsfunktion för flikar som inte är tillgänglig från Kommandotolken i Windows.
Om du vill aktivera tabbslut i Windows PowerShell kör Import-Module -name AzsphereClidu .
Med det här kommandot kan du bara slutföra flikar för sessionen. Du kan lägga till ett skript i din PowerShell-profil för att anpassa miljön och aktivera tabbslut för varje PowerShell-session som du startar.
I Linux har Azure Sphere CLI stöd för flikslutfunktionen för kommandon under Bash-gränssnittet.
Komplettera automatiskt hjälper dig dessutom att hitta kommandon, parametrar och parametervärden som är tillgängliga att använda. Det här är tillgängligt genom att använda CTRL+Blanksteg i Windows PowerShell eller trycka på TABB två gånger i Linux Bash-gränssnittet.
Skriv till exempel azsfärproduktuppdateringskommando och använd Komplettera automatiskt för att visa en lista över tillgängliga parametrar.
På samma sätt skriver du azsfärproduktuppdatering - produkt och använder komplettera automatiskt för att visa en lista över tillgängliga produkter i klientorganisationen.
Interaktivt läge (förhandsversion)
Viktigt
Den här funktionen är i förhandsversion. Den kan komma att ändras eller tas bort i en kommande version.
Nya CLI erbjuder ett interaktivt läge som automatiskt visar hjälpinformation och gör det enklare att välja kommandon, underkommandon, parameter- och parametervärden. Gå till det interaktiva läget med det interaktiva kommandot azsfär . Kommandotolken ändras för att azsphere>> indikera att du nu kör kommandon i det interaktiva gränssnittet.
Mer information finns i Interaktivt läge för Azure Sphere CLI.
CLI-utdatafunktioner
I det här avsnittet förklaras de utdatafunktioner som är tillgängliga i Azure Sphere CLI:
I följande avsnitt beskrivs de utdatafunktioner som är tillgängliga i nya CLI:
Utdataformat som stöds
De tillgängliga utdataformaten i nya CLI är json, jsonc (färgat JSON), tsv (Tab-Separated Values), table (läsbara ASCII-tabeller för människor) och yaml. Som standard utdata tablefrån CLI . Mer information om tillgängliga utdataformat finns i Utdataformat som stöds för Azure Sphere CLI.
Omdirigering och sidnumrering
Azure Sphere CLI stöder inte interaktiv sidbrytning. Du kan dock omdirigera standardutdata för ett kommando till en fil. I följande exempel för Kommandotolken i Windows skickas Windows PowerShell och Linux Bash-gränssnittet standardutdata till output.txt och standardfel skickas till logs.txt.
azsphere device list --verbose > output.txt 2> logs.txt
Du kan också paginate utdata på skärmen genom att piping till befintliga sidbrytningsverktyg.
Till exempel:
- I PowerShell (Windows):
azsphere device list | Out-Host –Paging - I en kommandotolk (Windows):
azsphere device list | more - In Bash shell (Linux):
azsphere device list | less
Observera
Den här åtgärden kan vara långsam beroende på hur mycket data som returneras.
Mer information om pagination för Azure Azure Sphere klassiska CLI finns i Paging och resultatomdirigering.
Fråge-CLI-kommandoutdata
Azure Sphere CLI använder --query argumentet för att köra en JMESPath-fråga på resultatet av kommandon. JMESPath är ett frågespråk för JSON, vilket ger dig möjlighet att välja och ändra data från CLI-utdata. Frågor körs på JSON-utdata före eventuell visningsformatering.
Argumentet --query stöds av alla kommandon i Azure Sphere CLI. Mer information och exempel finns i självstudiekursen om JMESPath och Fråga Azure CLI-kommandoutdata .
Bakåtkompatibilitet
CLI stöder bakåtkompatibilitet. I varje version strävar vi efter att upprätthålla bakåtkompatibilitet för både indata (kommandonamn, parameternamn, parametervärden) och dess utdata i JSON och YAML. I fall där sådan kompatibilitet inte är möjlig kommer vi att meddela minst 6 månader i förväg innan vi gör ändringar. Mer information finns i Viktiga ändringar (tillbakadragna funktioner) i Azure Sphere CLI.
Utgångskoder
Ett lyckat kommando returnerar en nolla. Alla värden som inte är noll kan tolkas som en felkod. Vid framgång har JSON - och YAML-utdata en bakåtkompatibel avtalsgaranti.
Ge feedback
Om du hittar ett fel i Azure Sphere kan du skapa ett problem på GitHub. Använd kommandot feedback om du vill ge feedback från kommandoraden.
Använd Azure Sphere CLI effektivt
Azure Sphere CLI kan användas från Bash, PowerShell eller ett kommandotolksfönster. Här är några tips för att använda CLI:
- Använda citattecken i värden: Om du anger ett parametervärde som innehåller blanksteg omger du det med citattecken. I Bash eller PowerShell tolkas både enkla och dubbla citattecken. I Kommandotolken i Windows tolkas endast citattecken. Enkla citattecken tolkas som en del av värdet. Till exempel
azsphere product create --name "My Fridge Product". Mer information finns i Citattecken och undantagstecken. - Många Azure Sphere-kommandon visar information i konsolen i standardformatet
table. Till exempelazsphere product device-group list --product DW100. Ibland passar inte informationen som visas på rätt sätt i konsolen. Det kan orsaka problem om du vill kopiera och klistra in informationen. Vi rekommenderar att du provar följande alternativ:- Ändra storlek på konsolen och kör kommandot igen.
- Använd JSON-utdata för koncisa utdata och skriptändamål. Till exempel
azsphere product device-group list --product DW100 --output json. - Använd tab-completion i Windows PowerShell eller Bash shell för att automatiskt slutföra en kommandopost.
- Använd det interaktiva läget som ger en interaktiv miljö för att automatiskt visa information och göra det enklare att välja kommandon och underkommandon. Gå till det interaktiva läget med det interaktiva kommandot azsfär . Kommandotolken ändras till azsfär för>> att indikera att du nu kör kommandon i det interaktiva gränssnittet.