community.azure.azure_rm_postgresqlserver_info – Получение фактов о сервере Azure PostgreSQL

Примечание

Этот плагин входит в коллекцию community.azure (версия 1.0.0).

Для его установки используйте: ansible-galaxy collection install community.azure.

Для использования в playbook укажите: community.azure.azure_rm_postgresqlserver_info.

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

Обзор

Получение фактов о сервере PostgreSQL.

Требования

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

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.
auth_source строка добавлено в 0.0.1 azure.azcollection	Варианты: auto ← cli credential_file env msi	Определяет источник учетных данных для аутентификации. Также может быть задан через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При значении `auto` (по умолчанию) приоритет имеет: параметры модуля -> `env` -> `credential_file` -> `cli`. При значении `env`, учетные данные считываются из переменных среды. При значении `credential_file`, профиль читается из `~/.azure/credentials`. При значении `cli`, учетные данные берутся из профиля Azure CLI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для определения идентификатора подписки, если их несколько, в противном случае используется стандартная подписка Azure CLI. При значении `msi`, хост-машина должна быть Azure-ресурсом с включенной расширенной службой MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка. `msi` добавлено в Ansible 2.6.
cert_validation_mode строка добавлено в 0.0.1 azure.azcollection	Варианты: ignore validate	Управляет поведением проверки сертификата для 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 строка / обязательно		Имя группы ресурсов, содержащей ресурс. Вы можете получить это значение из API Azure Resource Manager или портала.
secret строка		Секрет клиента Azure. Используйте при аутентификации со служебным принципалом.
subscription_id строка		Ваш идентификатор подписки Azure.
tags список / элементы=строка		Ограничение результатов путем предоставления списка тегов. Формат тегов: 'ключ' или 'ключ:значение'.
tenant строка		Идентификатор Azure-тенанта. Используйте при аутентификации со служебным принципалом.

Примечания

Примечание

Для аутентификации в Azure можно передавать параметры, задавать переменные среды, использовать профиль, сохраненный в ~/.azure/credentials, или войти в систему перед выполнением задач или playbook с помощью 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 Server
  community.azure.azure_rm_postgresqlserver_info:
    resource_group: myResourceGroup
    name: server_name

- name: List instances of PostgreSQL Server
  community.azure.azure_rm_postgresqlserver_info:
    resource_group: myResourceGroup

Возвращаемые значения

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

Ключ			Возвращаемое значение	Описание
серверы сложный			всегда	Список словарей, содержащих данные для серверов PostgreSQL.
	логин_админа строка		всегда	Имя пользователя администратора сервера. Пример: serveradmin
	enforce_ssl логическое		всегда	Включить принудительное использование SSL.
	полное_имя_домена строка		всегда	Полное доменное имя сервера. Пример: postgreabdud1223.postgres.database.azure.com
	id строка		всегда	Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforPostgreSQL/servers/po stgreabdud1223
	местоположение строка		всегда	Расположение ресурса. Пример: eastus
	имя строка		всегда	Имя ресурса. Пример: postgreabdud1223
	группа_ресурсов строка		всегда	Имя группы ресурсов. Пример: myResourceGroup
	sku сложный		всегда	SKU сервера.
		емкость целое число	всегда	Масштабируемая емкость. Пример: 2
		имя строка	всегда	Имя SKU. Пример: GP_Gen4_2
		уровень строка	всегда	Уровень конкретного SKU. Пример: GeneralPurpose
	хранилище_мб целое число		всегда	Максимальный объем хранилища, разрешенный для сервера. Пример: 128000
	метки словарь		успех	Метки, назначенные ресурсу. Словарь пар ключ-значение типа строка:строка. Пример: {'tag1': 'abc'}
	состояние_видимое_для_пользователя строка		всегда	Состояние сервера, видимое пользователю. Пример: Готов
	версия строка		всегда	Версия сервера. Пример: 9.6

Авторы

Zim Kalinowski (@zikalino)

© 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/community/azure/azure_rm_postgresqlserver_info_module.html