Создание и удаление маршрутов и конечных точек с помощью Azure CLI

В этой статье показано, как управлять маршрутами и конечными точками Центр Интернета вещей Azure с помощью Azure CLI. Узнайте, как использовать Azure CLI для создания маршрутов и конечных точек для Центры событий Azure, очередей и разделов Служебная шина Azure, служба хранилища Azure и Cosmos DB.

Дополнительные сведения о том, как работает маршрутизация в Центр Интернета вещей, см. в статье "Использование маршрутизации сообщений Центр Интернета вещей для отправки сообщений устройства в облако в разные конечные точки". Сведения о настройке маршрута, который отправляет сообщения в хранилище, а затем тестирование на имитированном устройстве, см. в руководстве по отправке данных устройства в служба хранилища Azure с помощью маршрутизации сообщений Центр Интернета вещей.

Необходимые компоненты

Процедуры, описанные в статье, используют следующие ресурсы:

• Azure CLI
• Центр Интернета вещей.
• Служба конечных точек в Azure

Azure CLI

В этой статье используется Azure CLI для работы с Центр Интернета вещей и другими службами Azure. Вы можете выбрать способ доступа к Azure CLI:

• Используйте среду Bash в Azure Cloud Shell. Дополнительные сведения см . в кратком руководстве по Bash в Azure Cloud Shell.

  

• Если вы предпочитаете выполнять справочные команды CLI локально, установите Azure CLI. Если вы работаете в Windows или macOS, Azure CLI можно запустить в контейнере Docker. Дополнительные сведения см. в статье Как запустить Azure CLI в контейнере Docker.

  • Если вы используете локальную установку, выполните вход в Azure CLI с помощью команды az login. Чтобы выполнить аутентификацию, следуйте инструкциям в окне терминала. Сведения о других возможностях, доступных при входе, см. в статье Вход с помощью Azure CLI.

  • Установите расширение Azure CLI при первом использовании, когда появится соответствующий запрос. Дополнительные сведения о расширениях см. в статье Использование расширений с Azure CLI.

  • Выполните команду az version, чтобы узнать установленную версию и зависимые библиотеки. Чтобы обновиться до последней версии, выполните команду az upgrade.

Центр Интернета вещей

У вас есть Центр Интернета вещей в подписке Azure. Если у вас еще нет центра, выполните действия, описанные в разделе Создание центра Интернета вещей.

Служба конечной точки

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

Определите, какую службу Azure вы хотите использовать в качестве конечной точки для получения перенаправленных устройств и данных событий: концентратор событий, очередь службы или раздел, учетная запись хранения или контейнер Cosmos DB. Чтобы использовать службу, выполните действия по созданию службы конечной точки.

Центры событий

1. Создайте пространство имен Центров событий и концентратор событий. Дополнительные сведения см . в кратком руководстве по созданию концентратора событий с помощью Azure CLI.

2. Создайте правило авторизации, которое будет использоваться для предоставления Центр Интернета вещей разрешения на отправку данных в концентратор событий.

   Совет

   name Значение RootManageSharedAccessKey параметра — это имя по умолчанию, которое позволяет управлять, отправлять, прослушивать утверждения (access). Если вы хотите ограничить утверждения, присвойте name параметру собственное уникальное имя и включите --rights флаг, за которым следует одно из утверждений. Например, --name my-name --rights Send.

   az eventhubs eventhub authorization-rule create --resource-group my-resource-group --namespace-name my-routing-namespace --eventhub-name my-event-hubs --name RootManageSharedAccessKey
   

   Дополнительные сведения см. в статье "Авторизация доступа к Центры событий Azure".

очередь служебной шины Azure

1. Создайте пространство имен и очередь служебной шины. Дополнительные сведения см. в статье "Использование Azure CLI" для создания пространства имен служебная шина и очереди.

2. Создайте правило авторизации, которое даст Центр Интернета вещей разрешение на отправку данных в очередь. Для nameэтого используйте уникальное значение для правила авторизации.

   az servicebus queue authorization-rule create --resource-group my-resource-group --namespace-name my-namespace --queue-name my-queue --name my-auth-rule --rights Listen
   

   Дополнительные параметры правила авторизации см. в статье az servicebus queue authorization-rule create.

Раздел служебной шины

Создайте пространство имен, раздел и подписку служебная шина. Дополнительные сведения см. в статье с помощью Azure CLI для создания раздела служебная шина и подписок в этом разделе.

Хранилище Azure

1. Создание учетной записи хранения. Дополнительные сведения см. в разделе Создание учетной записи хранения.

2. Создайте контейнер в учетной записи хранения. Дополнительные сведения см. в статье "Управление контейнерами BLOB-объектов с помощью Azure CLI"

Cosmos DB

