image-package, pkgimage-package, pkg

Gestisce le immagini Azure Sphere sul disco.Manages Azure Sphere images on disk.

OperazioneOperation DescrizioneDescription
pack-applicationpack-application Crea un pacchetto immagine.Creates an image package.
pack-board-configpack-board-config Crea un pacchetto immagine di configurazione della scheda.Creates a board configuration image package.
showshow Visualizza i dettagli relativi a un pacchetto immagine.Displays details about an image package.

pack-applicationpack-application

Crea un'applicazione eseguibile da un'immagine compilata e collegata e un file app_manifest.json.Creates an executable application from a compiled and linked image and an app_manifest.json file.

Le applicazioni con operazioni in tempo reale vengono compilate come file ELF o AXF e non come file binari non elaborati.Real-time capable applications (RTApps) are built as ELF or AXF files and not as raw binaries. Prima di creare il pacchetto di un'applicazione con operazioni in tempo reale, modificare il file manifesto dell'applicazione in modo che ApplicationType sia impostato su "RealTimeCapable" ed EntryPoint sia impostato sul nome del file ELF o AXF, che deve essere nella radice della directory dell'applicazione.Before packaging an RTApp, edit the application manifest file so that ApplicationType is set to "RealTimeCapable", and EntryPoint is set to the name of the ELF or AXF file, which must be in the root of the application directory.

Suggerimento

Questo comando viene eseguito quando si compila un' applicazione di alto livello o un' applicazione con supporto in tempo reale usando Visual Studio Code o Visual Studio.This command is run when you build a high-level application or a real-time capable application using Visual Studio Code or Visual Studio.

  • Il processo di compilazione crea una <app-name> directory AppRoot, ovvero la directory di input specificata nel --input parametro.The build process creates an approot<app-name> directory, which is the input directory specified in the --input parameter.
  • Il file manifesto dell'applicazione viene fornito nel --applicationmanifestpath parametro.The application manifest file is provided in the --applicationmanifestpath parameter.
  • Per le applicazioni di livello superiore, nel parametro viene fornita una versione del runtime dell'applicazione --targetapiset .For high-level applications, an application runtime version is provided in the --targetapiset parameter.

Parametri obbligatoriRequired parameters

ParametroParameter TipoType DescrizioneDescription Versione supportataSupported version
-i,--input-i, --input Percorso approot_folderPath to approot_folder Identifica la directory di input, che viene usata come directory principale del sistema per il file di immagine di Azure Sphere.Identifies the input directory, which is used as the system root for the Azure Sphere image file. Il file app_manifest.json per l'applicazione deve trovarsi in questa directory.The app_manifest.json file for the application must be in this directory. -Azure Sphere CLI V1- Azure Sphere CLI v1
-Azure Sphere interfaccia della riga di comando v2 beta- Azure Sphere CLI v2 Beta
-o, --output-o, --output Percorso del pacchetto immaginePath to image package Specifica un percorso e un nome file per il pacchetto immagine di output.Specifies a path and filename for the output image package. INTERFACCIA della riga di comando Azure Sphere V1Azure Sphere CLI v1
-f,--Destination-file-f, --destination-file Percorso del pacchetto immaginePath to image package Specifica un percorso e un nome file per il pacchetto immagine di output.Specifies a path and filename for the output image package. Interfaccia della riga di comando di Azure Sphere v2 BetaAzure Sphere CLI v2 Beta

Parametri facoltativiOptional parameters

ParametroParameter TipoType DescrizioneDescription Versione supportataSupported version
-x,--file eseguibili-x, --executables executable1,executable2 ...executable1,executable2 Specifica i percorsi secondari di uno o più file da contrassegnare come file eseguibile nel pacchetto immagine.Specifies the sub-paths to one or more files to mark as executable in the image package. Il EntryPoint elencato nei file di app_manifest è sempre contrassegnato come eseguibile, quindi il flag-x è necessario solo se sono presenti altri eseguibili.The EntryPoint listed in the app_manifest files is always marked as executable, so the -x flag is required only if other executables are present.

