az iot device c2d-message

  • Ссылка

Примечание.

Эта ссылка является частью расширения Azure-iot для Azure CLI (версия 2.37.0 или более поздней). Расширение будет автоматически устанавливаться при первом запуске команды 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 c2d-message abandon

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

az iot device c2d-message abandon --device-id
                                  [--etag]
                                  [--hub-name]
                                  [--login]
                                  [--resource-group]

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

--device-id -d

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

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

--etag -e

Тег Etag или сущности, соответствующий последнему состоянию ресурса. Если etag не указан, используется значение "*".

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

az iot device c2d-message complete

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

az iot device c2d-message complete --device-id
                                   [--etag]
                                   [--hub-name]
                                   [--login]
                                   [--resource-group]

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

--device-id -d

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

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

--etag -e

Тег Etag или сущности, соответствующий последнему состоянию ресурса. Если etag не указан, используется значение "*".

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

az iot device c2d-message purge

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

az iot device c2d-message purge --device-id
                                [--hub-name]
                                [--login]
                                [--resource-group]

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

--device-id -d

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

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

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

az iot device c2d-message receive

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

Текст полученного сообщения будет декодирован только в том случае, если для его кодировки содержимого задано значение utf-8, utf-16 или utf-32. Полезные данные сообщения будут отображаться как {{не декодируемые полезные данные}}, если кодировка содержимого не задана как одна из указанных выше, или не может декодироваться, даже если для кодировки содержимого задано одно из указанных выше данных.

Примечание. Будет принято только один аргумент ack сообщения [--complete, --reject, --abandon].

az iot device c2d-message receive --device-id
                                  [--abandon {false, true}]
                                  [--complete {false, true}]
                                  [--hub-name]
                                  [--lock-timeout]
                                  [--login]
                                  [--reject {false, true}]
                                  [--resource-group]

Примеры

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

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group}

Получение сообщения и установка времени ожидания блокировки в 30 секунд для этого сообщения

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group} --lt {30}

Получение сообщения и его взломать после получения

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group} --complete

Получение сообщения и отклонение его после получения

az iot device c2d-message receive -d {device_id} -n {hub_name} -g {resource_group} --reject

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

--device-id -d

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

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

--abandon

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

допустимые значения: false, true
значение по умолчанию: False
--complete

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

допустимые значения: false, true
значение по умолчанию: False
--hub-name -n

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

--lock-timeout --lt

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

значение по умолчанию: 60
--login -l

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

--reject

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

допустимые значения: false, true
значение по умолчанию: False
--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 c2d-message reject

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

az iot device c2d-message reject --device-id
                                 [--etag]
                                 [--hub-name]
                                 [--login]
                                 [--resource-group]

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

--device-id -d

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

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

--etag -e

Тег Etag или сущности, соответствующий последнему состоянию ресурса. Если etag не указан, используется значение "*".

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

az iot device c2d-message send

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

Эта команда используется и может устанавливать зависимый пакет Cython (uamqp) при первом выполнении. https://github.com/Azure/azure-uamqp-python

Примечание. Кодировка содержимого по умолчанию используется для utf-8. Команда отправляет текст сообщения с действием кодирования, если свойство кодирования содержимого имеет значение utf-8, utf-16 или utf-32. Если значение кодирования содержимого не является одним из этих значений, свойство по-прежнему будет отправлено без действия кодирования.

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

az iot device c2d-message send --device-id
                               [--ack {full, negative, positive}]
                               [--auth-type {key, login}]
                               [--ce]
                               [--cid]
                               [--content-type]
                               [--da]
                               [--data-file-path]
                               [--expiry]
                               [--hub-name]
                               [--login]
                               [--message-id]
                               [--properties]
                               [--repair {false, true}]
                               [--resource-group]
                               [--uid]
                               [--wait {false, true}]
                               [--yes {false, true}]

Примеры

Базовое использование с текстом сообщения по умолчанию

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

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

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

Отправка сообщения C2D и ожидание подтверждения устройства

az iot device c2d-message send -d {device_id} -n {iothub_name} --ack full --wait

Отправьте сообщение C2D в двоичном формате из файла.

az iot device c2d-message send -d {device_id} -n {iothub_name} --data-file-path {file_path} --content-type 'application/octet-stream'

Отправьте сообщение C2D в формате JSON из файла.

az iot device c2d-message send -d {device_id} -n {iothub_name} --data-file-path {file_path} --content-type 'application/json'

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

--device-id -d

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

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

--ack

Запросить доставку отзывов по каждому сообщению относительно окончательного состояния этого сообщения. Описание значенийack выглядит следующим образом. Положительный результат: если сообщение c2d достигает состояния завершено, Центр Интернета вещей создает сообщение обратной связи. Отрицательный: если сообщение c2d достигает состояния "Мертвый", Центр Интернета вещей создает сообщение обратной связи. Полный: Центр Интернета вещей создает сообщение обратной связи в любом случае. По умолчанию не запрашивается ack.

допустимые значения: full, negative, positive
--auth-type

Указывает, должна ли операция автоматически наследовать ключ политики или использовать текущий сеанс Azure AD. Если тип проверки подлинности является именем входа, а имя узла ресурса указано, поиск ресурсов будет пропущен, если это не требуется. Вы можете настроить значение по умолчанию с помощью az configure --defaults iothub-data-auth-type=<auth-type-value>.

допустимые значения: key, login
значение по умолчанию: key
--ce --content-encoding

Кодировка для текста сообщения C2D.

значение по умолчанию: utf-8
--cid --correlation-id

Идентификатор корреляции, связанный с сообщением C2D.

--content-type --ct

Тип контента для текста сообщения C2D.

--da --data

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

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

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

--expiry --expiry-time-utc

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

--hub-name -n

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

--login -l

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

--message-id --mid

Идентификатор сообщения C2D. Если идентификатор сообщения не указан, будет создан идентификатор UUID.

--properties --props -p

Контейнер свойств сообщения в парах "ключ-значение" со следующим форматом: a=b; c=d.

--repair -r

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

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

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

--uid --user-id

Сообщение C2D, свойство идентификатора пользователя.

--wait -w

Если задать операцию отправки c2d, будет блокироваться до получения обратной связи устройства.

допустимые значения: false, true
значение по умолчанию: False
--yes -y

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

допустимые значения: false, true
значение по умолчанию: False
Глобальные параметры
--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.