Overzicht van Azure Sphere CLI

  • Artikel

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

De volgende opdrachten zijn beschikbaar:

Azure Sphere CLI en klassieke Azure Sphere CLI

De Azure Sphere CLI wordt naast de bestaande CLI geïnstalleerd in zowel Windows als Linux, 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 een willekeurige opdrachtshell. Geef de azsphere-opdracht op als u Azure Sphere CLI als standaard instelt tijdens de SDK-installatie, of de opdracht azsphere_v2 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 buiten gebruik gesteld snelkoppeling naar de klassieke opdrachtprompt van Azure Sphere 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 is bewerking 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 tot d.

De meeste parameters hebben zowel een lange naam als een afkorting. Op de opdrachtregel introduceert u 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 wordt de lijst met waarden gescheiden door komma's. Bijvoorbeeld:

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.

Bijvoorbeeld:

Cloudafhankelijke opdrachten

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

  • ca-certificaat
  • apparaatgroep
  • get-support-data
  • Afbeelding
  • Login
  • Logout
  • Product
  • register-user
  • Role
  • show-user
  • Huurder

Daarnaast is voor de volgende azsphere-apparaatopdrachten ook een cloudverbinding vereist:

opdracht azsphere device Opmerkingen
Vermogen Vereist Azure Sphere Security Service voor het downloaden van apparaatmogelijkheden
Vordering
enable-cloud-test
enable-development
Afbeelding
Lijst
Herstellen Vereist internetverbinding, maar meld u niet aan bij Azure Sphere Security Service
Toon
show-count
show-deployment-status
show-os-version Vereist internetverbinding, maar meld u niet aan bij Azure Sphere Security Service
Update

Opdrachten die afhankelijk zijn van apparaatmogelijkheden

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

Bewerking Beschrijving
App Toepassingen beheren op het gekoppelde apparaat.
Vermogen Configuraties van apparaatfuncties beheren. Vereist voor het bijwerken van mogelijkheden.
Certificaat Apparaatcertificaatarchief beheren.
Afbeelding Apparaatinstallatiekopieën beheren.
productiestatus De productiestatus van gekoppelde apparaten beheren. Vereist voor het bijwerken van de productiestatus.
Opnieuw starten 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 De versie van het besturingssysteem weergeven op het gekoppelde apparaat.
sideloaden Toepassingen implementeren en beheren op het gekoppelde apparaat. Vereist voor sideload implementeren en sideload verwijderen.
Wifi Beheer Wi-Fi configuraties voor het gekoppelde apparaat.

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