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

Примечание

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

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

Для использования в плейбуке укажите: azure.azcollection.azure_rm_postgresqlserver.

Новое в версии 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.
admin_password строка			Пароль администратора.
admin_username строка			Имя входа администратора сервера. Может быть указано только при создании сервера (и требуется для создания).
api_profile строка добавлено в 0.0.1 из azure.azcollection		По умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
append_tags логическое значение		Варианты: no да ←	Управляет тем, является ли поле тегов каноническим или просто добавляет теги к существующим. В случае канонического, любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
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`.
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 строка	Варианты: Basic Standard	Уровень конкретного SKU, например `Basic`.
state строка		Варианты: present ← absent	Утвердить состояние сервера PostgreSQL. Используйте `present` для создания или обновления сервера и `absent` для его удаления.
storage_mb целое число			Максимальный объём хранилища для сервера.
subscription_id строка			Ваш идентификатор подписки Azure.
tags словарь			Словарь пар строка:строка, назначаемых в качестве метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите опцию append_tags в false.
tenant строка			Идентификатор арендатора Azure. Используется при аутентификации с принципалом службы.
version строка		Варианты: 9.5 9.6 10 11	Версия сервера.

Примечания

Примечание

Для аутентификации с 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. Также возможно добавление дополнительных профилей. Укажите профиль, передав профиль или установив 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`, `11`. Пример: 9.6

Авторы

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_postgresqlserver_module.html