Создайте учетную запись Cosmos DB для API SQL и контейнера Cosmos DB. Дополнительные сведения см. в статье "Создание Azure Cosmos DB для NoSQL".

Создание конечной точки

Все Центр Интернета вещей маршруты указывают на конечную точку, которая получит перенаправленное устройство и данные события. Несколько маршрутов могут указывать на одну конечную точку. В настоящее время Центр Интернета вещей поддерживает конечные точки для центров событий, служебная шина очередей или разделов, хранилища и Cosmos DB. Экземпляр службы, используемой для конечной точки, должен существовать в подписке Azure перед созданием конечной точки.

Примечание.

В этой статье используется группа команд az iot hub message-endpoint , которая появилась в версии 0.19.0 расширения Azure-iot для Azure CLI. Предыдущие версии расширения Azure-iot использовали группу команд az iot hub routing-endpoint , которая аналогична и по-прежнему поддерживается, но не поддерживает создание конечных точек Cosmos DB.

Используйте следующую команду, чтобы обновить до последней версии расширения Azure-iot:

az extension update --name azure-iot

Центры событий

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

1. Используйте команду az eventhubs eventhub authorization-rule keys list для перечисления правила авторизации. Укажите следующие значения для параметров заполнителя:

   параметр	значение
   eventhub_group	Группа ресурсов концентратора событий.
   eventhub_namespace	Имя пространства имен Центров событий.
   eventhub_name	Имя концентратора событий
   rule_name	Имя правила авторизации для концентратора событий. Если вы скопировали пример в предварительных требованиях, это имя RootManageSharedAccessKey.

   az eventhubs eventhub authorization-rule keys list --resource-group {eventhub_group} --namespace-name {eventhub_namespace} --eventhub-name my-event-hubs --name {rule_name}
   

2. Скопируйте строка подключения концентратора событий из выходных данных.

3. Используйте команду az iot hub message-endpoint create eventhub, чтобы создать пользовательскую конечную точку. Укажите следующие значения для параметров заполнителя:

   параметр	значение
   iothub_name	Имя центра Интернета вещей, в котором создается эта конечная точка.
   endpoint_name	Уникальное имя новой конечной точки.
   eventhub_subscription	Идентификатор подписки концентратора событий. Этот аргумент может быть оставлен, если концентратор событий находится в той же подписке, что и Центр Интернета вещей.
   eventhub_group	Группа ресурсов концентратора событий. Этот аргумент может быть оставлен, если концентратор событий находится в той же группе ресурсов, что и Центр Интернета вещей.
   eventhub_connection_string	Строка подключения, скопированные из правила авторизации концентратора событий.

   az iot hub message-endpoint create eventhub --hub-name {iothub_name} --endpoint-name {endpoint_name}  --connection-string "{eventhub_connection_string}" --endpoint-subscription-id {eventhub_subscription} --endpoint-resource-group {eventhub_group}
   

очередь служебной шины Azure

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

1. Используйте команду az servicebus queue authorization-rule key list, чтобы получить служебная шина очереди строка подключения. Укажите следующие значения для параметров заполнителя:

   параметр	значение
   queue_group	Группа ресурсов очереди служебная шина.
   queue_namespace	Имя пространства имен служебная шина очереди.
   queue_name	Имя очереди.
   rule_name	Имя правила авторизации для очереди. Если вы скопировали пример в предварительных требованиях, это имя my-auth-rule.

   az servicebus queue authorization-rule keys list --resource-group {queue_group} --namespace-name {queue_namespace} --queue-name {queue_name} --name {rule_name}
   

2. Скопируйте строка подключения очереди служебная шина из выходных данных.

3. Используйте команду az iot hub message-endpoint create servicebus-queue, чтобы создать пользовательскую конечную точку. Укажите следующие значения для параметров заполнителя:

   параметр	значение
   iothub_name	Имя центра Интернета вещей, в котором создается эта конечная точка.
   endpoint_name	Уникальное имя новой конечной точки.
   queue_connection_string	Строка подключения, скопированные из правила авторизации очереди служебная шина.
   queue_subscription	Идентификатор подписки очереди служебная шина. Этот аргумент может быть оставлен, если очередь находится в той же подписке, что и Центр Интернета вещей.
   queue_group	Группа ресурсов очереди служебная шина. Этот аргумент может быть оставлен, если очередь находится в той же группе ресурсов, что и центр Интернета вещей.

   az iot hub message-endpoint create servicebus-queue --hub-name {iothub_name} --endpoint-name {endpoint_name} --connection-string "Endpoint={queue_connection_string}" --endpoint-resource-group {queue_group} --endpoint-subscription-id {queue_subscription}
   

Раздел служебной шины

