Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_iotdevice — Управление устройством Azure IoT hub

Примечание

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

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

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

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

Новое в azure.azcollection 0.1.2

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

Описание

  • Создание и удаление устройства Azure IoT hub.

Требования

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

  • 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_method

string

Тип авторизации, с которым должен быть создан объект.

Choices:

  • "sas" ← (default)
  • "certificate_authority"
  • "self_signed"

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"

desired

dictionary

Используется вместе со свойствами отчетов для синхронизации конфигурации или условий устройства.

Тег может быть вложенным словарем, ‘.’, ‘$’, ‘#’, ‘ ‘ не допускаются в ключе.

Список не поддерживается.

Не поддерживается в IoT Hub с базовым уровнем.

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

edge_enabled

boolean

Флаг, указывающий на включение edge.

Не поддерживается в IoT Hub с базовым уровнем.

Choices:

  • false
  • true

hub

string / required

Имя IoT Hub.

hub_policy_key

string / required

Ключ hub_policy_name.

hub_policy_name

string / обязательно

Имя политики IoT Hub, которое будет использоваться для запроса из IoT Hub.

Эта политика должна иметь права «RegistryWrite, ServiceConnect, DeviceConnect». Отсутствие любого из этих прав может привести к ошибке 401.

log_mode

string

Родительский аргумент.

log_path

string

Родительский аргумент.

name

string / обязательно

Имя идентификатора устройства IoT Hub.

password

string

Пароль пользователя Active Directory. Используется при аутентификации пользователем Active Directory, а не службой-принципалом.

primary_key

псевдонимы: primary_thumbprint

string

Явный отпечаток сертификата с собственноручной подписью для использования с первичным ключом.

Явный общий закрытый ключ для использования с первичным ключом.

profile

string

Профиль безопасности, найденный в файле ~/.azure/credentials.

secondary_key

псевдонимы: secondary_thumbprint

string

Явный отпечаток сертификата с собственноручной подписью для использования со вторичным ключом.

Явный общий закрытый ключ для использования со вторичным ключом.

secret

string

Секрет Azure клиента. Используется при аутентификации службой-принципалом.

state

string

Состояние IoT Hub. Используйте present для создания или обновления устройства IoT Hub и absent для удаления устройства IoT Hub.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)

status

boolean

Установите состояние устройства при создании.

Варианты:

  • false
  • true

subscription_id

string

Ваш идентификатор подписки Azure.

tags

словарь

Словарь пар строка:строка, присваиваемых в качестве метаданных объекту.

Метаданные теги объекта будут обновлены любыми предоставленными значениями.

Для удаления тегов установите параметр append_tags в false.

В настоящее время Azure DNS зоны и службы Traffic Manager также не допускают использование пробелов в теге.

Azure Front Door не поддерживает использование

Azure Automation и Azure CDN поддерживают только 15 тегов на ресурсах.

tenant

string

Идентификатор Azure-аренды. Используется при аутентификации службой-принципалом.

thumbprint

string

добавлен в azure.azcollection 1.14.0

Отпечаток закрытого ключа, указанного в x509_certificate_path.

Используется при аутентификации службой-принципалом.

Необходим, если определен x509_certificate_path.

twin_tags

словарь

Раздел, из которого и в который решение может читать и записывать.

Теги не видны приложениям устройства.

Тег может быть вложенным словарем, не допускаются ‘.’, ‘$’, ‘#’, ‘ ‘ в ключе.

Список не поддерживается.

Не поддерживается в IoT Hub с базовым уровнем.

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 и 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
  azure_rm_iotdevice:
    hub: myHub
    name: Testing
    hub_policy_name: iothubowner
    hub_policy_key: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    primary_key: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    secondary_key: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

- name: Create Azure IoT Edge device
  azure_rm_iotdevice:
    hub: myHub
    name: Testing
    hub_policy_name: iothubowner
    hub_policy_key: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    primary_key: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    secondary_key: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    edge_enabled: true

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

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

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

Ключ

Описание

device

словарь

Устройство IoT Hub.

Возвращается: всегда

Пример: {"authentication": {"symmetricKey": {"primaryKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", "secondaryKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"}, "type": "sas", "x509Thumbprint": {"primaryThumbprint": null, "secondaryThumbprint": null}}, "capabilities": {"iotEdge": false}, "changed": true, "cloudToDeviceMessageCount": 0, "connectionState": "Disconnected", "connectionStateUpdatedTime": "0001-01-01T00:00:00", "deviceId": "Testing", "etag": "NzA2NjU2ODc=", "failed": false, "generationId": "636903014505613307", "lastActivityTime": "0001-01-01T00:00:00", "modules": [{"authentication": {"symmetricKey": {"primaryKey": "XXXXXXXXXXXXXXXXXXX", "secondaryKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"}, "type": "sas", "x509Thumbprint": {"primaryThumbprint": null, "secondaryThumbprint": null}}, "cloudToDeviceMessageCount": 0, "connectionState": "Disconnected", "connectionStateUpdatedTime": "0001-01-01T00:00:00", "deviceId": "testdevice", "etag": "MjgxOTE5ODE4", "generationId": "636903840872788074", "lastActivityTime": "0001-01-01T00:00:00", "managedBy": null, "moduleId": "test"}], "properties": {"desired": {"$metadata": {"$lastUpdated": "2019-04-10T05:00:46.2702079Z", "$lastUpdatedVersion": 8, "period": {"$lastUpdated": "2019-04-10T05:00:46.2702079Z", "$lastUpdatedVersion": 8}}, "$version": 1, "period": 100}, "reported": {"$metadata": {"$lastUpdated": "2019-04-08T06:24:10.5613307Z"}, "$version": 1}}, "status": "enabled", "statusReason": null, "statusUpdatedTime": "0001-01-01T00:00:00", "tags": {"location": {"city": "Redmond", "country": "us"}, "sensor": "humidity"}}

Авторы

  • 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_iotdevice_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API