az iot device

Примечание

Эта ссылка является частью расширения Azure-IOT для Azure CLI и требует версии 2.17.1 или более поздней. Расширение будет автоматически установлено при первом запуске команды 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 send-d2c-message

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

Примечание. команда работает только для устройств на основе проверки подлинности с симметричным ключом (SAS).

az iot device simulate

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

Пока выполняется имитация устройства, устройство автоматически получает и подтверждает сообщения, отправляемые из облака на устройство (C2D). Для имитации mqtt все сообщения C2D будут подтверждаться завершением. Подтверждение C2D моделирования HTTP зависит от выбора пользователя, который можно завершить, отклонить или отменить. Кроме того, моделирование mqtt поддерживается только для устройств на основе проверки подлинности с симметричным ключом (SAS)

Примечание. по умолчанию команда задаст для Content-Type значение Application/JSON и кодировку содержимого UTF-8. Это можно переопределить.

az iot device upload-file

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

az iot device send-d2c-message

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

Примечание. команда работает только для устройств на основе проверки подлинности с симметричным ключом (SAS).

az iot device send-d2c-message --device-id
                               [--da]
                               [--hub-name]
                               [--login]
                               [--mc]
                               [--properties]
                               [--qos {0, 1}]
                               [--resource-group]

Примеры

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

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

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

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>'

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

--device-id -d

Целевое устройство.

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

--da --data

Текст сообщения.

значение по умолчанию: Ping from Az CLI IoT Extension
--hub-name -n

Имя центра Интернета вещей.

--login -l

Эта команда поддерживает строку подключения сущности с правами на выполнение действия. Используйте, чтобы избежать сеанса входа в сеанс с помощью команды AZ Login. Если заданы строка подключения и имя сущности, то строка соединения имеет приоритет.

--mc --msg-count

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

значение по умолчанию: 1
--properties --props -p

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

--qos

Качество обслуживания. 0 = не более одного раза, 1 = хотя бы один раз. 2 (ровно один раз) не поддерживается. Этот параметр команды является устаревшим и будет удален в следующем выпуске.

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

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

az iot device simulate

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

Пока выполняется имитация устройства, устройство автоматически получает и подтверждает сообщения, отправляемые из облака на устройство (C2D). Для имитации mqtt все сообщения C2D будут подтверждаться завершением. Подтверждение C2D моделирования HTTP зависит от выбора пользователя, который можно завершить, отклонить или отменить. Кроме того, моделирование mqtt поддерживается только для устройств на основе проверки подлинности с симметричным ключом (SAS)

Примечание. по умолчанию команда задаст для Content-Type значение Application/JSON и кодировку содержимого UTF-8. Это можно переопределить.

az iot device simulate --device-id
                       [--da]
                       [--hub-name]
                       [--login]
                       [--mc]
                       [--mi]
                       [--properties]
                       [--proto {http, mqtt}]
                       [--receive-settle {abandon, complete, reject}]
                       [--resource-group]

Примеры

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

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

Базовое использование (mqtt) с отправкой смешанных свойств

az iot device simulate -n {iothub_name} -d {device_id} --properties "myprop=myvalue;$.ct=application/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

Целевое устройство.

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

--da --data

Текст сообщения.

значение по умолчанию: Ping from Az CLI IoT Extension
--hub-name -n

Имя центра Интернета вещей.

--login -l

Эта команда поддерживает строку подключения сущности с правами на выполнение действия. Используйте, чтобы избежать сеанса входа в сеанс с помощью команды AZ Login. Если заданы строка подключения и имя сущности, то строка соединения имеет приоритет.

--mc --msg-count

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

значение по умолчанию: 100
--mi --msg-interval

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

значение по умолчанию: 3
--properties --props -p

Контейнер свойств сообщения в парах "ключ-значение" со следующим форматом: a = b; c = d. Для обмена сообщениями mqtt — вы можете отправить системные свойства с помощью $. = значение. Например, экземпляр $. CID = 12345 задает свойство "идентификатор корреляции системы". Другие примеры идентификаторов системных свойств включают $. CT для типа содержимого, $. mid для идентификатора сообщения и $. CE для кодирования содержимого. Для обмена сообщениями HTTP свойства приложения отправляются с помощью iothub-App- = value, например iothub-App-мипроп = значения MyValue. Как правило, системные свойства имеют префикс iothub- Like iothub-correlationId, но существуют исключения, такие как Content-Type и Content-Encoding.

--proto --protocol

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

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

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

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

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

az iot device upload-file

Upload локальный файл в качестве устройства в предварительно настроенный контейнер хранилища 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 -l

Эта команда поддерживает строку подключения сущности с правами на выполнение действия. Используйте, чтобы избежать сеанса входа в сеанс с помощью команды AZ Login. Если заданы строка подключения и имя сущности, то строка соединения имеет приоритет.

--resource-group -g

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