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


device

Внимание

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

Управляет устройствами Azure Sphere.

Операция Description
app Изменяет состояние приложений на устройстве.
capability; Управляет возможностями устройства.
сертификат Управляет хранилищем сертификатов устройств.
claim Утверждает ранее неисключаемое устройство клиенту Azure Sphere.
enable-cloud-test Настраивает устройство для отключения отладки и получения обновлений.
enable-development Настраивает устройство для локальной отладки.
Изображение Управляет изображениями для устройства.
список Отображает все устройства в клиенте.
list-attached Выводит список подключенных устройств.
производственное состояние Управляет состоянием производства подключенного устройства.
network Предоставляет сведения о состоянии сетевых интерфейсов на устройстве.
recover Использует специальный режим восстановления для загрузки нового встроенного ПО на устройство.
пересканировать присоединенное Повторно сканирует подключенные устройства в качестве помощи по устранению неполадок (только Для Windows).
restart Перезапускает подключенное устройство.
show Отображает сведения о конфигурации обновления устройства.
show-attached Отображает сведения о подключенном устройстве с самого устройства.
show-count Отображает общее количество устройств в клиенте.
show-deployment-status Отображает состояние последнего обновления развертывания.
show-os-version Отображает версию операционной системы локального устройства.
загрузка неопубликованных данных Загружает изображение на подключенное устройство.
обновить Обновляет устройство, помещая его в определенную группу устройств.
wifi Управляет конфигурацией Wi-Fi для устройства.

Приложение

Управляет приложениями на устройстве.

Для многих вариантов приложения требуется возможность appDevelopment , которую можно получить с помощью azsphere device enable-development. Чтобы запускать, останавливать или отлаживать приложения, подписанные для пакета SDK или рабочей среды, приложение должно иметь возможность appdevelopment.

Вы можете использовать azsphere device app stop и azsphere device app start , чтобы перезапустить работающее приложение с поддержкой реального времени, чтобы определить, на каком ядре в режиме реального времени он работает.

Операция Description
show-memory-stats Отображает статистику памяти для приложений на подключенном устройстве.
show-quota Отображает объем хранилища, используемый текущим приложением на устройстве.
show-status Возвращает состояние текущего приложения на устройстве.
Начало Запускает приложение, которое загружается на устройство.
stop Останавливает приложение, которое выполняется на устройстве.

приложение show-memory-stats

Отображает статистику памяти для приложений на подключенном устройстве. Эта команда доступна только в том случае, если настроена возможность устройства appDevelopment. Дополнительные сведения отображаются, если настроено отслеживание выделения памяти кучи.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device app show-memory-stats
 -------------- -------------
 Name           Usage (bytes)
 ============================
 Total          434176
 User Mode      147456
 Peak User Mode 147456
 -------------- -------------

app show-quota

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

Вы устанавливаете в манифесте приложения мутируемую квоту хранилища, а ОС Azure Sphere применяет квоты при выделении секторов для файла. Это означает, что при уменьшении значения MutableStorage объем используемого хранилища не изменится, но в отчете будет указано новое значение выделенного объема. Например, если приложение уже использовало 16 КБ и измените MutableStorage значение на 8 КБ, команда сообщает, что приложение использует 16 КБ, выделенное 8 КБ. Все данные на устройстве сохранятся.

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

Параметр Тип Описание
-i, --component-id GUID Указывает идентификатор компонента, для которого необходимо получить сведения о квоте. Если опущено, отображает сведения о квоте для всех компонентов.
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device app show-quota
ae4714aa-03aa-492b-9663-962f966a9cc3: 0KB out of 8KB of mutable storage used.

app show-status

Отображает текущее состояние приложения на устройстве.

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

Параметр Тип Описание
-i, --component-id GUID Указывает идентификатор компонента для отображения состояния. Если не задан, отображается состояние всех компонентов.
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device app show-status
9ce57001-90eb-45e1-bd0a-4fc07b0c85c9
App state: running

app start

Запускает приложения на устройстве.

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

Параметр Тип Описание
--debug-mode Логический Запускает приложение для отладки. Необходимо --component-id указать.
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
-i, --component-id GUID Указывает идентификатор компонента для запуска. Если не задан, запускает все приложения.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device app start
836cbcf1-0b4d-45ab-963a-eadcd5017b6a
App state: running
Core     : High-level

app stop

Останавливает приложения на устройстве.

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

Параметр Тип Описание
-i, --component-id GUID Указывает идентификатор компонента для остановки. Если не задан, останавливает все приложения.
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device app stop
836cbcf1-0b4d-45ab-963a-eadcd5017b6a
App state: stopped

capability;

Управляет возможностями устройства. Возможности устройства определяют, какие операции могут выполняться на отдельном устройстве Azure Sphere.

Возможности устройства скачиваются в виде файла из службы безопасности Azure Sphere с помощью команды загрузки возможностей azsphere device. Вы можете применить конфигурацию возможностей устройства к подключенному устройству Azure Sphere с помощью команды azsphere device capability update и создать сеанс обслуживания с помощью команды azsphere device capability select. Дополнительные сведения о возможностях устройств см. в разделе "Возможности устройств" и "Обмен данными".

Операция Description
загрузить Загружает конфигурацию возможностей устройства из службы безопасности Azure Sphere.
select Выбирает скачанный файл возможностей, используемый для сеанса обслуживания.
show-attached Отображает конфигурацию возможностей для подключенного устройства.
обновить Применяет конфигурацию возможностей для подключенного устройства.

capability download

Скачивает возможность устройства из службы безопасности Azure Sphere.

Возможность appdevelopment позволяет загружать приложения, подписанные SDK, и запустить, остановить, отладить или удалить любое приложение на устройстве. Без возможности appdevelopment удастся загрузить только приложения, загруженные в облако, но запустить, остановить, отладить или удалить приложение будет невозможно. Возможность appDevelopment применяется в составе команды azsphere device enable-development.

При скачивании возможности fieldServicing вы получите файл с возможностью для одного устройства Azure Sphere. Файл возможности fieldServicing скачивается на локальный компьютер и может использоваться в сочетании с командой azsphere device capability select.

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

Параметр Тип Описание
--type Тип возможностей Указывает тип возможности устройства для скачивания. Возможные значения: appDevelopment, fieldServicing или none. Вариант none удаляет возможность appDevelopment или fieldServicing.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда. Этот параметр требуется при подключении нескольких устройств или при отсутствии устройства. Подключенное устройство используется по умолчанию. Вы можете указать идентификатор устройства для неподключаемого устройства или указать IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
--назначение Строка Указывает путь и имя файла, по которому необходимо сохранить конфигурацию возможности. Укажите абсолютный или относительный путь. Если вы не предоставляете путь, команда сохраняет файл в локальном каталоге с помощью возможности соглашения об именовании в формате type-first<> восемь символов идентификатора устройства ID.cap>.<
-t, --tenant GUID или имя Указывает клиент для выполнения этой операции. Переопределяет выбранный клиент по умолчанию. Можно указать идентификатор клиента или имя клиента.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device capability download --type appDevelopment
The appdevelopment capability was saved as:
 --------------------------------------------
 Result
 ============================================
 C:\capability-file\appdevelopment-<first eight characters of device ID>.cap
 --------------------------------------------

capability select

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

Команду azsphere device capability select можно использовать в сочетании с любой возможностью, но чаще всего она применяется для организации сеанса обслуживания с использованием fieldServicing. Команду azsphere device capability select --none может выполнять пользователь с любой ролью.

