azure_rm_postgresqlserver_facts – Получение фактов сервера Azure PostgreSQL.
Новая в версии 2.7.
Обзор
- Получение фактов сервера PostgreSQL.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user - | Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory вместо служебного принципала. | |
| adfs_authority_url - добавлено в 2.6 | Значение по умолчанию: null | URL-адрес авторизации Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственной авторизацией ADFS. |
| api_profile - добавлено в 2.5 | Значение по умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. |
| auth_source - добавлено в 2.5 |
| Управляет источником учетных данных для аутентификации. Если не указано, будет использована переменная среды 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 |
| Управляет поведением проверки сертификатов для Azure-точек доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси HTTPS или работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. |
| client_id - | 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. Используется при аутентификации с помощью служебного принципала. | |
| subscription_id - | Идентификатор вашей подписки Azure. | |
| tags - | Ограничение результатов с помощью списка тегов. Формат тегов 'ключ' или 'ключ:значение'. | |
| tenant - | Идентификатор Azure-тенанта. Используется при аутентификации с помощью служебного принципала. |
Примечания
Примечание
- Для аутентификации с Azure вы можете передать параметры, установить переменные среды или использовать профиль, хранящийся в ~/.azure/credentials. Аутентификация возможна с помощью служебного принципала или пользователя 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 в среде.
Примеры
- name: Get instance of PostgreSQL Server
azure_rm_postgresqlserver_facts:
resource_group: resource_group_name
name: server_name
- name: List instances of PostgreSQL Server
azure_rm_postgresqlserver_facts:
resource_group: resource_group_name
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие являются полями, уникальными для данного модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| servers complex | всегда | Список словарей, содержащих сведения о серверах PostgreSQL. | ||
| fully_qualified_domain_name string | всегда | Полное доменное имя сервера. Пример: postgreabdud1223.postgres.database.azure.com | ||
| id string | всегда | Идентификатор ресурса Пример: /subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/postgreabdud1223 | ||
| location string | всегда | Расположение ресурса. Пример: eastus | ||
| name string | всегда | Имя ресурса. Пример: postgreabdud1223 | ||
| sku complex | всегда | Набор характеристик (SKU) сервера. | ||
| capacity integer | всегда | Максимальная ёмкость. Пример: 2 | ||
| name string | всегда | Имя SKU. Пример: GP_Gen4_2 | ||
| tier string | всегда | Уровень SKU. Пример: GeneralPurpose | ||
| user_visible_state string | всегда | Состояние сервера, видимое пользователю. Пример: Ready | ||
| version string | всегда | Версия сервера. Пример: 9.6 | ||
Статус
- Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
- Данный модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.7/modules/azure_rm_postgresqlserver_facts_module.html