azure_rm_dnszone — Управление зонами Azure DNS.
Новая версия 2.4.
Обзор
- Создает и удаляет зоны Azure DNS.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user | По умолчанию: None | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы. |
| api_profile (добавлен в 2.5) |
| Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. |
| append_tags | По умолчанию: yes | Управляет тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. |
| auth_source (добавлен в 2.5) |
| Управляет источником учетных данных для аутентификации. auto будет следовать умолчанию параметров модуля -> переменных среды -> профиля по умолчанию в файле учетных данных ~/.azure/credentials. При значении cli, учетные данные берутся из профиля Azure CLI по умолчанию.Также может быть задано через переменную среды ANSIBLE_AZURE_AUTH_SOURCE. |
| cert_validation_mode (добавлен в 2.5) |
None | Управляет поведением проверки сертификатов для Azure-узлов. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или при взаимодействии с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. |
| client_id | По умолчанию: None | ID клиента Azure. Используется при аутентификации с принципалом службы. |
| cloud_environment (добавлен в 2.4) | По умолчанию: AzureCloud | Для облачных сред, отличных от общедоступного облака США, имя среды (определенное Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment или URL-адрес конечной точки обнаружения метаданных (необходим для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT. |
| name обязательно | имя зоны DNS. | |
| password | По умолчанию: None | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы. |
| profile | По умолчанию: None | Профиль безопасности, найденный в файле ~/.azure/credentials. |
| resource_group обязательно | имя группы ресурсов. | |
| secret | По умолчанию: None | Секрет клиента Azure. Используется при аутентификации с принципалом службы. |
| state |
| Утверждение состояния зоны. Используйте 'present' для создания или обновления и 'absent' для удаления. |
| subscription_id | По умолчанию: None | Ваш идентификатор подписки Azure. |
| tags | По умолчанию: None | Словарь пар строка:строка, назначаемый в качестве метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в false. |
| tenant | По умолчанию: None | Идентификатор клиента Azure. Используется при аутентификации с принципалом службы. |
Примечания
Примечание
- Для аутентификации с Azure вы можете передавать параметры, устанавливать переменные среды или использовать профиль, хранящийся в файле ~/.azure/credentials. Аутентификация возможна с использованием принципала службы или пользователя 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 в среде.
Примеры
- name: Create a DNS zone
azure_rm_dnszone:
resource_group: Testing
name: example.com
state: present
- name: Delete a DNS zone
azure_rm_dnszone:
resource_group: Testing
name: example.com
state: absent
Возвращаемые значения
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| state dict | всегда | Текущее состояние зоны. Пример: {'name_servers': ['ns1-07.azure-dns.com.', 'ns2-07.azure-dns.net.', 'ns3-07.azure-dns.org.', 'ns4-07.azure-dns.info.'], 'location': 'global', 'number_of_record_sets': 2, 'id': '/subscriptions/XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX/resourceGroups/Testing', 'name': 'Testing'} |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратно совместимый.
Автор
- Obezimnaka Boms (@ozboms)
Подсказка
Если вы обнаружите проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/azure_rm_dnszone_module.html