Модуль azure.azcollection.azure_rm_iothubconsumergroup – Управление узлом Azure IoT
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования, см. Требования для подробностей.
Для использования в плейбуке укажите: azure.azcollection.azure_rm_iothubconsumergroup.
Новое в 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. Значение по умолчанию Default: |
append_tags boolean | Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. Когда канонический, любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта. Choices:
|
auth_source string added in azure.azcollection 0.0.1 | Управляет источником учетных данных, используемых для аутентификации. Может быть также установлен через переменную среды При установке в При установке в При установке в При установке в При установке в
Choices:
|
cert_validation_mode string added in azure.azcollection 0.0.1 | Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но когда используется прокси HTTPS или Azure Stack, может потребоваться отключить это поведение, передав Choices:
|
client_id string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентичности (msi). Может быть также установлен через переменную среды |
cloud_environment string added in azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, Default: |
disable_instance_discovery boolean added in azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных полномочий с https://login.microsoft.com/ для проверки полномочий. Установив это значение в **True**, проверка полномочий отключается. В результате важно убедиться, что настроенный узел полномочий является действительным и заслуживающим доверия. Устанавливается через профиль файла учетных данных или переменную среды Choices:
|
event_hub string | Имя конечной точки концентратора событий. Default: |
hub string / required | Имя концентратора IoT. |
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string / required | Имя группы потребителей. |
password string | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным субъектом безопасности. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
resource_group string / обязательно | Имя группы ресурсов. |
secret string | Секретный ключ Azure. Используется при аутентификации с помощью принципала службы. |
state string | Состояние узла IoT. Используйте Выбор:
|
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. |
x509_certificate_path путь добавлен в azure.azcollection 1.14.0 | Путь к X509-сертификату, используемому для создания принципала службы в формате PEM. Сертификат должен быть присоединен к закрытому ключу. Используется при аутентификации с помощью принципала службы. |
Примечания
Примечание
- Для аутентификации с 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 an IoT hub consumer group
azure_rm_iothubconsumergroup:
name: test
resource_group: myResourceGroup
hub: Testing
Возвращаемые значения
Общие возвращаемые значения описаны в здесь, следующие — поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
id строка | Идентификатор ресурса группы потребителей. Возвращаемое значение: успех Пример: |
name строка | Имя группы потребителей. Возвращаемое значение: успех Пример: |
Справочные ссылки по коллекции
© 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_iothubconsumergroup_module.html