Per impostazione predefinita, i file non sono eseguibili quando vengono inseriti in pacchetto in un'immagine.By default, files are not executable when packaged into an image. I percorsi secondari sono relativi al --input percorso.The sub-paths are relative to the --input path. I percorsi possono usare sia la sintassi del nome file di Windows (backslash) o la sintassi del nome file di Linux (slash in avanti); spazi, virgole e punti e virgola non sono ammessi.The paths can use either Windows filename syntax (backslashes) or Linux filename syntax (forward slashes); spaces, commas, and semicolons are not allowed. È possibile specificare -x per ogni file eseguibile o usarlo una sola volta e specificare più percorsi, separati da virgole senza spazi intermedi.You can either specify -x for each executable file, or use it only once and supply multiple paths separated by commas without intervening spaces.
-Azure Sphere CLI V1- Azure Sphere CLI v1
-Azure Sphere interfaccia della riga di comando v2 beta-Azure Sphere CLI v2 Beta
-a,--applicationmanifestpath-a, --applicationmanifestpath stringString Specifica il percorso del file manifesto dell'applicazione.Specifies the path to the application manifest file. Può trattarsi di un file JSON o di una directory che contiene app_manifest.js.This can be a JSON file or a directory which contains app_manifest.json. È possibile fornire un percorso relativo o assoluto.You may provide a relative or absolute path. INTERFACCIA della riga di comando Azure Sphere V1Azure Sphere CLI v1
-p,--hardwaredefinitions-p, --hardwaredefinitions stringString Specifica il percorso facoltativo di un file JSON di definizione hardware usato per eseguire il mapping dei nomi delle periferiche in app_manifest.jsai valori sottostanti.Specifies the optional path to a hardware definition JSON file that is used to map peripheral names in app_manifest.json to underlying values. È possibile fornire un percorso relativo o assoluto.You may provide a relative or absolute path. Per altre informazioni, vedere Definizione dell'hardware.See hardware definition for more information. INTERFACCIA della riga di comando Azure Sphere V1Azure Sphere CLI v1
-s,--targetapiset-s, --targetapiset stringString Specifica il nome del set di API di destinazione usato durante la compilazione.Specifies the name of the target API set used during compilation. Obbligatorio per le app di alto livello se non è specificato nel manifesto dell'applicazione.Required for high-level apps if not specified in the app manifest. Non obbligatorio per RTApps.Not required for RTApps. INTERFACCIA della riga di comando Azure Sphere V1Azure Sphere CLI v1
-f,--targetdefinitionfilename-f, --targetdefinitionfilename stringString Specifica il nome del file di definizione di destinazione hardware utilizzato per eseguire il mapping dei nomi delle periferiche in app_manifest.js.Specifies name of the hardware target definition file used to map peripheral names in app_manifest.json. Deve essere specificato se l'applicazione usa definizioni hardware.It must be provided if the application uses hardware definitions. INTERFACCIA della riga di comando Azure Sphere V1Azure Sphere CLI v1
-a,--application-manifest-Path-a, --application-manifest-path stringString Specifica il percorso del file manifesto dell'applicazione.Specifies the path to the application manifest file. Può trattarsi di un file JSON o di una directory che contiene app_manifest.js.This can be a JSON file or a directory which contains app_manifest.json. È possibile fornire un percorso relativo o assoluto.You may provide a relative or absolute path. Interfaccia della riga di comando di Azure Sphere v2 BetaAzure Sphere CLI v2 Beta
--hardware-definizioni--hardware-definitions stringString Specifica il percorso facoltativo di un file JSON di definizione hardware usato per eseguire il mapping dei nomi delle periferiche in app_manifest.jsai valori sottostanti.Specifies the optional path to a hardware definition JSON file that is used to map peripheral names in app_manifest.json to underlying values. È possibile fornire un percorso relativo o assoluto.You may provide a relative or absolute path. Per altre informazioni, vedere Definizione dell'hardware.See hardware definition for more information. INTERFACCIA della riga di comando Azure Sphere V1Azure Sphere CLI v1
--target-API-set--target-api-set stringString Specifica il nome del set di API di destinazione usato durante la compilazione.Specifies the name of the target API set used during compilation. Obbligatorio per le app di alto livello se non è specificato nel manifesto dell'applicazione.Required for high-level apps if not specified in the app manifest. Non obbligatorio per RTApps.Not required for RTApps. Interfaccia della riga di comando di Azure Sphere v2 BetaAzure Sphere CLI v2 Beta
--target-Definition-filename--target-definition-filename stringString Specifica il nome del file di definizione di destinazione hardware utilizzato per eseguire il mapping dei nomi delle periferiche in app_manifest.js.Specifies name of the hardware target definition file used to map peripheral names in app_manifest.json. Deve essere specificato se l'applicazione usa definizioni hardware.It must be provided if the application uses hardware definitions. Interfaccia della riga di comando di Azure Sphere v2 BetaAzure Sphere CLI v2 Beta
Parametri globaliGlobal parameters

