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

az iot central diagnostics

  • Предварительный просмотр

Note

Эта ссылка является частью расширения Azure-iot для Azure CLI (версия 2.59.0 или более поздней). Расширение будет автоматически устанавливаться при первом запуске команды az iot central diagnostics. Подробнее о расширениях.

Эта группа команд находится в предварительной версии и в процессе разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

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

Команды

Имя Описание Тип Состояние
az iot central diagnostics monitor-events

Просмотр сообщений телеметрии устройства, отправленных в приложение IoT Central.

 Extension Preview
az iot central diagnostics monitor-properties

Просмотр требуемых и сообщаемых свойств, отправленных в приложение IoT Central или из нее.

 Extension Preview
az iot central diagnostics registration-summary

Просмотрите сводку регистрации всех устройств в приложении.

 Extension Preview
az iot central diagnostics validate-messages

Проверьте сообщения, отправленные в Центр Интернета вещей для приложения IoT Central.

 Extension Preview
az iot central diagnostics validate-properties

Проверьте сообщаемые свойства, отправленные в приложение IoT Central.

 Extension Preview

az iot central diagnostics monitor-events

Предварительный просмотр

Группа команд iot central diagnostics находится в предварительной версии и в процессе разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

Просмотр сообщений телеметрии устройства, отправленных в приложение IoT Central.

Отображает данные телеметрии, отправленные в приложение IoT Central. По умолчанию отображаются все данные, отправляемые всеми устройствами. Используйте параметр --device-id для фильтрации на определенное устройство.

az iot central diagnostics monitor-events --app-id
                                          [--central-api-uri --central-dns-suffix]
                                          [--cg --consumer-group]
                                          [--device-id]
                                          [--enqueued-time --et]
                                          [--module-id]
                                          [--properties --props {all, anno, app, sys}]
                                          [--repair {false, true}]
                                          [--timeout --to]
                                          [--token]
                                          [--yes {false, true}]

Примеры

Базовое использование

az iot central diagnostics monitor-events --app-id {app_id}

Базовое использование при фильтрации на целевом устройстве

az iot central diagnostics monitor-events --app-id {app_id} -d {device_id}

Базовое использование при фильтрации целевых устройств с подстановочным знаком в идентификаторе

az iot central diagnostics monitor-events --app-id {app_id} -d Device*d

Базовое использование при фильтрации в модуле.

az iot central diagnostics monitor-events --app-id {app_id} -m {module_id}

Базовое использование при фильтрации целевых модулей с подстановочным знаком в идентификаторе

az iot central diagnostics monitor-events --app-id {app_id} -m Module*

Отфильтруйте устройство и укажите группу потребителей Концентратора событий для привязки.

az iot central diagnostics monitor-events --app-id {app_id} -d {device_id} --cg {consumer_group_name}

Получение заметок сообщения (заголовки сообщений)

az iot central diagnostics monitor-events --app-id {app_id} -d {device_id} --properties anno

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

az iot central diagnostics monitor-events --app-id {app_id} -d {device_id} --properties anno sys --timeout 0

Получение всех атрибутов сообщения из всех сообщений устройства

az iot central diagnostics monitor-events --app-id {app_id} --props all

Получение всех сообщений и полезных данных для анализа сообщений в формате JSON

az iot central diagnostics monitor-events --app-id {app_id} --output json

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

--app-id -n

Идентификатор приложения IoT Central, которым требуется управлять. Идентификатор приложения можно найти на странице "О" для приложения в меню справки.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--central-api-uri --central-dns-suffix

Суффикс DNS IoT Central, связанный с приложением.

Свойство Значение
Default value: azureiotcentral.com
--cg --consumer-group -c

Укажите группу потребителей, используемую при подключении к конечной точке концентратора событий.

Свойство Значение
Default value: $Default
--device-id -d

Идентификатор устройства целевого устройства. Идентификатор устройства можно найти, нажав кнопку "Подключить" на странице сведений об устройстве.

--enqueued-time --et -e

Указывает время, которое следует использовать в качестве отправной точки для чтения сообщений из секций. Единицы являются миллисекундами с эпохи UNIX. Если время не указано "сейчас", используется.

--module-id -m

Идентификатор модуля IoT Edge, если тип устройства — IoT Edge.

--properties --props -p

Укажите ключевые свойства сообщения для вывода. sys = системные свойства, приложение = свойства приложения, anno = заметки.

Свойство Значение
Допустимые значения: all, anno, app, sys
--repair -r

Переустановите зависимость uamqp, совместимую с версией расширения. По умолчанию: false.

Свойство Значение
Default value: False
Допустимые значения: false, true
--timeout --to -t

Максимальное количество секунд для поддержания подключения без получения сообщения. Используйте 0 для бесконечности.

