az iot central device command

  • Ссылка

Примечание.

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

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

Команды

Имя Описание Тип Состояние
az iot central device command history

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

 Расширение Общедоступная версия
az iot central device command run

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

 Расширение Общедоступная версия

az iot central device command history

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

Выводит последние запросы и ответы, отправленные на устройство из IoT Central. Любое обновление, которое устройство выполняет для свойств устройства в результате выполнения команды, не включается в ответ.

az iot central device command history --app-id
                                      --cn
                                      --device-id
                                      [--api-version {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri]
                                      [--co]
                                      [--interface-id]
                                      [--mn]
                                      [--token]

Примеры

Показать ответ команды

az iot central device command history --app-id {appid} --device-id {deviceid} --interface-id {interfaceid} --command-name {commandname}

Отображение ответа команды компонента

az iot central device command history --app-id {appid} --device-id {deviceid} --component-name {componentname} --command-name {commandname}

Отображение ответа команды компонента модуля

az iot central device command history --app-id {appid} --device-id {deviceid} --module-name {modulename} --component-name {componentname} --command-name {commandname}

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

--app-id -n

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

--cn --command-name

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

--device-id -d

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

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

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

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

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

допустимые значения: 2022-06-30-preview, 2022-07-31
значение по умолчанию: 2022-07-31
--central-api-uri --central-dns-suffix

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

значение по умолчанию: azureiotcentral.com
--co --component-name

Имя компонента устройства.

--interface-id -i

Имя интерфейса или компонента, указанного в шаблоне устройства. Его можно найти, перейдя к шаблону устройства и просмотрев удостоверение интерфейса или компонента в соответствующей возможности устройства.

--mn --module-name

Имя модуля устройства.

--token

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

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

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

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

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

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

--subscription

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

--verbose

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

az iot central device command run

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

--content может быть встроенным json или путь к файлу.

az iot central device command run --app-id
                                  --cn
                                  --content
                                  --device-id
                                  [--api-version {2022-06-30-preview, 2022-07-31}]
                                  [--central-api-uri]
                                  [--co]
                                  [--interface-id]
                                  [--mn]
                                  [--token]

Примеры

Выполните команду с встроенными полезными данными. Полезные данные должны находиться в разделе "request" в строке JSON

az iot central device command run --app-id {appid} --device-id {deviceid} --interface-id {interfaceid} --command-name {commandname} --content '{"request": {payload}}'

Команда short run с пути полезных данных JSON.

az iot central device command run -n {appid} -d {deviceid} -i {interfaceid} --cn {commandname} -k {payload_file_path}

Выполните команду компонента.

az iot central device command run -n {appid} -d {deviceid} --co {componentname} --cn {commandname} -k {payload}

Выполните команду компонента модуля.

az iot central device command run -n {appid} -d {deviceid} --mn {modulename} --co {componentname} --cn {commandname} -k {payload}

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

--app-id -n

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

--cn --command-name

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

--content -k

Конфигурация запроса. Укажите путь к JSON-файлу или необработанным строкам JSON. [Пример пути к файлу: ./path/to/file.json] [Пример json stringified: {'a': 'b'}].

--device-id -d

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

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

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

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

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

допустимые значения: 2022-06-30-preview, 2022-07-31
значение по умолчанию: 2022-07-31
--central-api-uri --central-dns-suffix

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

значение по умолчанию: azureiotcentral.com
--co --component-name

Имя компонента устройства.

--interface-id -i

Имя интерфейса или компонента, указанного в шаблоне устройства. Его можно найти, перейдя к шаблону устройства и просмотрев удостоверение интерфейса или компонента в соответствующей возможности устройства.

--mn --module-name

Имя модуля устройства.

--token

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

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

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

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

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: json
--query

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

--subscription

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

--verbose

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