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

ad_user

string

Имя пользователя Active Directory. Используйте этот параметр для аутентификации от имени пользователя Active Directory, а не субъекта-службы.

adfs_authority_url

string

добавлено в azure.azcollection 0.0.1

URL-адрес центра Azure AD. Используйте этот параметр для аутентификации по имени пользователя и паролю, если у вас есть собственный центр ADFS.

administrator_login

string

Имя учетной записи администратора сервера.

Можно указать только при создании сервера (при создании обязательно).

administrator_login_password

string

Пароль для входа администратора (обязателен при создании сервера).

api_profile

string

добавлено в azure.azcollection 0.0.1

Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.

По умолчанию: "latest"

append_tags

boolean

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

Если поле каноническое, все теги объекта, отсутствующие в параметре tags, будут удалены из метаданных объекта.

Варианты:

• false
• true ← (по умолчанию)

auth_config

dictionary

добавлено в azure.azcollection 3.6.0

Свойства AuthConfig сервера.

active_directory_auth

string

Если Enabled, включена аутентификация Azure Active Directory.

Варианты:

• "Enabled"
• "Disabled"

password_auth

string

Если Enabled, включена аутентификация по паролю.

Варианты:

• "Enabled"
• "Disabled"

tenant_id

string

Идентификатор клиента сервера.

auth_source

string

добавлено в 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

string

Сведения о зоне доступности сервера

backup

dictionary

Свойства резервного копирования сервера.

backup_retention_days

integer

Срок хранения резервных копий сервера в днях.

geo_redundant_backup

string

Указывает, включено ли на сервере георезервирование резервных копий.

Варианты:

• "Enabled"
• "Disabled"

cert_validation_mode

string

добавлено в azure.azcollection 0.0.1

Определяет поведение проверки сертификатов для конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав ignore. Также можно задать в профиле файла учетных данных или с помощью переменной среды AZURE_CERT_VALIDATION.

Варианты:

• "ignore"
• "validate"

client_id

string

Идентификатор клиента Azure. Используйте для аутентификации с помощью субъекта-службы или управляемого удостоверения (msi).

Также можно задать с помощью переменной среды AZURE_CLIENT_ID.

cloud_environment

string

