tenant
Внимание
Это документация по Azure Sphere (устаревшая версия). Служба Azure Sphere (устаревшая версия) выходит на пенсию 27 сентября 2027 г., и к этому времени пользователи должны перейти в Azure Sphere (интегрированная). Используйте селектор версий, расположенный над toC, чтобы просмотреть документацию по Azure Sphere (интегрированная).
Управляет клиентом Azure Sphere.
Внимание
Команды azsphere tenant download-ca-certificateи azsphere tenant download-ca-certificate-chainazsphere 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 , чтобы выбрать клиент по умолчанию, используемый для текущего пользователя на компьютере. Это позволяет убедиться, что клиент по умолчанию является правильным для использования при выполнении однократной операции, которую нельзя отменить, например утверждение устройства.
| Операция | Description |
|---|---|
| создание | Создает новый клиент. |
| download-error-report | Возвращает сведения об ошибке для устройств в текущем клиенте. |
| список | Выводит список доступных клиентов Azure Sphere. |
| select | Выбирает клиент Azure Sphere по умолчанию, используемый на этом компьютере. |
| show-selected | Отображает клиент Azure Sphere по умолчанию для этого компьютера. |
| обновить | Обновляет сведения о клиенте, например имя клиента. |
create
Создает новый клиент Azure Sphere. Для выполнения этой команды требуется подключенное устройство. Дополнительные сведения см. в статье "Создание клиента Azure Sphere".
Если у вас уже есть клиент и вы уверены, что нужен еще один, используйте параметр --force-additional. Сейчас удалить клиент Azure Sphere невозможно.
После создания клиента запустите azsphere tenant, чтобы выбрать клиент по умолчанию, используемый для текущего пользователя на этом компьютере. Вы можете добавить роли для пользователей в текущем клиенте 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 доступны следующие глобальные параметры:
| Параметр | Описание |
|---|---|
| --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 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 доступны следующие глобальные параметры:
| Параметр | Описание |
|---|---|
| --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 tenant download-error-report --destination c:\error-report.csv --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
список
Выводит список клиентов 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 tenant list
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
143adbc9-1bf0-4be2-84a2-084a331d81cb MyTenant Administrator
Contributor
------------------------------------ --------------------- -------------
select
Выбирает клиент Azure Sphere по умолчанию, используемый для текущего пользователя на этом компьютере.
Для отображения текущего клиента по умолчанию используйте команду azsphere tenant show-selected.
Обязательные параметры
| Параметр | Тип | Описание |
|---|---|---|
| -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 tenant select --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
143adbc9-1bf0-4be2-84a2-084a331d81cb MyTenant Administrator
Contributor
------------------------------------ --------------------- -------------
show-selected
Отображает сведения о клиенте Azure Sphere по умолчанию для текущего пользователя на этом компьютере.
Этот клиент выбран с помощью команды azsphere tenant select.
Глобальные параметры
Для Интерфейса командной строки 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 tenant show-selected
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
143adbc9-1bf0-4be2-84a2-084a331d81cb MyTenant Administrator
Contributor
------------------------------------ --------------------- -------------
обновить
Обновляет сведения о клиенте, например имя клиента.
Обязательные параметры
| Параметр | Тип | Описание |
|---|---|---|
| -n, --new-name | Строка | Задает новое имя для клиента. Имя вашего клиента должно содержать буквы и цифры. Использовать специальные знаки не допускается. Имя не должно превышать 50 символов и учитывает регистр. |
Необязательные параметры
| Параметр | Тип | Описание |
|---|---|---|
| -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 tenant update --tenant a323c263-2aa3-2559-aabb-a3fc32631900 --new-name Tenant2
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
a323c263-2aa3-2559-aabb-a3fc32631900 Tenant2 Administrator
Contributor
------------------------------------ --------------------- -------------
Совет
Если вы не выбрали клиент по умолчанию, отобразится список доступных клиентов. Задайте клиент по умолчанию, выбрав один из вариантов.