azure_rm_dnszone — Управление зонами Azure DNS.
Новая версия с 2.4.
- Обзор
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Обзор
- Создаёт и удаляет зоны Azure DNS.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.7
- azure >= 2.0.0
Параметры
| параметр | обязательно | значение по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| ad_user | нет | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо службы-принципала. | ||
| append_tags | нет | True | Управляет тем, является ли поле тегов каноническим или просто добавляет к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. | |
| client_id | нет | Идентификатор клиента Azure. Используется при аутентификации со службой-принципалом. | ||
| cloud_environment | нет | AzureCloud | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть задан через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT. | |
| name | да | Имя зоны DNS. | ||
| password | нет | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо службы-принципала. | ||
| profile | нет | Профиль безопасности, найденный в файле ~/.azure/credentials. | ||
| resource_group | да | Имя группы ресурсов. | ||
| secret | нет | Секрет клиента Azure. Используется при аутентификации со службой-принципалом. | ||
| state | нет | present |
| Утвердить состояние зоны. Используйте 'present' для создания или обновления и 'absent' для удаления. |
| subscription_id | нет | Ваш идентификатор подписки Azure. | ||
| tags | нет | Словарь пар строка:строка, назначаемых в качестве метаданных объекту. Теги метаданных объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false. | ||
| tenant | нет | Идентификатор арендатора Azure. Используется при аутентификации со службой-принципалом. |
Примеры
- 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 | Текущее состояние зоны. | всегда | словарь | {'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'} |
Примечания
Примечание
- Для аутентификации с 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 в среде.
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Для получения помощи в разработке модулей, если вы захотите, пожалуйста, ознакомьтесь с информацией сообщества и участием в разработке, тестированием Ansible и разработкой модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/azure_rm_dnszone_module.html