Использование возможности fieldServicing обеспечивает взаимодействие между устройством Azure Sphere и локальным компьютером, который содержит файл этой возможности. Файл возможности fieldServicing используется для организации сеанса между локальным компьютером и устройством Azure Sphere, в котором каждая команда дополняется предваряющим сообщением с информацией об используемом файле возможности.

Чтобы завершить сеанс обслуживания, выполните команду azsphere device capability select --none.

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

Параметр Тип Описание
--capability-file Строка Указывает путь и имя файла для выбранного файла конфигурации возможностей устройства. Вы можете указать относительный или абсолютный путь.
-n, --none - Удаляет любую ранее выбранную конфигурацию возможностей устройства
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device capability select --capability-file appdevcap
The capability session uses C:\capability-file\appdevcap.

capability show-attached

Отображает конфигурацию возможностей, сохраненную на подключенном устройстве.

Примечание.

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

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device capability show-attached
 --------------------
 DeviceCapabilities
 ====================
 EnableFieldServicing
 --------------------
azsphere device capability show-attached
 --------------------
 DeviceCapabilities
 ====================
 EnableAppDevelopment
 --------------------

capability update

Применяет конфигурацию возможностей для подключенного устройства.

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

Параметр Тип Описание
--capability-file Строка Указывает путь и имя файла возможностей устройства, который будет применяться. Вы можете указать относительный или абсолютный путь.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда. Этот параметр требуется при подключении нескольких устройств или при отсутствии устройства. Подключенное устройство используется по умолчанию. Вы можете указать идентификатор устройства для неподключаемого устройства или указать IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device capability update --capability-file appdevcap.bin
Using selected capability file: C:\capability-file\appdevcap.bin
The capability file C:\capability-file\appdevcap.bin was added on the device. The device will restart.

сертификат

Управляет сертификатами на подключенном устройстве.

Операция Description
добавление Добавляет сертификат в хранилище сертификатов на подключенном устройстве.
Удаление Удаляет сертификат из хранилища сертификатов подключенного устройства.
список Выводит идентификаторы сертификатов, доступные в хранилище сертификатов подключенного устройства.
show Отображает сведения о сертификате в хранилище сертификатов подключенного устройства.
show-quota Отображает доступное свободное место в хранилище сертификатов подключенного устройства.

certificate add

Добавляет сертификат в хранилище сертификатов подключенного устройства.

Для загрузки на устройство Azure Sphere сертификаты клиента и корневого ЦС должны быть в формате PEM. Необходимо получить сертификат корневого ЦС с соответствующего сервера, а также сертификат клиента и закрытый ключ (а также пароль для закрытого ключа) для устройства. Каждый сертификат в вашей сети EAP-TLS должен быть создан и подписан соответствующим сервером. Сведения, необходимые для получения сертификатов, могут предоставить администраторы сети или группа безопасности. Дополнительные сведения о получении сертификата корневого ЦС см. в статье "Получение и развертывание сертификатов для сетей EAP-TLS".

Внимание

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

Дополнительные сведения см. в разделе Идентификаторы сертификатов.

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

Параметр Тип Описание
-i, --cert-id Строка Указывает идентификатор добавляемого сертификата. Строковый идентификатор (до 16 символов). Допустимые символы включают прописные буквы (A-Z), строчные буквы (a-z), цифры (0-9), подчеркивание (_), период (.) и дефис (-). Этот идентификатор также используется в конфигурациях Wi-Fi для сетей с поддержкой EAP-TLS.
--cert-type Строка Указывает тип сертификата для добавления клиента или rootca.
-p, --public-key-file Строка Указывает путь к pem-файлу сертификата открытого ключа. Вы можете указать относительный или абсолютный путь.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
--private-key-file Строка Указывает путь к pem-файлу сертификата закрытого ключа клиента. Требуется при добавлении сертификата клиента типа. Вы можете указать относительный или абсолютный путь.
-w, --private-key-password Строка Указывает необязательный пароль для закрытого ключа клиента. При добавлении зашифрованного закрытого ключа клиентского сертификата необходим пароль.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device certificate add --cert-id certroot --cert-type rootca --public-key-file publiccert.pem
Certificate 'certroot' successfully added.
azsphere device certificate add --cert-id certclient --cert-type client --private-key-file privatekey.pem --private-key-password 1234 --public-key-file publiccert.pem
Certificate 'certclient' successfully added.

certificate delete

Удаляет сертификат из хранилища сертификатов подключенного устройства.

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

Параметр Тип Описание
-c, --certificate
или
--cert-id [удаление]
Строка Указывает идентификатор удаленного сертификата. Аргумент --cert-id будет удален и будет удален в будущем выпуске. Дополнительные сведения см. в разделе "Важные изменения" (отставные функции) в Azure Sphere CLI.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device certificate delete --certificate certclient

certificate list

Выводит список сертификатов, доступных в хранилище сертификатов устройства.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device certificate list
 -----------
 Identifiers
 ===========
 rootCert
 -----------

certificate show

Отображает сведения об отдельном сертификате в хранилище сертификатов устройства.

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

Параметр Тип Описание
-c, --certificate
или
--cert-id [удаление]
Строка Указывает идентификатор сертификата, для которого отображаются сведения. Аргумент --cert-id будет удален и будет удален в будущем выпуске. Дополнительные сведения см. в разделе "Важные изменения" (отставные функции) в Azure Sphere CLI.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device certificate show --certificate certclient
---------- ------------------- ------------------- ----------------------------------- -----------------------------------
 Id         StartDate           EndDate             SubjectName                         IssuerName
 ==========================================================================================================================
 certclient 06/08/2019 19:15:48 06/08/2069 19:25:44 /DC=local/DC=azsphere/CN=azsphereca /DC=local/DC=azsphere/CN=azsphereca
 ---------- ------------------- ------------------- ----------------------------------- -----------------------------------

certificate show-quota

Отображает доступное свободное место в хранилище сертификатов подключенного устройства.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device certificate show-quota
--------------
Available space (bytes)
==============
24514
--------------

утверждение

Утверждает ранее невостребованные устройства для текущего клиента Azure Sphere.

Внимание

Прежде чем утвердить устройство, убедитесь, что вы выполнили вход в правильный клиент Azure Sphere. Устройство можно утвердить только один раз. После утверждения устройство нельзя перемещать в другой клиент.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда. Этот параметр требуется при подключении нескольких устройств или при отсутствии устройства. Подключенное устройство используется по умолчанию. Вы можете указать идентификатор устройства для неподключаемого устройства или указать IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
-t, --tenant GUID или имя Указывает клиент для выполнения этой операции. Переопределяет выбранный клиент по умолчанию. Можно указать идентификатор клиента или имя клиента.
--force Логический Принудительное утверждение устройства в выбранном клиенте Azure Sphere текущего пользователя.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device claim
warn: You are claiming a device to the following tenant:
warn: a323c263-2aa3-2559-aabb-a3fc32631900 (Tenant1)
warn: Do you want to claim the device ID 352fe1f59e40ef8a9266415e81af32b5b07d8f2bbd6b5650cef4a70b86c7fcbc70b129a41fbc6d02f8bb4aaabc52cd5740c85427d205e46a166b7e41135eb968 to this tenant?
warn: You cannot change the Azure Sphere tenant this device is claimed to once this action has completed.
Enter 'yes' to continue. Enter anything else to exit.
> yes
Claiming device.
Successfully claimed device ID '352fe1f59e40ef8a9266415e81af32b5b07d8f2bbd6b5650cef4a70b86c7fcbc70b129a41fbc6d02f8bb4aaabc52cd5740c85427d205e46a166b7e41135eb968' into tenant 'Tenant1' with ID 'a323c263-2aa3-2559-aabb-a3fc32631900'.

