Миграция из классического интерфейса командной строки в Azure Sphere CLI

  • Статья

Если вы по-прежнему используете классический интерфейс командной строки Azure Sphere, рекомендуется перейти на новый интерфейс командной строки Azure Sphere. В настоящее время обе версии ИНТЕРФЕЙСА командной строки можно установить и использовать параллельно, но классический интерфейс командной строки больше не обновляется и не поддерживается и будет удален из пакета SDK в будущем (не до конца 2022 г.). Мы рекомендуем ознакомиться с этими различиями и перенести процессы и скрипты до конца 2022 года, чтобы избежать сбоев.

Сведения об обновлении до последней версии пакета SDK см. в статье Установка пакета SDK Azure Sphere в Linux или Установка пакета SDK Azure Sphere для Windows.

Чтобы использовать Azure Sphere CLI в Windows, используйте PowerShell или стандартную командную строку Windows. Для Linux используйте любую командную оболочку. Дополнительные сведения см. в статье Запуск Azure Sphere CLI.

В Windows пользовательскую командную строку классического разработчика Azure Sphere (доступную как ярлык в меню "Пуск" в Azure Sphere) можно использовать только с классической командной строкой Azure Sphere. Дополнительные сведения см. в статье Запуск классического интерфейса командной строки Azure Sphere.

Ключевые различия

  • В классическом интерфейсе командной строки Azure Sphere для идентификации каждого типа объекта можно использовать несколько параметров. В Azure Sphere CLI для идентификации каждого типа объекта используется один параметр. Это означает, что для указания значения параметра можно использовать имя или идентификатор. Это реализовано для --deviceпараметров , --tenant, --productи --device-group .

    Тип объекта Azure Sphere CLI Классический интерфейс командной строки Azure Sphere (прекращение использования)
    Устройства --device --deviceid, --deviceipили --devicelocation
    Группа устройств --device-group --devicegroupid Или --devicegroupname
    Продукта --product --productid Или --productname
    Арендатор --tenant --tenantid

  • В классической версии поддерживается краткая форма для команд. В Azure Sphere CLI рекомендуется использовать функцию завершения tab или интерактивную функцию для просмотра списка доступных команд. Например, в классическом интерфейсе командной строки можно использовать команду azsphere device enable-development или azsphere dev edv , тогда как в новом интерфейсе командной строки Azure Sphere можно использовать автозавершение для быстрого ввода azsphere device enable-development команды.

  • Некоторые команды позволяют использовать несколько значений для одного параметра. В Azure Sphere CLI можно указать один параметр, за которым следует список значений, разделенных пробелами, а в классическом интерфейсе командной строки Azure Sphere список значений разделен запятыми. Например:

    azsphere image-package pack-application --package-directory myDirectory --destination myImagePackage --executables filepath-1 filepath-2

  • В новом интерфейсе командной строки клиент по умолчанию не выбирается автоматически при создании клиента. Необходимо выполнить команду azsphere tenant select , чтобы выбрать клиент по умолчанию для текущего пользователя на компьютере. Это позволяет убедиться, что клиент по умолчанию является правильным для использования при выполнении одноразовой операции, которую нельзя отменить, как утверждение устройства.

    При использовании скриптов можно выбрать клиент по умолчанию с помощью --tenant <tenant ID or tenant name> параметра .

    Задайте клиент по умолчанию в начале сценария, используя:

    azsphere tenant select --tenant <tenant ID or tenant name>

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

    azsphere get-support-data --destination logs.zip --tenant <tenant ID or tenant name>

  • Параметр --device-group идентифицирует группу устройств. Идентификатор группы устройств предоставляет идентификатор GUID, который однозначно идентифицирует группу устройств во всех продуктах. Кроме того, можно использовать пару имя продукта и имя группы устройств в <формате product-name>/<device-group-name> . Эта пара имен однозначно идентифицирует группу устройств для определенного продукта.

  • Следующие команды были составными командами в классическом интерфейсе командной строки. Это означает, что одна команда выполнила несколько задач. В новом интерфейсе командной строки необходимо выполнить две команды.

    • В классическом интерфейсе командной строки команда azsphere device-group deployment create отправила пакет образа и создала новое развертывание.

      В новом интерфейсе командной строки необходимо:

      1. Отправьте пакет образа в клиент Azure Sphere с помощью команды azsphere image add.
      2. Создайте новое развертывание для группы устройств для отправленных образов с помощью команды azsphere device-group deployment create.

    • В классическом интерфейсе командной строки скачаемая команда azsphere device capability download --select и временно выбранная конфигурация возможностей устройства для подключенного устройства.

      В новом интерфейсе командной строки необходимо:

      1. Скачайте файл возможностей с помощью команды azsphere device capability download.
      2. Выберите возможность с помощью команды azsphere device capability select.

    • В классическом интерфейсе командной строки скачайте команду azsphere device download --apply и применили конфигурацию возможностей устройства для подключенного устройства.

      В новом интерфейсе командной строки необходимо:

      1. Скачайте файл возможностей с помощью команды azsphere device capability download.
      2. Примените возможность с помощью azsphere device capability update.

  • В классическом интерфейсе командной -o строки параметр или --output используется для указания пути и имени файла для сохранения файла. В новом интерфейсе командной строки Azure Sphere контекстные параметры используются --destination для указания путей ввода и вывода.

  • В классическом интерфейсе командной -d строки параметр или --debug используется в команде azsphere device app start для запуска приложения в режиме отладки. В новом интерфейсе командной --debug-mode строки Azure Sphere параметр используется для запуска приложения в режиме отладки, а --debug параметр используется в качестве глобального параметра для повышения детализации ведения журнала для отображения всех журналов отладки.

  • В классическом интерфейсе командной строки нет контроля над форматом вывода. В Azure Sphere CLI параметр или --output используется для указания формата вывода, в котором нужно отформатировать выходные данные CLI.-o

  • Начиная с версии 21.02 явные номера версий были удалены из названий продуктов Azure Sphere CLI. Это изменение устраняет путаницу при обращении к различным версиям продукта.

    • Azure Sphere CLI версии 2 и более поздних версий теперь называются только "Azure Sphere CLI".
    • Более ранние версии Azure Sphere CLI (CLI версии 1 и более поздних версий) теперь называются классическими интерфейсами командной строки Azure Sphere.

  • Если вы используете скрипты, они могут быть несовместимы с новым интерфейсом командной строки Azure Sphere из-за различий, описанных выше. Внесите необходимые обновления для правильного выполнения скриптов в новом интерфейсе командной строки.

См. также