Dela via

Översikt över Azure Sphere CLI

  • Artikel

Viktigt!

Det här är dokumentationen om Azure Sphere (Legacy). Azure Sphere (Legacy) upphör den 27 september 2027 och användarna måste migrera till Azure Sphere (integrerad) vid den här tiden. Använd versionsväljaren ovanför TOC för att visa dokumentationen om Azure Sphere (integrerad).

Azure Sphere CLI är en uppsättning kommandon som används för att hantera dina Azure Sphere-resurser.

Följande kommandon är tillgängliga:

Kommentar

Kommandot register-user är nu inaktuellt.

Klassiska CLI för Azure Sphere CLI och Azure Sphere

Azure Sphere CLI installeras tillsammans med det befintliga CLI:et i både Windows och Linux, så du har åtkomst till något av gränssnitten. Det klassiska Azure Sphere CLI fortsätter att fungera som det alltid har gjort.

Så här använder du Azure Sphere CLI:

  • I Windows använder du PowerShell eller en standardkommandoprompt för Windows.
  • I Linux använder du valfritt kommandogränssnitt. Ange azsphere-kommandot om du anger Azure Sphere CLI som standard under SDK-installationen eller kommandot azsphere_v2 om du anger det klassiska Azure Sphere CLI som standard.

Mer information om de funktioner och kommandon som stöds av Azure Sphere CLI finns i Azure Sphere CLI .

Viktigt!

  • I Windows kan den klassiska kommandotolken i Azure Sphere endast användas med klassiska Azure Sphere CLI.

Kommandoradsformat

Kommandoraden azsphere har följande format:

azsphere [command] [subcommand] operation [parameters]

I allmänhet är kommando och underkommando substantiv och åtgärden är ett verb, så att kombinationen identifierar både en åtgärd och objektet för åtgärden. De flesta kommandon och åtgärder har både ett fullständigt namn och en förkortning. Enhetskommandot är till exempel förkortat d.

De flesta parametrar har både ett långt namn och en förkortning. På kommandoraden introducerar du det långa namnet med två bindestreck och förkortningen med ett enda bindestreck. Följande två kommandon är till exempel likvärdiga:

azsphere device wifi add --ssid MyNetwork --psk mynetworkkey

azsphere device wifi add -s MyNetwork -p mynetworkkey

Vissa kommandon tillåter flera värden för en enda parameter. I Azure Sphere CLI kan du ange en enskild parameter följt av en lista med värden avgränsade med blanksteg och i den klassiska Azure Sphere CLI avgränsas listan med värden med kommatecken. Till exempel:

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

Citattecken och escape-tecken

När du arbetar med Azure Sphere CLI-kommandon bör du vara medveten om hur gränssnittet använder citattecken och escape-tecken. Om du stöder skript som används i olika gränssnitt måste du förstå hur de skiljer sig åt.

Till exempel:

Molnberoende kommandon

Följande azsphere-kommandon kräver en molnanslutning och inloggning till Azure Sphere Security Service:

  • ca-certifikat
  • enhetsgrupp
  • get-support-data
  • bild
  • inloggning
  • logout
  • produkt
  • roll
  • show-user
  • klientorganisation

Dessutom kräver följande azsphere-enhetskommandon även en molnanslutning:

azsphere device command Kommentarer
förmåga Kräver Azure Sphere Security Service för nedladdning av enhetsfunktioner
anspråk
enable-cloud-test
enable-development
bild
lista
tillfriskna Kräver internetanslutning, men inte inloggning till Azure Sphere Security Service
visa
show-count
show-deployment-status
show-os-version Kräver internetanslutning, men inte inloggning till Azure Sphere Security Service
uppdatera

Enhetsfunktionsberoende kommandon

Följande azsphere-enhetskommandon kräver att en enhetsfunktion används för enheter i tillverkningstillståndet DeviceComplete:

Operation beskrivning
-program Hantera program på den anslutna enheten.
förmåga Hantera konfigurationer av enhetsfunktioner. Krävs för funktionsuppdatering.
certifikat Hantera enhetscertifikatarkiv.
bild Hantera enhetsbilder.
tillverkningstillstånd Hantera tillverkningstillståndet för anslutna enheter. Krävs för uppdatering av tillverkningstillstånd.
restart Starta om den anslutna enheten.
show-deployment-status Visa distributionsstatus för operativsystemet och programmen på den anslutna enheten.
show-os-version Visa operativsystemversionen på den anslutna enheten.
separat inläsning Distribuera och hantera program på den anslutna enheten. Krävs för separat inläsning av distribution och borttagning av separat inläsning.
wifi Hantera Wi-Fi-konfigurationer för den anslutna enheten.

Om du försöker köra dessa kommandon utan kapacitet får du ett felmeddelande som uppmanar dig att antingen köra azsphere device enable-development eller använda azsphere device capability för att ladda ned och välja en kapacitetsfil för enheten.