Поддерживаемые форматы вывода для Azure Sphere CLI

  • Статья

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

Примечание

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

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

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

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

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

Формат вывода таблицы

Формат 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, чтобы изменить имя ключа и избежать фильтрации. Дополнительные сведения об использовании запросов для фильтрации данных см. в разделе Выходные данные команды Cli запроса.

Формат выходных данных 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