Модуль azure.azcollection.azure_rm_postgresqlflexibleserver — Управление экземпляром PostgreSQL Flexible Server

Примечание

Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).

Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования, см. Требования для подробностей.

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

Введено в azure.azcollection 2.2.0

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

Описание

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

Требования

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

python >= 2.7
На хосте, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection через galaxy
Все пакеты python, перечисленные в файле requirements.txt коллекции, должны быть установлены через pip на хосте, на котором выполняются модули из azure.azcollection
Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр	Комментарии
ad_user строка	Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
adfs_authority_url строка добавлен в azure.azcollection 0.0.1	URL-адрес службы авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной службой ADFS.
administrator_login строка	Имя входа администратора сервера. Может быть указано только при создании сервера (и требуется для создания).
administrator_login_password строка	Пароль для входа администратора (требуется для создания сервера).
api_profile строка добавлен в azure.azcollection 0.0.1	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. По умолчанию: `"latest"`
append_tags логическое	Управление тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. Варианты: `false` `true` ← (по умолчанию)
auth_source строка добавлен в azure.azcollection 0.0.1	Управляет источником учетных данных для аутентификации. Также может быть задан через переменную среды `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. Варианты: `"auto"` ← (по умолчанию) `"cli"` `"credential_file"` `"env"` `"msi"`
availability_zone строка	Информация о зоне доступности сервера
backup словарь	Свойства резервного копирования сервера.
backup_retention_days целое число	Дни хранения резервных копий для сервера.
geo_redundant_backup строка	Указывает, включено ли географически избыточное резервное копирование на сервере. Варианты: `"Enabled"` `"Disabled"`
cert_validation_mode строка добавлен в azure.azcollection 0.0.1	Управляет поведением проверки сертификатов для Azure-точек доступа. По умолчанию все модули проверяют сертификат сервера, но при использовании прокси HTTPS или работе с Azure Stack может потребоваться отключить эту функцию, передав `ignore`. Также может быть задан через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`. Варианты: `"ignore"` `"validate"`
client_id строка	Идентификатор клиента Azure. Используйте при аутентификации с принципалом службы или управляемой учетной записью (msi). Также может быть задан через переменную среды `AZURE_CLIENT_ID`.
cloud_environment строка добавлен в azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`), или URL-адрес точки доступа к метаданным (необходим для Azure Stack). Также может быть задан через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`. По умолчанию: `"AzureCloud"`
create_mode строка	Режим создания нового сервера PostgreSQL. Варианты: `"Default"` `"Create"` `"Update"` `"PointInTimeRestore"`

END_OF_DOCUMENT_MARKER

disable_instance_discovery boolean added in azure.azcollection 2.3.0	Определяет, будет ли выполняться обнаружение экземпляра при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляра, так и проверку подлинности. Эта функция предназначена для использования в сценариях, где метаданные конечная точка недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляра предполагает извлечение метаданных подлинности с https://login.microsoft.com/ для проверки подлинности. Установив это значение в True, отключается проверка подлинности. Поэтому крайне важно убедиться, что хост запрошенной подлинности действителен и заслуживает доверия. Устанавливается в файле профилей учетных данных или переменной среды `AZURE_DISABLE_INSTANCE_DISCOVERY`. Варианты: `false` ← (по умолчанию) `true`
fully_qualified_domain_name string	Полное доменное имя сервера.
high_availability dictionary	Свойства высокой доступности сервера.
mode string	Режим высокой доступности для сервера. Варианты: `"Disabled"` `"ZoneRedundant"`
standby_availability_zone string	Информация о зоне доступности резервного сервера.
identity dictionary added in azure.azcollection 2.4.0	Идентификатор сервера.
type string	Тип управляемого идентификатора. Варианты: `"UserAssigned"` `"None"` ← (по умолчанию)
user_assigned_identities dictionary	Управляемые идентификаторы назначенные пользователю и их параметры По умолчанию: `{}`
append boolean	Если список идентификаторов должен быть добавлен к текущим идентификаторам (true) или заменить текущие идентификаторы (false) Варианты: `false` `true` ← (по умолчанию)
id list / elements=string	Список идентификаторов управляемых идентификаторов пользователей, связанных с виртуальной машиной По умолчанию: `[]`
is_restart boolean	Перезапускать ли сервер Post gresql. Варианты: `false` ← (по умолчанию) `true`
is_start boolean	Запускать ли сервер Post gresql. Варианты: `false` ← (по умолчанию) `true`
is_stop boolean	Остановить ли сервер Post gresql. Варианты: `false` ← (по умолчанию) `true`
location string	Расположение ресурса. Если не указано, используется расположение из группы ресурсов по умолчанию.
log_mode string	Родительский аргумент.
log_path string	Родительский аргумент.
maintenance_window dictionary	Свойства окна технического обслуживания сервера.
custom_window string	Указывает, включено или выключено пользовательское окно.
day_of_week integer	День недели для окна технического обслуживания.

