Поделиться через

CLI Azure Sphere

  • Статья

Внимание

Это документация по Azure Sphere (устаревшая версия). Служба Azure Sphere (устаревшая версия) выходит на пенсию 27 сентября 2027 г., и к этому времени пользователи должны перейти в Azure Sphere (интегрированная). Используйте селектор версий, расположенный над toC, чтобы просмотреть документацию по Azure Sphere (интегрированная).

Пакет SDK Для Azure Sphere предоставляет интерфейс командной строки Azure Sphere (CLI), доступный в PowerShell, командной строке Windows или командной оболочке Linux. Azure Sphere CLI — это набор команд, используемых для создания ресурсов Azure Sphere и управления ими.

Интерфейс командной строки Azure Sphere устанавливается вместе с классическим интерфейсом командной строки Azure Sphere в Windows и Linux, поэтому у вас есть доступ к обоим интерфейсам. Чтобы использовать Интерфейс командной строки Azure Sphere, выполните приведенные действия.

  • В Windows используйте PowerShell или стандартную командную строку Windows.
  • В Linux используйте любую командную оболочку.

Запуск интерфейса командной строки Azure Sphere

Теперь вы можете запустить Интерфейс командной строки Azure Sphere с azsphere помощью команды из командной строки Windows или PowerShell. Мы рекомендуем PowerShell, так как она предлагает функцию завершения вкладки, которая недоступна в командной строке Windows.

В Linux вы можете запустить Интерфейс командной строки Azure Sphere из любого интерфейса командной строки (CLI). Во время установки отображается уведомление, позволяющее задать azure Sphere CLI или классический интерфейс командной строки Azure Sphere в качестве предпочтительной версии интерфейса командной строки по умолчанию. Введите Yes для выбора интерфейса командной строки Azure Sphere или типа No для использования классического интерфейса командной строки Azure Sphere. Дополнительные сведения см. в статье "Установка пакета SDK Azure Sphere".

Примечание.

Короткая форма команд не поддерживается в версии Azure Sphere CLI. Мы рекомендуем использовать функцию завершения вкладки для просмотра списка доступных команд. В Windows ярлык командной строки классической командной строки разработчика Azure Sphere можно использовать только с классическим интерфейсом командной строки Azure Sphere.

Функции ввода ИНТЕРФЕЙСА командной строки

В этом разделе описываются входные функции, доступные в Azure Sphere CLI:

Команды

Все команды в интерфейсе командной строки Azure Sphere начинаются с azsphere. Например:

azsphere login
 ---------------------
 Name
 =====================
 bob@contoso.com
 ---------------------

Поиск команд

Команды в интерфейсе командной строки организованы в группах. Вы можете просмотреть полные сведения о доступных командах и параметрах с помощью --help классического интерфейса командной строки Azure Sphere и Интерфейса командной строки Azure Sphere.

Полный список команд можно получить, выполнив команду azsphere --help.

Например:

  • Для использования azsphere --help классического интерфейса командной строки Azure Sphere или azsphere -?
  • Для использования azsphere --help интерфейса командной строки Azure Sphere или azsphere -h

Параметры

Имя параметра предшествует двойным дефисом (-), который сигнализирует о том, что слово, следующее за дефисом, является параметром. Используйте пробел для разделения имени и значения параметра. Параметры, которые являются составными словами, разделены дефисом (-) в новом интерфейсе командной строки.

Например: --component-id или --application-update.

Упрощенная идентификация объектов

В Azure Sphere CLI используется один параметр для идентификации каждого типа объекта. Это означает, что можно указать идентификатор, имя, IP-адрес или расположение, применимое для этого параметра.

Например, можно использовать идентификатор клиента или имя клиента в следующей команде:

azsphere device list --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb

or

azsphere device list --tenant MyTenant

Это было реализовано для --deviceпараметров , --tenant--productи --device-group для параметров.

Например:

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
   ------------------------------------ ------------------------------------ ---------- ------------------------------------ --------- ---------------------- ---------------------------------------------------------- -------------------------

Несколько значений

Некоторые команды позволяют использовать несколько значений для одного параметра, в этом случае можно указать параметр с каждым значением или один параметр, за которым следует список значений, разделенных пробелами. Например, следующие две команды эквивалентны:

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

Обязательные и необязательные параметры

При запуске azsphere <command> <sub-command> --help списка параметров, применимых к этой команде, отображается. Параметр [Обязательный] указывает, является ли параметр обязательным для успешного выполнения команды. Все остальные параметры являются необязательными.

Если обязательный параметр отсутствует, вам будет предложено ввести значение для параметра.

Например:

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.

Пути ввода и вывода

В Azure Sphere CLI имена параметров, используемые для указания пути и имени файла, были обновлены для контекста команды.

Например:

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

--package-directory Здесь указывается входной каталог для пакета и --destination параметра, указывающий путь и имя файла для результирующего пакета образа.

Заполнение нажатием клавиши TAB

Завершение вкладки предоставляет помощь в автоматическом выполнении записи команды в интерфейсе командной строки. В завершении вкладки CLI Azure Sphere поддерживается для групп, команд, имен параметров и значений параметров. Введите несколько символов команды, а затем нажмите клавишу TAB , чтобы выбрать нужный текст завершения. Если с изначально введенного текста начинается несколько элементов, нажимайте клавишу TAB, пока не появится нужный.

В Windows PowerShell 7.1 предоставляет функцию завершения вкладки, которая недоступна в командной строке Windows.

Чтобы включить завершение вкладки в Windows PowerShell, выполните команду Import-Module -name AzsphereCli. Эта команда включает завершение вкладки только для сеанса. Вы можете добавить скрипт в профиль PowerShell, чтобы настроить среду и включить завершение вкладки для каждого запуска сеанса PowerShell.

