Azure Sphere CLI
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 SDK biedt de Azure Sphere-opdrachtregelinterface (CLI) die beschikbaar is in PowerShell, Windows-opdrachtprompt of Linux-opdrachtshell. De Azure Sphere CLI is een set opdrachten die worden gebruikt voor het maken en beheren van Azure Sphere-resources.
De Azure Sphere CLI wordt geïnstalleerd naast de buiten gebruik stellende klassieke Cli van Azure Sphere in zowel Windows als Linux, zodat u toegang hebt tot beide interfaces. Azure Sphere CLI gebruiken:
- Gebruik In Windows PowerShell of een standaard Windows-opdrachtprompt.
- Gebruik in Linux elke opdrachtshell.
De Azure Sphere CLI uitvoeren
U kunt nu de Azure Sphere CLI uitvoeren met de opdracht vanuit de azsphere Windows-opdrachtprompt of PowerShell. We raden PowerShell aan omdat deze de functie voor het voltooien van tabbladen biedt die niet beschikbaar is via de Windows-opdrachtprompt.
In Linux kunt u Azure Sphere CLI uitvoeren vanaf elke opdrachtregelinterface (CLI). Tijdens de installatie wordt een melding weergegeven waarmee u Azure Sphere CLI of klassieke Azure Sphere CLI kunt instellen als de standaard-CLI-versie van de voorkeur.
Typ het type Yes om Azure Sphere CLI of type No te kiezen voor het gebruik van de klassieke Azure Sphere CLI. Zie De Azure Sphere SDK installeren voor meer informatie.
Notitie
Het korte formulier voor opdrachten wordt niet ondersteund in de Azure Sphere CLI-versie. U wordt aangeraden de functie voor het voltooien van tabbladen te gebruiken om de lijst met beschikbare opdrachten weer te geven. In Windows kan de opdrachtpromptsneltoets voor klassieke Azure Sphere-ontwikkelaars alleen worden gebruikt met de klassieke Azure Sphere CLI.
CLI-invoerfuncties
In deze sectie worden de invoerfuncties beschreven die beschikbaar zijn in de Azure Sphere CLI:
Opdracht
Alle opdrachten in de Azure Sphere CLI beginnen met azsphere. Voorbeeld:
azsphere login
---------------------
Name
=====================
bob@contoso.com
---------------------
Opdrachten zoeken
Opdrachten in de CLI zijn ingedeeld in groepen. U kunt volledige Help-informatie weergeven voor de beschikbare opdrachten en parameters met behulp van --help de klassieke Azure Sphere CLI en Azure Sphere CLI.
U kunt een volledige lijst met opdrachten ophalen door de opdracht azsphere --helpuit te voeren.
Voorbeeld:
- Voor klassieke CLI-gebruik van Azure Sphere of
azsphere --helpazsphere -? - Voor gebruik van Azure Sphere CLI of
azsphere --helpazsphere -h
Parameters
De naam van de parameter wordt voorafgegaan door dubbele afbreekstreepjes (--), die aangeeft dat het woord na het afbreekstreepje een parameter is. Gebruik een spatie om de parameternaam en -waarde te scheiden. De parameters die samengestelde woorden zijn, worden gescheiden door een afbreekstreepje (-) in de nieuwe CLI.
Bijvoorbeeld: --component-id of --application-update
Vereenvoudigde objectidentificatie
In de Azure Sphere CLI wordt één parameter gebruikt om elk objecttype te identificeren. Dit betekent dat u de id, naam, IP of locatie kunt opgeven die van toepassing is op die parameter.
U kunt bijvoorbeeld de tenant-id of tenantnaam gebruiken in de volgende opdracht:
azsphere device list --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
or
azsphere device list --tenant MyTenant
Dit is geïmplementeerd voor de --deviceparameters , --tenanten --product--device-group de parameters.
Voorbeeld:
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
------------------------------------ ------------------------------------ ---------- ------------------------------------ --------- ---------------------- ---------------------------------------------------------- -------------------------
Meerdere waarden
Sommige opdrachten staan meerdere waarden toe voor één parameter. In dat geval kunt u een parameter opgeven met elke waarde, of één parameter gevolgd door een lijst met waarden gescheiden door spaties. De volgende twee opdrachten zijn bijvoorbeeld gelijkwaardig:
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
Vereiste en optionele parameters
Wanneer u een lijst met parameters uitvoert azsphere <command> <sub-command> --help die van toepassing zijn op die opdracht, wordt weergegeven. De instelling [Vereist] geeft aan of de parameter verplicht is om de opdracht uit te voeren. Alle andere parameters zijn optioneel.
Als de vereiste parameter ontbreekt, wordt u gevraagd om een waarde voor de parameter.
Voorbeeld:
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.
Invoer- en uitvoerpaden
In Azure Sphere CLI zijn de parameternamen die worden gebruikt om een pad en bestandsnaam op te geven bijgewerkt zodat deze relevant zijn voor de context van de opdracht.
Voorbeeld:
azsphere image-package pack-application --package-directory C:\AppSamples\LocalSamples\HelloWorld\HelloWorld_HighLevelApp\out\ARM-Debug\approotHelloWorld_HighLevelApp --destination myimage.imagepackage
--package-directory Hier geeft u de invoermap voor het pakket en --destination de parameter het pad en de bestandsnaam voor het resulterende installatiekopieënpakket.
Tabvoltooiing
Tabvoltooiing biedt hulp bij het automatisch voltooien van een opdrachtvermelding in de opdrachtregelinterface. Het voltooien van het Azure Sphere CLI-tabblad wordt ondersteund voor groepen, opdrachten, parameternamen en parameterwaarden. Typ een paar tekens van een opdracht en druk op Tab om de gewenste voltooiingstekst te selecteren. Als meerdere items beginnen met de tekst die u in eerste instantie hebt getypt, drukt u op Tab totdat het gewenste item wordt weergegeven.
In Windows biedt PowerShell 7.1 de functie voor het voltooien van tabbladen die niet beschikbaar is via de Windows-opdrachtprompt.
Als u tabvoltooiing wilt inschakelen in Windows PowerShell, voert u het volgende uit Import-Module -name AzsphereCli.
Met deze opdracht kunt u alleen tabvoltooiing voor de sessie inschakelen. U kunt een script toevoegen aan uw PowerShell-profiel om uw omgeving aan te passen en tabvoltooiing in te schakelen voor elke PowerShell-sessie die u start.
In Linux ondersteunt Azure Sphere CLI de functie voor het voltooien van tabbladen voor opdrachten onder de Bash-shell.
Daarnaast kunt u met automatisch aanvullen opdrachten, parameters en parameterwaarden detecteren die beschikbaar zijn voor gebruik. Dit is beschikbaar met Ctrl+Spatiebalk in Windows PowerShell of druk tweemaal op Tab in de Linux Bash-shell.
Typ bijvoorbeeld de opdracht azsphere-productupdate en gebruik automatisch aanvullen om een lijst met beschikbare parameters weer te geven.
Typ op dezelfde manier azsphere-productupdate --product en gebruik automatisch aanvullen om een lijst met beschikbare producten in uw tenant weer te geven.
Interactieve modus (preview)
Belangrijk
Deze functie is beschikbaar als preview-versie. Het kan worden gewijzigd of verwijderd in een toekomstige release.
De nieuwe CLI biedt een interactieve modus die automatisch Help-informatie weergeeft en het gemakkelijker maakt om opdrachten, subopdrachten, parameter- en parameterwaarden te selecteren. Voer de interactieve modus in met de interactieve opdracht azsphere. De opdrachtprompt verandert om aan te azsphere>> geven dat u nu opdrachten uitvoert in de interactieve shell.
Zie de interactieve modus van Azure Sphere CLI voor meer informatie.
CLI-uitvoerfuncties
In deze sectie wordt uitgelegd welke uitvoerfuncties beschikbaar zijn in de Azure Sphere CLI:
In de volgende secties worden de uitvoerfuncties beschreven die beschikbaar zijn in de nieuwe CLI:
Ondersteunde uitvoerindelingen
De beschikbare uitvoerindelingen in de nieuwe CLI zijn json, jsonc (gekleurde JSON), tsv (door tabs gescheiden waarden), table (door mensen leesbare ASCII-tabellen) en yaml. Standaard is table de uitvoer van de CLI. Zie Ondersteunde uitvoerindelingen voor Azure Sphere CLI voor meer informatie over de beschikbare uitvoerindelingen.
Omleiding en paginering
Azure Sphere CLI biedt geen ondersteuning voor interactieve paginering. U kunt de standaarduitvoer van een opdracht echter omleiden naar een bestand. In het volgende voorbeeld wordt voor windows-opdrachtprompt, Windows PowerShell en Linux Bash-shell de standaarduitvoer verzonden naar output.txt en wordt de standaardfout verzonden naar logs.txt.
azsphere device list --verbose > output.txt 2> logs.txt
U kunt de uitvoer ook op het scherm pagineren door naar bestaande pagineringshulpprogramma's te gaan.
Voorbeeld:
- In PowerShell (Windows):
azsphere device list | Out-Host –Paging - Bij een opdrachtprompt (Windows):
azsphere device list | more - In Bash-shell (Linux):
azsphere device list | less
Notitie
Deze bewerking kan mogelijk traag zijn, afhankelijk van de hoeveelheid gegevens die wordt geretourneerd.
Zie Paging en resultaatomleiding voor meer informatie over paginering voor de klassieke Azure Sphere-CLI.
Uitvoer van query-CLI-opdracht
De Azure Sphere CLI gebruikt het --query argument om een JMESPath-query uit te voeren op de resultaten van opdrachten. JMESPath is een querytaal voor JSON, zodat u gegevens uit cli-uitvoer kunt selecteren en wijzigen. Query's worden uitgevoerd op de JSON-uitvoer voordat er weergaveopmaak wordt weergegeven.
Het --query argument wordt ondersteund door alle opdrachten in Azure Sphere CLI. Zie de zelfstudie JMESPath en Voer uitvoer van Azure CLI-opdrachten uit voor meer informatie en voorbeelden.
Compatibiliteit met eerdere versies
De CLI ondersteunt compatibiliteit met eerdere versies. In elke release streven we ernaar om compatibiliteit met eerdere versies te behouden voor zowel invoer (opdrachtnamen, parameternamen, parameterwaarden) als de uitvoer ervan in JSON en YAML. In gevallen waarin dergelijke compatibiliteit niet mogelijk is, zullen we ten minste 6 maanden op de hoogte stellen voordat we wijzigingen aanbrengen. Zie Belangrijke wijzigingen (buiten gebruik stellen van functies) in Azure Sphere CLI voor meer informatie.
Afsluitcodes
Een geslaagde opdracht retourneert een nul. Elke waarde die niet nul is, kan worden geïnterpreteerd als foutcode. Bij succes hebben de JSON - en YAML-uitvoer een achterwaarts compatibele contractuele garantie.
Feedback geven
Als u een fout in Azure Sphere vindt, kunt u een probleem indienen op GitHub. Als u feedback wilt geven vanaf de opdrachtregel, gebruikt u de feedbackopdracht.
Azure Sphere CLI effectief gebruiken
Azure Sphere CLI kan worden gebruikt vanuit Bash, PowerShell of een opdrachtpromptvenster. Hier volgen enkele tips voor het gebruik van de CLI:
- Aanhalingstekens gebruiken in waarden: Als u een parameter opgeeft die spaties bevat, plaatst u deze tussen aanhalingstekens. In Bash of PowerShell worden zowel enkele als dubbele aanhalingstekens geïnterpreteerd. In de Windows-opdrachtprompt worden alleen dubbele aanhalingstekens geïnterpreteerd. Enkele aanhalingstekens worden geïnterpreteerd als onderdeel van de waarde. Bijvoorbeeld:
azsphere product create --name "My Fridge Product". Zie Aanhalingstekens en escapetekens voor meer informatie. - Veel Azure Sphere-opdrachten geven informatie weer in de console in de standaardindeling
table. Bijvoorbeeld:azsphere product device-group list --product DW100. Soms past de weergegeven informatie niet goed in de console. Dit kan problemen veroorzaken als u de informatie wilt kopiëren en plakken. We raden u aan de volgende opties uit te proberen:- Wijzig het formaat van de console en voer de opdracht opnieuw uit.
- Gebruik JSON-uitvoer voor beknopte uitvoer- en scriptdoeleinden. Bijvoorbeeld:
azsphere product device-group list --product DW100 --output json. - Gebruik tabvoltooiing in Windows PowerShell of Bash-shell om automatisch een opdrachtvermelding te voltooien.
- Gebruik de interactieve modus die een interactieve omgeving biedt om automatisch informatie weer te geven en maakt het gemakkelijker om opdrachten en subopdrachten te selecteren. Voer de interactieve modus in met de interactieve opdracht azsphere. De opdrachtprompt verandert in azsphere>> om aan te geven dat u nu opdrachten uitvoert in de interactieve shell.