azure_rm_postgresqldatabase — Управление экземпляром базы данных PostgreSQL.
Новая версия с 2.5.
Обзор
- Создание, обновление и удаление экземпляра базы данных 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. |
| charset | Кодировка символов базы данных. Обратитесь к документации PostgreSQL для возможных значений. Настраивается только при создании. Используйте force_update для пересоздания базы данных, если значения не совпадают. | |
| client_id | Идентификатор клиента Azure. Используется при аутентификации со служебным принципалом. | |
| cloud_environment (добавлено в 2.4) | По умолчанию: "AzureCloud" | Для облачных сред, отличных от общедоступного облака США, используется имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (необходим для Azure Stack). Также может быть задан через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT. |
| collation | Сопоставление базы данных. Обратитесь к документации PostgreSQL для возможных значений. Настраивается только при создании. Используйте force_update для пересоздания базы данных, если значения не совпадают. | |
| force_update bool |
| При значении true, существующая база данных PostgreSQL будет удалена и пересоздана, если какие-либо свойства не совпадают с заданными.При значении false, база данных не будет изменена, даже если какие-либо свойства не совпадают. |
| name обязательно | Имя базы данных. | |
| password | Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не служебного принципала. | |
| profile | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| resource_group обязательно | Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала. | |
| secret | Секрет клиента Azure. Используется при аутентификации со служебным принципалом. | |
| server_name обязательно | Имя сервера. | |
| state (добавлено в 2.6) |
| Утверждение состояния базы данных PostgreSQL. Используйте 'present' для создания или обновления базы данных и 'absent' для её удаления. |
| subscription_id | Ваш идентификатор подписки Azure. | |
| 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: 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 |
Статус
Этот модуль помечен как предварительный, что означает, что его интерфейс не гарантируется обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, поддерживаемых сообществом 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.6/modules/azure_rm_postgresqldatabase_module.html