END_OF_DOCUMENT_MARKER

start_hour integer	Начальный час для окна обслуживания.
start_minute integer	Начальная минута для окна обслуживания.
name string / обязательно	Имя гибкого сервера.
network словарь	Свойства сети сервера.
delegated_subnet_resource_id строка	Идентификатор ресурса делегированной подсети ARM.
private_dns_zone_arm_resource_id строка	Идентификатор ресурса частной зоны DNS ARM.
public_network_access строка	Включен или нет публичный сетевой доступ. Варианты: `"Enabled"` `"Disabled"`
password строка	Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не службы-принципала.
point_in_time_utc строка	Время создания точки восстановления (формат ISO8601), указывая время для восстановления. Требуется, когда create_mode=PointInTimeRestore.
profile строка	Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group строка / обязательно	Имя группы ресурсов, содержащей ресурс. Вы можете получить это значение из API Azure Resource Manager или портала.
secret строка	Секрет Azure клиента. Используется при аутентификации с помощью службы-принципала.
sku словарь	SKU (ценовой уровень) сервера.
name строка / обязательно	Имя SKU, как правило, уровень + семейство + ядра, например, Standard_D4s_v3.
tier строка / обязательно	Уровень конкретного Варианты: `"Burstable"` `"GeneralPurpose"` `"MemoryOptimized"`
source_server_resource_id строка	Идентификатор ресурса исходного сервера для восстановления. Требуется, когда create_mode=PointInTimeRestore
state строка	Утвердить состояние сервера PostgreSQL Flexible. Используйте `present` для создания или обновления сервера и `absent` для его удаления. Варианты: `"present"` ← (по умолчанию) `"absent"`
storage словарь	Свойства хранения сервера.
storage_size_gb целое число	Размер хранилища для сервера.
subscription_id строка	Ваш идентификатор подписки Azure.
tags словарь	Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные теги объекта будут обновлены с предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false. В настоящее время Azure DNS zones и службы Traffic Manager также не позволяют использовать пробелы в теге. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 тегов для ресурсов.
tenant строка	Идентификатор арендатора Azure. Используется при аутентификации с помощью службы-принципала.

отпечаток_ключа строка добавлено в azure.azcollection 1.14.0	Отпечаток частного ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью сервисного принципала. Требуется, если определено x509_certificate_path.
версия строка	Версия сервера PostgreSQL. Варианты: `"11"` `"12"` `"13"` `"14"` `"15"` `"16"`
x509_certificate_path путь добавлено в azure.azcollection 1.14.0	Путь к X509 сертификату, используемому для создания сервисного принципала в формате PEM. Сертификат должен быть присоединен к закрытому ключу. Используется при аутентификации с помощью сервисного принципала.

Примечания

Примечание

Для аутентификации с 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 Flexible Server
  azure_rm_postgresqlflexibleserver:
    resource_group: myResourceGroup
    name: testserver
    sku:
      name: Standard_B1ms
      tier: Burstable
    administrator_login: azureuser
    administrator_login_password: Fred@0329
    version: 12
    storage:
      storage_size_gb: 128
    fully_qualified_domain_name: st-private-dns-zone.postgres.database.azure.com
    backup:
      backup_retention_days: 7
      geo_redundant_backup: Disabled
    maintenance_window:
      custom_window: Enabled
      start_hour: 8
      start_minute: 0
      day_of_week: 0
    point_in_time_utc: 2023-05-31T00:28:17.7279547+00:00
    availability_zone: 1
    create_mode: Default

- name: Delete PostgreSQL Flexible Server
  azure_rm_postgresqlflexibleserver:
    resource_group: myResourceGroup
    name: testserver
    state: absent

Значения возврата

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