enable-cloud-test

Подготавливает подключенное устройство для тестовой загрузки в облако, отключив разработку, удалив любые существующие приложения и включив загруженные в облако обновления приложения.

Работает только на подключенном к ПК устройстве.

В частности, enable-cloud-test выполняет следующее.

  • Удаляет возможность appDevelopment для подключенного устройства.
  • Назначает устройству группу устройств, которая включает обновления приложения, загруженные в облако.
  • Перезагружает устройство.

Конкретные задачи, выполняемые enable-cloud-test, зависят от того, назначены ли этому устройству продукт и группа.

Если azsphere device enable-cloud-test выполняется без параметров, устройство помещается в группу устройств Field Test текущего продукта устройства. Это одна из групп устройств по умолчанию, которые автоматически создаются для каждого продукта. Она позволяет обновлять приложения. Ошибка возвращается, если у устройства нет продукта или в ней отсутствует группа устройств "Тестирование полей".

Если указан продукт, устройство помещается в группу устройств Field Test этого продукта. Ошибка возвращается, если эта группа устройств не существует.

Если указана группа устройств, устройство помещается в него. Ошибка возвращается, если целевая группа устройств не включает обновления приложений.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
-p, --product GUID или имя Указывает целевой продукт. Если это указано, устройство перемещается в группу устройств для тестирования полей по умолчанию этого продукта, если --device-group не указано также. Можно указать идентификатор или имя продукта Azure Sphere.
-t, --tenant GUID или имя Указывает клиент для выполнения этой операции. Переопределяет выбранный клиент по умолчанию. Можно указать идентификатор клиента или имя клиента.
-g, --device-group GUID или имя Указывает группу устройств, в которую будет перемещаться устройство. Можно указать идентификатор группы устройств или имя группы устройств. Чтобы использовать имя группы устройств, необходимо указать имя продукта и имя группы устройств в <product-name/device-group-name> формате. По умолчанию это группа устройств "Тестирование полей" продукта.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Примеры

Пример 1. Назначение устройства в существующую группу устройств с указанным идентификатором

В этом примере подключенное устройство назначается существующему продукту и помещается в группу устройств.

azsphere device enable-cloud-test --device-group '3548b179-m16f-4f64-6dme-d3c643662e76'
Your internal capabilities will be retained, including the Enable App development capability. Sideloaded images may be removed by over-the-air application updates.
Getting device group by ID '3548b179-m16f-4f64-6dme-d3c643662e76'.
Leaving any existing applications on the device.
Setting device group to 'Field Test' with ID '3548b179-m16f-4f64-6dme-d3c643662e76')
Successfully updated device's device group.
Successfully set up device for application updates.
(Device ID: 'ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABCD')

Пример 2. Назначение устройства другой группе устройств

Этот пример похож на предыдущий, но здесь для устройства сохраняется существующий продукт. Здесь операция enable-cloud-test изменяет группу устройств, которой принадлежит устройство, и удаляет возможность appDevelopment. Эта команда полезна для перемещения устройства из среды разработки, которая не позволяет обновлять приложения, в рабочую среду с поддержкой обновлений.

azsphere device enable-cloud-test --device-group "Marketing/Field Test"

Пример 3. Назначение устройства по названию продукта

В этом примере показана загрузка в облако и назначение устройства продукту по его имени.

azsphere device enable-cloud-test --product DW100

enable-development

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

В частности, enable-development выполняет следующие действия.

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

Если вы запускаете команду azsphere device enable-development без параметров:

  • Если устройству еще на назначены продукт или группа устройств, эта команда скачивает и применяет функцию appDevelopment для подключенного устройства, а затем перезагружает его. Все существующие приложения остаются на устройстве и ос обновляются. Процесс установки для утверждения устройства и краткого руководства по созданию высокоуровневого приложения не влияет.
  • Если устройству уже назначен продукт, эта команда переместит устройство в группу устройств Development того же продукта. По умолчанию обновления приложений отключены для этой группы, что гарантирует, что неопубликованные приложения не перезаписываются.

При выполнении команды azsphere device enable-development с параметром --product :

  • Помещает устройство в группу устройств разработки для продукта. Ошибка возвращается, если эта группа устройств не существует.

При выполнении команды azsphere device enable-development с параметром --device-group :

  • Назначает устройство в указанную группу устройств. Целевая группа устройств не должна включать обновления приложений или возвращается ошибка.

В некоторых случаях azsphere device enable-development возвращает ошибку и предлагает утвердить устройство. Если вы уже утвердили это устройство, выполните команду azsphere tenant show-selected и убедитесь, что выполнен вход в тот клиент, в котором утверждалось устройство. В противном случае перейдите в правильный клиент командой azsphere login. Если вы уверены, что вы вошли в соответствующий клиент, используйте утверждение azsphere device для утверждения устройства.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
-g, --device-group GUID или имя Указывает группу устройств, в которую будет перемещаться устройство. Если не задан, назначает устройство в группу по умолчанию. Можно указать идентификатор группы устройств или имя группы устройств. Чтобы использовать имя группы устройств, необходимо указать имя продукта и имя группы устройств в <product-name/device-group-name> формате.
-r, --enable-rt-core-debugging Логический Устанавливает драйверы, необходимые для отладки приложений, запущенных на ядре с поддержкой режима реального времени. Для этого параметра требуются разрешения администратора.
-p, --product GUID или имя Указывает целевой продукт. При указании этого значения устройство перемещается в группу устройств разработки по умолчанию этого продукта, если --device-group не указано также. Можно указать идентификатор или имя продукта Azure Sphere.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device enable-development
Capability configuration has been successfully cleared.
PS C:\Users\v-shypr> azsphere device enable-development
Getting device group 'Development' for product 'DW100'.
The device already has the 'Enable App development' capability. No changes will be applied to its existing capabilities.
Setting device group to 'Development' with ID '7f860cc1-4949-4000-a541-9a988ba4c3cd'.
Successfully disabled application updates.
Installing debugging server to device.
Deploying 'C:\Program Files (x86)\Microsoft Azure Sphere SDK\DebugTools\gdbserver.imagepackage' to the attached device.
Image package 'C:\Program Files (x86)\Microsoft Azure Sphere SDK\DebugTools\gdbserver.imagepackage' has been deployed to the attached device.
Previous device capabilities retained. Ensure that you have the correct development capabilities installed before continuing.
Successfully set up device for application development, and disabled application updates.
(Device ID: '352fe1f59e40ef8a9266415e81af32b5b07d8f2bbd6b5650cef4a70b86c7fcbc70b129a41fbc6d02f8bb4aaabc52cd5740c85427d205e46a166b7e41135eb968')

Изображение

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

Операция Description
list-installed Содержит сведения о образах, установленных на подключенном устройстве.
list-targeted Предоставляет сведения об образах, которые нацелены на подключенное устройство.

image list-installed

Отображает список образов, установленных на подключенное устройство. Список данных включает идентификаторы компонентов и образов.

Примечание.

Длинные имена изображений усечены на 31 символов.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
-f, --full Логический Выводит список всех образов программного обеспечения, установленных на устройстве. По умолчанию здесь перечисляются только образы приложений, отладчики и образы конфигурации платы.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device image list-installed
Installed images:
 --> gdbserver
   --> Image type:   Application
   --> Component ID: 8548b129-b16f-4f84-8dbe-d2c847862e78
   --> Image ID:     dc6205bd-4478-4c9b-81ad-5e41ac23ed68
 --> CrashApplicatio
   --> Image type:   Application
   --> Component ID: 9ce57001-90eb-45e1-bd0a-4fc07b0c85c9
   --> Image ID:     cc77124e-6447-4c0f-9f99-fc0ad5ef46ef

