Модуль azure.azcollection.azure_rm_iothub — Управление центром Azure IoT

Примечание

Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные зависимости. Подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: azure.azcollection.azure_rm_iothub.

Новый в azure.azcollection 0.1.2

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

Описание

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

Требования

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

python >= 2.7
На хосте, на котором выполняется этот модуль, должна быть установлена коллекция azure.azcollection с помощью galaxy.
Все пакеты Python, указанные в файле requirements.txt коллекции, должны быть установлены с помощью pip на хосте, на котором выполняются модули из azure.azcollection.
Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр	Комментарии
ad_user string	Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным субъектом безопасности.
adfs_authority_url string added in azure.azcollection 0.0.1	URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и собственным узлом ADFS.
api_profile string added in azure.azcollection 0.0.1	Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. Default: `"latest"`
append_tags boolean	Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом виде любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта. Choices: `false` `true` ← (default)
auth_source string added in azure.azcollection 0.0.1	Управляет источником учетных данных для аутентификации. Также может быть установлено через переменную среды `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. Choices: `"auto"` ← (default) `"cli"` `"credential_file"` `"env"` `"msi"`
cert_validation_mode string added in azure.azcollection 0.0.1	Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси HTTPS или для Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть установлено через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`. Choices: `"ignore"` `"validate"`
client_id string	Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентификации (msi). Также может быть установлено через переменную среды `AZURE_CLIENT_ID`.
cloud_environment string added in azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть установлено через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`. Default: `"AzureCloud"`
disable_instance_discovery boolean added in azure.azcollection 2.3.0	Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя извлечение метаданных узла из https://login.microsoft.com/ для проверки узла. Установив это значение в True, проверка узла отключается. В результате крайне важно убедиться, что настроенный узел является действительным и заслуживающим доверия. Устанавливается через профиль файла учетных данных или переменную среды `AZURE_DISABLE_INSTANCE_DISCOVERY`. Choices: `false` ← (default) `true`
enable_file_upload_notifications boolean	Уведомления о загрузке файлов включены, если установлено значение `True`. Choices: `false` `true`
event_endpoint dictionary	Свойство совместимой с Event Hub конечной точки.
partition_count integer	Количество разделов для приема сообщений от устройства к облаку в совместимой с Event Hub конечной точке. См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. Значение по умолчанию `2`.
retention_time_in_days integer	Время хранения сообщений от устройства к облаку в днях. См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. Значение по умолчанию `1`.

identity dictionary added in azure.azcollection 2.6.0	Идентификатор этого ресурса.
type string	Тип управляемой идентичности Варианты: `"SystemAssigned"` `"UserAssigned"` `"None"` ← (по умолчанию)
user_assigned_identities dictionary	Пользовательские назначенные управляемые идентификаторы и их параметры По умолчанию: `{}`
append boolean	Если список идентификаторов должен быть добавлен к текущим идентификаторам (true) или заменить текущие идентификаторы (false) Варианты: `false` `true` ← (по умолчанию)
id list / elements=string	Список назначенных пользователю идентификаторов, связанных с этим ресурсом По умолчанию: `[]`
ip_filters list / elements=dictionary	Настройка правил для отклонения или приема трафика от определенных IPv4-адресов.
action string / обязательно	Желаемое действие для запросов, захваченных этим правилом. Варианты: `"accept"` `"reject"`
ip_mask string / обязательно	Строка, содержащая диапазон IP-адресов в нотации CIDR для правила.
name string / обязательно	Имя фильтра.
location string	Расположение IoT-хаба.
log_mode string	Родительский аргумент.
log_path string	Родительский аргумент.
name string / обязательно	Имя IoT-хаба.
password string	Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо принципала службы.
profile string	Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group string / обязательно	Имя группы ресурсов.
routes list / elements=dictionary	Маршрутизация сообщений «устройство-облако» на сервисно-ориентированные конечные точки.
condition string	Запрос выражения для запроса маршрутизации, который выполняется над свойствами приложения сообщений, свойствами системы, телом сообщения, тегами двойника устройства и свойствами двойника устройства, чтобы определить, соответствует ли он конечной точке. Для получения дополнительной информации о построении запроса см. https://docs.microsoft.com/ru-ru/azure/iot-hub/iot-hub-devguide-routing-query-syntax
enabled boolean / обязательно	Включить ли маршрут. Варианты: `false` `true`
endpoint_name string / обязательно	Имя конечной точки в routing_endpoints, куда IoT Hub отправляет сообщения, соответствующие запросу.
name string / обязательно	Имя маршрута.
source string / обязательно	Источник потока данных, на который должно быть произведено действие. Варианты: `"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 строка	Уровень ценообразования для Azure IoT Hub. Обратите внимание, что в каждой подписке разрешен только один бесплатный экземпляр IoT Hub. Если бесплатные экземпляры превысят один, будет выброшено исключение. По умолчанию значение `s1` при создании. Варианты: `"b1"` `"b2"` `"b3"` `"f1"` `"s1"` `"s2"` `"s3"`
state строка	Состояние IoT Hub. Используйте `present` для создания или обновления IoT Hub и `absent` для удаления IoT Hub. Варианты: `"absent"` `"present"` ← (по умолчанию)
subscription_id строка	Идентификатор вашей подписки Azure.
tags словарь	Словарь пар "строка:строка" для назначения метаданных объекту. Метаданные теги объекта будут обновлены всеми предоставленными значениями. Чтобы удалить теги, установите опцию append_tags в false. В настоящее время зоны Azure DNS и службы Traffic Manager также не позволяют использовать пробелы в теге. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 тегов для ресурсов.
tenant строка	Идентификатор Azure-аренды. Используйте при аутентификации с помощью Служебного принципала.
thumbprint строка добавлен в azure.azcollection 1.14.0	Отпечаток цифрового сертификата, указанного в x509_certificate_path. Используйте при аутентификации с помощью Служебного принципала. Обязательно, если определен x509_certificate_path.
unit целое число	Единицы в вашем IoT Hub. По умолчанию `1`.
x509_certificate_path путь добавлен в azure.azcollection 1.14.0	Путь к X509-сертификату, используемому для создания служебного принципала в формате PEM. Сертификат должен быть приложен к закрытому ключу. Используйте при аутентификации с помощью Служебного принципала.

