Арендатор
Управляет клиентом Azure Sphere.
Важно
Команды azsphere tenant download-ca-certificate, azsphere tenant download-ca-certificate-chainи azsphere tenant download-validation-certificate устарели. Вместо этого используйте azsphere ca-certificate download, azsphere ca-certificate download-chain, azsphere ca-certificate download-proofи azsphere ca-certificate list .
В Azure Sphere CLI клиент по умолчанию не выбирается автоматически при создании клиента. Необходимо выполнить команду azsphere tenant select , чтобы выбрать клиент по умолчанию для текущего пользователя на компьютере. Это позволяет убедиться, что клиент по умолчанию является правильным для использования при выполнении одноразовой операции, которую нельзя отменить, например при утверждении устройства.
| Операции | Описание |
|---|---|
| Создать | Создает новый клиент. |
| download-error-report | Возвращает сведения об ошибке для устройств в текущем клиенте. |
| Список | Список доступных клиентов Azure Sphere. |
| Выберите | Выбирает клиент Azure Sphere по умолчанию для использования на этом компьютере. |
| показать выбранный | Отображает клиент Azure Sphere по умолчанию для этого компьютера. |
| Обновление | Обновления сведения о клиенте, например имя клиента. |
Создать
Создает новый клиент Azure Sphere. Для выполнения этой команды требуется подключенное устройство. Дополнительные сведения см. в статье Создание клиента Azure Sphere.
Если у вас уже есть клиент и вы уверены, что хотите использовать другой клиент, используйте --force-additional параметр . В настоящее время невозможно удалить клиент Azure Sphere.
После создания клиента выполните команду azsphere tenant select , чтобы выбрать клиент по умолчанию для текущего пользователя на этом компьютере. Вы можете добавить роли для пользователей в текущем клиенте Azure Sphere с помощью команды azsphere role add .
Команда azsphere tenant create работает с локально подключенным устройством Azure Sphere. При попытке выполнить команду без подключенного устройства вы получите сообщение об ошибке. Идентификатор устройства записывается при создании клиента, и для каждого устройства можно создать только один клиент.
Обязательные параметры
| Параметр | Тип | Описание |
|---|---|---|
| -n, --name | Строка | Указывает имя клиента. При именовании клиента используйте буквенно-цифровые символы. Специальные символы не допускаются. Имя не должно превышать 50 символов и учитывает регистр. |
Необязательные параметры
| Параметр | Тип | Описание |
|---|---|---|
| -d, --device | Строка | Указывает устройство, на котором будет выполняться команда при подключении нескольких устройств. Этот параметр является обязательным при подключении нескольких устройств. Текущее подключенное устройство используется по умолчанию. Можно указать идентификатор устройства, IP-адрес или идентификатор локального подключения подключенного устройства. Azure Sphere CLI поддерживает несколько устройств MT3620 в Windows, но вы можете подключать только одно устройство одновременно в Linux. По этой причине этот параметр поддерживается для Windows, но не для Linux. Если этот параметр используется с командой в Linux, возвращается ошибка. |
| --force-additional | Логических | Принудительное создание нового клиента Azure Sphere. Используйте эту команду, только если вы уверены, что хотите использовать текущую учетную запись для создания нового клиента Azure Sphere с помощью подключенного устройства. |
| --disable-confirm-prompt | Логических | Отключает запрос на подтверждение пользователя. |
Глобальные параметры
Для Azure Sphere CLI доступны следующие глобальные параметры:
| Параметр | Описание |
|---|---|
| --Отладки | Повышает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, укажите выходные данные, созданные с флагом --debug в при отправке отчета об ошибке. |
| -h, --help | Выводит справочные сведения о командах и их аргументах, а также список доступных подгрупп и команд. |
| --only-show-errors | Отображает только ошибки, подавляющие предупреждения. |
| -o, --output | Изменяет формат вывода. Доступные форматы выходных данных: json, jsonc (цветной JSON), tsv (значения, разделенные табуляциями), таблица (читаемые человеком таблицы ASCII) и yaml. По умолчанию CLI выводит .table Дополнительные сведения о доступных форматах вывода см. в статье Формат вывода для команд Azure Sphere CLI. |
| --Запроса | Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см. в руководстве по JMESPath и запросе выходных данных команды Azure CLI . |
| --Подробного | Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другую полезную информацию. Используется --debug для полных журналов отладки. |
Примечание
Если вы используете классический интерфейс командной строки Azure Sphere, дополнительные сведения о доступных параметрах см. в статье Глобальные параметры .
Примере
azsphere tenant create --name MyTenant
--force-additional Используйте параметры и--disable-confirm-prompt, если вы уверены, что хотите использовать эту учетную запись для создания нового клиента Azure Sphere с помощью подключенного устройства. Устройство, которое ранее использовалось для создания клиента Azure Sphere, не может использоваться для создания нового клиента.
azsphere tenant create --name MyTenant --force-additional
You have logged in with the following account:
bob@contoso.com
Do you want to use this account to create a new Azure Sphere tenant using the attached device?
You cannot change the tenant name 'MyTenant1' once it has been created.
Enter 'yes' to continue. Enter anything else to exit.
yes
> verbose: TraceId: c761ba73-761e-4df2-94f5-3f87384d71b7
Created a new Azure Sphere tenant:
--> Tenant Name: MyTenant1
--> Tenant ID: 768c2cd6-059a-49ad-9f53-89f5271cea15
Please use 'azsphere tenant select --tenant MyTenant' to select the created tenant.
Совет
После создания клиента убедитесь, что вы запустите команду azsphere tenant select , чтобы выбрать клиент по умолчанию для текущего пользователя на этом компьютере.
download-error-report
Возвращает сведения об ошибках, сообщаемых устройствами в текущем клиенте.
Эта команда извлекает данные события из облака службы безопасности Azure Sphere и не требует физического подключения к конкретному устройству. Команда azsphere tenant download-error-report работает в контексте текущего клиента и возвращает отчеты об ошибках для всех устройств в этом клиенте.
Примечание
На то, что недавно сообщаемые события будут доступны для скачивания, может потребоваться до 24 часов. Дополнительные сведения см. в статье Сбор и интерпретация данных об ошибках.
Необязательные параметры
| Параметр | Тип | Описание |
|---|---|---|
| --Назначения | Строка | Указывает путь и имя файла выходного файла. |
| -t, --tenant | GUID или имя | Указывает клиент, в котором будет выполняться эта операция. Переопределяет выбранный по умолчанию клиент. Можно указать идентификатор клиента или имя клиента. |
Глобальные параметры
Для Azure Sphere CLI доступны следующие глобальные параметры:
| Параметр | Описание |
|---|---|
| --Отладки | Повышает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, укажите выходные данные, созданные с флагом --debug в при отправке отчета об ошибке. |
| -h, --help | Выводит справочные сведения о командах и их аргументах, а также список доступных подгрупп и команд. |
| --only-show-errors | Отображает только ошибки, подавляющие предупреждения. |
| -o, --output | Изменяет формат вывода. Доступные форматы выходных данных: json, jsonc (цветной JSON), tsv (значения, разделенные табуляциями), таблица (читаемые человеком таблицы ASCII) и yaml. По умолчанию CLI выводит .table Дополнительные сведения о доступных форматах вывода см. в статье Формат вывода для команд Azure Sphere CLI. |
| --Запроса | Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см. в руководстве по JMESPath и запросе выходных данных команды Azure CLI . |
| --Подробного | Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другую полезную информацию. Используется --debug для полных журналов отладки. |
Примечание
Если вы используете классический интерфейс командной строки Azure Sphere, дополнительные сведения о доступных параметрах см. в статье Глобальные параметры .
Примере
azsphere tenant download-error-report --destination c:\error-report.csv --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
Список
Список клиентов Azure Sphere.
Глобальные параметры
Для Azure Sphere CLI доступны следующие глобальные параметры:
| Параметр | Описание |
|---|---|
| --Отладки | Повышает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, укажите выходные данные, созданные с флагом --debug в при отправке отчета об ошибке. |
| -h, --help | Выводит справочные сведения о командах и их аргументах, а также список доступных подгрупп и команд. |
| --only-show-errors | Отображает только ошибки, подавляющие предупреждения. |
| -o, --output | Изменяет формат вывода. Доступные форматы выходных данных: json, jsonc (цветной JSON), tsv (значения, разделенные табуляциями), таблица (читаемые человеком таблицы ASCII) и yaml. По умолчанию CLI выводит .table Дополнительные сведения о доступных форматах вывода см. в статье Формат вывода для команд Azure Sphere CLI. |
| --Запроса | Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см. в руководстве по JMESPath и запросе выходных данных команды Azure CLI . |
| --Подробного | Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другую полезную информацию. Используется --debug для полных журналов отладки. |
Примечание
Если вы используете классический интерфейс командной строки Azure Sphere, дополнительные сведения о доступных параметрах см. в статье Глобальные параметры .
Примере
azsphere tenant list
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
143adbc9-1bf0-4be2-84a2-084a331d81cb MyTenant Administrator
Contributor
------------------------------------ --------------------- -------------
Выберите
Выбирает клиент Azure Sphere по умолчанию для текущего пользователя на этом компьютере.
Чтобы отобразить текущий клиент по умолчанию, используйте команду azsphere tenant show-selected.
Обязательные параметры
| Параметр | Тип | Описание |
|---|---|---|
| -t, --tenant | GUID или имя | Указывает клиент, в котором будет выполняться эта операция. Переопределяет выбранный по умолчанию клиент. Можно указать идентификатор клиента или имя клиента. |
Глобальные параметры
Для Azure Sphere CLI доступны следующие глобальные параметры:
| Параметр | Описание |
|---|---|
| --Отладки | Повышает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, укажите выходные данные, созданные с флагом --debug в при отправке отчета об ошибке. |
| -h, --help | Выводит справочные сведения о командах и их аргументах, а также список доступных подгрупп и команд. |
| --only-show-errors | Отображает только ошибки, подавляющие предупреждения. |
| -o, --output | Изменяет формат вывода. Доступные форматы выходных данных: json, jsonc (цветной JSON), tsv (значения, разделенные табуляциями), таблица (читаемые человеком таблицы ASCII) и yaml. По умолчанию CLI выводит .table Дополнительные сведения о доступных форматах вывода см. в статье Формат вывода для команд Azure Sphere CLI. |
| --Запроса | Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см. в руководстве по JMESPath и запросе выходных данных команды Azure CLI . |
| --Подробного | Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другую полезную информацию. Используется --debug для полных журналов отладки. |
Примечание
Если вы используете классический интерфейс командной строки Azure Sphere, дополнительные сведения о доступных параметрах см. в статье Глобальные параметры .
Примере
azsphere tenant select --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
143adbc9-1bf0-4be2-84a2-084a331d81cb MyTenant Administrator
Contributor
------------------------------------ --------------------- -------------
показать выбранный
Отображает сведения о клиенте Azure Sphere по умолчанию для текущего пользователя на этом компьютере.
Это клиент, выбранный с помощью команды azsphere tenant select .
Глобальные параметры
Для Azure Sphere CLI доступны следующие глобальные параметры:
| Параметр | Описание |
|---|---|
| --Отладки | Повышает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, укажите выходные данные, созданные с флагом --debug в при отправке отчета об ошибке. |
| -h, --help | Выводит справочные сведения о командах и их аргументах, а также список доступных подгрупп и команд. |
| --only-show-errors | Отображает только ошибки, подавляющие предупреждения. |
| -o, --output | Изменяет формат вывода. Доступные форматы выходных данных: json, jsonc (цветной JSON), tsv (значения, разделенные табуляциями), таблица (читаемые человеком таблицы ASCII) и yaml. По умолчанию CLI выводит .table Дополнительные сведения о доступных форматах вывода см. в статье Формат вывода для команд Azure Sphere CLI. |
| --Запроса | Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см. в руководстве по JMESPath и запросе выходных данных команды Azure CLI . |
| --Подробного | Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другую полезную информацию. Используется --debug для полных журналов отладки. |
Примечание
Если вы используете классический интерфейс командной строки Azure Sphere, дополнительные сведения о доступных параметрах см. в статье Глобальные параметры .
Примере
azsphere tenant show-selected
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
143adbc9-1bf0-4be2-84a2-084a331d81cb MyTenant Administrator
Contributor
------------------------------------ --------------------- -------------
Обновление
Обновления сведения о клиенте, например имя клиента.
Обязательные параметры
| Параметр | Тип | Описание |
|---|---|---|
| -n, --new-name | Строка | Задает новое имя клиента. При именовании клиента используйте буквенно-цифровые символы. Специальные символы не допускаются. Имя не должно превышать 50 символов и учитывает регистр. |
Необязательные параметры
| Параметр | Тип | Описание |
|---|---|---|
| -t, --tenant | GUID или имя | Указывает клиент, в котором будет выполняться эта операция. Переопределяет выбранный по умолчанию клиент. Можно указать идентификатор клиента или имя клиента. |
Глобальные параметры
Для Azure Sphere CLI доступны следующие глобальные параметры:
| Параметр | Описание |
|---|---|
| --Отладки | Повышает детализацию ведения журнала для отображения всех журналов отладки. Если вы обнаружили ошибку, укажите выходные данные, созданные с флагом --debug в при отправке отчета об ошибке. |
| -h, --help | Выводит справочные сведения о командах и их аргументах, а также список доступных подгрупп и команд. |
| --only-show-errors | Отображает только ошибки, подавляющие предупреждения. |
| -o, --output | Изменяет формат вывода. Доступные форматы выходных данных: json, jsonc (цветной JSON), tsv (значения, разделенные табуляциями), таблица (читаемые человеком таблицы ASCII) и yaml. По умолчанию CLI выводит .table Дополнительные сведения о доступных форматах вывода см. в статье Формат вывода для команд Azure Sphere CLI. |
| --Запроса | Использует язык запросов JMESPath для фильтрации выходных данных, возвращаемых службами безопасности Azure Sphere. Дополнительные сведения и примеры см. в руководстве по JMESPath и запросе выходных данных команды Azure CLI . |
| --Подробного | Выводит сведения о ресурсах, созданных в Azure Sphere во время операции, и другую полезную информацию. Используется --debug для полных журналов отладки. |
Примечание
Если вы используете классический интерфейс командной строки Azure Sphere, дополнительные сведения о доступных параметрах см. в статье Глобальные параметры .
Примере
azsphere tenant update --tenant a323c263-2aa3-2559-aabb-a3fc32631900 --new-name Tenant2
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
a323c263-2aa3-2559-aabb-a3fc32631900 Tenant2 Administrator
Contributor
------------------------------------ --------------------- -------------
Совет
Если вы не выбрали клиент по умолчанию, отобразится список доступных клиентов. Задайте клиент по умолчанию, выбрав один из параметров.