image list-targeted

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

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда. Этот параметр требуется при подключении нескольких устройств или при отсутствии устройства. Подключенное устройство используется по умолчанию. Вы можете указать идентификатор устройства для неподключаемого устройства или указать IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
-t, --tenant GUID или имя Указывает клиент для выполнения этой операции. Переопределяет выбранный клиент по умолчанию. Можно указать идентификатор клиента или имя клиента.
-f, --full Логический Выводит список всех образов в клиенте Azure Sphere.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device image list-targeted
 ----------------------- ------------------------------------ ------------------------------------ ---------------- --------------------
 Name                    ComponentId                          ImageId                              ImageType       RegionalDataBoundary 
 =======================================================================================================================================
 HelloWorld_HighLevelApp 1689d8b2-c835-2e27-27ad-e894d6d15fa9 50419cb6-a33b-4cbe-8bd0-425048664b6f Applications    None   
 ----------------------- ------------------------------------ ------------------------------------ -------------------------------------   

список

Выводит список всех устройства в клиенте. Список усечен после первых 500 устройств.

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

Параметр Тип Описание
-t, --tenant GUID или имя Указывает клиент для выполнения этой операции. Переопределяет выбранный клиент по умолчанию. Можно указать идентификатор клиента или имя клиента.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device list
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------ -------- ------------------------------------ ------------------------------------
 DeviceId                                                                                                                         TenantId                             ChipSku  ProductId                            DeviceGroupId
 ========================================================================================================================================================================================================================================================
 352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968 a323c263-2aa3-2559-aabb-a3fc32631900 MT3620AN 4f48d618-09f7-45dc-a5a4-1433cabbee91 6f52bead-700d-4289-bdc2-2f11f774270e
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------ -------- ------------------------------------ ------------------------------------
 ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABCD a323c263-2aa3-2559-aabb-a3fc32631900 MT3620AN 4f48d618-09f7-45dc-a5a4-1433cabbee91 6f52bead-700d-4289-bdc2-2f11f774270e
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------ -------- ------------------------------------ ------------------------------------

Параметр можно использовать --query для настройки выходных данных, отображаемых для этой команды. Дополнительные сведения см. в разделе "Вывод команд командной строки запроса".

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

azsphere device list --query '[].{DeviceId:deviceId, ProductId:productId}'
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------
 DeviceId                                                                                                                         ProductId
 =====================================================================================================================================================================
 352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968 4f48d618-09f7-45dc-a5a4-1433cabbee91
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------
 ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABCD 4f48d618-09f7-45dc-a5a4-1433cabbee91
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------

Совет

Запустите azsphere product show --product-ID><, чтобы просмотреть имя продукта или azsphere device-group show --device-group <devicegroup-ID>, чтобы просмотреть имя группы устройств.

list-attached

Выводит список всех устройств, подключенных к локальному компьютеру.

Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device list-attached
1 device attached:
--> Device ID: 352fe1f59e40ef8a9266415e81af32b5b07d8f2bbd6b5650cef4a70b86c7fcbc70b129a41fbc6d02f8bb4aaabc52cd5740c85427d205e46a166b7e41135eb968
  --> Is responsive: yes
  --> IP address: 192.128.48.1
  --> Connection path: 21143

производственное состояние

Управляет состоянием производства подключенного устройства.

Операция Description
show Отображает состояние производства подключенного устройства.
обновить Обновляет состояние производства подключенного устройства.

Внимание

Изменения состояния производства являются постоянными и необратимыми.

manufacturing-state show

Отображает состояние производства подключенного устройства.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device manufacturing-state show
------------------
ManufacturingState
==================
Module1Complete
------------------

manufacturing-state update

Обновляет состояние производства подключенного устройства. Дополнительные сведения см. в разделе "Настройка состояния производства устройства".

Внимание

Изменения состояния производства являются постоянными и необратимыми.

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

Параметр Тип Описание
-s, --state Производственные состояния Указывает состояние производства для устройства. Возможные состояния включают DeviceComplete и Module1Complete.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device manufacturing-state update --state Module1Complete
Updating manufacturing state to Module1Complete.
Restarting device for changes to take effect.
The device was successfully restarted.

сеть

Предоставляет сведения о состоянии сетевых интерфейсов на подключенном устройстве.

Операция Description
enable Включает сетевой интерфейс на подключенном устройстве.
disable Отключает сетевой интерфейс на подключенном устройстве.
list-firewall-rules Выводит список правил брандмауэра для подключенного устройства.
интерфейсы list-interfaces Выводит список сетевых интерфейсов для подключенного устройства.
прокси-сервер Управляет параметрами сетевого прокси-сервера.
show-диагностика Отображает диагностика сети для одной или всех беспроводных сетей на подключенном устройстве.
show-status Отображает состояние сети для подключенного устройства.
update-interface Обновляет конфигурацию сетевого интерфейса для устройства.

включение сети

Включает сетевой интерфейс на подключенном устройстве.

Примечание.

Эта команда поддерживается для настройки Ethernet eth0 и wlan0 подключений. Ошибка возвращается при настройке lo или azspheresvc.

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

Параметр Тип Описание
--интерфейс строка Указывает интерфейс для включения.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device network enable --interface wlan0
Network interface configuration is successfully applied to the device.
Run the command 'azsphere device network list-interfaces' to view details of the network interfaces for the attached device.

отключение сети

Отключает сетевой интерфейс на подключенном устройстве.

Примечание.

Эта команда поддерживается для настройки Ethernet eth0 и wlan0 подключений. Ошибка возвращается при настройке lo или azspheresvc.

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

Параметр Тип Описание
--интерфейс строка Указывает интерфейс для включения.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device network disable --interface wlan0
Network interface configuration is successfully applied to the device.
Run the command 'azsphere device network list-interfaces' to view details of the network interfaces for the attached device.

правила брандмауэра сети

Выводит список правил брандмауэра для подключенного устройства.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.

Отображаются следующие правила:

  • Имя набора правил брандмауэра: отображает имя блока набора правил брандмауэра.
    • Значения: PREROUTING, POSTROUTING, INPUT, FORWARD и OUTPUT.
  • Является допустимым набором правил: отображает состояние набора правил. Значения: True или False.
  • Правила набора правил брандмауэра: отображает значения для следующих правил:
    • Исходный IP-адрес: отображает IP-адрес отправляющего компьютера.
    • Маска источника: отображает сетевую маску отправляющего компьютера.
    • Ip-адрес назначения: отображает IP-адрес целевого компьютера.
    • Маска назначения: отображает сетевую маску компьютера дестамации.
    • UID: отображает идентификацию пользователя, примененную к правилу. 4294967295 (0xFFFFFFFF) означает, что uiD не применяется и поэтому применяется ко всем пользователям.
    • Действие. Отображает действие, выполняемое. Значения могут принимать или удаляться.
    • Имя интерфейса IN: отображает имя входного интерфейса. Например, wlan0.
    • Имя интерфейса OUT: отображает имя выходного интерфейса. Например, wlan0.
    • Состояние: отображает состояние подключения. Значения не установлены, установлены или связаны.
    • Маска TCP: отображает массив маски TCP. Значения : fin, syn, rst, psh, ack и urg.
    • TCP Cmp: отображает массив флагов TCP. Значения : urg, ack, psh, rst, syb и fin.
    • Tcp Inv: Boolean указывает, что смысл флагов TCP должен быть инвертирован. Значения: True или False.
    • Протокол: отображает протокол правила брандмауэра. Значения: icmp, igmp, tcp, udp.
    • Диапазон исходных портов: отображает диапазон портов от источника, отправляющего трафик. Значение может быть от 0 до 65535.
    • Диапазон портов назначения: отображает диапазон портов в назначении, который получает трафик. Значение может быть от 0 до 65535.
    • Пакеты: отображает количество пакетов.
    • Байт: отображает количество байтов.

