azure.azcollection.azure_rm_iothub – Управление центром Azure IoT

Примечание

Этот плагин входит в коллекцию azure.azcollection (версия 1.4.0).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

Для использования в playbook укажите: azure.azcollection.azure_rm_iothub.

Введено в версии 0.1.2: of azure.azcollection

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Обзор

Создание, удаление центра Azure IoT.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

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		Варианты: авто ← cli credential_file env msi	Управляет источником используемых учетных данных для аутентификации. Также может быть установлено через переменную среды `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		Варианты: ignore validate	Управляет поведением проверки сертификатов для 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. См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. Значение по умолчанию `2`.
	retention_time_in_days целое число		Срок хранения сообщений с устройства на облако в днях. См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. Значение по умолчанию `1`.
ip_filters список / элементы=строка			Настройка правил для отклонения или принятия трафика со специфических 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/ru-ru/azure/iot-hub/iot-hub-devguide-routing-query-syntax
	enabled логический тип / обязательно	Варианты: нет да	Включить ли маршрут.
	endpoint_name строка / обязательно		Имя точки входа в routing_endpoints, куда IoT Hub отправляет сообщения, соответствующие запросу.
	name строка / обязательно		Имя маршрута.
	source строка / обязательно	Варианты: device_messages twin_change_events device_lifecycle_events device_job_lifecycle_events	Источник потока данных, который необходимо обработать.
routing_endpoints список / элементы=строка			Пользовательские точки входа.
	connection_string строка / обязательно		Строка подключения пользовательской точки входа. Строка подключения должна иметь права отправки.
	container строка		Имя контейнера пользовательской точки входа, когда resource_type=storage.
	encoding строка		Кодировка сообщения, когда resource_type=storage.
	name строка / обязательно		Имя пользовательской точки входа.
	resource_group строка		Группа ресурсов точки входа. По умолчанию совпадает с resource_group.
	resource_type строка / обязательно	Варианты: eventhub queue storage topic	Тип ресурса пользовательской точки входа.
	subscription строка		Идентификатор подписки точки входа. По умолчанию совпадает с subscription.
secret строка			Секрет клиента Azure. Используйте при аутентификации с главным принципом службы.
sku строка		Варианты: b1 b2 b3 f1 s1 s2 s3	Ценовой уровень для Azure IoT Hub. Обратите внимание, что в каждой подписке разрешено только одно бесплатное экземпляра IoT Hub. Бросок исключения, если количество бесплатных экземпляров превышает одно. По умолчанию `s1` при создании.

Состояние строка	Варианты: отсутствует присутствует ←	Состояние центра IoT. Используйте `present`, чтобы создать или обновить центр IoT, и `absent`, чтобы удалить центр IoT.
subscription_id строка		Ваш идентификатор подписки Azure.
метки словарь		Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные метки объекта будут обновлены любыми предоставленными значениями. Чтобы удалить метки, установите параметр append_tags в значение false.
арендатор строка		Идентификатор аренды Azure. Используйте при аутентификации с помощью принципала службы.
единица целое число		Единицы в вашем центре IoT. По умолчанию `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. Также можно добавить дополнительные профили. Укажите профиль, передав параметр profile или установив 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	Требуемое действие для запросов, пойманных этим правилом. Пример: Отклонить
	ip_mask string		success	Строка, содержащая диапазон IP-адресов в CIDR-нотации для правила. Пример: 40.54.7.3
	name string		success	Имя фильтра. Пример: фильтр
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	Список настраиваемых конечных точек Event Hub.
		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	Список настраиваемых конечных точек очереди Service Bus.
		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	Список настраиваемых конечных точек темы Service Bus.
		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

END_OF_DOCUMENT_MARKER

	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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_iothub_module.html