az iot device

  • Ссылка

Примечание.

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

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

Команды

Имя Описание Тип Состояние
az iot device c2d-message

Команды обмена сообщениями между облаками.

 Расширение Общедоступная версия
az iot device c2d-message abandon

Отказаться от сообщения из облака на устройство.

 Расширение Общедоступная версия
az iot device c2d-message complete

Завершите сообщение об использовании облака на устройство.

 Расширение Общедоступная версия
az iot device c2d-message purge

Очистка очереди сообщений из облака на устройство для целевого устройства.

 Расширение Общедоступная версия
az iot device c2d-message receive

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

 Расширение Общедоступная версия
az iot device c2d-message reject

Отклонить или отменить отправку сообщения из облака на устройство.

 Расширение Общедоступная версия
az iot device c2d-message send

Отправка сообщения из облака на устройство.

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

Управление регистрацией устройств Интернета вещей для службы подготовки устройств Интернета вещей.

 Расширение Предварительная версия
az iot device registration create

Зарегистрируйте устройство Интернета вещей в службе подготовки устройств Интернета вещей.

 Расширение Предварительная версия
az iot device send-d2c-message

Отправьте сообщение mqtt device-to-cloud.

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

Имитация устройства в Центр Интернета вещей Azure.

 Расширение Экспериментальный
az iot device upload-file

Отправьте локальный файл в качестве устройства в предварительно настроенный контейнер хранилища BLOB-объектов.

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

az iot device send-d2c-message

Отправьте сообщение mqtt device-to-cloud.

Команда поддерживает отправку сообщений с пользовательскими полезными данными в строке юникода или двоичном формате. При попытке отправить двоичный файл данные должны поступать из файла (через --data-file-path) и тип контента должен иметь значение application/octet-stream.

Примечание. Команда работает только для устройств на основе симметричного ключа (SAS). Чтобы включить запросы к тексту сообщения в маршрутизации сообщений, системное свойство ContentType должно быть приложением/JSON, а системное свойство contentEncoding должно быть одним из значений кодировки UTF, поддерживаемых этим системным свойством (UTF-8, UTF-16 или UTF-32). Если кодировка содержимого не задана, если служба хранилища Azure используется в качестве конечной точки маршрутизации, Центр Интернета вещей записывает сообщения в кодировке base 64. При использовании методов проверки подлинности x509 необходимо предоставить файлы сертификатов и ключей (и парольную фразу при необходимости).

az iot device send-d2c-message --device-id
                               [--certificate-file-path]
                               [--da]
                               [--data-file-path]
                               [--dtmi]
                               [--hub-name]
                               [--key]
                               [--key-file-path]
                               [--login]
                               [--mc]
                               [--pass]
                               [--properties]
                               [--resource-group]

Примеры

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

az iot device send-d2c-message -n {iothub_name} -d {device_id}

Базовое использование для регистрации модели id модели dtmi:com:example:Thermostat; 1' при подключении

az iot device send-d2c-message -n {iothub_name} -d {device_id} --model-id 'dtmi:com:example:Thermostat;1'

Базовое использование для устройства с проверкой подлинности x509

az iot device send-d2c-message -n {iothub_name} -d {device_id} --cp {certificate_file_path} --kp {key_file_path}

Базовое использование для устройства с проверкой подлинности x509, в которой файл ключа имеет парольную фразу

az iot device send-d2c-message -n {iothub_name} -d {device_id} --cp {certificate_file_path} --kp {key_file_path} --pass {passphrase}

Базовое использование с пользовательскими данными

az iot device send-d2c-message -n {iothub_name} -d {device_id} --data {message_body}

Отправка свойств приложения

az iot device send-d2c-message -n {iothub_name} -d {device_id} --props 'key0=value0;key1=value1'

Отправка системных свойств (идентификатор сообщения и идентификатор корреляции)

az iot device send-d2c-message -n {iothub_name} -d {device_id} --props '$.mid=<id>;$.cid=<id>'

Отправка пользовательских данных путем указания типа контента и кодирования контента в системных свойствах

az iot device send-d2c-message -n {iothub_name} -d {device_id} --props '$.ct=<content-type>;$.ce=<content-encoding>' --data {message_body}

Отправка пользовательских данных в двоичном формате путем указания кодирования содержимого в системных свойствах

az iot device send-d2c-message -n {iothub_name} -d {device_id} --props '$.ct=application/octet-stream' --data-file-path {file_path}

Отправка пользовательских данных в формате JSON путем указания типа контента и кодирования контента в системных свойствах