Ключ	Описание
servers сложный	Список словарей, содержащих данные о серверах PostgreSQL Flexible. Возвращается: всегда
administrator_login строка	Имя входа администратора сервера. Возвращается: всегда Пример: `"azureuser"`
availability_zone строка	Информация о зоне доступности сервера. Возвращается: всегда Пример: `"1"`
backup сложный	Свойства резервного копирования сервера. Возвращается: всегда
backup_retention_days целое число	Дни хранения резервных копий сервера. Возвращается: всегда Пример: `7`
geo_redundant_backup строка	Значение, указывающее, включено ли гео-избыточное резервное копирование на сервере. Возвращается: всегда Пример: `"Disabled"`
fully_qualified_domain_name строка	Полное доменное имя гибкого сервера. Возвращается: всегда Пример: `"postflexiblefredpgsqlflexible.postgres.database.azure.com"`
high_availability сложный	Свойства высокой доступности сервера. Возвращается: всегда
mode строка	Режим высокой доступности для сервера. Возвращается: всегда Пример: `"Disabled"`
standby_availability_zone строка	Информация о зоне доступности резервного сервера. Возвращается: всегда
id строка	Идентификатор ресурса сервера PostgreSQL Flexible. Возвращается: всегда Пример: `"/subscriptions/xxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforPostgreSQL/flexibleservers/postgresql3"`
location строка	Расположение ресурса. Возвращается: всегда Пример: `"eastus"`
maintenance_window сложный	Свойства окна технического обслуживания сервера. Возвращается: всегда
custom_window строка	Указывает, включено или выключено пользовательское окно. Возвращается: всегда Пример: `"Enabled"`
day_of_week целое число	День недели для окна технического обслуживания. Возвращается: всегда Пример: `0`
start_hour целое число	Начальный час для окна технического обслуживания. Возвращается: всегда Пример: `8`
start_minute целое число	Начальная минута для окна технического обслуживания. Возвращается: всегда Пример: `0`

имя строка	Имя ресурса. Возвращается: всегда Пример: `"postgreabdud1223"`
сеть сложный тип	Свойства сети сервера. Возвращается: всегда
идентификатор_делегированной_подсети строка	Идентификатор ресурса делегированной подсети ARM. Возвращается: всегда
идентификатор_ресурса_зоны_private_dns_arm строка	Идентификатор ресурса зоны private DNS ARM. Возвращается: всегда
доступ_к_общей_сети строка	Включен ли доступ к общей сети. Возвращается: всегда Пример: `"Enabled"`
точное_время_utc строка	Время создания точки восстановления (формат ISO8601). Возвращается: всегда
группа_ресурсов строка	Имя группы ресурсов. Возвращается: всегда Пример: `"myResourceGroup"`
sku сложный тип	SKU сервера. Возвращается: всегда
имя строка	Имя SKU. Возвращается: всегда Пример: `"Standard_B1ms"`
уровень строка	Уровень данного SKU. Возвращается: всегда Пример: `"Burstable"`
идентификатор_исходного_сервера строка	Идентификатор ресурса исходного сервера для восстановления. Возвращается: всегда
хранилище сложный тип	Максимальный размер хранилища, разрешенный для сервера. Возвращается: всегда
размер_хранилища_в_гб целое число	Разрешенный размер хранилища для сервера. Возвращается: всегда Пример: `128`
системные_данные сложный тип	Системные метаданные, относящиеся к этому ресурсу. Возвращается: всегда
создано_в строка	Дата и время создания ресурса (UTC). Возвращается: всегда
создано_кем строка	Идентификатор пользователя, создавшего ресурс. Возвращается: всегда
тип_создавшего_пользователя строка	Тип идентификатора пользователя, создавшего ресурс. Возвращается: всегда
последнее_изменение строка	Дата и время последнего изменения ресурса (UTC). Возвращается: всегда
последнее_изменение_кем строка	Идентификатор пользователя, который последний раз изменял ресурс. Возвращается: всегда
тип_пользователя_последнего_изменения строка	Тип идентификатора пользователя, который последний раз изменял ресурс. Возвращается: всегда

метки словарь	Метки, назначенные ресурсу. Словарь пар ключ-значение типа строка:строка. Возвращается: всегда Пример: `{"tag1": "abc"}`
версия строка	Версия гибкого сервера. Возвращается: всегда Возможные значения: `"11"` `"12"` `"13"` Пример: `"12"`

Авторы

xuzhang3 (@xuzhang3)
Fred-sun (@Fred-sun)

Ссылки на коллекцию

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