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 | URL-адрес службы авторизации Azure AD. Используется при аутентификации с именем пользователя/паролем и собственной службой ADFS авторизации. | ||
| admin_password - | Пароль администратора. | ||
| admin_username - | Имя пользователя администратора сервера. Может быть указан только при создании сервера (и является обязательным для создания). | ||
| api_profile строка добавлено в 2.5 | По умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. | |
| append_tags булево |
| Управление тем, является ли поле тегов стандартным или оно просто добавляется к существующим тегам. В случае стандартного значения, все теги, не найденные в параметре тегов, будут удалены из метаданных объекта. | |
| 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 строка | ID клиента Azure. Используется при аутентификации с помощью службы-принципала. | ||
| cloud_environment строка добавлено в 2.4 | По умолчанию: "AzureCloud" | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес точки доступа к метаданным (необходим для Azure Stack). Также может быть установлен через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT. | |
| create_mode - | По умолчанию: "Default" | Режим создания SQL Server. | |
| enforce_ssl булево |
| Включить принудительное использование SSL. | |
| location - | Расположение ресурса. Если не указано, используется расположение из группы ресурсов по умолчанию. | ||
| name - / обязательно | Имя сервера. | ||
| password строка | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо службы-принципала. | ||
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | ||
| resource_group - / обязательно | Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала. | ||
| secret строка | Секрет клиента Azure. Используется при аутентификации с помощью службы-принципала. | ||
| sku - | SKU (ценовой уровень) сервера. | ||
| capacity - | Емкость масштабирования вверх/вниз, представляющая вычислительные единицы сервера. | ||
| name - | Имя SKU, обычно, уровень + семейство + ядра, например B_Gen4_1, GP_Gen5_8. | ||
| size - | Код размера, интерпретируемый ресурсом соответствующим образом. | ||
| tier - |
| Уровень конкретного SKU, например Basic. | |
| state - |
| Утверждение состояния сервера PostgreSQL. Используйте present для создания или обновления сервера и absent для удаления. | |
| storage_mb целое число | Максимальный объем памяти, разрешённый для сервера. | ||
| subscription_id строка | Ваш идентификатор подписки Azure. | ||
| tags словарь | Словарь пар "строка:строка" для назначения метаданных объекту. Метаданные тегов объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в false. | ||
| tenant строка | Идентификатор аренды Azure. Используется при аутентификации с помощью службы-принципала. | ||
| version - |
| Версия сервера. | |
Примечания
Примечание
- Для аутентификации с Azure можно передать параметры, задать переменные среды, использовать профиль, сохраненный в ~/.azure/credentials, или войти в систему перед выполнением задач или плейбука с
az login. - Аутентификация также возможна с помощью служебного принципала или пользователя 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 в среде.
См. также
См. также
- Вход с помощью Azure CLI
- Как выполнить аутентификацию с помощью команды
az login.
Примеры
- name: Create (or update) PostgreSQL Server
azure_rm_postgresqlserver:
resource_group: myResourceGroup
name: testserver
sku:
name: B_Gen5_1
tier: Basic
location: eastus
storage_mb: 1024
enforce_ssl: True
admin_username: cloudsa
admin_password: password
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| fully_qualified_domain_name строка | всегда | Полное доменное имя сервера. Пример: postgresqlsrv1b6dd89593.postgresql.database.azure.com |
| id строка | всегда | Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforPostgreSQL/servers/mysqlsrv1b6dd89593 |
| state строка | всегда | Состояние сервера, видимое пользователю. Возможные значения включают Ready, Dropping, Disabled. Пример: Готово |
| version строка | всегда | Версия сервера. Возможные значения включают 9.5, 9.6, 10. Пример: 9.6 |
Статус
- Для этого модуля не гарантируется обратная совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом 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.9/modules/azure_rm_postgresqlserver_module.html
