azure.azcollection.azure_rm_dnszone – Управление зонами Azure DNS
Примечание
Этот плагин является частью коллекции azure.azcollection (версия 1.3.1).
Для его установки используйте: ansible-galaxy collection install azure.azcollection.
Для использования в книге задач укажите: azure.azcollection.azure_rm_dnszone.
Введено в версии 0.1.0: коллекции azure.azcollection
Обзор
- Создаёт и удаляет зоны Azure DNS.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с главным принципом службы. | |
| adfs_authority_url строка добавлен в 0.0.1 в azure.azcollection | URL-адрес авторизации Azure AD. Используется при аутентификации с именем пользователя/паролем и собственной службой авторизации ADFS. | |
| api_profile строка добавлен в 0.0.1 в azure.azcollection | По умолчанию: "latest" | Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. |
| append_tags логическое |
| Управляет тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. Когда каноническое, любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. |
| auth_source строка добавлен в 0.0.1 в azure.azcollection |
| Управляет источником учетных данных для аутентификации. Также может быть задано через переменную среды ANSIBLE_AZURE_AUTH_SOURCE. При значении auto (по умолчанию) приоритет: параметры модуля -> env -> credential_file -> cli. При значении env, учетные данные будут считываться из переменных среды.При значении credential_file, он будет считывать профиль из ~/.azure/credentials.При значении cli, учетные данные будут получены из профиля Azure CLI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для определения идентификатора подписки, если их несколько, иначе используется стандартная подписка Azure CLI.При значении msi, хост-машина должна быть ресурсом Azure с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка.msi был добавлен в Ansible 2.6. |
| cert_validation_mode строка добавлен в 0.0.1 в azure.azcollection |
| Управляет поведением проверки сертификатов для конечных точек Azure. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть задано в профиле файла учетных данных или в переменной среды AZURE_CERT_VALIDATION. |
| client_id строка | Идентификатор клиента Azure. Используется при аутентификации с главным принципом службы. | |
| cloud_environment строка добавлен в 0.0.1 в azure.azcollection | По умолчанию: "AzureCloud" | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (необходим для Azure Stack). Также может быть задано в профиле файла учетных данных или в переменной среды AZURE_CLOUD_ENVIRONMENT. |
| name строка / обязательно | Имя зоны DNS. | |
| password строка | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с главным принципом службы. | |
| profile строка | Профиль безопасности в файле ~/.azure/credentials. | |
| registration_virtual_networks список / элементы=строка | Список ссылок на виртуальные сети, которые регистрируют имена хостов в этой зоне DNS. Это только когда type=private. Каждый элемент может быть именем или идентификатором ресурса, или словарем, содержащим name, resource_group информацию о виртуальной сети. | |
| resolution_virtual_networks список / элементы=строка | Список ссылок на виртуальные сети, которые разрешают записи в этой зоне DNS. Это только когда type=private. Каждый элемент может быть именем или идентификатором ресурса, или словарем, содержащим name, resource_group информацию о виртуальной сети. | |
| resource_group строка / обязательно | имя группы ресурсов. | |
| secret строка | Секрет клиента Azure. Используется при аутентификации с главным принципом службы. | |
| state строка |
| Утвердить состояние зоны. Используйте present для создания или обновления и absent для удаления. |
| subscription_id строка | Ваш идентификатор подписки Azure. | |
| tags словарь | Словарь пар строка:строка для назначения в качестве метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в false. | |
| tenant строка | Идентификатор клиента Azure. Используется при аутентификации с главным принципом службы. | |
| type строка |
| Тип этой зоны DNS ( public или private). |
Примечания
Примечание
- Для аутентификации с Azure вы можете передать параметры, установить переменные среды, использовать профиль, сохраненный в файле ~/.azure/credentials, или войти в систему перед запуском задач или книги задач с помощью
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. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или установив 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 словарь | всегда | Текущее состояние зоны. Пример: {'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup', '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, 'resolution_virtual_networks': ['/subscriptions/XXXX/resourceGroup/myResourceGroup/providers/Microsoft.Network/virtualNetworks/foo'], 'type': 'private'} |
Авторы
- 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.10/collections/azure/azcollection/azure_rm_dnszone_module.html