Свойство Значение
Default value: 300
--token

Если вы хотите отправить запрос без проверки подлинности в Azure CLI, можно указать действительный маркер пользователя для проверки подлинности запроса. Необходимо указать тип ключа в рамках запроса. Узнайте больше на сайте https://aka.ms/iotcentraldocsapi.

--yes -y

Пропустить запросы пользователей. Указывает на принятие действия. Используется в основном для сценариев автоматизации. По умолчанию: false.

Свойство Значение
Default value: False
Допустимые значения: false, true
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az iot central diagnostics monitor-properties

Предварительный просмотр

Группа команд iot central diagnostics находится в предварительной версии и в процессе разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

Просмотр требуемых и сообщаемых свойств, отправленных в приложение IoT Central или из нее.

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

az iot central diagnostics monitor-properties --app-id
                                              --device-id
                                              [--central-api-uri --central-dns-suffix]
                                              [--token]

Примеры

Базовое использование

az iot central diagnostics monitor-properties --app-id {app_id} -d {device_id}

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

--app-id -n

Идентификатор приложения IoT Central, которым требуется управлять. Идентификатор приложения можно найти на странице "О" для приложения в меню справки.

--device-id -d

Идентификатор устройства целевого устройства. Идентификатор устройства можно найти, нажав кнопку "Подключить" на странице сведений об устройстве.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--central-api-uri --central-dns-suffix

Суффикс DNS IoT Central, связанный с приложением.

Свойство Значение
Default value: azureiotcentral.com
--token

Если вы хотите отправить запрос без проверки подлинности в Azure CLI, можно указать действительный маркер пользователя для проверки подлинности запроса. Необходимо указать тип ключа в рамках запроса. Узнайте больше на сайте https://aka.ms/iotcentraldocsapi.

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

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az iot central diagnostics registration-summary

Предварительный просмотр

Группа команд iot central diagnostics находится в предварительной версии и в процессе разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

Просмотрите сводку регистрации всех устройств в приложении.

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

az iot central diagnostics registration-summary --app-id
                                                [--api-version --av {2022-06-30-preview, 2022-07-31}]
                                                [--central-api-uri --central-dns-suffix]
                                                [--token]

Примеры

Сводка по регистрации

az iot central diagnostics registration-summary --app-id {appid}

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

--app-id -n

Идентификатор приложения IoT Central, которым требуется управлять. Идентификатор приложения можно найти на странице "О" для приложения в меню справки.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-version --av
Не рекомендуется

Аргумент "api_version" устарел и будет удален в будущем выпуске.

Этот параметр команды не рекомендуется использовать и будет игнорироваться. В будущем выпуске мы будем поддерживать только API IoT Central из последней версии общедоступной версии. Если любой API еще не является общедоступной, мы вызовем последнюю предварительную версию.

Свойство Значение
Default value: 2022-07-31
Допустимые значения: 2022-06-30-preview, 2022-07-31
--central-api-uri --central-dns-suffix

Суффикс DNS IoT Central, связанный с приложением.

Свойство Значение
Default value: azureiotcentral.com
--token

Если вы хотите отправить запрос без проверки подлинности в Azure CLI, можно указать действительный маркер пользователя для проверки подлинности запроса. Необходимо указать тип ключа в рамках запроса. Узнайте больше на сайте https://aka.ms/iotcentraldocsapi.

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

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az iot central diagnostics validate-messages

Предварительный просмотр

Группа команд iot central diagnostics находится в предварительной версии и в процессе разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

Проверьте сообщения, отправленные в Центр Интернета вещей для приложения IoT Central.

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

az iot central diagnostics validate-messages --app-id
                                             [--central-api-uri --central-dns-suffix]
                                             [--cg --consumer-group]
                                             [--device-id]
                                             [--dr --duration]
                                             [--enqueued-time --et]
                                             [--max-messages --mm]
                                             [--minimum-severity {error, info, warning}]
                                             [--module-id]
                                             [--properties --props {all, anno, app, sys}]
                                             [--repair {false, true}]
                                             [--style {csv, json, scroll}]
                                             [--timeout --to]
                                             [--token]
                                             [--yes {false, true}]

Примеры

Базовое использование

az iot central diagnostics validate-messages --app-id {app_id}

Ошибки вывода при обнаружении

az iot central diagnostics validate-messages --app-id {app_id} --style scroll

Базовое использование при фильтрации на целевом устройстве

az iot central diagnostics validate-messages --app-id {app_id} -d {device_id}

Базовое использование при фильтрации целевых устройств с подстановочным знаком в идентификаторе

az iot central diagnostics validate-messages --app-id {app_id} -d Device*

Базовое использование при фильтрации в модуле.

az iot central diagnostics validate-messages --app-id {app_id} -m {module_id}

