azure.azcollection.azure_rm_postgresqldatabase – Управление экземпляром базы данных PostgreSQL

Примечание

Этот плагин входит в коллекцию azure.azcollection (версия 1.3.1).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

Чтобы использовать его в книге задач, укажите: azure.azcollection.azure_rm_postgresqldatabase.

Новый в версии 0.1.2: из azure.azcollection

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Обзор

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

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user строка		Имя пользователя Active Directory. Используйте при аутентификации с помощью пользователя Active Directory, а не служебного принципала.
adfs_authority_url строка добавлен в 0.0.1 коллекции azure.azcollection		URL-адрес полномочий Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственных полномочиях ADFS.
api_profile строка добавлен в 0.0.1 коллекции azure.azcollection	Значение по умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для публичных облаков; будущие значения позволят использовать Azure Stack.
auth_source строка добавлен в 0.0.1 коллекции azure.azcollection	Варианты: auto ← cli credential_file env msi	Управляет источником учетных данных для аутентификации. Также может быть задано через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При значении `auto` (значение по умолчанию) приоритет имеет параметры модуля -> `env` -> `credential_file` -> `cli`. При значении `env`, учетные данные считываются из переменных среды При значении `credential_file`, профиль считывается из `~/.azure/credentials`. При значении `cli`, учетные данные берутся из профиля Azure CLI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` может использоваться для идентификации идентификатора подписки, если их несколько, в противном случае используется стандартная подписка az cli. При значении `msi`, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` может использоваться для идентификации идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка. Переменная `msi` была добавлена в Ansible 2.6.
cert_validation_mode строка добавлен в 0.0.1 коллекции azure.azcollection	Варианты: ignore validate	Управляет поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или подключении к Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть установлено через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
charset строка		Кодировка символов базы данных. Проверьте документацию PostgreSQL для возможных значений. Устанавливается только при создании. Используйте force_update для пересоздания базы данных, если значения не совпадают.
client_id строка		Идентификатор клиента Azure. Используйте при аутентификации с помощью служебного принципала.
cloud_environment строка добавлен в 0.0.1 коллекции azure.azcollection	Значение по умолчанию: "AzureCloud"	Для облачных сред, отличных от публичного облака США, используется имя среды (определяется Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`), или URL-адрес точки входа для обнаружения метаданных (необходим для Azure Stack). Также может быть установлен через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
collation строка		Сортировка базы данных. Проверьте документацию PostgreSQL для возможных значений. Устанавливается только при создании. Используйте force_update для пересоздания базы данных, если значения не совпадают.
force_update булево	Варианты: нет ← да	При значении `true`, существующая база данных PostgreSQL будет удалена и пересоздана, если какие-либо свойства не совпадают с заданными. При значении `false`, изменения в базе данных не произойдут, даже если какие-либо свойства не совпадают.
name строка / обязательно		Имя базы данных.
password строка		Пароль пользователя Active Directory. Используйте при аутентификации с помощью пользователя Active Directory, а не служебного принципала.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group строка / обязательно		Имя группы ресурсов, содержащей ресурс. Вы можете получить это значение из API Azure Resource Manager или портала.
secret строка		Секрет клиента Azure. Используйте при аутентификации с помощью служебного принципала.
server_name строка / обязательно		Имя сервера.
state строка	Варианты: absent present ←	Утверждение состояния базы данных PostgreSQL. Используйте `present` для создания или обновления базы данных и `absent` для ее удаления.
subscription_id строка		Идентификатор вашей подписки Azure.
tenant строка		Идентификатор Azure-арендатора. Используйте при аутентификации с помощью служебного принципала.

Примечания

Примечание

Для аутентификации с 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 Database
  azure_rm_postgresqldatabase:
    resource_group: myResourceGroup
    server_name: testserver
    name: db1

Возвращаемые значения

Общие возвращаемые значения описаны в здесь, следующие поля уникальны для данного модуля:

Ключ	Возвращаемое значение	Описание
id строка	всегда	Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroups/providers/Microsoft.DBforPostgreSQL/servers/testserve r/databases/db1
name строка	всегда	Имя ресурса. Пример: db1

Авторы

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.10/collections/azure/azcollection/azure_rm_postgresqldatabase_module.html