Per l'interfaccia della riga di comando di Azure Sphere sono disponibili i parametri globali seguenti:The following global parameters are available for the Azure Sphere CLI:

ParametroParameter DescrizioneDescription
--debug--debug Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.Increases logging verbosity to show all debug logs. Se si rilevano bug, fornire l'output generato con il flag --debug attivato quando si invia la segnalazione.If you find a bug, provide output generated with the --debug flag on when submitting a bug report.
-h, --help-h, --help Stampa le informazioni di riferimento dell'interfaccia della riga di comando sui comandi e i relativi argomenti ed elenca i sottogruppi e i comandi disponibili.Prints CLI reference information about commands and their arguments and lists available subgroups and commands.
--only-show-errors--only-show-errors Mostra solo gli errori, evitando gli avvisi.Shows only errors, suppressing warnings.
-o, --output-o, --output Modifica il formato di output.Changes the output format. I formati di output disponibili sono JSON, jsonc (colori JSON), TSV (valori delimitati da tabulazioni), tabelle (tabelle ASCII leggibili) e YAML.The available output formats are json, jsonc (colorized JSON), tsv (Tab-Separated Values), table (human-readable ASCII tables), and yaml. Per impostazione predefinita, l'output dell'interfaccia della riga di comando è in formato table.By default the CLI outputs table. Per altre informazioni sui formati di output disponibili, vedere il formato di output per i comandi dell'interfaccia della riga di comando Azure Sphere.To learn more about the available output formats, see Output format for Azure Sphere CLI commands.
--query--query Usa il linguaggio di query JMESPath per filtrare l'output restituito da Azure Sphere servizi di sicurezza.Uses the JMESPath query language to filter the output returned from Azure Sphere Security Services. Per altre informazioni ed esempi, vedere esercitazione su JMESPath ed eseguire query sull'output del comando dell'interfaccia della riga di comandoSee JMESPath tutorial and Query Azure CLI command output for more information and examples.
--verbose--verbose Stampa le informazioni sulle risorse create in Azure Sphere durante un'operazione e altre informazioni utili.Prints information about resources created in Azure Sphere during an operation and other useful information. Usare --debug per i log di debug completi.Use --debug for full debug logs.

Nota

Se si usa Azure Sphere interfaccia della riga di comando classica, vedere parametri globali per ulteriori informazioni sulle opzioni disponibili.If you are using Azure Sphere classic CLI, see Global parameters for more information on available options.

EsempioExample

azsphere image-package pack-application --input C:\AppSamples\LocalSamples\HelloWorld\HelloWorld_HighLevelApp\out\ARM-Debug\approotHelloWorld_HighLevelApp --output myimage.imagepackage

pack-board-configpack-board-config

Crea un pacchetto immagine di configurazione della scheda.Creates a board configuration image package. Si può usare un'immagine di configurazione della scheda preimpostata oppure specificare un'immagine di configurazione personalizzata.You can either use a preset board configuration image or provide a custom configuration image.

Parametri obbligatoriRequired parameters

ParametroParameter TipoType DescrizioneDescription Versione supportataSupported version
-o, --output-o, --output filenamefilename Specifica un nome file per il pacchetto immagine di output.Specifies a filename for the output image package. INTERFACCIA della riga di comando Azure Sphere V1Azure Sphere CLI v1
-f,--Destination-file-f, --destination-file filenamefilename Specifica un nome file per il pacchetto immagine di output.Specifies a filename for the output image package. Interfaccia della riga di comando di Azure Sphere v2 BetaAzure Sphere CLI v2 Beta

Parametri facoltativiOptional parameters

