Delen via

Overzicht van Azure Sphere CLI

  • Artikel

Belangrijk

Dit is de Documentatie voor Azure Sphere (verouderd). Azure Sphere (verouderd) wordt op 27 september 2027 buiten gebruik gesteld en gebruikers moeten tegen deze tijd migreren naar Azure Sphere (geïntegreerd). Gebruik de versiekiezer boven de inhoudsweergave om de Documentatie van Azure Sphere (geïntegreerd) weer te geven.

De Azure Sphere CLI is een set opdrachten die worden gebruikt voor het beheren van uw Azure Sphere-resources.

De volgende opdrachten zijn beschikbaar:

Notitie

De opdracht Register-user is nu afgeschaft.

Azure Sphere CLI en klassieke Azure Sphere CLI

De Azure Sphere CLI wordt naast de bestaande CLI in zowel Windows als Linux geïnstalleerd, zodat u toegang hebt tot beide interfaces. De klassieke Cli van Azure Sphere blijft werken zoals altijd.

De Azure Sphere CLI gebruiken:

  • Gebruik In Windows PowerShell of een standaard Windows-opdrachtprompt.
  • Gebruik in Linux elke opdrachtshell. Geef de azsphere-opdracht op als u Azure Sphere CLI instelt als de standaardinstelling tijdens de SDK-installatie of de azsphere_v2 opdracht als u de klassieke Azure Sphere CLI als standaard instelt.

Zie Azure Sphere CLI voor meer informatie over de functies en opdrachten die worden ondersteund door Azure Sphere CLI.

Belangrijk

  • In Windows kan de opdrachtpromptsneltoets voor klassieke Azure Sphere-ontwikkelaars alleen worden gebruikt met de klassieke Azure Sphere CLI.

Opdrachtregelindeling

De azsphere-opdrachtregel heeft de volgende indeling:

azsphere [command] [subcommand] operation [parameters]

Over het algemeen zijn opdracht en subopdracht zelfstandige naamwoorden en bewerkingen een werkwoord, zodat de combinatie zowel een actie als het object van de actie identificeert. De meeste opdrachten en bewerkingen hebben zowel een volledige naam als een afkorting. De apparaatopdracht wordt bijvoorbeeld afgekort d.

De meeste parameters hebben zowel een lange naam als een afkorting. Introduceer op de opdrachtregel de lange naam met twee afbreekstreepjes en de afkorting met één afbreekstreepje. De volgende twee opdrachten zijn bijvoorbeeld gelijkwaardig:

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

azsphere device wifi add -s MyNetwork -p mynetworkkey

Sommige opdrachten staan meerdere waarden toe voor één parameter. In Azure Sphere CLI kunt u één parameter opgeven, gevolgd door een lijst met waarden gescheiden door spaties en in de klassieke Azure Sphere CLI worden de lijst met waarden gescheiden door komma's. Voorbeeld:

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

Aanhalingstekens en escapetekens

Wanneer u met Azure Sphere CLI-opdrachten werkt, moet u rekening houden met hoe uw shell aanhalingstekens en escapetekens gebruikt. Als u scripts ondersteunt die in verschillende shells worden gebruikt, moet u weten hoe deze verschillen.

Voorbeeld:

Cloudafhankelijke opdrachten

Voor de volgende azsphere-opdrachten is een cloudverbinding en aanmelding bij de Azure Sphere-beveiligingsservice vereist:

  • ca-certificate
  • apparaatgroep
  • get-support-data
  • image
  • aanmelding
  • Meld u af
  • product
  • role
  • show-user
  • tenant

Daarnaast vereisen de volgende azsphere-apparaatopdrachten ook een cloudverbinding:

azsphere device command Opmerkingen
vermogen Vereist Azure Sphere Security Service voor het downloaden van apparaatmogelijkheden
aanspraak maken op
enable-cloud-test
enable-development
afbeelding
lijst
herstellen Vereist een internetverbinding, maar geen aanmelding bij Azure Sphere Security Service
tonen
show-count
show-deployment-status
show-os-version Vereist een internetverbinding, maar geen aanmelding bij Azure Sphere Security Service
update

Afhankelijke opdrachten voor apparaatmogelijkheden

Voor de volgende azsphere-apparaatopdrachten moet een apparaatmogelijkheid worden gebruikt voor apparaten met de productiestatus DeviceComplete:

Operation Omschrijving
-app Toepassingen op het gekoppelde apparaat beheren.
vermogen Apparaatondersteuningsconfiguraties beheren. Vereist voor het bijwerken van de mogelijkheid.
certificaat Apparaatcertificaatarchief beheren.
image Apparaatinstallatiekopieën beheren.
productiestatus De productiestatus van gekoppelde apparaten beheren. Vereist voor de productiestatusupdate.
restart Start het gekoppelde apparaat opnieuw op.
show-deployment-status De implementatiestatus van het besturingssysteem en de toepassingen op het gekoppelde apparaat weergeven.
show-os-version Geef de versie van het besturingssysteem weer op het gekoppelde apparaat.
sideloaden Toepassingen implementeren en beheren op het gekoppelde apparaat. Vereist voor sideload implementeren en sideload verwijderen.
wifi Wi-Fi-configuraties voor het gekoppelde apparaat beheren.

Als u deze opdrachten zonder een mogelijkheid probeert uit te voeren, ontvangt u een foutbericht met de mededeling dat u deze moet uitvoeren azsphere device enable-development of gebruiken azsphere device capability om een mogelijkheidsbestand voor het apparaat te downloaden en te selecteren.