az iot device send-d2c-message -n {iothub_name} -d {device_id} --props '$.ct=application/json;$.ce=utf-8' --data-file-path {file_path}

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

--device-id -d

Идентификатор целевого устройства.

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

--certificate-file-path --cp

Путь к файлу сертификата.

--da --data

Текст сообщения. Укажите текст или необработанный json.

значение по умолчанию: Ping from Az CLI IoT Extension
--data-file-path --dfp
Предварительный просмотр

Укажите путь к файлу полезных данных текста сообщения. Обратите внимание, что при отправке полезных данных в двоичном формате укажите тип контента для application/octet-stream.

--dtmi --model-id

Идентификатор модели цифрового двойника, который устройство будет сообщать при подключении к концентратору. Дополнительные сведения см. в статье https://docs.microsoft.com/en-us/azure/iot-develop/overview-iot-plug-and-play.

--hub-name -n

Центр Интернета вещей имя или имя узла. Требуется, если --login не указан.

--key --symmetric-key

Симметричный ключ, используемый для устройства. Если указаны симметричный ключ и другие аргументы проверки подлинности устройства, симметричный ключ имеет приоритет.

--key-file-path --kp

Путь к файлу ключа.

--login -l

Эта команда поддерживает сущность строка подключения с правами на выполнение действия. Используйте для предотвращения входа сеанса с помощью az login. Если строка подключения сущности и имя указаны, строка подключения имеет приоритет. Требуется, если имя --hub-name не указано.

--mc --msg-count

Количество сообщений устройства для отправки в Центр Интернета вещей.

значение по умолчанию: 1
--pass --passphrase

Парольная фраза для файла ключа.

--properties --props -p

Контейнер свойств сообщения в парах "ключ-значение" со следующим форматом: a=b; c=d. Для обмена сообщениями mqtt — вы можете отправлять системные свойства с помощью $.=value. Например, $.cid=12345 задает свойство идентификатора корреляции системы. Другие примеры идентификатора системного свойства включают $.ct для типа контента, $.mid для идентификатора сообщения и $.ce для кодирования содержимого.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

Глобальные параметры
--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 device simulate

Экспериментальный

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

Имитация устройства в Центр Интернета вещей Azure.

При выполнении имитации устройства устройство автоматически получает и подтверждает сообщения из облака на устройство (c2d). Для моделирования mqtt все сообщения c2d будут подтверждены с завершением. Для подтверждения c2d по протоколу HTTP используется выбор пользователя, который может быть завершен, отклонен или отклонен. Моделирование mqtt также поддерживает прямой вызов метода, который можно подтвердить кодом состояния ответа и полезными данными ответа. Примечание. Команда по умолчанию задает тип контента для application/json и кодировки содержимого для utf-8. Это может быть переопределено. Примечание. При использовании методов проверки подлинности x509 необходимо предоставить файлы сертификатов и ключей (и парольную фразу при необходимости).

az iot device simulate --device-id
                       [--certificate-file-path]
                       [--da]
                       [--dtmi]
                       [--hub-name]
                       [--init-reported-properties]
                       [--key]
                       [--key-file-path]
                       [--login]
                       [--mc]
                       [--method-response-code]
                       [--method-response-payload]
                       [--mi]
                       [--pass]
                       [--properties]
                       [--proto {http, mqtt}]
                       [--receive-settle {abandon, complete, reject}]
                       [--resource-group]

Примеры

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

az iot device simulate -n {iothub_name} -d {device_id}

Базовое использование для регистрации модели id модели dtmi:com:example:Thermostat; 1' при подключении (mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --model-id 'dtmi:com:example:Thermostat;1'