1. Чтобы получить строка подключения раздела служебная шина, используйте список ключей авторизации в разделе az servicebus. Имя правила авторизации по умолчанию, которое поставляется RootManageSharedAccessKeyс новым пространством имен. Укажите следующие значения для параметров заполнителя:

   параметр	значение
   topic_group	Группа ресурсов раздела служебная шина.
   topic_namespace	Имя пространства имен служебная шина раздела.
   topic_name	Имя раздела.

   az servicebus topic authorization-rule keys list --resource-group {topic_group} --namespace-name {topic_namespace} --topic-name {topic_name} --name RootManageSharedAccessKey
   

2. Скопируйте раздел служебная шина строка подключения из выходных данных.

3. Используйте команду az iot hub message-endpoint create servicebus-topic, чтобы создать пользовательскую конечную точку. Укажите следующие значения для параметров заполнителя:

   параметр	значение
   iothub_name	Имя центра Интернета вещей, в котором создается эта конечная точка.
   endpoint_name	Уникальное имя новой конечной точки.
   topic_connection_string	Строка подключения, скопированные из правила авторизации раздела служебная шина.
   topic_subscription	Идентификатор подписки раздела служебная шина. Этот аргумент может быть оставлен, если раздел находится в той же подписке, что и Центр Интернета вещей.
   topic_group	Группа ресурсов раздела служебная шина. Этот аргумент может быть оставлен, если раздел находится в той же группе ресурсов, что и Центр Интернета вещей.

   az iot hub message-endpoint create servicebus-topic --hub-name {iothub_name} --endpoint-name {endpoint_name} --connection-string "Endpoint={topic_connection_string};EntityPath=my-service-bus-topic --endpoint-resource-group {topic_group} --endpoint-subscription-id {topic_subscription}
   

Хранилище Azure

1. Используйте команду az storage account show-connection-string, чтобы получить строка подключения из ресурса служба хранилища Azure, чтобы создать конечную точку. Укажите следующие значения для параметров заполнителя:

   параметр	значение
   storage_group	Группа ресурсов учетной записи хранения.
   storage_name	Имя учетной записи хранения

   az storage account show-connection-string --resource-group my-resource-group --name my-storage-account 
   

2. Скопируйте строка подключения учетной записи хранения из выходных данных.

3. Используйте команду az iot hub message-endpoint create storage-container, чтобы создать новую конечную точку служба хранилища Azure. Для всех остальных параметров используйте значения для вашего сценария. Укажите следующие значения для параметров заполнителя:

   параметр	значение
   iothub_name	Имя центра Интернета вещей, в котором создается эта конечная точка.
   endpoint_name	Уникальное имя новой конечной точки.
   storage_connection_string	Строка подключения, скопированные из команды учетной записи хранения.
   container_name	Имя контейнера в учетной записи хранения, в которой будут отправляться данные.
   storage_subscription	Идентификатор подписки хранилища служебная шина. Этот аргумент может быть оставлен, если хранилище находится в той же подписке, что и Центр Интернета вещей.
   storage_group	Группа ресурсов хранилища служебная шина. Этот аргумент может быть оставлен, если раздел находится в той же группе ресурсов, что и Центр Интернета вещей.

   az iot hub message-endpoint create storage-container--hub-name {iothub_name} --endpoint-name {endpoint_name} --container {container_name} --endpoint-resource-group {storage_group} --connection-string "DefaultEndpointsProtocol={storage_connection_string}" --endpoint-subscription-id {storage_subscription} --resource-group {storage_group}
   

Cosmos DB

1. Используйте команду az cosmosdb keys list, чтобы получить строка подключения из учетной записи базы данных Cosmos DB.

   az cosmosdb keys list --name my-cosmosdb-account --resource-group my-resource-group --type connection-strings
   

2. Скопируйте строка подключения Cosmos DB из выходных данных.

3. Используйте команду az iot hub message-endpoint create cosmosdb-container, чтобы создать пользовательскую конечную точку. Укажите следующие значения для параметров заполнителя:

   параметр	значение
   iothub_name	Имя центра Интернета вещей, в котором создается эта конечная точка.
   endpoint_name	Уникальное имя новой конечной точки.
   cosmosdb_connection_string	Строка подключения, скопированные из команды учетной записи Cosmos DB.
   container_name	Имя контейнера в учетной записи Cosmos DB, в которой будут отправляться данные.
   database_name	Имя базы данных в учетной записи Cosmos DB, в которой будут отправляться данные.
   cosmosdb_subscription	Идентификатор подписки учетной записи базы данных Cosmos DB. Этот аргумент может быть оставлен, если база данных находится в той же подписке, что и Центр Интернета вещей.
   cosmosdb_group	Группа ресурсов учетной записи базы данных Cosmos DB. Этот аргумент может быть оставлен, если база данных находится в той же группе ресурсов, что и Центр Интернета вещей.

   az iot hub message-endpoint create cosmosdb-container --hub-name {iothub_name} --endpoint-name {endpoint_name} --connection-string "{cosmosdb_connection_string}" --container {container_name} --database-name {database_name} --resource-group my-resource-group --endpoint-account my-cosmosdb-account --container my-cosmosdb-database-container
   

   Примечание.

   Если вы используете управляемые удостоверения вместо строка подключения, используйте команду az cosmosdb sql role assignment create для проверки подлинности удостоверения в учетной записи Cosmos DB.

   az cosmosdb sql role assignment create -a my-cosmosdb-account -g my-resource-group --scope '/' -n 'Cosmos DB Built-in Data Contributor' -p "IoT Hub System Assigned or User Assigned Identity"
   

