azure_rm_dnszone – Управление зонами DNS Azure.
Новая в версии 2.4.
Описание
- Создаёт и удаляет зоны DNS Azure.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user - | Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не сервисного принципала. | |
| adfs_authority_url - добавлен в 2.6 | По умолчанию: null | URL-адрес авторизации Azure AD. Используется при аутентификации с именем пользователя/паролем и собственной авторизацией ADFS. |
| api_profile - добавлен в 2.5 | По умолчанию: "latest" | Выбирает профиль API для использования при общении с сервисами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. |
| append_tags boolean |
| Используется для управления тем, является ли поле тегов каноническим или просто добавляет к существующим тегам. При каноническом варианте любые теги, отсутствующие в параметре tags, будут удалены из метаданных объекта. |
| auth_source - добавлен в 2.5 |
| Управляет источником учетных данных для аутентификации. Если не указано, будет использоваться переменная среды ANSIBLE_AZURE_AUTH_SOURCE и по умолчанию auto в случае, если переменная не определена.auto будет следовать стандартному приоритету параметров модуля -> переменные окружения -> профиль по умолчанию в файле учетных данных ~/.azure/credentials. При установке в cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.Также может быть установлено через переменную окружения ANSIBLE_AZURE_AUTH_SOURCE. При установке в msi, хост-машина должна быть ресурсом Azure с включённым расширением MSI. subscription_id или переменная окружения AZURE_SUBSCRIPTION_ID можно использовать для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, иначе выбирается первая подписка.msi был добавлен в Ansible 2.6. |
| cert_validation_mode - добавлен в 2.5 |
| Управляет поведением проверки сертификатов для конечных точек Azure. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси HTTPS или подключении к Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть установлено через профиль файла учетных данных или переменную окружения AZURE_CERT_VALIDATION. |
| client_id - | Идентификатор клиента Azure. Используется при аутентификации с помощью сервисного принципала. | |
| cloud_environment - добавлен в 2.4 | По умолчанию: "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' для создания или обновления, и 'absent' для удаления. |
| subscription_id - | Идентификатор вашей подписки Azure. | |
| tags - | Словарь пар "строка:строка" для назначения метаданных объекту. Метаданные тегов объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false. | |
| tenant - | Идентификатор арендатора 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 словарь | всегда | Текущее состояние зоны. Пример: {'id': '/subscriptions/XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX/resourceGroups/Testing', 'location': 'global', 'name': 'Testing', 'name_servers': ['ns1-07.azure-dns.com.', 'ns2-07.azure-dns.net.', 'ns3-07.azure-dns.org.', 'ns4-07.azure-dns.info.'], 'number_of_record_sets': 2} |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [бета-версия]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.7/modules/azure_rm_dnszone_module.html
