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

Примечание

Этот плагин является частью коллекции azure.azcollection (версия 1.4.0).

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

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

Новое в версии 0.1.2: из azure.azcollection

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

Обзор

Получение фактов о сервере 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` может использоваться для идентификации идентификатора подписки, если их несколько, иначе используется стандартная подписка az 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. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или установив AZURE_PROFILE в среде.

См. также

Вход с помощью Azure CLI: Как аутентифицироваться с помощью команды az login.

Примеры

- name: Get instance of PostgreSQL Server
  azure_rm_postgresqlserver_info:
    resource_group: myResourceGroup
    name: server_name

- name: List instances of PostgreSQL Server
  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/azure/azcollection/azure_rm_postgresqlserver_info_module.html