image-package
Управляет образами Azure Sphere на диске.
| Операции | Описание |
|---|---|
| pack-application | Создает пакет образа. |
| pack-board-config | Создает пакет образа конфигурации платы. |
| Показать | Отображает сведения о пакете изображений. |
pack-application
Создает исполняемое приложение на основе скомпилированного и связанного образа и файла app_manifest.json.
Приложения с поддержкой реального времени (RTApp) создаются как файлы ELF или AXF, а не как необработанные двоичные файлы. Перед упаковкой RTApp измените файл манифеста приложения, чтобы для параметра ApplicationType было задано значение RealTimeCapable, а для EntryPoint — имя ФАЙЛА ELF или AXF, который должен находиться в корневой папке приложения.
Совет
Эта команда выполняется при создании высокоуровневого приложения или приложения с поддержкой реального времени с помощью Visual Studio Code или Visual Studio.
- В процессе сборки создается каталог approot<app-name> , который является входным каталогом, указанным в параметре
--package-directory. - Файл манифеста приложения предоставляется в параметре
--application-manifest. - Для высокоуровневых приложений в параметре
--target-api-setуказана версия среды выполнения приложения.
Обязательные параметры
| Параметр | Тип | Описание |
|---|---|---|
| --Назначения | Путь к пакету изображений | Указывает путь и имя файла для выходного пакета изображения. |
| --package-directory | Путь к approot_folder | Определяет входной каталог, который используется в качестве системного корневого каталога для файла образа Azure Sphere. Файл app_manifest.json для приложения должен находиться в этом каталоге. |
Необязательные параметры
| Параметр | Тип | Описание |
|---|---|---|
| -a, --application-manifest | Строка | Указывает путь к файлу манифеста приложения. Это может быть JSON-файл или каталог, содержащий app_manifest.json. Можно указать относительный или абсолютный путь. |
| --hardware-definitions | Строка | Указывает необязательный разделенный пробелами список путей к каталогам, содержащим файлы определения оборудования (JSON). Значения из файлов используются для сопоставления имен периферийных устройств в app_manifest.json с базовыми значениями. Можно указать относительный или абсолютный путь. Дополнительные сведения см. в разделе Определение оборудования . |
| --target-api-set | Строка | Указывает имя целевого набора API, используемого во время компиляции. Требуется для высокоуровневых приложений, если не указано в манифесте приложения. Не требуется для RTApp. |
| --target-definition-filename | Строка | Указывает имя файла определения целевого оборудования, используемого для сопоставления имен периферийных устройств в app_manifest.json. Он должен быть указан, если приложение использует определения оборудования. |
| -x, --исполняемые файлы | исполняемый1,исполняемый2 ... | Указывает пути к одному или нескольким файлам, которые помечают как исполняемые в пакете образа. Элемент EntryPoint, указанный в файлах app_manifest, всегда помечается как исполняемый, поэтому флаг -x требуется только при наличии других исполняемых файлов. По умолчанию файлы не являются исполняемыми при упаковке в образ. Вложенные пути относятся к пути к исполняемым файлам. В путях может использоваться синтаксис имени файла Windows (обратные косые черты) или синтаксис имени файла Linux (косая черта); Пробелы, запятые и точка с запятой не допускаются. Можно либо указать -x для каждого исполняемого файла, либо использовать его только один раз и указать несколько путей, разделенных запятыми, без промежуточных пробелов. |
Глобальные параметры
Для Azure Sphere CLI доступны следующие глобальные параметры:
| Параметр | Описание |
|---|---|
| --Отладки | Повышает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, укажите выходные данные, созданные с флагом --debug в при отправке отчета об ошибке. |
| -h, --help | Выводит справочные сведения о командах и их аргументах, а также список доступных подгрупп и команд. |
| --only-show-errors | Отображает только ошибки, подавляющие предупреждения. |
| -o, --output | Изменяет формат вывода. Доступные форматы выходных данных: json, jsonc (цветной JSON), tsv (значения, разделенные табуляциями), таблица (читаемые человеком таблицы ASCII) и yaml. По умолчанию CLI выводит .table Дополнительные сведения о доступных форматах вывода см. в статье Формат вывода для команд Azure Sphere CLI. |
| --Запроса | Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см. в руководстве по JMESPath и запросе выходных данных команды Azure CLI . |
| --Подробного | Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другую полезную информацию. Используется --debug для полных журналов отладки. |
Примечание
Если вы используете классический интерфейс командной строки Azure Sphere, дополнительные сведения о доступных параметрах см. в статье Глобальные параметры .
Примере
azsphere image-package pack-application --package-directory C:\AppSamples\LocalSamples\HelloWorld\HelloWorld_HighLevelApp\out\ARM-Debug\approotHelloWorld_HighLevelApp --destination myimage.imagepackage
pack-board-config
Создает пакет образа конфигурации платы. Можно использовать предустановленный образ конфигурации платы или предоставить пользовательский образ конфигурации.
Обязательные параметры
| Параметр | Тип | Описание |
|---|---|---|
| --Назначения | Строка | Указывает путь к имени выходного файла для результирующего пакета изображений. |
Необязательные параметры
| Параметр | Тип | Описание |
|---|---|---|
| --board-config-file | Путь | Определяет путь к образу конфигурации платы. Если этот параметр включен, использовать не следует; --preset эти два параметра являются взаимоисключающими. |
| -n, --name | Строка | Задает имя пакета изображений в метаданных созданного файла. Если оно не указано, будет создано новое имя на основе предоставленной конфигурации платы, включив часть идентификатора компонента для уникальности. |
| -p, --preset | Строка | Предоставляет идентификатор применяемого образа конфигурации предустановленной платы. Введите идентификатор предустановленного пакета или укажите путь к файлу конфигурации платы с помощью --board-config-file параметра для пользовательского образа конфигурации платы. Идентификатор является значением перечисления и в настоящее время фиксируется в отдельном значении lan-enc28j60-isu0-int5. |
Глобальные параметры
Для Azure Sphere CLI доступны следующие глобальные параметры:
| Параметр | Описание |
|---|---|
| --Отладки | Повышает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, укажите выходные данные, созданные с флагом --debug в при отправке отчета об ошибке. |
| -h, --help | Выводит справочные сведения о командах и их аргументах, а также список доступных подгрупп и команд. |
| --only-show-errors | Отображает только ошибки, подавляющие предупреждения. |
| -o, --output | Изменяет формат вывода. Доступные форматы выходных данных: json, jsonc (цветной JSON), tsv (значения, разделенные табуляциями), таблица (читаемые человеком таблицы ASCII) и yaml. По умолчанию CLI выводит .table Дополнительные сведения о доступных форматах вывода см. в статье Формат вывода для команд Azure Sphere CLI. |
| --Запроса | Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см. в руководстве по JMESPath и запросе выходных данных команды Azure CLI . |
| --Подробного | Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другую полезную информацию. Используется --debug для полных журналов отладки. |
Примечание
Если вы используете классический интерфейс командной строки Azure Sphere, дополнительные сведения о доступных параметрах см. в статье Глобальные параметры .
Примере
azsphere image-package pack-board-config --preset lan-enc28j60-isu0-int5 --destination board2.imagepackage
Показать
Отображает сведения о пакете изображений.
Обязательные параметры
| Параметр | Тип | Описание |
|---|---|---|
| -f, --image-package | Строка | Указывает путь к пакету образа. Можно указать относительный или абсолютный путь. |
Глобальные параметры
Для Azure Sphere CLI доступны следующие глобальные параметры:
| Параметр | Описание |
|---|---|
| --Отладки | Повышает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, укажите выходные данные, созданные с флагом --debug в при отправке отчета об ошибке. |
| -h, --help | Выводит справочные сведения о командах и их аргументах, а также список доступных подгрупп и команд. |
| --only-show-errors | Отображает только ошибки, подавляющие предупреждения. |
| -o, --output | Изменяет формат вывода. Доступные форматы выходных данных: json, jsonc (цветной JSON), tsv (значения, разделенные табуляциями), таблица (читаемые человеком таблицы ASCII) и yaml. По умолчанию CLI выводит .table Дополнительные сведения о доступных форматах вывода см. в статье Формат вывода для команд Azure Sphere CLI. |
| --Запроса | Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см. в руководстве по JMESPath и запросе выходных данных команды Azure CLI . |
| --Подробного | Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другую полезную информацию. Используется --debug для полных журналов отладки. |
Примечание
Если вы используете классический интерфейс командной строки Azure Sphere, дополнительные сведения о доступных параметрах см. в статье Глобальные параметры .
Примере
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