ParametroParameter TipoType DescrizioneDescription Versione supportataSupported version
-i,--input-i, --input PercorsoPath Identifica il percorso dell'immagine di configurazione della scheda.Identifies the path to the board configuration image. È possibile aggiungere più immagini aggiungendo parametri aggiuntivi oppure è possibile combinare più percorsi in un singolo parametro in un elenco delimitato da virgole.You can add multiple images by adding additional parameters, or multiple paths can be combined in a single parameter in a comma-separated list. Se incluso, non è possibile usare --preset perché i due parametri si escludono a vicenda.If this is included, --preset must not be used; the two parameters are mutually exclusive. -Azure Sphere CLI V1- Azure Sphere CLI v1
-Azure Sphere interfaccia della riga di comando v2 beta- Azure Sphere CLI v2 Beta
-n, --name-n, --name Nome pacchettopackage-name Imposta il nome del pacchetto immagine nei metadati del file creato.Sets the image package name in the created file's metadata. Se non specificato, verrà generato un nuovo nome in base alla configurazione della scheda specificata, che include parte dell'ID componente per univocità.If not provided, a new name will be generated based on the provided board configuration, incorporating part of the component ID for uniqueness. -Azure Sphere CLI V1- Azure Sphere CLI v1
-Azure Sphere interfaccia della riga di comando v2 beta- Azure Sphere CLI v2 Beta
-p, --preset-p, --preset stringString Specifica l'ID dell'immagine di configurazione della scheda preimpostata da applicare.Provides the ID of the preset board configuration image to apply. Usare questo flag con l'ID di un pacchetto preimpostato oppure specificare --input per un'immagine di configurazione della scheda personalizzata.Either use this flag with the ID of a preset package, or provide --input for a custom board configuration image. L'ID è un valore di enumerazione ed è attualmente impostato sul singolo valore fisso "lan enc28j60-isu0 int5".The ID is an enumeration value and is currently fixed to the single value "lan-enc28j60-isu0-int5". -Azure Sphere CLI V1- Azure Sphere CLI v1
-Azure Sphere interfaccia della riga di comando v2 beta- Azure Sphere CLI v2 Beta
Parametri globaliGlobal parameters

Per l'interfaccia della riga di comando di Azure Sphere sono disponibili i parametri globali seguenti:The following global parameters are available for the Azure Sphere CLI:

ParametroParameter DescrizioneDescription
--debug--debug Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.Increases logging verbosity to show all debug logs. Se si rilevano bug, fornire l'output generato con il flag --debug attivato quando si invia la segnalazione.If you find a bug, provide output generated with the --debug flag on when submitting a bug report.
-h, --help-h, --help Stampa le informazioni di riferimento dell'interfaccia della riga di comando sui comandi e i relativi argomenti ed elenca i sottogruppi e i comandi disponibili.Prints CLI reference information about commands and their arguments and lists available subgroups and commands.
--only-show-errors--only-show-errors Mostra solo gli errori, evitando gli avvisi.Shows only errors, suppressing warnings.
-o, --output-o, --output Modifica il formato di output.Changes the output format. I formati di output disponibili sono JSON, jsonc (colori JSON), TSV (valori delimitati da tabulazioni), tabelle (tabelle ASCII leggibili) e YAML.The available output formats are json, jsonc (colorized JSON), tsv (Tab-Separated Values), table (human-readable ASCII tables), and yaml. Per impostazione predefinita, l'output dell'interfaccia della riga di comando è in formato table.By default the CLI outputs table. Per altre informazioni sui formati di output disponibili, vedere il formato di output per i comandi dell'interfaccia della riga di comando Azure Sphere.To learn more about the available output formats, see Output format for Azure Sphere CLI commands.
--query--query Usa il linguaggio di query JMESPath per filtrare l'output restituito da Azure Sphere servizi di sicurezza.Uses the JMESPath query language to filter the output returned from Azure Sphere Security Services. Per altre informazioni ed esempi, vedere esercitazione su JMESPath ed eseguire query sull'output del comando dell'interfaccia della riga di comandoSee JMESPath tutorial and Query Azure CLI command output for more information and examples.
--verbose--verbose Stampa le informazioni sulle risorse create in Azure Sphere durante un'operazione e altre informazioni utili.Prints information about resources created in Azure Sphere during an operation and other useful information. Usare --debug per i log di debug completi.Use --debug for full debug logs.

Nota

Se si usa Azure Sphere interfaccia della riga di comando classica, vedere parametri globali per ulteriori informazioni sulle opzioni disponibili.If you are using Azure Sphere classic CLI, see Global parameters for more information on available options.

EsempioExample

