azure_rm_postgresqldatabase — Управление экземпляром базы данных PostgreSQL.
Новая версия с 2.5.
Обзор
- Создание, обновление и удаление экземпляра базы данных PostgreSQL.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user | Значение по умолчанию: None | Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не службы-принципала. |
| api_profile (добавлен в 2.5) |
| Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. |
| auth_source (добавлен в 2.5) |
| Определяет источник данных для аутентификации. auto будет следовать стандартному приоритету параметров модуля -> переменные окружения -> профиль по умолчанию в файле учетных данных ~/.azure/credentials. При установке значения cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.Также может быть задан через переменную окружения ANSIBLE_AZURE_AUTH_SOURCE. |
| cert_validation_mode (добавлен в 2.5) |
None | Управляет поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или при работе с Azure Stack может потребоваться отключить эту функцию, передав ignore. Также может быть установлено через профиль файла учетных данных или переменную окружения AZURE_CERT_VALIDATION. |
| charset | Кодировка символов базы данных. Обратитесь к документации PostgreSQL для получения возможных значений. Настраивается только при создании. Используйте force_update для повторного создания базы данных, если значения не совпадают. | |
| client_id | Значение по умолчанию: None | Идентификатор клиента Azure. Используется при аутентификации с помощью службы-принципала. |
| cloud_environment (добавлен в 2.4) | Значение по умолчанию: AzureCloud | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment ), или URL-адрес точки входа для обнаружения метаданных (требуется для Azure Stack). Также может быть задан через профиль файла учетных данных или переменную окружения AZURE_CLOUD_ENVIRONMENT. |
| collation | Сортировка базы данных. Обратитесь к документации PostgreSQL для получения возможных значений. Настраивается только при создании. Используйте force_update для повторного создания базы данных, если значения не совпадают. | |
| force_update |
| При установке значения true, существующая база данных PostgreSQL будет удалена и пересоздана, если какие-либо свойства не совпадают с заданными.При установке значения false, изменения в базе данных не будут внесены, даже если какие-либо свойства не совпадают. |
| name обязательно | Имя базы данных. | |
| password | Значение по умолчанию: None | Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не службы-принципала. |
| profile | Значение по умолчанию: None | Профиль безопасности, найденный в файле ~/.azure/credentials. |
| resource_group обязательно | Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала. | |
| secret | Значение по умолчанию: None | Секрет клиента Azure. Используется при аутентификации с помощью службы-принципала. |
| server_name обязательно | Имя сервера. | |
| subscription_id | Значение по умолчанию: None | Идентификатор вашей подписки Azure. |
| tenant | Значение по умолчанию: None | Идентификатор клиента 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: Create (or update) PostgreSQL Database
azure_rm_postgresqldatabase:
resource_group: TestGroup
server_name: testserver
name: db1
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| id str | всегда | Идентификатор ресурса Пример: /subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/databases/db1 |
| name str | всегда | Имя ресурса. Пример: db1 |
Статус
Этот модуль помечен как preview, что означает, что его интерфейс не гарантируется как обратная совместимость.
Автор
- 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.5/modules/azure_rm_postgresqldatabase_module.html
