azure.azcollection.azure_rm_dnszone_info – Получение фактов о зоне DNS
Примечание
Этот плагин является частью коллекции azure.azcollection (версия 1.4.0).
Для его установки используйте: ansible-galaxy collection install azure.azcollection.
Для использования в плейбуке укажите: azure.azcollection.azure_rm_dnszone_info.
Новый в версии 0.1.2: коллекции azure.azcollection
Обзор
- Получение фактов для определенной зоны DNS или всех зон 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 может использоваться для идентификации идентификатора подписки, если их несколько; в противном случае используется стандартная подписка az 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 строка | Показывать результаты только для определенной зоны. | |
| password строка | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы. | |
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| resource_group строка | Ограничить результаты по группе ресурсов. Требуется при фильтрации по имени. | |
| secret строка | Секрет клиента Azure. Используйте при аутентификации с принципалом службы. | |
| subscription_id строка | Ваш идентификатор Azure-подписки. | |
| tags словарь | Ограничить результаты, указав список тегов. Формат тегов: 'ключ' или 'ключ:значение'. | |
| tenant строка | Идентификатор Azure-тенанта. Используйте при аутентификации с принципалом службы. |
Примечания
Примечание
- Для аутентификации с 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. Также можно добавить дополнительные профили. Укажите профиль, передав profile или установив AZURE_PROFILE в среде.
См. также
См. также
- Вход с помощью Azure CLI
-
Как выполнить аутентификацию с помощью команды
az login.
Примеры
- name: Get facts for one zone
azure_rm_dnszone_info:
resource_group: myResourceGroup
name: foobar22
- name: Get facts for all zones in a resource group
azure_rm_dnszone_info:
resource_group: myResourceGroup
- name: Get facts by tags
azure_rm_dnszone_info:
tags:
- testing
Возвращаемые значения
Общие возвращаемые значения описаны в документации, ниже приведены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| azure_dnszones список / элементы=строка | всегда | Список словарей зон. Пример: [{'etag': '00000002-0000-0000-0dcb-df5776efd201', 'location': 'global', 'properties': {'maxNumberOfRecordSets': 5000, 'numberOfRecordSets': 15}, 'tags': {}}] | |
| dnszones список / элементы=строка | всегда | Список словарей зон, которые имеют тот же макет, что и параметр модуля azure_rm_dnszone. | |
| id строка | успех | Идентификатор зоны DNS. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/dnszones/azure.com | |
| max_number_of_record_sets целое число | успех | Максимальное количество наборов записей, которые могут быть созданы в этой зоне DNS. Пример: 5000 | |
| name строка | успех | Имя зоны DNS. Пример: azure.com | |
| name_servers список / элементы=строка | успех | Серверы имен для этой зоны DNS. Пример: ['ns1-03.azure-dns.com.', 'ns2-03.azure-dns.net.', 'ns3-03.azure-dns.org.', 'ns4-03.azure-dns.info.'] | |
| number_of_record_sets целое число | успех | Текущее количество наборов записей в этой зоне DNS. Пример: 2 | |
| registration_virtual_networks список / элементы=строка | успех | Список ссылок на виртуальные сети, которые регистрируют имена хостов в этой зоне DNS. Пример: ['/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/bar'] | |
| resolution_virtual_networks список / элементы=строка | успех | Список ссылок на виртуальные сети, которые разрешают записи в этой зоне DNS. Пример: ['/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/deadbeef'] | |
| type строка | успех | Тип этой зоны DNS ( public или private).Пример: private | |
Авторы
- Obezimnaka Boms (@ozboms)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_dnszone_info_module.html