Базовое использование при фильтрации целевых модулей с подстановочным знаком в идентификаторе

az iot central diagnostics validate-messages --app-id {app_id} -m Module*

Отфильтруйте устройство и укажите группу потребителей Концентратора событий для привязки.

az iot central diagnostics validate-messages --app-id {app_id} -d {device_id} --cg {consumer_group_name}

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

--app-id -n

Идентификатор приложения IoT Central, которым требуется управлять. Идентификатор приложения можно найти на странице "О" для приложения в меню справки.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--central-api-uri --central-dns-suffix

Суффикс DNS IoT Central, связанный с приложением.

Свойство Значение
Default value: azureiotcentral.com
--cg --consumer-group -c

Укажите группу потребителей, используемую при подключении к конечной точке концентратора событий.

Свойство Значение
Default value: $Default
--device-id -d

Идентификатор устройства целевого устройства. Идентификатор устройства можно найти, нажав кнопку "Подключить" на странице сведений об устройстве.

--dr --duration

Максимальная длительность получения сообщений от целевого устройства перед завершением подключения. Используйте 0 для бесконечности.

Свойство Значение
Default value: 300
--enqueued-time --et -e

Указывает время, которое следует использовать в качестве отправной точки для чтения сообщений из секций. Единицы являются миллисекундами с эпохи UNIX. Если время не указано "сейчас", используется.

--max-messages --mm

Максимальное количество сообщений для получения от целевого устройства перед завершением подключения. Используйте 0 для бесконечности.

Свойство Значение
Default value: 10
--minimum-severity

Минимальная серьезность проблемы, необходимой для создания отчетов.

Свойство Значение
Default value: warning
Допустимые значения: error, info, warning
--module-id -m

Идентификатор модуля IoT Edge, если тип устройства — IoT Edge.

--properties --props -p

Укажите ключевые свойства сообщения для вывода. sys = системные свойства, приложение = свойства приложения, anno = заметки.

Свойство Значение
Допустимые значения: all, anno, app, sys
--repair -r

Переустановите зависимость uamqp, совместимую с версией расширения. По умолчанию: false.

Свойство Значение
Default value: False
Допустимые значения: false, true
--style

Укажите выходные стилиcroll = доставить ошибки по мере их поступления, json = суммировать результаты в формате json, csv = суммировать результаты в формате CSV.

Свойство Значение
Default value: scroll
Допустимые значения: csv, json, scroll
--timeout --to -t

Максимальное количество секунд для поддержания подключения без получения сообщения. Используйте 0 для бесконечности.

Свойство Значение
Default value: 300
--token

Если вы хотите отправить запрос без проверки подлинности в Azure CLI, можно указать действительный маркер пользователя для проверки подлинности запроса. Необходимо указать тип ключа в рамках запроса. Узнайте больше на сайте https://aka.ms/iotcentraldocsapi.

--yes -y

Пропустить запросы пользователей. Указывает на принятие действия. Используется в основном для сценариев автоматизации. По умолчанию: false.

Свойство Значение
Default value: False
Допустимые значения: false, true
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az iot central diagnostics validate-properties

Предварительный просмотр

Группа команд iot central diagnostics находится в предварительной версии и в процессе разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

Проверьте сообщаемые свойства, отправленные в приложение IoT Central.

Выполняет проверки при обновлении сообщаемого свойства:

  1. Предупреждение — свойства, отправляемые устройством, которое не моделировалось в центре.
  2. Предупреждение. Свойства с одинаковым именем, объявленным в нескольких интерфейсах, должны содержать имя интерфейса в рамках обновления свойства.
az iot central diagnostics validate-properties --app-id
                                               --device-id
                                               [--central-api-uri --central-dns-suffix]
                                               [--minimum-severity {error, info, warning}]
                                               [--token]

Примеры

Базовое использование

az iot central diagnostics validate-properties --app-id {app_id} -d {device_id}

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

--app-id -n

Идентификатор приложения IoT Central, которым требуется управлять. Идентификатор приложения можно найти на странице "О" для приложения в меню справки.

--device-id -d

Идентификатор устройства целевого устройства. Идентификатор устройства можно найти, нажав кнопку "Подключить" на странице сведений об устройстве.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--central-api-uri --central-dns-suffix

Суффикс DNS IoT Central, связанный с приложением.

Свойство Значение
Default value: azureiotcentral.com
--minimum-severity

Минимальная серьезность проблемы, необходимой для создания отчетов.

Свойство Значение
Default value: warning
Допустимые значения: error, info, warning
--token

Если вы хотите отправить запрос без проверки подлинности в Azure CLI, можно указать действительный маркер пользователя для проверки подлинности запроса. Необходимо указать тип ключа в рамках запроса. Узнайте больше на сайте https://aka.ms/iotcentraldocsapi.

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

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False