модуль azure.azcollection.azure_rm_dnsrecordset_info — получение сведений о наборах DNS-записей
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_dnsrecordset_info.
Добавлено в azure.azcollection 0.1.2
Краткое описание
- Получение сведений о конкретном наборе DNS-записей в зоне либо о записях определённого типа во всех зонах или в одной зоне и т. д.
Требования
На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.
- python >= 2.7
- На хосте, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection из Galaxy
- Все пакеты Python, указанные в файле requirements.txt коллекции, должны быть установлены с помощью pip на хосте, выполняющем модули из azure.azcollection
- Полные инструкции по установке доступны по адресу https://galaxy.ansible.com/azure/azcollection
Параметры
Параметр | Комментарии |
|---|---|
ad_user строка | Имя пользователя Active Directory. Используется при аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
adfs_authority_url строка добавлено в azure.azcollection 0.0.1 | URL-адрес центра Azure AD. Используется при аутентификации с помощью имени пользователя и пароля, если у вас есть собственный центр ADFS. |
api_profile строка добавлено в azure.azcollection 0.0.1 | Выбирает профиль API для взаимодействия со службами Azure. Значение По умолчанию: |
append_tags логическое значение | Определяет, является ли поле tags каноническим или только дополняет существующие теги. В каноническом режиме все теги, отсутствующие в параметре tags, будут удалены из метаданных объекта. Варианты:
|
auth_source строка добавлено в azure.azcollection 0.0.1 | Определяет источник учетных данных для аутентификации. Также можно задать с помощью переменной окружения Если задано значение Если задано значение Если задано значение Если задано значение Если задано значение Параметр Варианты:
|
cert_validation_mode строка добавлено в azure.azcollection 0.0.1 | Определяет поведение проверки сертификатов конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав Варианты:
|
client_id строка | Идентификатор клиента Azure. Используется при аутентификации с помощью субъекта-службы или управляемого удостоверения (msi). Также можно задать с помощью переменной окружения |
cloud_environment строка добавлено в azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, указывается имя среды (определенное в Azure Python SDK, например По умолчанию: |
disable_instance_discovery логическое значение добавлено в azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Если задать значение true, обнаружение экземпляров и проверка центра будут полностью отключены. Эта функция предназначена для сценариев, в которых невозможно получить доступ к конечной точке метаданных, например в частных облаках или Azure Stack. Обнаружение экземпляров подразумевает получение метаданных центра с сайта https://login.microsoft.com/ для проверки центра. Если задать значение **True**, проверка центра будет отключена. Поэтому крайне важно убедиться, что настроенный узел центра действителен и заслуживает доверия. Задается в профиле файла учетных данных или с помощью переменной окружения Варианты:
|
log_mode строка | Родительский аргумент. |
log_path строка | Родительский аргумент. |
oidc_token строка добавлено в azure.azcollection 3.17.0 | Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации удостоверения рабочей нагрузки. Этот токен обменивается с Azure AD с использованием федеративного удостоверения OIDC. Полезен в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC. Также можно задать с помощью переменной окружения |
oidc_token_file_path путь добавлено в azure.azcollection 3.17.0 | Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации удостоверения рабочей нагрузки. Файл должен содержать только исходный токен. Этот способ часто используется на платформах, которые предоставляют токены OIDC в виде файлов. Также можно задать с помощью переменной окружения |
password строка | Пароль пользователя Active Directory. Используется при аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
profile строка | Профиль безопасности из файла ~/.azure/credentials. |
record_type строка | Ограничение наборов записей по типу записи. |
relative_name строка | Показывать результаты только для одного набора записей. |
resource_group строка | Ограничение результатов по группе ресурсов. Обязательный параметр при фильтрации по имени или типу. |
secret строка | Секрет клиента Azure. Используется при аутентификации с помощью субъекта-службы. |
subscription_id строка | Идентификатор вашей подписки Azure. |
tags словарь | Словарь пар «строка:строка», назначаемых объекту в качестве метаданных. Теги метаданных объекта будут обновлены с учетом всех предоставленных значений. Чтобы удалить теги, установите для параметра append_tags значение false. В настоящее время зоны Azure DNS и службы Traffic Manager также не позволяют использовать пробелы в тегах. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают не более 15 тегов для ресурсов. |
tenant строка | Идентификатор клиента Azure. Используется при аутентификации с помощью субъекта-службы. |
thumbprint строка добавлено в azure.azcollection 1.14.0 | Отпечаток закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью субъекта-службы. Обязателен, если задан x509_certificate_path. |
top целое число | Ограничение максимального количества возвращаемых наборов записей. |
x509_certificate_path путь добавлено в azure.azcollection 1.14.0 | Путь к сертификату X509 в формате PEM, использованному для создания субъекта-службы. Сертификат должен быть добавлен к закрытому ключу. Используется при аутентификации с помощью субъекта-службы. |
zone_name строка | Ограничение результатов по зонам. Обязательный параметр при фильтрации по имени или типу. |
Примечания
Примечание
- Для аутентификации в Azure можно передать параметры, задать переменные окружения, использовать профиль из ~/.azure/credentials или войти в систему перед запуском задач или плейбука с помощью
az login. - Также возможна аутентификация с помощью субъекта-службы или пользователя Active Directory.
- Для аутентификации через OIDC передайте client_id, tenant и oidc_token либо oidc_token_file_path или задайте переменные окружения AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN либо AZURE_FEDERATED_TOKEN_FILE.
- Для аутентификации через субъект-службу передайте 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 список / элементы=строка | Список словарей наборов записей. Возвращается: всегда Пример: |
dnsrecordsets сложный тип | Список словарей наборов записей, имеющих ту же иерархию, что и параметр модуля azure.azcollection.azure_rm_dnsrecordset. Возвращается: всегда |
|
fqdn строка |
Полное доменное имя набора записей. Возвращается: при успешном выполнении Пример: |
|
id строка |
Идентификатор набора DNS-записей. Возвращается: при успешном выполнении Пример: |
|
provisioning_state строка |
Состояние подготовки ресурса. Возвращается: при успешном выполнении Пример: |
|
record_type строка |
Тип набора записей. Возможные значения: Возвращается: при успешном выполнении Пример: |
|
records словарь |
Список записей в зависимости от типа набора записей. Возвращается: при успешном выполнении Пример: |
|
relative_name строка |
Имя набора DNS-записей. Возвращается: при успешном выполнении Пример: |
|
target_resource словарь |
Ссылка на ресурс Azure, из которого берется значение ресурса DNS. Возвращается: всегда Пример: |
|
time_to_live целое число |
Время жизни набора записей в секундах. Возвращается: при успешном выполнении Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/azure/azcollection/azure_rm_dnsrecordset_info_module.html