Примечания

Примечание

Для аутентификации с 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 и пароль или установите 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: true

Значения возврата

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

Ключ	Описание
cloud_to_device сложный	Свойства сообщения «облако-устройство». Возвращено: успешно
max_delivery_count целое число	Количество попыток передачи сообщения IoT-хаба в очереди обратной связи. См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. Возвращено: успешно Пример: `10`
ttl_as_iso8601 строка	Период времени, в течение которого сообщение доступно для обработки, прежде чем его истечёт срок действия в IoT-хабе. См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. Возвращено: успешно Пример: `"1:00:00"`
enable_file_upload_notifications логическое значение	Включены ли уведомления о загрузке файлов. Возвращено: успешно Пример: `true`
event_endpoints сложный	Встроенный конечный пункт для доставки сообщений устройства. Возвращено: успешно
endpoint строка	Конечная точка совместимая с Event Hub. Возвращено: успешно Пример: `"sb://iothub-ns-testing-1478811-9bbc4a15f0.servicebus.windows.net/"`
partition_count целое число	Количество разделов для получения сообщений «устройство-облако» в конечной точке, совместимой с Event Hub. См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. Возвращено: успешно Пример: `2`
partition_ids список / элементы=строка	Список идентификаторов разделов для конечной точки события. Возвращено: успешно Пример: `["0", "1"]`
retention_time_in_days целое число	Срок хранения сообщений «устройство-облако» в днях. См. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. Возвращено: успешно Пример: `1`
host_name строка	Хост IoT-хаба. Возвращено: успешно Пример: `"testing.azure-devices.net"`
id строка	Идентификатор ресурса IoT-хаба. Возвращено: успешно Пример: `"/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/Testing"`
ip_filters сложный	Настройка правил для отклонения или принятия трафика со специфических IPv4 адресов. Возвращено: успешно
action строка	Требуемое действие для запросов, захваченных этим правилом. Возвращено: успешно Пример: `"Reject"`
ip_mask строка	Строка, содержащая диапазон IP-адресов в нотации CIDR для правила. Возвращено: успешно Пример: `"40.54.7.3"`
name строка	Имя фильтра. Возвращено: успешно Пример: `"filter"`
location строка	Расположение IoT-хаба. Возвращено: успешно Пример: `"eastus"`

