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

ad_user

string

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

adfs_authority_url

string

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

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

admin_password

string

Пароль учетной записи администратора.

Указанный пароль должен содержать от 6 до 72 символов и соответствовать как минимум 3 из следующих требований к сложности пароля.

1. Содержать символ в верхнем регистре
2. Содержать символ в нижнем регистре
3. Содержать цифру
4. Содержать специальный символ
5. Не содержать управляющих символов

admin_username

string

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

api_profile

string

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

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

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

append_tags

boolean

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

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

Варианты:

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

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; в противном случае используется подписка Azure CLI по умолчанию.

Если задано значение msi, узел должен быть ресурсом Azure с включенным расширением MSI. Для указания идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, можно использовать subscription_id или переменную окружения AZURE_SUBSCRIPTION_ID; в противном случае будет выбрана первая подписка.

Параметр msi добавлен в Ansible 2.6.

Варианты:

• "auto" ← (по умолчанию)
• "cli"
• "credential_file"
• "env"
• "msi"

backup_retention_days

integer

Срок хранения резервных копий от 7 до 35 дней. Если значение не задано, по умолчанию используется 7 дней.

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"

create_mode

string

Режим создания SQL Server. Пустое значение (по умолчанию), восстановление из георезервной копии (geo_restore) или восстановление на момент времени (point_in_time_restore).

Варианты:

• "default" ← (по умолчанию)
• "geo_restore"
• "point_in_time_restore"

disable_instance_discovery

boolean

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

Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Если задать значение true, обнаружение экземпляра и проверка центра будут полностью отключены. Эта возможность предназначена для сценариев, в которых конечная точка метаданных недоступна, например в частных облаках или Azure Stack. Обнаружение экземпляра включает получение метаданных центра с адреса https://login.microsoft.com/ для проверки центра. Если задать значение **True**, проверка центра отключается. Поэтому крайне важно убедиться, что настроенный узел центра является действительным и заслуживающим доверия.

Задается через профиль в файле учетных данных или переменную окружения AZURE_DISABLE_INSTANCE_DISCOVERY.

Варианты:

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

enforce_ssl

boolean

Включить обязательное использование SSL.

Варианты:

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

geo_redundant_backup

boolean

Выберите локально избыточное резервное копирование (по умолчанию) или геоизбыточное. После первого развертывания изменить этот параметр нельзя.

Варианты:

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

location

string

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

log_mode

string

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

log_path

string

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

name

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

Имя сервера.

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, а не субъекта-службы.

profile

string

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

resource_group

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

Имя группы ресурсов, содержащей ресурс. Это значение можно получить с помощью API Azure Resource Manager или на портале.

restore_point_in_time

string

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

Обязательно, если create_mode=point_in_time_restore.

secret

string

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

sku

dictionary

SKU (уровень цен) сервера.

capacity

string

Вычислительная мощность при вертикальном/горизонтальном масштабировании, выраженная в единицах вычислительной мощности сервера.

name

string

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

size

string

Код размера, интерпретируемый ресурсом соответствующим образом.

tier

string

Уровень данного SKU, например Basic.

Варианты:

• "Basic"
• "Standard"

source_server_id

string

Идентификатор исходного сервера, если create_mode=default.

state

string

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

Варианты:

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

storage_autogrow

boolean

Включить автоматическое увеличение объема хранилища.

Варианты:

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

storage_mb

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

Версия сервера.

Варианты:

• "9.5"
• "9.6"
• "10"
• "11"

x509_certificate_path

path

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

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

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

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

fully_qualified_domain_name

string

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

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

Пример: "postgresqlsrv1b6dd89593.postgresql.database.azure.com"

id

string

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

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

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforPostgreSQL/servers/mysqlsrv1b6dd89593"

state

string

Состояние сервера, отображаемое пользователю. Возможные значения: Ready, Dropping, Disabled.

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

Пример: "Ready"

version

string

Версия сервера. Возможные значения: 9.5, 9.6, 10, 11.

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

Пример: "9.6"