azure_rm_postgresqlserver - Управление экземпляром сервера PostgreSQL.
Новое в версии 2.5.
Обзор
- Создание, обновление и удаление экземпляра сервера PostgreSQL.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| ad_user | Значение по умолчанию: None | Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не служебного принципала. | |
| admin_password | Пароль администратора. | ||
| admin_username | Имя пользователя администратора сервера. Может быть указано только при создании сервера (и требуется для создания). | ||
| 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. | |
| client_id | Значение по умолчанию: None | ID клиента Azure. Используется при аутентификации с помощью служебного принципала. | |
| cloud_environment (добавлено в 2.4) | Значение по умолчанию: AzureCloud | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также можно задать через профиль файла учетных данных или переменную окружения AZURE_CLOUD_ENVIRONMENT. | |
| enforce_ssl |
| Включить принудительное использование SSL. | |
| location | Расположение ресурса. Если не задано, используется расположение из группы ресурсов по умолчанию. | ||
| name обязательно | Имя сервера. | ||
| password | Значение по умолчанию: None | Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не служебного принципала. | |
| profile | Значение по умолчанию: None | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| resource_group обязательно | Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала. | ||
| secret | Значение по умолчанию: None | Секрет клиента Azure. Используется при аутентификации с помощью служебного принципала. | |
| sku | SKU (ценовой уровень) сервера. | ||
| tier |
| Уровень конкретного SKU, например, Basic. | |
| capacity | Вместимость масштабирования вверх/вниз, представляющая вычислительные единицы сервера. | ||
| name | Имя sku, обычно код буквы + цифры, например, P3. | ||
| size | Код размера, который будет интерпретирован ресурсом соответствующим образом. | ||
| storage_mb | Максимальный объем памяти, разрешенный для сервера. | ||
| subscription_id | Значение по умолчанию: None | Ваш идентификатор подписки Azure. | |
| tenant | Значение по умолчанию: None | ID арендатора Azure. Используется при аутентификации с помощью служебного принципала. | |
| version |
| Версия сервера. | |
Примечания
Примечание
- Для аутентификации с 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 Server
azure_rm_postgresqlserver:
resource_group: TestGroup
name: testserver
sku:
name: PGSQLS100
tier: Basic
capacity: 100
location: eastus
storage_mb: 1024
enforce_ssl: True
admin_username: cloudsa
admin_password: password
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| fully_qualified_domain_name str | всегда | Полное доменное имя сервера. Пример: postgresqlsrv1b6dd89593.postgresql.database.azure.com |
| id str | всегда | Идентификатор ресурса Пример: /subscriptions/12345678-1234-1234-1234-123412341234/resourceGroups/samplerg/providers/Microsoft.DBforPostgreSQL/servers/mysqlsrv1b6dd89593 |
| state str | всегда | Состояние сервера, видимое пользователю. Возможные значения: Ready, Dropping, Disabled.
Пример: Готово |
| version str | всегда | Версия сервера. Возможные значения: 9.5, 9.6.
Пример: 9.6 |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Автор
- 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_postgresqlserver_module.html