Краткая сводка по флагам представлена следующим образом:

  • URG: важное поле срочного указателя
  • ACK: поле подтверждения значительно
  • PSH: push-функция
  • RST: сброс подключения
  • SYN: синхронизация порядковых номеров
  • FIN: больше данных от отправителя не будет
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device network list-firewall-rules
 ----------- ------- ------------ --------------- --------------- --------------- ---------- ------ --------------- ------ -------- --------------- -------------------- ------- ------ ------- ------
 Ruleset     IsValid SourceIp     SourceMask      DestinationIp   DestinationMask UID        Action InterfaceInName TcpInv Protocol SourcePortRange DestinationPortRange Packets Bytes  TcpMask TcpCmp
 =====================================================================================================================================================================================================
 PREROUTING  False   None         None            None            None            None       None   None            None   None     None            None                 None    None   None    None
 ----------- ------- ------------ --------------- --------------- --------------- ---------- ------ --------------- ------ -------- --------------- -------------------- ------- ------ ------- ------
 INPUT       True    <value>      <value>         <value>         <value>         <value>     accept                 False  any      0-65535         0-65535              0       0      None    None
 ----------- ------- ------------ --------------- --------------- --------------- ---------- ------ --------------- ------ -------- --------------- -------------------- ------- ------ ------- ------
 INPUT       True    <value>      <value>         <value>         <value>         <value>     accept                 True   tcp      0-65535         0-65535              823     394754 syn,ack syn
 ----------- ------- ------------ --------------- --------------- --------------- ---------- ------ --------------- ------ -------- --------------- -------------------- ------- ------ ------- ------
 INPUT       True    192.168.35.1 <value>         <value>         <value>         <value>     accept azspheresvc     False  any      0-65535         0-65535              15      780    None    None
 ----------- ------- ------------ --------------- --------------- --------------- ---------- ------ --------------- ------ -------- --------------- -------------------- ------- ------ ------- ------
 INPUT       True    <value>      <value>         <value>         <value>         <value>     accept                 False  udp      53-53           0-65535              0       0      None    None
 ----------- ------- ------------ --------------- --------------- --------------- ---------- ------ --------------- ------ -------- --------------- -------------------- ------- ------ ------- ------
 INPUT       True    <value>      <value>         <value>         <value>         <value>     accept                 False  udp      53-53           0-65535              0       0      None    None
 ----------- ------- ------------ --------------- --------------- --------------- ---------- ------ --------------- ------ -------- --------------- -------------------- ------- ------ ------- ------
 INPUT       True    <value>      <value>         <value>         <value>         <value>     accept                 False  udp      53-53           0-65535              0       0      None    None
 ----------- ------- ------------ --------------- --------------- --------------- ---------- ------ --------------- ------ -------- --------------- -------------------- ------- ------ ------- ------

сетевые интерфейсы списка

Выводит список сетевых интерфейсов для подключенного устройства.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device network list-interfaces
 ------------- ----------- ------------------ ---------- ------------- ------------------- ------------ -----------------
 InterfaceName InterfaceUp ConnectedToNetwork IpAcquired IpAddresses   ConnectedToInternet IpAssignment HardwareAddress
 ========================================================================================================================
 azspheresvc   True        False              False      <value>       False               None         None
 ------------- ----------- ------------------ ---------- ------------- ------------------- ------------ -----------------
 eth0          True        True               True       <value>       True                dynamic      <value>
 ------------- ----------- ------------------ ---------- ------------- ------------------- ------------ -----------------
 lo            True        False              False      <value>       False               None         None
 ------------- ----------- ------------------ ---------- ------------- ------------------- ------------ -----------------
 wlan0         True        True               True       <value>       True                dynamic      <value>
 ------------- ----------- ------------------ ---------- ------------- ------------------- ------------ -----------------

сетевой прокси-сервер

Управляет адресом прокси-сервера, используемым для сетевого подключения. Дополнительные сведения о настройке устройства Azure Sphere для подключения к Интернету через прокси-сервер см. в статье "Подключение через прокси-сервер".

Примечание.

В настоящее время поддерживаются только прокси-серверы HTTP.

Операция Description
Применение прокси-сервера Настраивает сетевой прокси-сервер на подключенном устройстве.
удаление прокси-сервера Удаляет прокси-подключение на подключенном устройстве.
прокси-шоу Отображает прокси-подключение на подключенном устройстве.

Применение прокси-сервера

Настраивает сетевой прокси-сервер на подключенном устройстве.

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

Параметр Тип Описание
-a, --address Строка Указывает сетевой адрес прокси-сервера, который будет использоваться.
-t, --authentication Строка Указывает используемый тип проверки подлинности. Допустимые значения: anonymous или basic. Если для прокси-сервера требуется имя пользователя и пароль, задайте для этого значение basic, в противном случае — значение anonymous.
-r, --port Целое Указывает порт для используемого сетевого адреса. Значение должно быть равно или меньше 65535.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
--давать возможность Строка Указывает, следует ли включить прокси-сервер. Необходимо задать либо--enable.--disable
--отключить Строка Указывает, следует ли отключить прокси-сервер. Необходимо задать либо--enable.--disable
-n, --no-proxy-addresses Строка Указывает массив адресов сети, разделенных пробелами, устройство должно избегать прокси-подключения.
-p, --password Строка Указывает пароль для проверки подлинности прокси-сервера, используемый только для базовой проверки подлинности. Максимальная длина: 64 символа.
-u, --username Строка Указывает имя пользователя для проверки подлинности прокси-сервера. Используется только для базовой проверки подлинности. Максимальная длина: 64 символа.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device network proxy apply --address contoso.com --authentication anonymous --port 8080 --enable
 ----------- ------- ----- ------------------ ----------------
 Address     Enabled Port  AuthenticationType NoProxyAddresses
 =============================================================
 contoso.com True   8080  anonymous
 ----------- ------- ----- ------------------ ----------------

удаление прокси-сервера

Удаляет прокси-подключение на подключенном устройстве.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device network proxy delete

прокси-шоу

Отображает прокси-подключение на подключенном устройстве.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device network proxy show
 ----------- ------- ----- ------------------ ----------------
 Address     Enabled Port  AuthenticationType NoProxyAddresses
 =============================================================
 contoso.com True   8080  anonymous
 ----------- ------- ----- ------------------ ----------------

сетевая диагностика

Отображает диагностика для одной или всех сетей Wi-Fi на подключенном устройстве.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
-n, --network Целое Указывает идентификатор сети Wi-Fi, для которой отображается диагностика.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device network show-diagnostics
 ------------------------- --------- ----- ------------- --------------- --------
 Timestamp                 NetworkId Ssid  ConfigState   ConnectionState Error
 ================================================================================
 2021-06-16T20:51:29+00:00 0         <value> temp-disabled disconnected    WrongKey
 ------------------------- --------- ----- ------------- --------------- --------

состояние сетевого отображения

Отображает состояние сети для подключенного устройства.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device network show-status
 --------------------------- --------------- -----
 DeviceAuthenticationIsReady NetworkTimeSync Proxy
 =================================================
 True                        complete        ready
 --------------------------- --------------- -----

сетевой интерфейс обновления

Обновляет сетевой интерфейс Ethernet для устройства. Дополнительные сведения о настройке MAC-адреса для устройства см. в разделе "Настройка устройства для Ethernet".

