az iot hub message-route

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

Note

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

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

Управление маршрутами Центра Интернета вещей.

Команды

Имя Описание Тип Состояние
az iot hub message-route create

Добавьте маршрут для IoT Hub.

 Extension Preview
az iot hub message-route delete

Удалите все маршруты или упомянутый маршрут в IoT Hub.

 Extension Preview
az iot hub message-route fallback

Управление резервным маршрутом Центра Интернета вещей.

 Extension Preview
az iot hub message-route fallback set

Включите или отключите резервный маршрут в IoT Hub.

 Extension Preview
az iot hub message-route fallback show

Отображение резервного маршрута IoT Hub.

 Extension Preview
az iot hub message-route list

Получите все маршруты в IoT Hub.

 Extension Preview
az iot hub message-route show

Получение сведений о маршруте в IoT Hub.

 Extension Preview
az iot hub message-route test

Проверьте все маршруты или упомянутый маршрут в IoT Hub.

 Extension Preview
az iot hub message-route update

Обновите маршрут для IoT Hub.

 Extension Preview

az iot hub message-route create

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

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

Добавьте маршрут для IoT Hub.

az iot hub message-route create --en --endpoint --endpoint-name
                                --hub-name
                                --rn --route --route-name
                                --source-type --type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}
                                [--acquire-policy-token]
                                [--change-reference]
                                [--condition]
                                [--enabled {false, true}]
                                [--resource-group]

Примеры

Создайте маршрут для IoT Hub с заданной конечной точкой и типом источника DeviceMessages.

az iot hub message-route create -n {iothub_name} --route-name {route_name} --endpoint-name {endpoint_name} --source DeviceMessages

Создайте маршрут для IoT Hub со встроенной конечной точкой и типом источника DeviceMessages.

az iot hub message-route create -n {iothub_name} --route-name {route_name} --endpoint-name events --source DeviceMessages

Создайте отключенный маршрут для IoT Hub с заданной конечной точкой, тип источника DigitalTwinChangeEvents и настраиваемое условие.

az iot hub message-route create -n {iothub_name} --route-name {route_name} --endpoint-name {endpoint_name} --source DigitalTwinChangeEvents --condition {condition} --enabled false

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

--en --endpoint --endpoint-name

Имя конечной точки маршрутизации. Для встроенной конечной точки используйте имя конечной точки "события".

--hub-name -n

IoT Hub имя.

--rn --route --route-name

Имя маршрута.

--source-type --type -t

Источник маршрута.

Свойство Значение
Допустимые значения: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents

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

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

--acquire-policy-token

Автоматическое получение маркера Azure Policy для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--condition -c

Условие, которое оценивается для применения правила маршрутизации.

Свойство Значение
Default value: true
--enabled -e

Логическое значение, указывающее, следует ли включить маршрут к IoT Hub.

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

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

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

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

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

Удалите все маршруты или упомянутый маршрут в IoT Hub.

