Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

Новое в azure.azcollection 0.1.2

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

Описание

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

Требования

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

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

Параметры

Параметр

Комментарии

ad_user

string

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

adfs_authority_url

string

added in 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

added in azure.azcollection 0.0.1

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

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

append_tags

boolean

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

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

Варианты:

  • false
  • true ← (default)

auth_source

string

added in 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" ← (default)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

backup_retention_days

integer

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

cert_validation_mode

string

added in 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

added in 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" ← (default)
  • "geo_restore"
  • "point_in_time_restore"

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

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

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

Варианты:

  • false ← (default)
  • true

enforce_ssl

boolean

Включить принудительное использование SSL.

Варианты:

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

geo_redundant_backup

boolean

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

Варианты:

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

location

string

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

log_mode

string

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

log_path

string

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

name

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

Имя сервера.

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

ID источника сервера, если 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.

Сертификат должен быть присоединен к закрытому ключу.

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

Примечания

Примечание

  • Для аутентификации с 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 Server
  azure_rm_postgresqlserver:
    resource_group: myResourceGroup
    name: testserver
    sku:
      name: B_Gen5_1
      tier: Basic
    location: eastus
    storage_mb: 1024
    enforce_ssl: true
    storage_autogrow: true
    admin_username: cloudsa
    admin_password: password

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

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

Ключ

Описание

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"

Авторы

  • Zim Kalinowski (@zikalino)

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

  • Система отслеживания ошибок
  • Главная страница
  • Репозиторий (исходный код)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API