Примечание.

Эта команда поддерживается для настройки подключений Ethernet eth0 . Ошибка возвращается при настройке loazspheresvc илиwlan0.

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

Параметр Тип Описание
--hardware-address Строка Указывает аппаратный адрес, заданный для устройства в любом из следующих форматов: AA:BB:33:DD:EE:FF или aa:bb:33:dd:ee:ff.
--интерфейс
или
--interface-name [выход из эксплуатации]
Строка Указывает имя настраиваемого интерфейса. Запустите azsphere device network list-interfaces , чтобы просмотреть сведения о сетевых интерфейсах для подключенного устройства. Аргумент --interface-name будет удален и будет удален в будущем выпуске. Дополнительные сведения см. в разделе "Важные изменения" (отставные функции) в Azure Sphere CLI.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device network update-interface --interface eth0 --hardware-address ba:98:76:54:32:10

восстановление

Заменяет системное программное обеспечение на устройстве.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство для выполнения команды при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Укажите идентификатор, IP-адрес или идентификатор локального подключения устройства.
-c, --capability Строка Указывает образ возможностей устройства, применяемый к устройству во время восстановления.
-i, --images Строка Указывает путь к папке, которая содержит пакеты образов для записи на устройстве. По умолчанию операция восстановления использует образы в пакете SDK, если только с помощью этого флага не указан альтернативный путь.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

Пример 1:

azsphere device recover
Downloading recovery images...
Download complete.
Starting device recovery. Please note that this may take up to 10 minutes.
Board found. Sending recovery bootloader.
Erasing flash.
Sending 17 images. (5443272 bytes to send)
Sent 1 of 17 images. (5440896 of 5443272 bytes remaining)
Sent 2 of 17 images. (5414844 of 5443272 bytes remaining)
Sent 3 of 17 images. (5311892 of 5443272 bytes remaining)
Sent 4 of 17 images. (5311500 of 5443272 bytes remaining)
Sent 5 of 17 images. (5041520 of 5443272 bytes remaining)
Sent 6 of 17 images. (5024908 of 5443272 bytes remaining)
Sent 7 of 17 images. (4994856 of 5443272 bytes remaining)
Sent 8 of 17 images. (2397456 of 5443272 bytes remaining)
Sent 9 of 17 images. (885796 of 5443272 bytes remaining)
Sent 10 of 17 images. (861220 of 5443272 bytes remaining)
Sent 11 of 17 images. (758608 of 5443272 bytes remaining)
Sent 12 of 17 images. (135796 of 5443272 bytes remaining)
Sent 13 of 17 images. (70048 of 5443272 bytes remaining)
Sent 14 of 17 images. (41164 of 5443272 bytes remaining)
Sent 15 of 17 images. (32768 of 5443272 bytes remaining)
Sent 16 of 17 images. (16384 of 5443272 bytes remaining)
Sent 17 of 17 images. (0 of 5443272 bytes remaining)
Finished writing images; rebooting board.
Device ID: 352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968
Device recovered successfully.

Пример 2:

azsphere device recover --capability "C:\Users\capability file\capability_352FE1F_5.bin"
Downloading recovery images...
Download complete.
Starting device recovery. Please note that this may take up to 10 minutes.
Board found. Sending recovery bootloader.
Erasing flash.
Sending 16 images. (5474668 bytes to send)
Sent 1 of 16 images. (5447384 of 5474668 bytes remaining)
Sent 2 of 16 images. (5343788 of 5474668 bytes remaining)
Sent 3 of 16 images. (5343396 of 5474668 bytes remaining)
Sent 4 of 16 images. (5073416 of 5474668 bytes remaining)
Sent 5 of 16 images. (5056612 of 5474668 bytes remaining)
Sent 6 of 16 images. (5026240 of 5474668 bytes remaining)
Sent 7 of 16 images. (2479376 of 5474668 bytes remaining)
Sent 8 of 16 images. (889892 of 5474668 bytes remaining)
Sent 9 of 16 images. (865316 of 5474668 bytes remaining)
Sent 10 of 16 images. (754512 of 5474668 bytes remaining)
Sent 11 of 16 images. (135796 of 5474668 bytes remaining)
Sent 12 of 16 images. (70048 of 5474668 bytes remaining)
Sent 13 of 16 images. (41164 of 5474668 bytes remaining)
Sent 14 of 16 images. (32768 of 5474668 bytes remaining)
Sent 15 of 16 images. (16384 of 5474668 bytes remaining)
Sent 16 of 16 images. (0 of 5474668 bytes remaining)
Finished writing images; rebooting board.
Device ID: 352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968
Device recovered successfully.

пересканировать присоединенное

Повторно сканирует подключенные устройства с помощью питания велоспорта всех портов FTDI и отображает общее количество подключенных устройств. Используйте эту команду при устранении неполадок с подключением устройства в Windows. Эта команда выполняется только в Windows.

Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

 azsphere device rescan-attached
 -----------
 Count
 ===========
 2
 -----------

restart

Перезапускает подключенное устройство.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device restart
Restarting device.
Device restarted successfully.

show

Отображает сведения о подключенном устройстве в клиенте Azure Sphere.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда. Этот параметр требуется при подключении нескольких устройств или при отсутствии устройства. Подключенное устройство используется по умолчанию. Вы можете указать идентификатор устройства для неподключаемого устройства или указать IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
-t, --tenant GUID или имя Указывает клиент для выполнения этой операции. Переопределяет выбранный клиент по умолчанию. Можно указать идентификатор клиента или имя клиента.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device show
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------ -------- ------------------------------------ ------------------------------------
 DeviceId                                                                                                                         TenantId                             ChipSku  ProductId                            DeviceGroupId
 ========================================================================================================================================================================================================================================================
 352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968 a323c263-2aa3-2559-aabb-a3fc32631900 MT3620AN 6f52bead-700d-4289-bdc2-2f11f774270e 7f860cc1-4949-4000-a541-9a988ba4c3cd
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------ -------- ------------------------------------ ------------------------------------

Параметр можно использовать --query для настройки выходных данных, отображаемых для этой команды. Дополнительные сведения см. в разделе "Вывод команд командной строки запроса".

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

azsphere device show --device 352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968  --query '{DeviceId:deviceId, ProductId:productId}'
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------
 DeviceId                                                                                                                         ProductId
 =====================================================================================================================================================================
 352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968 6f52bead-700d-4289-bdc2-2f11f774270e
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------

show-attached

Отображает сведения о подключенном устройстве на самом устройстве. Эти данные отличаются от тех, которые хранит служба безопасности Azure Sphere для устройства.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device show-attached
Device ID: 352fe1f59e40ef8a9266415e81af32b5b07d8f2bbd6b5650cef4a70b86c7fcbc70b129a41fbc6d02f8bb4aaabc52cd5740c85427d205e46a166b7e41135eb968
IP address: 192.128.48.1
Connection path: 21143

show-deployment-status

Отображает состояние развертывания для обновлений приложения и операционной системы на устройстве.

Используйте эту команду, чтобы узнать, какая версия операционной системы Azure Sphere работает на устройстве и (или) завершено ли текущее обновление развертывания.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
-t, --tenant GUID или имя Указывает клиент для выполнения этой операции. Переопределяет выбранный клиент по умолчанию. Можно указать идентификатор клиента или имя клиента.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device show-deployment-status
Your device is running Azure Sphere OS version <version-number>.
The Azure Sphere Security Service is targeting this device with Azure Sphere OS version <version-number>.
Your device has the expected version of the Azure Sphere OS: <version-number>.

В этом примере <номер> версии представляет текущую версию операционной системы.

