image-package
Important
Il s’agit de la documentation Azure Sphere (héritée). Azure Sphere (hérité) prend sa retraite le 27 septembre 2027 et les utilisateurs doivent migrer vers Azure Sphere (intégré) pour l’instant. Utilisez le sélecteur de version situé au-dessus du TOC pour afficher la documentation Azure Sphere (intégrée).
Gère les images Azure Sphere sur le disque.
| Operation | Description |
|---|---|
| pack-application | Crée un package d’image. |
| pack-board-config | Crée un package d’image de configuration de tableau. |
| show | Affiche des détails sur un package d’images. |
pack-application
Crée une application exécutable à partir d’une image liée compilée et d’un fichier app_manifest.json.
Les applications en temps réel sont générées en tant que fichiers ELF ou AXF, non en tant que fichiers binaires bruts. Avant d’empaqueter une application en temps réel, modifiez le fichier du manifeste de l’application de façon que ApplicationType soit défini sur « RealTimeCapable », et EntryPoint sur le nom du fichier ELF ou AXF qui doit figurer à la racine du répertoire de l’application.
Conseil
Cette commande est exécutée lorsque vous générez une application de haut niveau ou une application compatible en temps réel à l’aide de Visual Studio Code ou de Visual Studio.
- Le processus de génération crée un répertoire approot<app-name> , qui est le répertoire d’entrée spécifié dans le
--package-directoryparamètre. - Le fichier manifeste de l’application est fourni dans le
--application-manifestparamètre. - Pour les applications de haut niveau, une version du runtime d’application est fournie dans le
--target-api-setparamètre.
Paramètres obligatoires
| Paramètre | Type | Description |
|---|---|---|
| --destination | Chemin d’accès au package d’images | Spécifie un chemin et un nom de fichier pour le package d’image de sortie. |
| --package-directory | Chemin d’accès à approot_folder | Identifie le répertoire d’entrée, qui est utilisé comme racine du système pour le fichier image Azure Sphere. Le fichier app_manifest.json de l’application doit se trouver dans ce répertoire. |
Paramètres facultatifs
| Paramètre | Type | Description |
|---|---|---|
| -a, --application-manifest | Chaîne | Spécifie le chemin d’accès au fichier manifeste de l’application. Il peut s’agir d’un fichier JSON ou d’un répertoire qui contient app_manifest.json. Vous pouvez fournir un chemin d’accès relatif ou absolu. |
| --hardware-definitions | Chaîne | Spécifie une liste facultative de chemins d’accès séparés par des espaces vers les répertoires contenant des fichiers JSON (Hardware Definition). Les valeurs des fichiers sont utilisées pour mapper les noms de périphériques dans app_manifest.json aux valeurs sous-jacentes. Vous pouvez fournir un chemin relatif ou absolu. Pour plus d’informations, voir Définition matérielle. |
| --target-api-set | Chaîne | Spécifie le nom du jeu d’API cible utilisé pendant la compilation. Obligatoire pour les applications de haut niveau s’il n’est pas spécifié dans le manifeste de l’application. Non requis pour rtApps. |
| --target-definition-filename | Chaîne | Spécifie le nom du fichier de définition de cible matérielle utilisé pour mapper les noms de périphériques dans app_manifest.json. Elle doit être fournie si l’application utilise des définitions matérielles. |
| -x, --exécutables | exécutable1, exécutable2 ... | Spécifie les chemins d’accès à un ou plusieurs fichiers à marquer comme exécutables dans le package d’image. L’élément EntryPoint figurant dans les fichiers app_manifest est toujours marqué comme exécutable. L’indicateur -x est donc nécessaire uniquement en présence d’autres exécutables. Par défaut, les fichiers ne sont pas exécutables quand ils sont empaquetés dans une image. Les sous-chemins sont relatifs au chemin des exécutables. Les chemins prennent en charge la syntaxe de nom de fichier Windows (barres obliques inverses) ou la syntaxe de nom de fichier Linux (barres obliques), mais les points-virgules, les virgules et les espaces ne sont pas autorisés. Vous pouvez spécifier -x pour chaque fichier exécutable, ou le spécifier une seule fois et fournir plusieurs chemins séparés par des virgules, sans espaces. |
Paramètres globaux
Les paramètres globaux suivants sont disponibles pour l’interface CLI Azure Sphere :
| Paramètre | Description |
|---|---|
| --debug | Augmente la détail de journalisation pour afficher tous les journaux de débogage. Si vous rencontrez un bogue, fournissez la sortie générée avec l’indicateur --debug lors de l’envoi d’un rapport de bogue. |
| -h, --help | Imprime les informations de référence cli sur les commandes et leurs arguments et listes disponibles sous-groupes et commandes. |
| --only-show-errors | Affiche uniquement les erreurs, en supprimant les avertissements. |
| -o, --output | Modifie le format de sortie. Les formats de sortie disponibles sont json, jsonc (JSON colorisé), tsv (Valeurs séparées par des tabulations), table (tables ASCII lisibles par l’homme) et yaml. Par défaut, l’interface CLI génère table. Pour en savoir plus sur les formats de sortie disponibles, consultez le format de sortie pour les commandes CLI Azure Sphere. |
| --query | Utilise le langage de requête JMESPath pour filtrer la sortie retournée par les services de sécurité Azure Sphere. Pour plus d’informations et d’exemples, consultez le didacticiel JMESPath et interrogez la sortie de commande Azure CLI. |
| --verbose | Imprime des informations sur les ressources créées dans Azure Sphere pendant une opération et d’autres informations utiles. Utilisez --debug pour les journaux de débogage complets. |
Remarque
Si vous utilisez Azure Sphere Classic CLI, consultez les paramètres globaux pour plus d’informations sur les options disponibles.
Exemple
azsphere image-package pack-application --package-directory C:\AppSamples\LocalSamples\HelloWorld\HelloWorld_HighLevelApp\out\ARM-Debug\approotHelloWorld_HighLevelApp --destination myimage.imagepackage
pack-board-config
Crée un package d’image de configuration de tableau. Vous pouvez utiliser une image de configuration de carte prédéfinie ou fournir une image de configuration personnalisée.
Paramètres obligatoires
| Paramètre | Type | Description |
|---|---|---|
| --destination | Chaîne | Spécifie un chemin d’accès au nom de fichier de sortie du package d’image résultant. |
Paramètres facultatifs
| Paramètre | Type | Description |
|---|---|---|
| --board-config-file | Chemin d’accès | Identifie le chemin de l’image de configuration de tableau. Si cela est inclus, --preset ne doit pas être utilisé ; les deux paramètres s’excluent mutuellement. |
| -n,--name | Chaîne | Définit le nom du package d’image dans les métadonnées du fichier créé. S’il n’est pas donné, un nouveau nom est généré en fonction de la configuration de carte fournie, et en incorporant une partie de l’ID de composant pour le rendre unique. |
| -p, --preset | Chaîne | Fournit l’ID de l’image de configuration de carte prédéfinie à appliquer. Entrez l’ID d’un package prédéfini ou fournissez un chemin d’accès pour le fichier de configuration de carte à l’aide du --board-config-file paramètre d’une image de configuration de carte personnalisée. L’ID est une valeur d’énumération et est actuellement fixe à la valeur lan-enc28j60-isu0-int5unique. |
Paramètres globaux
Les paramètres globaux suivants sont disponibles pour l’interface CLI Azure Sphere :
| Paramètre | Description |
|---|---|
| --debug | Augmente la détail de journalisation pour afficher tous les journaux de débogage. Si vous rencontrez un bogue, fournissez la sortie générée avec l’indicateur --debug lors de l’envoi d’un rapport de bogue. |
| -h, --help | Imprime les informations de référence cli sur les commandes et leurs arguments et listes disponibles sous-groupes et commandes. |
| --only-show-errors | Affiche uniquement les erreurs, en supprimant les avertissements. |
| -o, --output | Modifie le format de sortie. Les formats de sortie disponibles sont json, jsonc (JSON colorisé), tsv (Valeurs séparées par des tabulations), table (tables ASCII lisibles par l’homme) et yaml. Par défaut, l’interface CLI génère table. Pour en savoir plus sur les formats de sortie disponibles, consultez le format de sortie pour les commandes CLI Azure Sphere. |
| --query | Utilise le langage de requête JMESPath pour filtrer la sortie retournée par les services de sécurité Azure Sphere. Pour plus d’informations et d’exemples, consultez le didacticiel JMESPath et interrogez la sortie de commande Azure CLI. |
| --verbose | Imprime des informations sur les ressources créées dans Azure Sphere pendant une opération et d’autres informations utiles. Utilisez --debug pour les journaux de débogage complets. |
Remarque
Si vous utilisez Azure Sphere Classic CLI, consultez les paramètres globaux pour plus d’informations sur les options disponibles.
Exemple
azsphere image-package pack-board-config --preset lan-enc28j60-isu0-int5 --destination board2.imagepackage
show
Affiche les informations d’un package d’image.
Paramètres obligatoires
| Paramètre | Type | Description |
|---|---|---|
| -f, --image-package | Chaîne | Spécifie le chemin du package d’image. Vous pouvez fournir un chemin relatif ou absolu. |
Paramètres globaux
Les paramètres globaux suivants sont disponibles pour l’interface CLI Azure Sphere :
| Paramètre | Description |
|---|---|
| --debug | Augmente la détail de journalisation pour afficher tous les journaux de débogage. Si vous rencontrez un bogue, fournissez la sortie générée avec l’indicateur --debug lors de l’envoi d’un rapport de bogue. |
| -h, --help | Imprime les informations de référence cli sur les commandes et leurs arguments et listes disponibles sous-groupes et commandes. |
| --only-show-errors | Affiche uniquement les erreurs, en supprimant les avertissements. |
| -o, --output | Modifie le format de sortie. Les formats de sortie disponibles sont json, jsonc (JSON colorisé), tsv (Valeurs séparées par des tabulations), table (tables ASCII lisibles par l’homme) et yaml. Par défaut, l’interface CLI génère table. Pour en savoir plus sur les formats de sortie disponibles, consultez le format de sortie pour les commandes CLI Azure Sphere. |
| --query | Utilise le langage de requête JMESPath pour filtrer la sortie retournée par les services de sécurité Azure Sphere. Pour plus d’informations et d’exemples, consultez le didacticiel JMESPath et interrogez la sortie de commande Azure CLI. |
| --verbose | Imprime des informations sur les ressources créées dans Azure Sphere pendant une opération et d’autres informations utiles. Utilisez --debug pour les journaux de débogage complets. |
Remarque
Si vous utilisez Azure Sphere Classic CLI, consultez les paramètres globaux pour plus d’informations sur les options disponibles.
Exemple
azsphere image-package show --image-package 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