имя строка	Имя IoT-хаба. Возвращается: успех Пример: `"Testing"`
группа_ресурсов строка	Группа ресурсов IoT-хаба. Возвращается: успех Пример: `"myResourceGroup."`
маршруты сложная	Маршрутизация сообщений устройства в облако на сервисно-ориентированные конечные точки. Возвращается: успех
условие логический	Выражение запроса для запроса маршрутизации, выполняемого над свойствами приложения сообщения, системными свойствами, телом сообщения, тегами двойника устройства и свойствами двойника устройства, чтобы определить, соответствует ли оно конечной точке. Дополнительную информацию о построении запроса см. на странице https://docs.microsoft.com/ru-ru/azure/iot-hub/iot-hub-devguide-routing-query-syntax Возвращается: успех Пример: `true`
включено строка	Включить или отключить маршрут. Возвращается: успех Пример: `"True"`
имя_конечной_точки строка	Имя конечной точки в `routing_endpoints`, куда IoT Hub отправляет сообщения, соответствующие запросу. Возвращается: успех Пример: `"foo"`
имя строка	Имя маршрута. Возвращается: успех Пример: `"route1"`
источник строка	Источник потока данных, который необходимо обработать. Возвращается: успех Пример: `"device_messages"`
конечные_точки_маршрутизации сложная	Пользовательские конечные точки. Возвращается: успех
event_hubs сложная	Список пользовательских конечных точек центров событий. Возвращается: успех
строка_соединения строка	Строка подключения к пользовательской конечной точке. Возвращается: успех Пример: `"Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo"`
имя строка	Имя пользовательской конечной точки. Возвращается: успех Пример: `"foo"`
группа_ресурсов строка	Группа ресурсов конечной точки. Возвращается: успех Пример: `"bar"`
подписка строка	Идентификатор подписки конечной точки. Возвращается: успех Пример: `"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"`
service_bus_queues сложная	Список пользовательских конечных точек очередей службы сообщений. Возвращается: всегда
строка_соединения строка	Строка подключения к пользовательской конечной точке. Возвращается: успех Пример: `"Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo"`
имя строка	Имя пользовательской конечной точки. Возвращается: успех Пример: `"foo"`
группа_ресурсов строка	Группа ресурсов конечной точки. Возвращается: успех Пример: `"bar"`

подписка строка	Идентификатор подписки на конечную точку. Возвращено: успешно Пример: `"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"`
service_bus_topics сложный тип	Список пользовательских конечных точек темы Service Bus. Возвращено: успешно
connection_string строка	Строка подключения к пользовательской конечной точке. Возвращено: успешно Пример: `"Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo"`
имя строка	Имя пользовательской конечной точки. Возвращено: успешно Пример: `"foo"`
resource_group строка	Группа ресурсов конечной точки. Возвращено: успешно Пример: `"bar"`
подписка строка	Идентификатор подписки на конечную точку. Возвращено: успешно Пример: `"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"`
storage_containers сложный тип	Список пользовательских конечных точек хранилища. Возвращено: успешно
connection_string строка	Строка подключения к пользовательской конечной точке. Возвращено: успешно Пример: `"Endpoint=sb://quux.servicebus.windows.net:5671/;SharedAccessKeyName=qux;SharedAccessKey=****;EntityPath=foo"`
имя строка	Имя пользовательской конечной точки. Возвращено: успешно Пример: `"foo"`
resource_group строка	Группа ресурсов конечной точки. Возвращено: успешно Пример: `"bar"`
подписка строка	Идентификатор подписки на конечную точку. Возвращено: успешно Пример: `"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"`
sku строка	Ценовой тариф Azure IoT Hub. Возвращено: успешно Пример: `"f1"`
единица целое число	Единицы в Azure IoT Hub. Возвращено: успешно Пример: `1`

Авторы

Yuwei Zhou (@yuwzho)

Ссылки на сборки

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_iothub_module.html