show-count

Отображает число устройств в текущем клиенте.

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

Параметр Тип Описание
-t, --tenant GUID или имя Указывает клиент для выполнения этой операции. Переопределяет выбранный клиент по умолчанию. Можно указать идентификатор клиента или имя клиента.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

 azsphere device show-count
 ------
 Result
 ======
 2
 ------

show-os-version

Отображает текущую версию операционной системы на подключенном устройстве.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device show-os-version
Your device is running Azure Sphere OS version <version-number>

В этом примере <номер> версии представляет текущую версию операционной системы.

загрузка неопубликованных данных

Управляет приложением на устройстве.

Некоторые параметры загрузки требуют дополнительных возможностей после того, как устройство находится в производственном состоянии DeviceComplete. Возможность fieldServicing позволяет развертывать и удалять временные образы, подписанные рабочей средой, и развертывать постоянные рабочие подписанные образы. Возможность appDevelopment позволяет развертывать и удалять как рабочие подписанные, так и подписанные пакетом SDK образы.

Операция Description
Удаление Удаляет текущее приложение с устройства.
deploy Загружает приложение на устройство.
время ожидания set-deployment-timeout Задает период времени ожидания развертывания в секундах.
show-deployment-timeout Показывает период времени ожидания развертывания в секундах.

Обратите внимание, что параметры startв , show-statusstopи show-quota были перемещены в команду azsphere device app.

sideload delete

Удаляет приложения с устройства.

Эта команда доступна только в том случае, если настроена возможность устройства appDevelopment.

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

Параметр Тип Описание
-i, --component-id GUID Указывает идентификатор приложения для удаления с устройства. Если не задан, удаляет все приложения.
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device sideload delete
Component '54acba7c-7719-461a-89db-49c807e0fa4d' deleted.

sideload deploy

Загружает приложение на подключенное устройство и запускает его.

Эта команда не выполняется, если манифест приложения запрашивает ресурс, который используется приложением, которое уже находится на устройстве. В этом случае следует использовать azsphere device sideload delete, чтобы удалить существующее приложение и повторить попытку загрузки неопубликованных приложений. Команда azsphere device sideload delete удаляет как высокоуровневые приложения, так и приложения в режиме реального времени. Чтобы удалить одно приложение и оставить другое, укажите идентификатор компонента приложения для удаления.

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

Примечание.

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

Если перезагрузка устройства инициируется, дождитесь завершения перезагрузки и устройство будет реагировать.

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

Параметр Тип Описание
-p, --image-package Строка Указывает путь и имя файла пакета образов загрузки на устройстве.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
-m, --manual-start Логический Указывает, что после загрузки приложения не запускается автоматически.
--force Логический Инициирует принудительное развертывание образа, использующего интерфейс API бета-версии, поддержка которого завершается.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device sideload deploy --image-package C:\Users\LocalSamples\HelloWorld\HelloWorld_HighLevelApp\out\ARM-Debug\HelloWorld_HighLevelApp.imagepackage
Deploying 'C:\Users\LocalSamples\HelloWorld\HelloWorld_HighLevelApp\out\ARM-Debug\HelloWorld_HighLevelApp.imagepackage' to the attached device.
Image package 'C:\Users\LocalSamples\HelloWorld\HelloWorld_HighLevelApp\out\ARM-Debug\HelloWorld_HighLevelApp.imagepackage' has been deployed to the attached device.

Время ожидания неопубликованного набора данных set-deployment-timeout

Задает значение времени ожидания развертывания в секундах для загрузки неопубликованных образов на устройстве.

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

Параметр Тип Описание
-v, --value Целое Указывает длительность в секундах до истечения времени ожидания неопубликованной команды. Значение должно быть положительным целым числом.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device sideload set-deployment-timeout --value 60
 ------------------
 Deployment timeout
 ==================
 60
 ------------------

Загрузка неопубликованного времени ожидания show-deployment-timeout

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

Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device sideload show-deployment-timeout
 ------------------
 Deployment timeout
 ==================
 60
 ------------------

обновить

Перемещает устройство в другую группу в клиенте Azure Sphere.

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

  • Разработка. Принимает только обновления системного программного обеспечения. Не принимает обновления приложений.
  • Проверка поля. Принимает все обновления из службы безопасности Azure Sphere.
  • Рабочая среда: принимает все обновления из службы безопасности Azure Sphere.
  • Оценка рабочей ОС: принимает все обновления из службы безопасности Azure Sphere.
  • Оценка ОС для тестирования полей: принимает все обновления из службы безопасности Azure Sphere.

Дополнительные сведения об основных элементах, участвующих в развертывании, см. в основах развертывания.

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

Параметр Тип Описание
-g, --device-group GUID или имя Указывает группу устройств, в которой нужно переместить устройство. Можно указать идентификатор группы устройств или имя группы устройств. Чтобы использовать имя группы устройств, необходимо указать имя продукта и имя группы устройств в <product-name/device-group-name> формате.
-d, --device Строка Указывает устройство, на котором выполняется команда. Этот параметр требуется при подключении нескольких устройств или при отсутствии устройства. Подключенное устройство используется по умолчанию. Вы можете указать идентификатор устройства для неподключаемого устройства или указать IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
-t, --tenant GUID или имя Указывает клиент для выполнения этой операции. Переопределяет выбранный клиент по умолчанию. Можно указать идентификатор клиента или имя клиента.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device update --device-group AW100/Marketing
 ------------------------------------------------------------------------------------------------------ ------------------------------------ -------- ------------------------------------ ------------------------------------
 DeviceId                                                                                               TenantId                             ChipSku  ProductId                            DeviceGroupId
 ==============================================================================================================================================================================================================================
 352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85 a323c263-2aa3-2559-aabb-a3fc32631900 MT3620AN 6f52bead-700d-4289-bdc2-2f11f774270e 7f860cc1-4949-4000-a541-9a988ba4c3cd
 427D205E46A166B7E41135EB968
 ------------------------------------------------------------------------------------------------------ ------------------------------------ -------- ------------------------------------ ------------------------------------

Параметр можно использовать --query для настройки выходных данных, отображаемых для этой команды. Дополнительные сведения см. в разделе "Вывод команд командной строки запроса".

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

azsphere device update --device-group AW100/Marketing  --query '{DeviceId:deviceId, ProductId:productId}'
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------
 DeviceId                                                                                                                         ProductId
 =====================================================================================================================================================================
 352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968 6f52bead-700d-4289-bdc2-2f11f774270e
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------

wifi

Управляет конфигурациями Wi-Fi для подключенного устройства.

Чтобы использовать устройство в сети Wi-Fi, необходимо добавить сведения о сети и включить сеть на устройстве. Несмотря на то, что можно вводить символы не из набора ASCII в идентификаторы SSID, azsphere не отображает их должным образом.

Если приложение использует API конфигурации Wi-Fi, необходимо также включить функцию WifiConfig в файл app_manifest.json приложения.

Операция Description
добавление Добавляет сведения о беспроводной сети на устройстве.
disable Отключает беспроводную сеть на устройстве.
enable Включает беспроводную сеть на устройстве.
forget Удаляет сведения о беспроводной сети на устройстве.
список Отображает текущую конфигурацию Wi-Fi для устройства.
reload-config Перезагружает конфигурацию Wi-Fi устройства.
scan Проверяет наличие доступных сетей.
show Отображает сведения о конфигурации Wi-Fi.
show-status Отображает состояние интерфейса беспроводной сети.

wifi add

Добавляет сведения о сети Wi-Fi на подключенное устройство.

