Поддерживаемые форматы выходных данных для Интерфейса командной строки Azure Sphere

Статья
09/27/2024

Внимание

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

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

Примечание.

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

Значения аргументов и типы выходных данных:

Формат вывода	Description
`table`	Таблица ASCII с ключами в качестве заголовков столбцов. Этот формат по умолчанию.
`json`	Строка в формате JSON.
`jsonc`	Выделенная цветом строка JSON.
`yaml`	YAML, альтернативный JSON машиночитаемый формат.
`yamlc`	Цветной YAML.
`tsv`	Значения, разделенные табуляции, без ключей.
`none`	Выходные данные, отличные от ошибок и предупреждений.

Поддерживаемые команды

Вы можете указать необходимый формат выходных данных для команды с помощью --output, --outили -o. Если у нас отсутствует команда, которую необходимо выполнить скрипт, сообщите нам об этом с помощью azsphere feedback. Она поддерживается для следующих команд:

Формат табличных выходных данных

Формат table по умолчанию выводит выходные данные в виде таблицы ASCII, что упрощает чтение и сканирование. Этот формат лучше всего подходит, если требуется быстрый и доступный для поиска людей обзор данных. Это полезно для получения сводки сосредоточенной информации, особенно для команд списка.

azsphere tenant list --output table
 ------------------------------------ --------------------- -------------
 Id                                   Name                  Roles
 ========================================================================
 143adbc9-1bf0-4be2-84a2-084a331d81cb MyTenant               Contributor
 ------------------------------------ --------------------- -------------
 768c2cd6-059a-49ad-9f53-89f5271cea15 MyTenant1              Administrator
                                                             Contributor
 ------------------------------------ --------------------- -------------

Параметр можно использовать --query для настройки свойств и столбцов, которые нужно отобразить в выходных данных. В следующем примере показано, как выбрать только Идентификатор клиента и роль в команде списка.

azsphere tenant list --query '[].{TenantID:id, Role:roles}'
 ------------------------------------ -------------
 TenantID                             Role
 ==================================================
 143adbc9-1bf0-4be2-84a2-084a331d81cb Contributor
 ------------------------------------ -------------
 183adhc9-a5c8-8he2-84a2-c4f00f73a471 Administrator
                                      Contributor
 ------------------------------------ -------------

Примечание.

Выполните команду в формате JSON, чтобы просмотреть доступные имена свойств, которые будут использоваться в запросе. Например, при выполнении azsphere tenant list --output json команды выходные данные отображают имена и значения, доступные для этой команды.
Вложенные объекты, некоторые ключи и поля не печатаются в выходных данных таблицы по умолчанию. Если вам нужно отобразить их в выходных данных, вы можете использовать функцию повторного добавления ключа JMESPath, чтобы изменить имя ключа и избежать фильтрации. Дополнительные сведения об использовании запросов для фильтрации данных см. в выходных данных командной строки запроса.

Формат выходных данных JSON.

Формат выходных данных JSON включает все необработанные данные и вложенные данные в структурированном формате. Мы рекомендуем использовать выходные данные JSON для кратких выходных данных и сценариев. Это применимо только в том случае, если команда завершается успешно и возвращает значение 0.

В следующем примере отображается список клиентов в формате JSON по умолчанию.

azsphere tenant list --output json
[
  {
    "id": "143adbc9-1bf0-4be2-84a2-084a331d81cb",
    "name": "MyTenant",
    "roles": [
      "Contributor"
    ]
  },
  {
    "id": "768c2cd6-059a-49ad-9f53-89f5271cea15",
    "name": "MyTenant1",
    "roles": [
      "Administrator",
      "Contributor"
    ]
  }
]

Формат выходных данных YAML

yamlВыходные данные отображаются в YAML, формате сериализации данных обычного текста. YAML, как правило, проще читать, чем JSON.

azsphere tenant list --output yaml
- id: 143adbc9-1bf0-4be2-84a2-084a331d81cb
  name: MyTenant
  roles:
  - Contributor
- id: 768c2cd6-059a-49ad-9f53-89f5271cea15
  name: MyTenant1
  roles:
  - Administrator
  - Contributor

Формат выходных данных TSV

Формат tsv выходных данных возвращает разделенные табуляции и разделенные новой строкой значения без дополнительного форматирования, ключей или других символов. Выходные tsv данные похожи на table выходные данные, но отличаются следующими способами:

Заголовки столбцов не отображаются в выходных tsv данных.
В table выходных данных отображается список и tsv отображается длина списка.
Вложенные объекты не печатаются в выходных tsv данных.
Выходные tsv данные разделены и не масштабируются для размещения терминала.

azsphere tenant list --output tsv
143adbc9-1bf0-4be2-84a2-084a331d81cb    MyTenant    1
768c2cd6-059a-49ad-9f53-89f5271cea15    MyTenant1    2

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