добавлено в azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, укажите имя среды (согласно Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (обязательно для Azure Stack). Также можно задать в профиле файла учетных данных или с помощью переменной среды AZURE_CLOUD_ENVIRONMENT.

По умолчанию: "AzureCloud"

cluster

dictionary

Свойства эластичного кластера сервера.

cluster_size

integer / обязательный

Количество экземпляров в кластере.

default_database_name

string

Имя базы данных по умолчанию для кластера.

create_mode

string

Режим создания сервера PostgreSQL.

Варианты:

• "Default"
• "Create"
• "Update"
• "PointInTimeRestore"

disable_instance_discovery

boolean

добавлено в 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"
• "SameZone"

standby_availability_zone

string

Сведения о зоне доступности резервного экземпляра.

identity

dictionary

добавлено в azure.azcollection 2.4.0

Удостоверение сервера.

type

string

Тип управляемого удостоверения

Варианты:

• "UserAssigned"
• "None" ← (по умолчанию)
• "SystemAssigned"

user_assigned_identities

dictionary

Назначенные пользователем управляемые удостоверения и их параметры

По умолчанию: {}

append

boolean

Следует ли добавить список удостоверений к текущим удостоверениям (true) или заменить текущие удостоверения (false)

Варианты:

• false
• true ← (по умолчанию)

id

list / элементы=string

Список идентификаторов назначенных пользователем удостоверений, связанных с виртуальной машиной

По умолчанию: []

is_restart

boolean

Следует ли перезапустить сервер PostgreSQL.

Варианты:

• false ← (по умолчанию)
• true

is_start

boolean

Следует ли запустить сервер PostgreSQL.

Варианты:

• false ← (по умолчанию)
• true

is_stop

boolean

Следует ли остановить сервер PostgreSQL.

Варианты:

• false ← (по умолчанию)
• true

location

string

Расположение ресурса. Если не задано, по умолчанию используется расположение группы ресурсов.

log_mode

string

Родительский аргумент.

log_path

string

Родительский аргумент.

maintenance_window

dictionary

Свойства окна обслуживания сервера.

custom_window

string

Указывает, включено или отключено пользовательское окно обслуживания.

Варианты:

• "Enabled"
• "Disabled"

day_of_week

integer

День недели для окна обслуживания.

start_hour

integer

Час начала окна обслуживания.

start_minute

integer

Минута начала окна обслуживания.

name

string / обязательный

Имя гибкого сервера.

network

dictionary

Свойства сети сервера.

delegated_subnet_resource_id

string

Идентификатор ресурса ARM делегированной подсети.

private_dns_zone_arm_resource_id

string

Идентификатор ресурса ARM частной зоны DNS.

public_network_access

string

Указывает, включен ли доступ через общедоступную сеть.

Варианты:

• "Enabled"
• "Disabled"

oidc_token

string

добавлено в azure.azcollection 3.17.0

Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Этот токен обменивается с Azure AD с использованием федеративного удостоверения OIDC.

Полезно в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC.

Также можно задать с помощью переменной среды AZURE_FEDERATED_TOKEN.

oidc_token_file_path

path

добавлено в azure.azcollection 3.17.0

Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Файл должен содержать только необработанный токен.

Этот метод обычно используется на платформах, которые записывают токены OIDC в файлы.

Также можно задать с помощью переменной среды AZURE_FEDERATED_TOKEN_FILE.

password

string

Пароль пользователя Active Directory. Используйте этот параметр для аутентификации от имени пользователя Active Directory, а не субъекта-службы.

point_in_time_utc

string

Время создания точки восстановления (в формате ISO8601), определяющее момент, на который следует восстановить данные.

Это значение необходимо, если задано create_mode=PointInTimeRestore.

profile

string

Профиль безопасности из файла ~/.azure/credentials.

resource_group

string / обязательный

Имя группы ресурсов, содержащей ресурс.

Это значение можно получить с помощью API Azure Resource Manager или на портале.

secret

string

Секрет клиента Azure. Используется при аутентификации с помощью субъекта-службы.

sku

dictionary

SKU (ценовая категория) сервера.

name

string / обязательный

Имя SKU, обычно состоящее из уровня, семейства и количества ядер, например Standard_D4s_v3.

tier

string / обязательный

Уровень конкретного

Варианты:

• "Burstable"
• "GeneralPurpose"
• "MemoryOptimized"

source_server_resource_id

string

Идентификатор ресурса исходного сервера, из которого выполняется восстановление.

Это значение необходимо, если задано create_mode=PointInTimeRestore

state

string

Проверка состояния гибкого сервера PostgreSQL.

Используйте present для создания или обновления сервера и absent для его удаления.

Варианты:

• "present" ← (по умолчанию)
• "absent"

storage

dictionary

Свойства хранилища сервера.

storage_size_gb

integer

Размер хранилища сервера.

subscription_id

string

Идентификатор вашей подписки Azure.

tags

dictionary

Словарь пар «строка:строка», назначаемых объекту в качестве метаданных.

Теги метаданных объекта обновляются с использованием всех предоставленных значений.

Чтобы удалить теги, установите для параметра append_tags значение false.

В настоящее время зоны Azure DNS и службы Traffic Manager также не допускают использование пробелов в тегах.

Azure Front Door не поддерживает использование

Azure Automation и Azure CDN поддерживают не более 15 тегов для ресурсов.

tenant

string

Идентификатор клиента Azure. Используется при аутентификации с помощью субъекта-службы.

thumbprint

string

добавлено в azure.azcollection 1.14.0

Отпечаток закрытого ключа, указанного в x509_certificate_path.

Используется при аутентификации с помощью субъекта-службы.

Обязателен, если задан x509_certificate_path.

version

string

Версия PostgreSQL Server.

Варианты:

• "11"
• "12"
• "13"
• "14"
• "15"
• "16"
• "17"

x509_certificate_path

path

добавлено в azure.azcollection 1.14.0

Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы.

Сертификат необходимо добавить в конец закрытого ключа.

Используется при аутентификации с помощью субъекта-службы.

servers

complex

Список словарей, содержащих сведения о серверах PostgreSQL Flexible.

Возвращается: всегда

administrator_login

string

Имя учетной записи администратора сервера.

Возвращается: всегда

Пример: "azureuser"

auth_config

dictionary

Свойства AuthConfig сервера.

Возвращается: всегда

Пример: {"active_directory_auth": "Disabled", "password_auth": "Enabled", "tenant_id": null}

availability_zone

string

Сведения о зоне доступности сервера.

Возвращается: всегда

Пример: "1"

backup

complex

Свойства резервного копирования сервера.

Возвращается: всегда

backup_retention_days

integer

Срок хранения резервных копий сервера в днях.

Возвращается: всегда

Пример: 7

geo_redundant_backup

string

Указывает, включено ли для сервера георезервное копирование.

Возвращается: всегда

Пример: "Disabled"

cluster

complex

Свойства эластичного кластера сервера.

Возвращается: всегда

cluster_size

integer

Количество экземпляров в кластере.

Возвращается: всегда

Пример: 3

default_database_name

string

Имя базы данных по умолчанию для кластера.

Возвращается: всегда

Пример: "mydb"

fully_qualified_domain_name

string

Полное доменное имя гибкого сервера.

Возвращается: всегда

Пример: "postflexiblefredpgsqlflexible.postgres.database.azure.com"

high_availability

complex

Свойства высокой доступности сервера.

Возвращается: всегда

mode

string

Режим высокой доступности сервера.

Возвращается: всегда

Пример: "Disabled"

standby_availability_zone

string

Сведения о зоне доступности резервного экземпляра.

Возвращается: всегда

id

string

Идентификатор ресурса гибкого сервера PostgreSQL.

Возвращается: всегда

Пример: "/subscriptions/xxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforPostgreSQL/flexibleservers/postgresql3"

location

string

Расположение ресурса.

Возвращается: всегда

Пример: "eastus"

maintenance_window

complex

Свойства окна обслуживания сервера.

Возвращается: всегда

custom_window

string

Указывает, включено или отключено пользовательское окно обслуживания.

Возвращается: всегда

Пример: "Enabled"

day_of_week

integer

День недели для окна обслуживания.

Возвращается: всегда

Пример: 0

start_hour

integer

Час начала окна обслуживания.

Возвращается: всегда

Пример: 8

start_minute

integer

Минута начала окна обслуживания.

Возвращается: всегда

Пример: 0

name

string

Имя ресурса.

Возвращается: всегда

Пример: "postgreabdud1223"

network

complex

Сетевые свойства сервера.

Возвращается: всегда

delegated_subnet_resource_id

string

Идентификатор ресурса ARM делегированной подсети.

Возвращается: всегда

private_dns_zone_arm_resource_id

string

Идентификатор ресурса ARM частной зоны DNS.

Возвращается: всегда

public_network_access

string

Указывает, включен ли доступ к общедоступной сети.

Возвращается: всегда

Пример: "Enabled"

point_in_time_utc

string

Время создания точки восстановления (в формате ISO8601).

Возвращается: всегда

resource_group

string

Имя группы ресурсов.

Возвращается: всегда

Пример: "myResourceGroup"

sku

complex

Артикул SKU сервера.

Возвращается: всегда

name

string

Имя SKU.

Возвращается: всегда

Пример: "Standard_B1ms"

tier

string

Уровень данного SKU.

Возвращается: всегда

Пример: "Burstable"

source_server_resource_id

string

Идентификатор ресурса исходного сервера для восстановления.

Возвращается: всегда

storage

complex

Максимальный объем хранилища, разрешенный для сервера.

Возвращается: всегда

storage_size_gb

integer

Максимальный объем хранилища, разрешенный для сервера.

Возвращается: всегда

Пример: 128

system_data

complex

Системные метаданные, связанные с этим ресурсом.

Возвращается: всегда

created_at

string

Время создания ресурса (UTC).

Возвращается: всегда

created_by

string

Удостоверение, создавшее ресурс.

Возвращается: всегда

created_by_type

string

Тип удостоверения, создавшего ресурс.

Возвращается: всегда

last_modified_at

string

Время последнего изменения ресурса (UTC).

Возвращается: всегда

last_modified_by

string

Удостоверение, последним изменившее ресурс.

Возвращается: всегда

last_modified_by_type

string

Тип удостоверения, последним изменившего ресурс.

Возвращается: всегда

tags

dictionary

Теги, назначенные ресурсу. Словарь пар строка:строка.

Возвращается: всегда

Пример: {"tag1": "abc"}

version

string

Версия Flexible Server.

Возвращается: всегда

Может возвращать только:

• "11"
• "12"
• "13"

Пример: "12"