Устройство может иметь несколько подключений Wi-Fi. Несмотря на то, что можно вводить символы не из набора ASCII в идентификаторы SSID, azsphere не отображает их должным образом. Можно включить --targeted-scan параметр для подключения к скрытым SSID. Дополнительные сведения см. в статье "Подключение Azure Sphere к Wi-Fi".

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

Параметр Тип Описание
-s, --ssid Строка Указывает идентификатор SSID сети. Идентификаторы SSID сети учитывают регистр.

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

Параметр Тип Описание
--client-cert-id Строка [EAP-TLS] Указывает идентификатор (до 16 символов), определяющий сертификат клиента (содержащий открытый и закрытый ключ). Требуется для настройки сети с поддержкой EAP-TLS.
--client-id <user@domain> Строка [EAP-TLS] Указывает идентификатор, распознанный для проверки подлинности сервером RADIUS сети. Требуется для некоторых сетей с поддержкой EAP-TLS.
--config-name Строка Задает строку (до 16 символов), указывающую имя конфигурации сети.
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
--root-ca-cert-id Строка [EAP-tLS] Указывает идентификатор (до 16 символов), определяющий корневой сертификат ЦС сервера для сетей EAP-TLS, где устройство выполняет проверку подлинности сервера.
--targeted-scan Логический Пытается подключиться к сети, даже если она не транслирует или скрыта из-за перегрузки сети.
-p, --psk Строка Задает ключ WPA и WPA2 для новой сети. Не указывайте, чтобы добавить этот идентификатор SSID в открытую сеть. Если ваш ключ содержит знак амперсанда (&), заключите его в кавычки.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device wifi add --ssid MyNetwork --psk MyPassword
Successfully added network:
 ----- -------- ------------------ --------------- ------------- ------------
 ID    SSID     ConfigurationState ConnectionState SecurityState TargetedScan
 ============================================================================
 1     MyNetwork enabled            unknown         psk           False
 ----- -------- ------------------ --------------- ------------- ------------

Если сетевой SSID или ключ имеет внедренные пробелы или амперсанд, заключите SSID или ключ в одинарные кавычки. Если идентификатор SSID или ключ содержит знак кавычек, используйте обратную косую черту, чтобы экранировать этот знак. Обратная косая косая черта не должна быть экранирована, если они являются частью значения. Дополнительные сведения см. в кавычках и escape-символах. Например:

azsphere device wifi add --ssid "New SSID" --psk "key \'value\' with quotes"

wifi disable

Отключает сеть Wi-Fi на подключенном устройстве.

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

Параметр Тип Описание
-i, --id Целое Указывает идентификатор сети для отключения.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device wifi disable --id 0
Successfully disabled network:
----- -------- ------------------ --------------- ------------- ------------
ID    SSID     ConfigurationState ConnectionState SecurityState TargetedScan
============================================================================
0     MyNetwork disabled           disconnected    psk           False
----- -------- ------------------ --------------- ------------- ------------

wifi enable

Включает сеть Wi-Fi на подключенном устройстве.

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

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

Параметр Тип Описание
-i, --id Целое Указывает идентификатор сети для включения.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device wifi enable --id 0
Successfully enabled network:
 ----- -------- ------------------ --------------- ------------- ------------
 ID    SSID     ConfigurationState ConnectionState SecurityState TargetedScan
 ============================================================================
 0     MyNetwork enabled            disconnected    psk           False
 ----- -------- ------------------ --------------- ------------- ------------

wifi forget

Удаляет сведения о сети Wi-Fi с подключенного устройства.

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

Параметр Тип Описание
-i, --id Целое Указывает идентификатор сети для удаления.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device wifi forget --id 0
Successfully forgotten network.

wifi list

Отображает текущую конфигурацию Wi-Fi для подключенного устройства.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device wifi list
 ----- --------- ------------------ --------------- ------------- ------------
 ID    SSID      ConfigurationState ConnectionState SecurityState TargetedScan
 =============================================================================
 0     MyNetwork1 enabled            connected       psk           False
 ----- ---------  ------------------ --------------- ------------- ------------
 1     MyNetwork2 enabled            disconnected    psk           False
 ----- ---------  ------------------ --------------- ------------- ------------
 2     MyNetwork3 enabled            disconnected    eaptls        False
 ----- ---------  ------------------ --------------- ------------- ------------

wifi reload-config

Перезагрузит конфигурацию сети Wi-Fi на подключенном устройстве. Используйте эту команду после добавления или удаления сертификата (azsphere device certificate), чтобы убедиться, что сети EAP-TLS используют последнее содержимое хранилища сертификатов.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device wifi reload-config
Wi-Fi configuration was successfully reloaded.

wifi scan

Проверьте наличие доступных сетей Wi-Fi, видимых на подключенном устройстве. Команда возвращает до 64 сетей Wi-Fi, но количество отображаемых сетей Wi-Fi может быть ограничено экологическими факторами, такими как плотность точек доступа в диапазоне.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device wifi scan
----------------- ------------- ----------------- ----------- ---------
SSID              SecurityState BSSID             SignalLevel Frequency
=======================================================================
MyNetwork0        psk           <value>           -66         2442
----------------- ------------- ----------------- ----------- ---------
MyNetwork1        psk           <value>           -75         2442
----------------- ------------- ----------------- ----------- ---------
MyNetwork2        psk           <value>           -86         2412
----------------- ------------- ----------------- ----------- ---------

wifi show

Отображает сведения о сети Wi-Fi на подключенном устройстве.

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

Параметр Тип Описание
-i, --id Целое Указывает идентификатор отображаемой конфигурации сети.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

azsphere device wifi show --id 0
 ----- --------- ------------------ --------------- ------------- ------------
 ID    SSID      ConfigurationState ConnectionState SecurityState TargetedScan
 =============================================================================
 0     MyNetwork enabled            disconnected    psk           False
 ----- --------- ------------------ --------------- ------------- ------------

wifi show-status

Отображает состояние интерфейса Wi-Fi на подключенном устройстве.

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

Параметр Тип Описание
-d, --device Строка Указывает устройство, на котором выполняется команда при подключении нескольких устройств. Этот параметр требуется при подключении нескольких устройств. Подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства.
Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка.
Глобальные параметры

Для Интерфейса командной строки Azure Sphere доступны следующие глобальные параметры:

Параметр Описание
--debug Увеличивает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, включите выходные данные, полученные с помощью флага --debug, в отправляемый отчет об ошибке.
-h, --help Выводит справочные сведения о командах и их аргументах и списках доступных подгрупп и команд.
--only-show-errors Отображает только ошибки, подавляя предупреждения.
-o, --output Изменяет формат выходных данных. Доступные форматы выходных данных : jsonc, jsonc (цветной JSON), tsv (значения с разделительными табуляциями), таблица (таблицы ASCII, доступные для чтения человека) и yaml. По умолчанию CLI выводит формат table. Дополнительные сведения о доступных форматах выходных данных см. в разделе "Формат выходных данных" для команд Azure Sphere CLI.
--query Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см . в руководстве по JMESPath и выходным данным команды Azure CLI.
--verbose Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другие полезные сведения. Используйте параметр--debug, чтобы включить полные журналы отладки.

Примечание.

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

Пример

 azsphere device wifi show-status
 ----- ------------------ --------------- ------------- --------- ------- ------------- --------- ------------- -----------------
 SSID  ConfigurationState ConnectionState SecurityState Frequency Mode    KeyManagement WpaState  IpAddress     MacAddress
 ================================================================================================================================
<value> enabled            connected       psk           2412      station WPA2-PSK      COMPLETED <value>      <value>
 ----- ------------------ --------------- ------------- --------- ------- ------------- --------- ------------- -----------------