az iot hub message-route delete [--acquire-policy-token]
                                [--change-reference]
                                [--hub-name]
                                [--ids]
                                [--resource-group]
                                [--rn --route --route-name]
                                [--source-type --type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                                [--subscription]
                                [--yes {false, true}]

Примеры

Удалите маршрут из IoT Hub.

az iot hub message-route delete -n {iothub_name} --route-name {route_name}

Удалите все маршруты исходного типа DeviceMessages из IoT Hub.

az iot hub message-route delete -n {iothub_name} --source DeviceMessages

Удалите все маршруты из IoT Hub.

az iot hub message-route delete -n {iothub_name}

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

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

--acquire-policy-token

Автоматическое получение маркера Azure Policy для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--hub-name -n

IoT Hub имя.

Свойство Значение
Группа параметров: Resource Id Arguments
--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

Свойство Значение
Группа параметров: Resource Id Arguments
--resource-group -g

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

Свойство Значение
Группа параметров: Resource Id Arguments
--rn --route --route-name

Имя маршрута.

--source-type --type -t

Источник маршрута.

Свойство Значение
Допустимые значения: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
--subscription

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

Свойство Значение
Группа параметров: Resource Id Arguments
--yes -y

Пропустить запросы пользователей. Указывает на принятие действия. Используется в основном для сценариев автоматизации. По умолчанию: 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/.

--verbose

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

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

az iot hub message-route list

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

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

Получите все маршруты в IoT Hub.

az iot hub message-route list [--hub-name]
                              [--ids]
                              [--resource-group]
                              [--source-type --type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                              [--subscription]

Примеры

Получите все маршруты из IoT Hub.

az iot hub message-route list -n {iothub_name}

Получите все маршруты исходного типа DeviceMessages из IoT Hub.

az iot hub message-route list -n {iothub_name} --source DeviceMessages

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

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

--hub-name -n

IoT Hub имя.

Свойство Значение
Группа параметров: Resource Id Arguments
--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

Свойство Значение
Группа параметров: Resource Id Arguments
--resource-group -g

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

Свойство Значение
Группа параметров: Resource Id Arguments
--source-type --type -t

Источник маршрута.

Свойство Значение
Допустимые значения: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
--subscription

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

Свойство Значение
Группа параметров: Resource Id Arguments
Глобальные параметры
--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/.

--verbose

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

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

az iot hub message-route show

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

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

Получение сведений о маршруте в IoT Hub.

az iot hub message-route show --rn --route --route-name
                              [--hub-name]
                              [--ids]
                              [--resource-group]
                              [--subscription]

Примеры

Получение сведений о маршруте из IoT Hub.

az iot hub message-route show -n {iothub_name} --route-name {route_name}

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

--rn --route --route-name

Имя маршрута.

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

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

--hub-name -n

IoT Hub имя.

Свойство Значение
Группа параметров: Resource Id Arguments
--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

Свойство Значение
Группа параметров: Resource Id Arguments
--resource-group -g

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

Свойство Значение
Группа параметров: Resource Id Arguments
--subscription

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

Свойство Значение
Группа параметров: Resource Id Arguments
Глобальные параметры
--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/.

--verbose

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

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

az iot hub message-route test

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

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

Проверьте все маршруты или упомянутый маршрут в IoT Hub.

Вы можете предоставить пример сообщения для тестирования маршрутов.

az iot hub message-route test [--acquire-policy-token]
                              [--ap --app-properties]
                              [--body]
                              [--change-reference]
                              [--hub-name]
                              [--ids]
                              [--resource-group]
                              [--rn --route --route-name]
                              [--source-type --type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                              [--sp --system-properties]
                              [--subscription]

Примеры

Проверьте маршрут из IoT Hub.

az iot hub message-route test -n {iothub_name} --route-name {route_name}

Проверьте все маршруты исходного типа DeviceMessages из IoT Hub.

az iot hub message-route test -n {iothub_name} --source DeviceMessages

Протестируйте весь маршрут из IoT Hub с помощью настраиваемого сообщения, включая текст, свойства приложения и системные свойства.

az iot hub message-route test -n {iothub_name} -b {body} --ap {app_properties} --sp {system_properties}

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

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

--acquire-policy-token

Автоматическое получение маркера Azure Policy для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--ap --app-properties

Свойства приложения сообщения маршрута.

--body -b

Текст сообщения маршрута.

--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--hub-name -n

IoT Hub имя.

Свойство Значение
Группа параметров: Resource Id Arguments
--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

Свойство Значение
Группа параметров: Resource Id Arguments
--resource-group -g

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

Свойство Значение
Группа параметров: Resource Id Arguments
--rn --route --route-name

Имя маршрута.

--source-type --type -t

Источник маршрута.

Свойство Значение
Допустимые значения: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
--sp --system-properties

Системные свойства сообщения маршрута.

--subscription

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

Свойство Значение
Группа параметров: Resource Id Arguments
Глобальные параметры
--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/.

--verbose

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

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

az iot hub message-route update

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

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

Обновите маршрут для IoT Hub.

Вы можете изменить исходное состояние, конечную точку, условие или состояние включено в маршруте.

az iot hub message-route update --rn --route --route-name
                                [--acquire-policy-token]
                                [--change-reference]
                                [--condition]
                                [--en --endpoint --endpoint-name]
                                [--enabled {false, true}]
                                [--hub-name]
                                [--ids]
                                [--resource-group]
                                [--source-type --type {deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents}]
                                [--subscription]

Примеры

Обновите маршрут до заданной конечной точки и типа источника DeviceMessages.

az iot hub message-route update -n {iothub_name} --route-name {route_name} --endpoint-name {endpoint_name} --source DeviceMessages

Отключите маршрут.

az iot hub message-route update -n {iothub_name} --route-name {route_name} --enabled false

Изменение условия маршрута.

az iot hub message-route update -n {iothub_name} --route-name {route_name} --condition {condition}

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

--rn --route --route-name

Имя маршрута.

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

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

--acquire-policy-token

Автоматическое получение маркера Azure Policy для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--condition -c

Условие, которое оценивается для применения правила маршрутизации.

--en --endpoint --endpoint-name

Имя конечной точки маршрутизации. Для встроенной конечной точки используйте имя конечной точки "события".

--enabled -e

Логическое значение, указывающее, следует ли включить маршрут к IoT Hub.

Свойство Значение
Допустимые значения: false, true
--hub-name -n

IoT Hub имя.

Свойство Значение
Группа параметров: Resource Id Arguments
--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

Свойство Значение
Группа параметров: Resource Id Arguments
--resource-group -g

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

Свойство Значение
Группа параметров: Resource Id Arguments
--source-type --type -t

Источник маршрута.

Свойство Значение
Допустимые значения: deviceconnectionstateevents, devicejoblifecycleevents, devicelifecycleevents, devicemessages, digitaltwinchangeevents, invalid, twinchangeevents
--subscription

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

Свойство Значение
Группа параметров: Resource Id Arguments
Глобальные параметры
--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/.

--verbose

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

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