azure.azcollection.azure_rm_postgresqlconfiguration – Управление конфигурацией Azure PostgreSQL

Примечание

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

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

Для использования в книге задач укажите: azure.azcollection.azure_rm_postgresqlconfiguration.

Добавлено в версии 0.1.2: коллекции azure.azcollection

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

Обзор

Обновление или сброс настроек Azure 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`.
client_id строка		Идентификатор клиента Azure. Используйте при аутентификации с помощью службы принципала.
cloud_environment строка добавлено в 0.0.1 коллекции azure.azcollection	По умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (определённое в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment` или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть задано в профиле файла учетных данных или переменной окружения `AZURE_CLOUD_ENVIRONMENT`.
name строка / обязательно		Имя настройки.
password строка		Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо службы принципала.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group строка / обязательно		Имя группы ресурсов, содержащей ресурс.
secret строка		Секрет клиента Azure. Используйте при аутентификации с помощью службы принципала.
server_name строка / обязательно		Имя сервера.
state строка	Варианты: absent present ←	Утвердите состояние настройки PostgreSQL. Используйте `present` для обновления настройки или `absent` для сброса до значения по умолчанию.
subscription_id строка		Идентификатор вашей подписки Azure.
tenant строка		Идентификатор Azure-аренды. Используйте при аутентификации с помощью службы принципала.
value строка		Значение настройки.

Примечания

Примечание

Для аутентификации с 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: Update PostgreSQL Server setting
  azure_rm_postgresqlconfiguration:
    resource_group: myResourceGroup
    server_name: myServer
    name: deadlock_timeout
    value: 2000

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

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

Ключ	Возвращаемое значение	Описание
id строка	всегда	Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforPostgreSQL/servers/myServer/confi gurations/event_scheduler

Авторы

Zim Kalinowski (@zikalino)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_postgresqlconfiguration_module.html