Модуль azure.azcollection.azure_rm_postgresqlflexibledatabase_info — получение сведений о гибкой базе данных Azure PostgreSQL
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные зависимости. Подробнее см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_postgresqlflexibledatabase_info.
Добавлено в azure.azcollection 2.2.0
Краткое описание
- Получение сведений о гибкой базе данных PostgreSQL.
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- python >= 2.7
- На узле, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection из Galaxy
- Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены с помощью pip на узле, выполняющем модули из azure.azcollection
- Полные инструкции по установке доступны по адресу https://galaxy.ansible.com/azure/azcollection
Параметры
Параметр | Комментарии |
|---|---|
ad_user string | Имя пользователя Active Directory. Используйте этот параметр для аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
adfs_authority_url string добавлено в azure.azcollection 0.0.1 | URL-адрес центра Azure AD. Используйте этот параметр для аутентификации с именем пользователя и паролем при наличии собственного центра ADFS. |
api_profile string добавлено в azure.azcollection 0.0.1 | Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию По умолчанию: |
auth_source string добавлено в azure.azcollection 0.0.1 | Определяет источник учётных данных для аутентификации. Также можно задать с помощью переменной среды Если установлено значение Если установлено значение Если установлено значение Если установлено значение Если установлено значение Параметр Допустимые значения:
|
cert_validation_mode string добавлено в azure.azcollection 0.0.1 | Управляет проверкой сертификатов для конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав Допустимые значения:
|
client_id string | Идентификатор клиента Azure. Используйте для аутентификации с помощью субъекта-службы или управляемого удостоверения (msi). Также можно задать с помощью переменной среды |
cloud_environment string добавлено в azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, укажите имя среды (как определено в Azure Python SDK, например, По умолчанию: |
disable_instance_discovery boolean добавлено в azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Установка значения true полностью отключает обнаружение экземпляра и проверку центра. Эта функция предназначена для сценариев, в которых невозможно подключиться к конечной точке метаданных, например в частных облаках или Azure Stack. Обнаружение экземпляра включает получение метаданных центра с сайта https://login.microsoft.com/ для проверки центра. Если установить значение **True**, проверка центра отключается. Поэтому важно убедиться, что настроенный узел центра является допустимым и заслуживающим доверия. Задаётся в профиле файла учётных данных или с помощью переменной среды Допустимые значения:
|
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string | Имя базы данных PostgreSQL. |
oidc_token string добавлено в azure.azcollection 3.17.0 | Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки. Этот токен обменивается с Azure AD с помощью федеративного удостоверения OIDC. Полезен в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC. Также можно задать с помощью переменной среды |
oidc_token_file_path path добавлено в azure.azcollection 3.17.0 | Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки. Файл должен содержать только необработанный токен. Этот способ обычно используется на платформах, которые сохраняют токены OIDC в файлах. Также можно задать с помощью переменной среды |
password string | Пароль пользователя Active Directory. Используйте этот параметр для аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
profile string | Профиль безопасности в файле ~/.azure/credentials. |
resource_group string / обязательный | Имя группы ресурсов, содержащей ресурс. Это значение можно получить с помощью API Azure Resource Manager или на портале. |
secret string | Секрет клиента Azure. Используйте для аутентификации с помощью субъекта-службы. |
server_name string / обязательный | Имя сервера PostgreSQL. |
subscription_id string | Идентификатор вашей подписки Azure. |
tenant string | Идентификатор клиента Azure. Используйте для аутентификации с помощью субъекта-службы. |
thumbprint string добавлено в azure.azcollection 1.14.0 | Отпечаток закрытого ключа, указанного в x509_certificate_path. Используйте для аутентификации с помощью субъекта-службы. Обязателен, если задан параметр x509_certificate_path. |
x509_certificate_path path добавлено в azure.azcollection 1.14.0 | Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы. Сертификат должен быть добавлен после закрытого ключа. Используйте для аутентификации с помощью субъекта-службы. |
Примечания
Примечание
- Для аутентификации в 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: List instance of PostgreSQL Flexible Database by server name
azure_rm_postgresqlflexibledatabase_info:
resource_group: myResourceGroup
server_name: server_name
- name: Get instances of PostgreSQL Flexible Database
azure_rm_postgresqlflexibledatabase_info:
resource_group: myResourceGroup
server_name: server_name
name: database_name
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
database complex | Список словарей со сведениями о гибкой базе данных PostgreSQL. Возвращается: всегда |
|
charset string |
Кодировка базы данных. Возвращается: всегда Пример: |
|
collation string |
Порядок сортировки базы данных. Возвращается: всегда Пример: |
|
id string |
Идентификатор ресурса гибкой базы данных PostgreSQL. Возвращается: всегда Пример: |
|
name string |
Имя ресурса. Возвращается: всегда Пример: |
|
system_data complex |
Системные метаданные, связанные с этим ресурсом. Возвращается: всегда |
|
created_at string |
Время создания ресурса (UTC). Возвращается: всегда |
|
created_by string |
Удостоверение, создавшее ресурс. Возвращается: всегда |
|
created_by_type string |
Тип удостоверения, создавшего ресурс. Возвращается: всегда |
|
last_modified_at string |
Время последнего изменения ресурса (UTC). Возвращается: всегда |
|
last_modified_by string |
Удостоверение, выполнившее последнее изменение ресурса. Возвращается: всегда |
|
last_modified_by_type string |
Тип удостоверения, выполнившего последнее изменение ресурса. Возвращается: всегда |
|
type string |
Тип ресурса. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_postgresqlflexibledatabase_info_module.html