azsphere image-package pack-board-config --preset lan-enc28j60-isu0-int5 --output board2.imagepackage

showshow

Visualizza le informazioni su un pacchetto immagini.Displays information about an image package.

Parametri obbligatoriRequired parameters

ParametroParameter TipoType DescrizioneDescription Versione supportataSupported version
-f,--FilePath-f, --filepath stringString Specifica il percorso del pacchetto immagine.Specifies the path to the image package. È possibile specificare un percorso relativo o assoluto.You can provide a relative or absolute path. INTERFACCIA della riga di comando Azure Sphere V1Azure Sphere CLI v1
-f,--file-path-f, --file-path stringString Specifica il percorso del pacchetto immagine.Specifies the path to the image package. È possibile specificare un percorso relativo o assoluto.You can provide a relative or absolute path. Interfaccia della riga di comando di Azure Sphere v2 BetaAzure Sphere CLI v2 Beta
Parametri globaliGlobal parameters

Per l'interfaccia della riga di comando di Azure Sphere sono disponibili i parametri globali seguenti:The following global parameters are available for the Azure Sphere CLI:

ParametroParameter DescrizioneDescription
--debug--debug Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.Increases logging verbosity to show all debug logs. Se si rilevano bug, fornire l'output generato con il flag --debug attivato quando si invia la segnalazione.If you find a bug, provide output generated with the --debug flag on when submitting a bug report.
-h, --help-h, --help Stampa le informazioni di riferimento dell'interfaccia della riga di comando sui comandi e i relativi argomenti ed elenca i sottogruppi e i comandi disponibili.Prints CLI reference information about commands and their arguments and lists available subgroups and commands.
--only-show-errors--only-show-errors Mostra solo gli errori, evitando gli avvisi.Shows only errors, suppressing warnings.
-o, --output-o, --output Modifica il formato di output.Changes the output format. I formati di output disponibili sono JSON, jsonc (colori JSON), TSV (valori delimitati da tabulazioni), tabelle (tabelle ASCII leggibili) e YAML.The available output formats are json, jsonc (colorized JSON), tsv (Tab-Separated Values), table (human-readable ASCII tables), and yaml. Per impostazione predefinita, l'output dell'interfaccia della riga di comando è in formato table.By default the CLI outputs table. Per altre informazioni sui formati di output disponibili, vedere il formato di output per i comandi dell'interfaccia della riga di comando Azure Sphere.To learn more about the available output formats, see Output format for Azure Sphere CLI commands.
--query--query Usa il linguaggio di query JMESPath per filtrare l'output restituito da Azure Sphere servizi di sicurezza.Uses the JMESPath query language to filter the output returned from Azure Sphere Security Services. Per altre informazioni ed esempi, vedere esercitazione su JMESPath ed eseguire query sull'output del comando dell'interfaccia della riga di comandoSee JMESPath tutorial and Query Azure CLI command output for more information and examples.
--verbose--verbose Stampa le informazioni sulle risorse create in Azure Sphere durante un'operazione e altre informazioni utili.Prints information about resources created in Azure Sphere during an operation and other useful information. Usare --debug per i log di debug completi.Use --debug for full debug logs.

Nota

Se si usa Azure Sphere interfaccia della riga di comando classica, vedere parametri globali per ulteriori informazioni sulle opzioni disponibili.If you are using Azure Sphere classic CLI, see Global parameters for more information on available options.

EsempioExample

azsphere image-package show --filepath C:\sample\quickstart_steps\QuickStart-AzureSphereBlink1\QuickStart-AzureSphereBlink1\out\ARM-Debug\QuickStart-AzureSphereBlink1.imagepackage
Image package metadata:
  Section: Identity
    Image Type:           Application
    Component ID:         99d419ef-296d-43b0-ade1-809efe3a7aba
    Image ID:             d788fdd1-28eb-4477-9818-a4734289f2f1
  Section: Signature
    Signing Type:         ECDsa256
    Cert:                 a8d5cc6958f48710140d7a26160fc1cfc31f5df0
  Section: Debug
    Image Name:           QuickStart-AzureSphereBlink1
    Built On (UTC):       09/07/2020 13:18:52
    Built On (Local):     09/07/2020 14:18:52
  Section: Temporary Image
    Remove image at boot: False
    Under development:    True
  Section: ABI Depends
    Depends on:           ApplicationRuntime, version 5