azure.azcollection.azure_rm_iothub – Управление Azure IoT Hub
Примечание
Этот плагин входит в коллекцию azure.azcollection (версия 1.3.1).
Для его установки используйте: ansible-galaxy collection install azure.azcollection
Для использования в playbook, укажите: azure.azcollection.azure_rm_iothub
Добавлена в версии 0.1.2: коллекции azure.azcollection
Обзор
- Создание, удаление Azure IoT Hub.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным объектом службы. | ||
| adfs_authority_url строка добавлен в 0.0.1 azure.azcollection | URL авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной службой ADFS. | ||
| api_profile строка добавлен в 0.0.1 azure.azcollection | По умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-службами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. | |
| append_tags логический тип |
| Используется для управления тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом формате любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. | |
| auth_source строка добавлен в 0.0.1 azure.azcollection |
| Управляет источником учетных данных для аутентификации. Также может быть задан через переменную среды ANSIBLE_AZURE_AUTH_SOURCE. При значении auto (по умолчанию) приоритет имеет параметры модуля -> env -> credential_file -> cli. При значении env, учетные данные будут читаться из переменных среды.При значении credential_file, профиль будет считываться из ~/.azure/credentials. При значении cli, учетные данные будут взяты из профиля Azure CLI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для определения идентификатора подписки, если их несколько, иначе используется стандартная подписка az cli.При значении msi, хост-машина должна быть Azure-ресурсом с включённым расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID может использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка.Переменная msi была добавлена в Ansible 2.6. | |
| cert_validation_mode строка добавлен в 0.0.1 azure.azcollection |
| Управляет поведением проверки сертификата для Azure-точек входа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть задано в профиле файла учетных данных или переменной среды AZURE_CERT_VALIDATION. | |
| client_id строка | Идентификатор клиента Azure. Используйте при аутентификации с главным объектом службы. | ||
| cloud_environment строка добавлен в 0.0.1 azure.azcollection | По умолчанию: "AzureCloud" | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть задано в профиле файла учетных данных или переменной среды AZURE_CLOUD_ENVIRONMENT. | |
| enable_file_upload_notifications логический тип |
| Уведомления о загрузке файлов включены, если значение равно True. | |
| event_endpoint словарь | Свойство конечной точки, совместимой с Event Hub. | ||
| partition_count целое число | Количество разделов для получения сообщений "устройство-облако" в конечной точке, совместимой с Event Hub. Значение по умолчанию 2. | ||
| retention_time_in_days целое число | Срок хранения сообщений "устройство-облако" в днях. Значение по умолчанию 1. | ||
| ip_filters список / элементы=строка | Настройка правил отклонения или принятия трафика от определённых IP-адресов IPv4. | ||
| action строка / обязательно |
| Желаемое действие для запросов, захваченных этим правилом. | |
| ip_mask строка / обязательно | Строка, содержащая диапазон IP-адресов в нотации CIDR для правила. | ||
| name строка / обязательно | Имя фильтра. | ||
| location строка | Расположение IoT Hub. | ||
| name строка / обязательно | Имя IoT Hub. | ||
| password строка | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным объектом службы. | ||
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | ||
| resource_group строка / обязательно | Имя группы ресурсов. | ||
| routes список / элементы=строка | Маршрутизация сообщений "устройство-облако" к службам, ориентированным на сервис. | ||
| condition строка | Выражение запроса для запроса маршрутизации, которое выполняется с помощью свойств приложения сообщения, системных свойств, тела сообщения, тегов двойника устройства и свойств двойника устройства для определения совпадения с конечной точкой. Дополнительную информацию о построении запроса см. в https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-routing-query-syntax | ||
| enabled логический тип / обязательно |
| Включить или отключить маршрут. | |
| endpoint_name строка / обязательно | Имя конечной точки в routing_endpoints, куда IoT Hub отправляет сообщения, соответствующие запросу. | ||
| name строка / обязательно | Имя маршрута. | ||
| source строка / обязательно |
| Источник потока данных, к которому будет применено действие. | |
| routing_endpoints список / элементы=строка | Пользовательские конечные точки. | ||
| connection_string строка / обязательно | Строка подключения к пользовательской конечной точке. Строка подключения должна иметь права на отправку. | ||
| container строка | Имя контейнера пользовательской конечной точки, когда resource_type=storage. | ||
| encoding строка | Кодировка сообщения, когда resource_type=storage. | ||
| name строка / обязательно | Имя пользовательской конечной точки. | ||
| resource_group строка | Группа ресурсов конечной точки. По умолчанию совпадает с resource_group. | ||
| resource_type строка / обязательно |
| Тип ресурса пользовательской конечной точки. | |
| subscription строка | Идентификатор подписки на конечную точку. По умолчанию совпадает с subscription. | ||
| secret строка | Секрет клиента Azure. Используйте при аутентификации с главным объектом службы. | ||
| sku string |
| Тарифный план для Azure IoT Hub. Обратите внимание, что в каждой подписке разрешен только один бесплатный экземпляр IoT Hub. Будет выброшено исключение, если бесплатных экземпляров будет больше одного. По умолчанию s1 при создании. | |
| state string |
| Состояние IoT Hub. Используйте present для создания или обновления IoT Hub и absent для удаления IoT Hub. | |
| subscription_id string | Ваш идентификатор подписки Azure. | ||
| tags dictionary | Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Чтобы удалить теги, установите параметр append_tags в значение false. | ||
| tenant string | Идентификатор Azure-аренды. Используется при аутентификации с помощью принципала службы. | ||
| unit integer | Единицы измерения вашего IoT Hub. Значение по умолчанию 1. | ||
Примечания
Примечание
- Для аутентификации в Azure вы можете передавать параметры, устанавливать переменные среды, использовать профиль, сохраненный в ~/.azure/credentials, или войти в систему перед запуском задач или книги сценариев с помощью
az login. - Аутентификация также возможна с использованием принципала службы или пользователя Active Directory.
- Для аутентификации через принципала службы передайте subscription_id, client_id, secret и tenant или установите переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
- Для аутентификации через пользователя Active Directory передайте ad_user и password или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
- В качестве альтернативы учетные данные могут храниться в ~/.azure/credentials. Это файл ini, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant или subscription_id, ad_user и password. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или установив AZURE_PROFILE в среде.
См. также
См. также
- Вход в Azure CLI
-
Как аутентифицироваться с помощью команды
az login.
Примеры
- name: Create a simplest IoT hub
azure_rm_iothub:
name: Testing
resource_group: myResourceGroup
- name: Create an IoT hub with route
azure_rm_iothub:
resource_group: myResourceGroup
name: Testing
routing_endpoints:
- connection_string: "Endpoint=sb://qux.servicebus.windows.net/;SharedAccessKeyName=quux;SharedAccessKey=****;EntityPath=myQueue"
name: foo
resource_type: queue
resource_group: myResourceGroup1
routes:
- name: bar
source: device_messages
endpoint_name: foo
enabled: yes
Значения возврата
Общие значения возврата описаны здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| cloud_to_device complex | success | Свойства сообщения «облако-устройство». | ||
| max_delivery_count integer | success | Количество попыток IoT Hub доставить сообщение в очередь обратной связи. См. https://docs.microsoft.com/ru-ru/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. Пример: 10 | ||
| ttl_as_iso8601 string | success | Период времени, в течение которого сообщение доступно для использования, прежде чем IoT Hub его удалит. См. https://docs.microsoft.com/ru-ru/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. Пример: 1:00:00 | ||
| enable_file_upload_notifications boolean | success | Включены ли уведомления о загрузке файлов. Пример: True | ||
| event_endpoints complex | success | Встроенный конечный пункт для доставки сообщений устройств. | ||
| endpoint string | success | Конечный пункт, совместимый с Event Hub. Пример: sb://iothub-ns-testing-1478811-9bbc4a15f0.servicebus.windows.net/ | ||
| partition_count integer | success | Количество разделов для получения сообщений «устройство-облако» в конечном пункте, совместимом с Event Hub. См. https://docs.microsoft.com/ru-ru/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. Пример: 2 | ||
| partition_ids list / elements=string | success | Список идентификаторов разделов для конечного пункта событий. Пример: ['0', '1'] | ||
| retention_time_in_days integer | success | Срок хранения сообщений «устройство-облако» в днях. См. https://docs.microsoft.com/ru-ru/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. Пример: 1 | ||
| host_name string | success | Хост IoT Hub. Пример: testing.azure-devices.net | ||
| id string | success | Идентификатор ресурса IoT Hub. Пример: /subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/Testing | ||
| ip_filters complex | success | Настройка правил для отклонения или принятия трафика со специфических адресов IPv4. | ||
| action string | success | Желаемое действие для запросов, захваченных этим правилом. Пример: Reject | ||
| ip_mask string | success | Строка, содержащая диапазон IP-адресов в формате CIDR для правила. Пример: 40.54.7.3 | ||
| name string | success | Имя фильтра. Пример: filter | ||
| location string | success | Расположение IoT Hub. Пример: eastus | ||
| name string | success | Имя IoT Hub. Пример: Testing | ||
| resource_group string | success | Группа ресурсов IoT Hub. Пример: myResourceGroup. | ||
| routes complex | success | Маршрутизация сообщений «устройство-облако» на конечные пункты, доступные для служб. | ||
| condition boolean | success | Выражение запроса для маршрутизации, выполняемое с помощью приложения сообщений, системных свойств, тела сообщения, тегов и свойств устройства, чтобы определить, соответствует ли он конечной точке. Дополнительную информацию о построении запроса см. в разделе https://docs.microsoft.com/ru-ru/azure/iot-hub/iot-hub-devguide-routing-query-syntax
Пример: true | ||
| enabled string | success | Включить ли маршрут. Пример: True | ||
| endpoint_name string | success | Имя конечного пункта в routing_endpoints, куда IoT Hub отправляет сообщения, соответствующие запросу.Пример: foo | ||
| name string | success | Имя маршрута. Пример: route1 | ||
| source string | success | Источник потока данных, над которым будут выполнены действия. Пример: device_messages | ||
| routing_endpoints complex | success | Пользовательские конечные пункты. | ||
| event_hubs complex | success | Список пользовательских конечных точек центров событий. | ||
| connection_string string | success | Строка подключения к пользовательскому конечной точке. Пример: Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo | ||
| name string | success | Имя пользовательского конечного пункта. Пример: foo | ||
| resource_group string | success | Группа ресурсов конечной точки. Пример: bar | ||
| subscription string | success | Идентификатор подписки на конечный пункт. Пример: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX | ||
| service_bus_queues complex | always | Список пользовательских конечных точек очередей службы обмена сообщениями. | ||
| connection_string string | success | Строка подключения к пользовательскому конечной точке. Пример: Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo | ||
| name string | success | Имя пользовательского конечного пункта. Пример: foo | ||
| resource_group string | success | Группа ресурсов конечной точки. Пример: bar | ||
| subscription string | success | Идентификатор подписки на конечный пункт. Пример: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX | ||
| service_bus_topics complex | success | Список пользовательских конечных точек тем службы обмена сообщениями. | ||
| connection_string string | success | Строка подключения к пользовательскому конечной точке. Пример: Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo | ||
| name string | success | Имя пользовательского конечного пункта. Пример: foo | ||
| resource_group string | success | Группа ресурсов конечной точки. Пример: bar | ||
| subscription string | success | Идентификатор подписки на конечный пункт. Пример: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX | ||
| storage_containers complex | success | Список пользовательских конечных точек хранилища | ||
| connection_string string | success | Строка подключения к пользовательской конечной точке. Пример: Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo | ||
| name string | success | Имя пользовательской конечной точки. Пример: foo | ||
| resource_group string | success | Группа ресурсов конечной точки. Пример: bar | ||
| subscription string | success | Идентификатор подписки на конечную точку. Пример: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX | ||
| sku string | success | Ценовой уровень для Azure IoT Hub. Пример: f1 | ||
| unit integer | success | Единицы в IoT Hub. Пример: 1 | ||
Авторы
- Yuwei Zhou (@yuwzho)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/azure/azcollection/azure_rm_iothub_module.html
