azure.azcollection.azure_rm_iotdevicemodule – Управление модулем устройства Azure IoT hub

Примечание

Этот плагин является частью коллекции azure.azcollection (версия 1.3.1).

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

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

Новое в версии 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 логическое значение	Варианты: no да ←	Управление тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. В случае канонического значения теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.
auth_method строка	Варианты: sas ← certificate_authority self_signed	Тип авторизации, с которым должен быть создан объект.
auth_source строка добавлено в 0.0.1 azure.azcollection	Варианты: auto ← 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`, могут использоваться для указания идентификатора подписки, если их несколько; в противном случае используется стандартная подписка Azure 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`.
desired словарь		Используется вместе с отчётными свойствами для синхронизации конфигурации или состояния устройства. Ключ тега может быть вложенным словарем, символы '.', '$', '#', ' ' в ключе запрещены. Списки не поддерживаются.
device строка / обязательно		Имя устройства, с которым связывается модуль.
hub строка / обязательно		Имя IoT Hub.
hub_policy_key строка / обязательно		Ключ политики hub_policy_name.
hub_policy_name строка / обязательно		Имя политики IoT Hub, которая будет использоваться для запросов к IoT Hub. Эта политика должна иметь как минимум права «Чтение реестра».
name строка / обязательно		Имя идентификатора устройства IoT hub.
password строка		Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory вместо служебного принципала.
primary_key строка		Явный отпечаток самозаверяющего сертификата для использования с первичным ключом. Явный общий закрытый ключ для использования с первичным ключом. псевдонимы: primary_thumbprint
profile строка		Профиль безопасности в файле ~/.azure/credentials.
secondary_key строка		Явный отпечаток самозаверяющего сертификата для использования со вторичным ключом. Явный общий закрытый ключ для использования со вторичным ключом. псевдонимы: secondary_thumbprint
secret строка		Секрет клиента Azure. Используется при аутентификации с помощью служебного принципала.
state строка	Варианты: absent present ←	Состояние IoT hub. Используйте `present`, чтобы создать или обновить устройство IoT hub и `absent`, чтобы удалить устройство IoT hub.
subscription_id строка		Идентификатор вашей Azure-подписки.
tags словарь		Словарь пар строка:строка, назначаемых в качестве метаданных объекту. Метаданные теги объекта будут обновлены с любыми заданными значениями. Для удаления тегов установите опцию append_tags в false.
tenant строка		Идентификатор Azure-аренды. Используется при аутентификации с помощью служебного принципала.
twin_tags словарь		Раздел, который бэкенд решения может читать и изменять. Теги не видны приложениям устройства. Ключ тега может быть вложенным словарем, символы '.', '$', '#', ' ' в ключе запрещены. Списки не поддерживаются.

Примечания

Примечание

Для аутентификации с Azure вы можете передать параметры, установить переменные среды, использовать профиль, сохранённый в ~/.azure/credentials, или войти в систему перед запуском задач или playbook с помощью 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 simplest Azure IoT Hub device module
  azure_rm_iotdevicemodule:
    hub: myHub
    name: Testing
    device: mydevice
    hub_policy_name: iothubowner
    hub_policy_key: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

- name: Create Azure IoT Edge device module
  azure_rm_iotdevice:
    hub: myHub
    device: mydevice
    name: Testing
    hub_policy_name: iothubowner
    hub_policy_key: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    edge_enabled: yes

- name: Create Azure IoT Hub device module with module twin properties and tag
  azure_rm_iotdevice:
    hub: myHub
    name: Testing
    device: mydevice
    hub_policy_name: iothubowner
    hub_policy_key: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    twin_tags:
        location:
            country: US
            city: Redmond
        sensor: humidity
    desired:
        period: 100

Возвращаемые значения

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

Ключ	Возвращаемое значение	Описание
module словарь	всегда	Устройство IoT Hub. Пример: {'authentication': {'symmetricKey': {'primaryKey': 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', 'secondaryKey': 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'}, 'type': 'sas', 'x509Thumbprint': {'primaryThumbprint': None, 'secondaryThumbprint': None}}, 'cloudToDeviceMessageCount': 0, 'connectionState': 'Отключено', 'connectionStateUpdatedTime': '0001-01-01T00:00:00', 'deviceId': 'mydevice', 'etag': 'ODM2NjI3ODg=', 'generationId': '636904759703045768', 'lastActivityTime': '0001-01-01T00:00:00', 'managedBy': None, 'moduleId': 'Testing'}

Авторы

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_iotdevicemodule_module.html