azure_rm_postgresqlserver_info – Получение фактов сервера Azure PostgreSQL
Новая версия с 2.9.
Описание
- Получение фактов сервера PostgreSQL.
Псевдонимы: azure_rm_postgresqlserver_facts
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- 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 |
| Управляет источником учетных данных для аутентификации. Если не указано, используется переменная среды 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 строка | Идентификатор клиента 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, или войти перед запуском задач или игры с помощью
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
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 | ||
| storage_mb целое число | всегда | Максимальный объем памяти, разрешенный для сервера. Пример: 128000 | ||
| метки словарь | Метки, назначенные ресурсу. Словарь пар «строка:строка». Пример: {'tag1': 'abc'} | |||
| видимое_состояние_пользователя строка | всегда | Состояние сервера, видимое пользователю. Пример: Готово | ||
| версия строка | всегда | Версия сервера. Пример: 9.6 | ||
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль содержится сообществом 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.9/modules/azure_rm_postgresqlserver_info_module.html