В Linux Azure Sphere CLI поддерживает функцию завершения вкладок для команд в оболочке Bash.

Кроме того, автозавершение помогает обнаруживать команды, параметры и значения параметров, доступные для использования. Это доступно с помощью КЛАВИШ CTRL+ПРОБЕЛ в Windows PowerShell или дважды нажмите клавишу TAB в оболочке Linux Bash.

Например, введите команду azsphere product update и используйте автозавершение, чтобы просмотреть список доступных параметров.

Параметры автозаполнения PowerShell

Аналогичным образом введите azsphere product update --product и используйте автозавершение, чтобы просмотреть список доступных продуктов в клиенте.

Продукты автозаполнения PowerShell

Интерактивный режим (предварительная версия)

Внимание

Эта функция находится в режиме предварительного просмотра. Его можно изменить или удалить в будущем выпуске.

Новый интерфейс командной строки предлагает интерактивный режим, который автоматически отображает сведения о справке и упрощает выбор команд, вложенных команд, параметров и значений параметров. Введите интерактивный режим с помощью команды azsphere interactive. Командная строка изменится, чтобы azsphere>> указать, что теперь выполняются команды в интерактивной оболочке. Дополнительные сведения см . в интерактивном режиме Интерфейса командной строки Azure Sphere.

Интерактивный режим Azure Sphere

Выходные функции CLI

В этом разделе описываются выходные функции, доступные в Azure Sphere CLI:

В следующих разделах описываются выходные функции, доступные в новом интерфейсе командной строки:

Поддерживаемые форматы выходных данных

Доступные форматы выходных данных в новом интерфейсе командной строки json: jsonc (цветные JSON), tsv (разделенные табуляции), table (таблицы ASCII, доступные для чтения человеком) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в статье "Поддерживаемые форматы выходных данных" для Azure Sphere CLI.

Перенаправление и разбиение на страницы

Интерфейс командной строки Azure Sphere не поддерживает интерактивную разбивку на страницы. Однако вы можете перенаправить стандартные выходные данные команды в файл. В следующем примере командная строка Windows, Windows PowerShell и Оболочка Linux Bash отправляют стандартные выходные данные в output.txt, а стандартная ошибка отправляется в logs.txt.

azsphere device list --verbose > output.txt 2> logs.txt

Вы также можете разбиение выходных данных на экране путем подключения к существующим средствам разбиения на страницы.

Например:

  • В PowerShell (Windows): azsphere device list | Out-Host –Paging
  • В командной строке (Windows): azsphere device list | more
  • В оболочке Bash (Linux): azsphere device list | less

Примечание.

Эта операция может быть медленной в зависимости от количества возвращаемых данных.

Дополнительные сведения о разбивке на страницы для классического интерфейса командной строки Azure Sphere см. в статье "Перенаправление по страницам" и перенаправление результатов.

Выходные данные команды CLI запроса

Azure Sphere CLI использует --query аргумент для выполнения запроса JMESPath в результатах команд. JMESPath — это язык запросов для JSON, который позволяет выбирать и изменять выходные данные команд CLI. Запросы выполняются в выходных данных JSON перед отображением форматирования.

Аргумент --query поддерживается всеми командами в Azure Sphere CLI. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.

обратная совместимость

Интерфейс командной строки поддерживает обратную совместимость. В каждом выпуске мы стремимся обеспечить обратную совместимость входных данных (имен команд, имен параметров, значений параметров) и выходных данных в ФОРМАТЕ JSON и YAML. В случаях, когда такая совместимость невозможна, перед внесением изменений мы предоставим по крайней мере 6 месяцев уведомление. Дополнительные сведения см. в разделе "Важные изменения" (отставные функции) в Azure Sphere CLI.

Коды выхода

Успешная команда возвращает ноль. Любое ненулевое значение может быть интерпретировано как код ошибки. При успешном выполнении выходные данные JSON и YAML имеют обратную совместимость договорной гарантии.

Предоставление отзыва

Если в Azure Sphere обнаружена ошибка, отправьте проблему на GitHub. Чтобы предоставить отзыв из командной строки, используйте команду обратной связи.

Эффективное использование Интерфейса командной строки Azure Sphere

Интерфейс командной строки Azure Sphere можно использовать из Bash, PowerShell или окна командной строки. Ниже приведены несколько советов по использованию интерфейса командной строки.

  • Использование кавычек в значениях: если указать параметр, содержащий пробелы, заключите его в кавычки. В Bash и PowerShell интерпретируются как одинарные, так и двойные кавычки. В командной строке Windows интерпретируются только двойные кавычки. Одинарные кавычки всегда считаются частью значения. Например, azsphere product create --name "My Fridge Product". Дополнительные сведения см. в кавычках и escape-символах.
  • Многие команды Azure Sphere отображают сведения в консоли в формате по умолчанию table . Например, azsphere product device-group list --product DW100. Иногда отображаемые сведения не соответствуют консоли правильно. Это может привести к проблемам, если вы хотите скопировать и вставить сведения. Рекомендуется попробовать следующие варианты:
    • Измените размер консоли и снова запустите команду.
    • Используйте выходные данные JSON для кратких выходных данных и сценариев. Например, azsphere product device-group list --product DW100 --output json.
    • Используйте завершение вкладок в оболочке Windows PowerShell или Bash, чтобы автоматически завершить запись команды.
    • Используйте интерактивный режим, предоставляющий интерактивную среду для автоматического отображения информации и упрощения выбора команд и вложенных команд. Введите интерактивный режим с помощью команды azsphere interactive. Командная строка изменяется на azsphere>> , чтобы указать, что вы выполняете команды в интерактивной оболочке.

См. также