Удаление конечной точки

Если вы хотите удалить конечную точку из Центра Интернета вещей, используйте команду az iot hub message-endpoint delete . С помощью этой команды можно удалить одну конечную точку, удалить все конечные точки одного типа или удалить все конечные точки из концентратора.

Например, следующая команда удаляет все конечные точки в Центре Интернета вещей, указывающие на ресурсы хранилища:

az iot hub message-endpoint delete --hub-name {iothub_name} --endpoint-type storage-container

Создание маршрута Центр Интернета вещей

В Центр Интернета вещей можно создать маршрут для отправки сообщений или записи событий. Каждый маршрут имеет источник данных и конечную точку. Источник данных — это место, где возникают сообщения или журналы событий. Конечная точка заключается в том, что сообщения или журналы событий заканчиваются. Вы выбираете расположения для источника данных и конечной точки при создании нового маршрута в Центре Интернета вещей. При необходимости можно добавить запросы к маршрутам сообщений для фильтрации сообщений или событий перед переходом к конечной точке.

Примечание.

В этой статье используется группа команд az iot hub message-route , которая была представлена в версии 0.19.0 расширения Azure-iot для Azure CLI. Предыдущие версии расширения azure-iot использовали группу команд команд маршрута az iot hub , которая по-прежнему поддерживается.

Используйте следующую команду, чтобы обновить до последней версии расширения Azure-iot:

az extension update --name azure-iot

1. Используйте команду az iot hub message-route create, чтобы создать новый маршрут Центр Интернета вещей с помощью этой конечной точки. Укажите следующие значения для параметров заполнителя:

   параметр	значение
   iothub_name	Имя Центра Интернета вещей, в котором создается этот маршрут.
   route_name	Уникальное имя нового маршрута.
   endpoint_name	Имя конечной точки, в которую маршрут отправляет данные.
   data_source	Источник маршрута. Допустимые значения: deviceconnectionstateevents, , devicejoblifecycleevents, devicelifecycleeventsdevicemessages, digitaltwinchangeevents, invalidили twinchangeevents.

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

2. Чтобы убедиться, что новый маршрут находится в Центре Интернета вещей, используйте команду az iot hub message-route list , чтобы просмотреть все маршруты в Центре Интернета вещей:

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

   Вы увидите ответ в Azure CLI, аналогичном следующему примеру:

   [
      {
        "condition": "true",
        "endpointNames": [
          "endpoint_name"
        ],
        "isEnabled": true,
        "name": "route_name",
        "source": "DeviceConnectionStateEvents"
      }
   ]
   

Обновление маршрута Центр Интернета вещей

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

Используйте команду az iot hub message-route show для просмотра сведений о маршруте.

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

Используйте команду az iot hub message-route update для обновления свойств маршрута. Например, следующая команда обновляет источник маршрута.

az iot hub message-route update --hub-name {iothub_name} --route-name {route_name} --source devicejoblifecycleevents

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

Используйте команду az iot hub message-route delete, чтобы удалить маршрут из Центра Интернета вещей.

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

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

Управление резервным маршрутом

Резервный маршрут отправляет все сообщения из devicemessages источника, не удовлетворяющие условиям запроса ни одного из существующих маршрутов в встроенную конечную точку.

Используйте команду az iot hub message-route fallback show, чтобы просмотреть состояние резервного маршрута в Центре Интернета вещей.

az iot hub message-route fallback show --hub-name {iothub_name}

Используйте команду az iot hub message-route fallback set, чтобы включить или отключить резервный маршрут в Центре Интернета вещей.

az iot hub message-route fallback set --hub-name {iothub_name} --enabled {true_false}

Следующие шаги

Из этой статьи вы узнали, как создать маршрут и конечную точку для Центров событий, служебная шина очереди и разделы и служба хранилища Azure.

Дополнительные сведения о маршрутизации сообщений см. в руководстве по отправке данных устройства в служба хранилища Azure с помощью маршрутизации сообщений Центр Интернета вещей. В этом руководстве вы создадите маршрут хранения и протестируете его с помощью устройства в Центре Интернета вещей.