azure_rm_postgresqlserver - Управление экземпляром сервера 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. Используется при аутентификации с именем пользователя/паролем и собственном источнике Azure AD. | |
| admin_password | Пароль администратора. | ||
| admin_username | Имя входа администратора сервера. Может быть указано только при создании сервера (и требуется для создания). | ||
| 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. | |
| create_mode (добавлено в 2.6) | Значение по умолчанию: "Default" | Режим создания SQL Server | |
| enforce_ssl bool |
| Включить принудительное использование SSL. | |
| location | Расположение ресурса. Если не указано, используется расположение из группы ресурсов по умолчанию. | ||
| name обязательно | Имя сервера. | ||
| password | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с главным принципом службы. | ||
| profile | Профиль безопасности в файле ~/.azure/credentials. | ||
| resource_group обязательно | Имя группы ресурсов, содержащей ресурс. Вы можете получить это значение из API Azure Resource Manager или портала. | ||
| secret | Секрет клиента Azure. Используется при аутентификации с главным принципом службы. | ||
| sku | SKU (ценовой уровень) сервера. | ||
| name | Имя SKU, обычно код буквы + цифры, например P3. | ||
| tier |
| Уровень конкретного SKU, например Basic. | |
| capacity | Вместимость масштабирования вверх/вниз, представляющая вычислительные единицы сервера. | ||
| size | Код размера, который будет интерпретирован ресурсом соответствующим образом. | ||
| state (добавлено в 2.6) |
| Утвердить состояние сервера PostgreSQL. Используйте 'present' для создания или обновления сервера и 'absent' для удаления. | |
| storage_mb | Максимальный объем памяти, разрешенный для сервера. | ||
| subscription_id | Идентификатор вашей подписки Azure. | ||
| tenant | Идентификатор клиента 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 |
Статус
Этот модуль помечен как предварительный просмотр, что означает, что его интерфейс не гарантированно будет обратной совместимым.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом 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_postgresqlserver_module.html
