az iot hub message-endpoint

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

Note

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

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

Управление пользовательскими конечными точками Центра Интернета вещей.

Команды

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

Добавьте конечную точку в IoT Hub.

 Extension Preview
az iot hub message-endpoint create cosmosdb-container

Добавьте конечную точку контейнера Cosmos DB для IoT Hub.

 Extension Preview
az iot hub message-endpoint create eventhub

Добавьте конечную точку Концентратора событий для IoT Hub.

 Extension Preview
az iot hub message-endpoint create servicebus-queue

Добавьте конечную точку очереди Service Bus для IoT Hub.

 Extension Preview
az iot hub message-endpoint create servicebus-topic

Добавьте конечную точку раздела Service Bus для IoT Hub.

 Extension Preview
az iot hub message-endpoint create storage-container

Добавьте конечную точку контейнера хранилища для IoT Hub.

 Extension Preview
az iot hub message-endpoint delete

Удалите все или определенную конечную точку для IoT Hub.

 Extension Preview
az iot hub message-endpoint list

Получите сведения обо всех конечных точках для IoT Hub.

 Extension Preview
az iot hub message-endpoint show

Получите сведения о указанной конечной точке для IoT Hub.

 Extension Preview
az iot hub message-endpoint update

Обновите свойства существующей конечной точки для IoT Hub.

 Extension Preview
az iot hub message-endpoint update cosmosdb-container

Обновите свойства существующей конечной точки контейнера Cosmos DB для IoT Hub.

 Extension Preview
az iot hub message-endpoint update eventhub

Обновите свойства существующей конечной точки Концентратора событий для IoT Hub.

 Extension Preview
az iot hub message-endpoint update servicebus-queue

Обновите свойства существующей конечной точки очереди Service Bus для IoT Hub.

 Extension Preview
az iot hub message-endpoint update servicebus-topic

Обновите свойства существующей конечной точки раздела Service Bus для IoT Hub.

 Extension Preview
az iot hub message-endpoint update storage-container

Обновите свойства существующей конечной точки контейнера хранилища для IoT Hub.

 Extension Preview

az iot hub message-endpoint delete

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

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

Удалите все или определенную конечную точку для IoT Hub.

Перед удалением конечной точки необходимо удалить все маршруты и обогащение сообщений.

az iot hub message-endpoint delete [--acquire-policy-token]
                                   [--change-reference]
                                   [--en --endpoint --endpoint-name]
                                   [--endpoint-type --type {cosmosdb-container, eventhub, servicebus-queue, servicebus-topic, storage-container}]
                                   [--force]
                                   [--hub-name]
                                   [--ids]
                                   [--resource-group]
                                   [--subscription]
                                   [--yes {false, true}]

Примеры

Удалите конечную точку из IoT Hub.

az iot hub message-endpoint delete -n {iothub_name} --endpoint-name {endpoint_name}

Удалите все конечные точки типа EventHub из IoT Hub.

az iot hub message-endpoint delete -n {iothub_name} --endpoint-type eventhub

Удалите все конечные точки из IoT Hub.

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

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

az iot hub message-endpoint delete -n {iothub_name} --endpoint-name {endpoint_name} -f

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

az iot hub message-endpoint delete -n {iothub_name} --endpoint-type eventhub -f

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

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

--acquire-policy-token

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

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

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

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

Имя конечной точки маршрутизации.

--endpoint-type --type -t

Тип конечной точки маршрутизации.

Свойство Значение
Допустимые значения: cosmosdb-container, eventhub, servicebus-queue, servicebus-topic, storage-container
--force -f

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

Свойство Значение
Default value: False
--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
--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-endpoint list

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

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

Получите сведения обо всех конечных точках для IoT Hub.

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

az iot hub message-endpoint list [--endpoint-type --type {cosmosdb-container, eventhub, servicebus-queue, servicebus-topic, storage-container}]
                                 [--hub-name]
                                 [--ids]
                                 [--resource-group]
                                 [--subscription]

Примеры

Получите все конечные точки из IoT Hub.

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

Получите все конечные точки типа EventHub из IoT Hub.

az iot hub message-endpoint list -n {iothub_name} --endpoint-type eventhub

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

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

--endpoint-type --type -t

Тип конечной точки маршрутизации.

Свойство Значение
Допустимые значения: cosmosdb-container, eventhub, servicebus-queue, servicebus-topic, storage-container
--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-endpoint show

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

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

Получите сведения о указанной конечной точке для IoT Hub.

az iot hub message-endpoint show --en --endpoint --endpoint-name
                                 [--hub-name]
                                 [--ids]
                                 [--resource-group]
                                 [--subscription]

Примеры

Получение сведений о конечной точке из IoT Hub.

az iot hub message-endpoint show -n {iothub_name} --endpoint-name {endpoint_name}

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

--en --endpoint --endpoint-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