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 boolean |
| При установке в true, будет удалена и пересоздана существующая база данных PostgreSQL, если какие-либо свойства не соответствуют заданным.При установке в false, изменения в базе данных не произойдут, даже если какие-либо свойства не совпадают. |
| name - / обязательно | Имя базы данных. | |
| password - | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом. | |
| profile - | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| resource_group - / обязательно | Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала. | |
| secret - | Секрет клиента Azure. Используется при аутентификации с помощью сервисного принципала. | |
| server_name - / обязательно | Имя сервера. | |
| state - |
| Утверждение состояния базы данных PostgreSQL. Используйте 'присутствует' для создания или обновления базы данных и 'отсутствует' для её удаления. |
| 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 строка | всегда | Идентификатор ресурса Пример: /subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/databases/db1 |
| name строка | всегда | Имя ресурса. Пример: db1 |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом 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_postgresqldatabase_module.html
