azure_rm_postgresqldatabase_facts – Получение фактов о базе данных Azure PostgreSQL

Новая версия с 2.7.

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Значения возврата
Статус

Обзор

Получение фактов о базе данных PostgreSQL.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user строка		Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
adfs_authority_url строка добавлен в 2.6		URL-адрес авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной авторизацией ADFS.
api_profile строка добавлен в 2.5	По умолчанию: "latest"	Выбор профиля API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для публичных облаков; будущие значения позволят использовать с Azure Stack.
auth_source строка добавлен в 2.5	Варианты: auto cli credential_file env msi	Определяет источник учетных данных для аутентификации. Если не указано, будет использована переменная среды ANSIBLE_AZURE_AUTH_SOURCE и по умолчанию `auto` если переменная не определена. `auto` будет следовать стандартному порядку приоритета параметров модуля -> переменных среды -> профиля по умолчанию в файле учетных данных `~/.azure/credentials`. При значении `cli`, учетные данные будут взяты из профиля по умолчанию Azure CLI. Также можно установить через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При значении `msi`, хост-машина должна быть ресурсом Azure с включённым расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут быть использованы для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка. `msi` был добавлен в Ansible 2.6.
cert_validation_mode строка добавлен в 2.5	Варианты: ignore validate	Управляет поведением проверки сертификатов для Azure-точек конечного доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси-сервера HTTPS или работе с Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также можно установить через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка		Идентификатор клиента Azure. Используйте при аутентификации с принципалом службы.
cloud_environment строка добавлен в 2.4	По умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес точки конечного доступа для обнаружения метаданных (необходимо для Azure Stack). Также можно установить через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
name -		Имя базы данных.
password -		Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group - / обязательно		Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала.
secret строка		Секрет клиента Azure. Используйте при аутентификации с принципалом службы.
server_name - / обязательно		Имя сервера.
subscription_id строка		Идентификатор вашей подписки Azure.
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 instance of PostgreSQL Database
  azure_rm_postgresqldatabase_facts:
    resource_group: myResourceGroup
    server_name: server_name
    name: database_name

- name: List instances of PostgreSQL Database
  azure_rm_postgresqldatabase_facts:
    resource_group: myResourceGroup
    server_name: server_name

Значения возврата

Общие значения возврата описаны в разделе, ниже перечислены поля, уникальные для данного модуля:

Ключ		Возвращаемое значение	Описание
databases сложный		всегда	Список словарей результатов, где ключ — имя базы данных PostgreSQL, а значения — факты для этой базы данных PostgreSQL.
	charset строка	всегда	Кодировка символов базы данных. Пример: UTF8
	collation строка	всегда	Сортировка базы данных. Пример: English_United States.1252
	id строка	всегда	Идентификатор ресурса Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforPostgreSQL/servers/testser ver/databases/db1
	name строка	всегда	Имя ресурса. Пример: db1
	resource_group строка	всегда	Имя группы ресурсов. Пример: testrg
	server_name строка	всегда	Имя сервера. Пример: testserver

Статус

Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Zim Kalinowski (@zikalino)

Подсказка

Если вы обнаружите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/azure_rm_postgresqldatabase_facts_module.html