Базовое использование для устройства с проверкой подлинности x509 (mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --cp {certificate_file_path} --kp {key_file_path}

Базовое использование для устройства с проверкой подлинности x509 (mqtt), в которой файл ключа имеет парольную фразу

az iot device simulate -n {iothub_name} -d {device_id} --cp {certificate_file_path} --kp {key_file_path} --pass {passphrase}

Отправка смешанных свойств (mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --properties "myprop=myvalue;$.ct=application/json"

Отправка кода состояния ответа прямого метода и полезные данные ответа прямого метода в виде необработанных json (только mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --method-response-code 201 --method-response-payload '{"result":"Direct method successful"}'

Отправка кода состояния ответа прямого метода и полезные данные ответа прямого метода в виде пути к локальному файлу (только mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --method-response-code 201 --method-response-payload '../my_direct_method_payload.json'

Отправка исходного состояния свойств двойника устройства в виде необработанного json для целевого устройства (только mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --init-reported-properties '{"reported_prop_1":"val_1", "reported_prop_2":val_2}'

Отправка исходного состояния свойств двойника устройства в качестве пути к локальному файлу для целевого устройства (только mqtt)

az iot device simulate -n {iothub_name} -d {device_id} --init-reported-properties '../my_device_twin_reported_properties.json'

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

az iot device simulate -n {iothub_name} -d {device_id} --protocol http

Отправка смешанных свойств (http)

az iot device simulate -n {iothub_name} -d {device_id} --protocol http --properties "iothub-app-myprop=myvalue;content-type=application/json;iothub-correlationid=12345"

Выбор общего количества сообщений и интервала между сообщениями

az iot device simulate -n {iothub_name} -d {device_id} --msg-count 1000 --msg-interval 5

Отклонение сообщений c2d (только http)

az iot device simulate -n {iothub_name} -d {device_id} --rs reject --protocol http

Отказ от сообщений c2d (только http)

az iot device simulate -n {iothub_name} -d {device_id} --rs abandon --protocol http

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

--device-id -d

Идентификатор целевого устройства.

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

--certificate-file-path --cp

Путь к файлу сертификата.

--da --data

Текст сообщения. Укажите текст или необработанный json.

значение по умолчанию: Ping from Az CLI IoT Extension
--dtmi --model-id

Идентификатор модели цифрового двойника, который устройство будет сообщать при подключении к концентратору. Дополнительные сведения см. в статье https://docs.microsoft.com/en-us/azure/iot-develop/overview-iot-plug-and-play.

--hub-name -n

Центр Интернета вещей имя или имя узла. Требуется, если --login не указан.

--init-reported-properties --irp

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

--key --symmetric-key

Симметричный ключ, используемый для устройства. Если указаны симметричный ключ и другие аргументы проверки подлинности устройства, симметричный ключ имеет приоритет.

--key-file-path --kp

Путь к файлу ключа.

--login -l

Эта команда поддерживает сущность строка подключения с правами на выполнение действия. Используйте для предотвращения входа сеанса с помощью az login. Если строка подключения сущности и имя указаны, строка подключения имеет приоритет. Требуется, если имя --hub-name не указано.

--mc --msg-count

Количество сообщений устройства для отправки в Центр Интернета вещей.

значение по умолчанию: 100
--method-response-code --mrc

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

--method-response-payload --mrp

Полезные данные, возвращаемые при выполнении прямого метода на устройстве. Укажите путь к файлу или необработанный json. Необязательный параметр, поддерживаемый только для mqtt.

--mi --msg-interval

Задержка в секундах между сообщениями из устройства в облако.

значение по умолчанию: 3
--pass --passphrase

Парольная фраза для файла ключа.

--properties --props -p

Контейнер свойств сообщения в парах "ключ-значение" со следующим форматом: a=b; c=d. Для обмена сообщениями mqtt — вы можете отправлять системные свойства с помощью $.=value. Например, $.cid=12345 задает свойство идентификатора корреляции системы. Другие примеры идентификатора системного свойства включают $.ct для типа контента, $.mid для идентификатора сообщения и $.ce для кодирования содержимого. Для обмена сообщениями http — свойства приложения отправляются с помощью iothub-app-value, например iothub-app-myprop=myvalue. Системные свойства обычно префиксируются с iothub, например iothub-correlationid, но существуют исключения, такие как тип контента и кодировка контента.

--proto --protocol

Указывает протокол сообщений между устройствами и облаком.

допустимые значения: http, mqtt
значение по умолчанию: mqtt
--receive-settle --rs

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

допустимые значения: abandon, complete, reject
значение по умолчанию: complete
--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

Глобальные параметры
--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 device upload-file

Отправьте локальный файл в качестве устройства в предварительно настроенный контейнер хранилища BLOB-объектов.

az iot device upload-file --content-type
                          --device-id
                          --file-path
                          [--hub-name]
                          [--login]
                          [--resource-group]

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

--content-type --ct

Тип ФАЙЛА MIME.

--device-id -d

Идентификатор целевого устройства.

--file-path --fp

Путь к файлу для отправки.

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

--hub-name -n

Центр Интернета вещей имя или имя узла. Требуется, если --login не указан.

--login -l

Эта команда поддерживает сущность строка подключения с правами на выполнение действия. Используйте для предотвращения входа сеанса с помощью az login. Если строка подключения сущности и имя указаны, строка подключения имеет приоритет. Требуется, если имя --hub-name не указано.

--resource-group -g

Имя группы ресурсов. Вы можете настроить расположение по умолчанию с помощью az configure --defaults group=<name>.

Глобальные параметры
--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.