azure_rm_postgresqlserver – Управление экземпляром PostgreSQL Server.

Новая версия с 2.5.

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Описание

Создание, обновление и удаление экземпляра PostgreSQL Server.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

python >= 2.7
azure >= 2.0.0

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
ad_user -			Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом.
adfs_authority_url - добавлено в 2.6		По умолчанию: null	URL-адрес авторизации Azure AD. Используется при аутентификации с именем пользователя/паролем и собственной службой ADFS.
admin_password -			Пароль администратора.
admin_username -			Имя пользователя администратора сервера. Может быть указан только при создании сервера (и является обязательным для создания).
api_profile - добавлено в 2.5		По умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
auth_source - добавлено в 2.5		Варианты: auto cli credential_file env msi	Управляет источником учетных данных для аутентификации. Если не указано, будет использована переменная среды 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		Варианты: validate ignore	Управляет поведением проверки сертификатов для 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 -		По умолчанию: "Default"	Режим создания SQL Server
enforce_ssl boolean		Варианты: нет ← да	Включить принудительное использование SSL.
location -			Расположение ресурса. Если не указано, используется расположение из группы ресурсов по умолчанию.
name - / обязательно			Имя сервера.
password -			Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом.
profile -			Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group - / обязательно			Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала.
secret -			Секретный ключ клиента Azure. Используется при аутентификации с помощью сервисного принципала.
sku -			SKU (уровень ценообразования) сервера.
	capacity -		Ёмкость масштабирования вверх/вниз, представляющая вычислительные единицы сервера.
	name -		Имя SKU, обычно буквенно-цифровой код, например, P3.
	size -		Код размера, который ресурс должен интерпретировать соответствующим образом.
	tier -	Варианты: basic standard	Уровень конкретного SKU, например, Basic.
state -		Варианты: present ← absent	Укажите состояние PostgreSQL сервера. Используйте 'present' для создания или обновления сервера, и 'absent' для удаления.
storage_mb -			Максимальный объем памяти, разрешённый для сервера.
subscription_id -			Ваш идентификатор подписки Azure.
tenant -			Идентификатор клиента Azure. Используется при аутентификации с помощью сервисного принципала.
version -		Варианты: 9.5 9.6	Версия сервера.

Примечания

Примечание

Для аутентификации с 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: GP_Gen4_2
      tier: GeneralPurpose
      capacity: 2
    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/12345678-1234-1234-1234-123412341234/resourceGroups/samplerg/providers/Microsoft.DBforPostgreSQL/servers/mysqlsrv1b6dd89593
state строка	всегда	Состояние сервера, видимое пользователю. Возможные значения: `Ready`, `Dropping`, `Disabled` Пример: Готово
version строка	всегда	Версия сервера. Возможные значения: `9.5`, `9.6` Пример: 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.7/modules/azure_rm_postgresqlserver_module.html