Модуль azure.azcollection.azure_rm_dnszone – Управление зонами Azure DNS
Примечание
Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Для использования в книге задач укажите: azure.azcollection.azure_rm_dnszone.
Добавлен в azure.azcollection 0.1.0
Описание
- Создание и удаление зон Azure DNS.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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:
|
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string / required | Имя зоны DNS. |
password string | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с главным субъектом безопасности. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
registration_virtual_networks list / elements=any | Список ссылок на виртуальные сети, которые регистрируют имена хостов в этой зоне DNS. Это используется только когда type=private. Каждый элемент может быть именем или идентификатором ресурса, или словарем, содержащим информацию |
resolution_virtual_networks список / элементы=любой | Список ссылок на виртуальные сети, которые разрешают записи в этой зоне DNS. Это необходимо только когда type=private. Каждый элемент может быть именем или идентификатором ресурса, или словарем, содержащим |
resource_group строка / обязательно | Имя группы ресурсов. |
secret строка | Секрет Azure клиента. Используйте при аутентификации с помощью Сервисного принципала. |
state строка | Утверждение состояния зоны. Используйте Варианты:
|
subscription_id строка | Ваш идентификатор подписки Azure. |
tags словарь | Словарь пар "строка:строка" для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Чтобы удалить теги, установите параметр append_tags в значение false. В настоящее время зоны DNS Azure и службы Traffic Manager также не допускают использование пробелов в теге. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 тегов на ресурсах. |
tenant строка | Идентификатор аренды Azure. Используйте при аутентификации с помощью Сервисного принципала. |
thumbprint строка добавлен в azure.azcollection 1.14.0 | Отпечаток цифровой подписи закрытого ключа, указанного в x509_certificate_path. Используйте при аутентификации с помощью Сервисного принципала. Требуется, если определен x509_certificate_path. |
type строка | Тип этой зоны DNS ( Варианты:
|
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 a DNS zone
azure_rm_dnszone:
resource_group: myResourceGroup
name: example.com
- name: Delete a DNS zone
azure_rm_dnszone:
resource_group: myResourceGroup
name: example.com
state: absent
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для этого модуля:
Ключ | Описание |
|---|---|
state словарь | Текущее состояние зоны. Возвращаемое значение: всегда Пример: |
Ссылки на коллекцию
© 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_dnszone_module.html