azure.azcollection.azure_rm_dnsrecordset_info – Получение фактов набора записей DNS
Примечание
Этот плагин входит в коллекцию azure.azcollection (версия 1.3.1).
Для его установки используйте: ansible-galaxy collection install azure.azcollection.
Для использования в книге задач укажите: azure.azcollection.azure_rm_dnsrecordset_info.
Новое в версии 0.1.2: из azure.azcollection
Обзор
- Получить сведения о конкретном наборе записей 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. |
| password строка | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы. | |
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| record_type строка | Ограничение наборов записей по типу записи. | |
| relative_name строка | Отображать только результаты для набора записей. | |
| resource_group строка | Ограничение результатов по группе ресурсов. Требуется при фильтрации по имени или типу. | |
| secret строка | Секрет клиента Azure. Используйте при аутентификации с принципалом службы. | |
| subscription_id строка | Идентификатор вашей подписки Azure. | |
| tags словарь | Словарь пар "строка:строка" для назначения метаданных объекту. Метаданные теги объекта будут обновлены всеми предоставленными значениями. Для удаления тегов установите опцию append_tags в значение false. | |
| tenant строка | Идентификатор клиента Azure. Используйте при аутентификации с принципалом службы. | |
| top целое число | Ограничение максимального количества наборов записей для возврата. | |
| zone_name строка | Ограничить результаты по зонам. Требуется при фильтрации по имени или типу. |
Примечания
Примечание
- Для аутентификации с 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 Record Set
azure_rm_dnsrecordset_info:
resource_group: myResourceGroup
zone_name: example.com
relative_name: server10
record_type: A
- name: Get facts for all Type A Record Sets in a Zone
azure_rm_dnsrecordset_info:
resource_group: myResourceGroup
zone_name: example.com
record_type: A
- name: Get all record sets in one zone
azure_rm_dnsrecordset_info:
resource_group: myResourceGroup
zone_name: example.com
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| azure_dnsrecordset список / элементы=строка | всегда | Список словарей записей набора. Пример: [{'etag': '60ac0480-44dd-4881-a2ed-680d20b3978e', 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/dnszones/newzone.com/A/servera', 'name': 'servera', 'properties': {'ARecords': [{'ipv4Address': '10.4.5.7'}, {'ipv4Address': '2.4.5.8'}], 'TTL': 12900}, 'type': 'Microsoft.Network/dnszones/A'}] | |
| dnsrecordsets список / элементы=строка | всегда | Список словарей записей набора, которые используют ту же иерархию, что и параметр модуля azure_rm_dnsrecordset. | |
| fqdn строка | успех | Полное доменное имя набора записей. Пример: www.newzone.com | |
| id строка | успех | Идентификатор набора записей DNS. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/dnszones/newzone. com/A/servera | |
| provisioning_state строка | успех | Состояние подготовки ресурса. Пример: Успешно | |
| record_type строка | успех | Тип набора записей. Может быть A, AAAA, CNAME, MX, NS, SRV, TXT, PTR. Пример: A | |
| records строка | успех | Список записей, зависящий от типа набора записей. Пример: [{'ipv4Address': '10.4.5.7'}, {'ipv4Address': '2.4.5.8'}] | |
| relative_name строка | успех | Имя набора записей DNS. Пример: servera | |
| time_to_live строка | успех | Время жизни набора записей в секундах. Пример: 12900 | |
Авторы
- Ozi 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_dnsrecordset_info_module.html