Модуль azure.azcollection.azure_rm_postgresqldatabase – Управление экземпляром базы данных PostgreSQL
Примечание
Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Для использования в книге задач укажите: azure.azcollection.azure_rm_postgresqldatabase.
Новое в 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. |
api_profile string added in azure.azcollection 0.0.1 | Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию Default: |
auth_source string added in azure.azcollection 0.0.1 | Управляет источником учетных данных для аутентификации. Также может быть установлен с помощью переменной среды При установке в При установке в При установке в При установке в При установке в Параметр Варианты:
|
cert_validation_mode string added in azure.azcollection 0.0.1 | Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси HTTPS или в Azure Stack может потребоваться отключить это поведение, передав Варианты:
|
charset string | Кодировка базы данных. Проверьте документацию PostgreSQL для возможных значений. Это устанавливается только при создании, используйте force_update для повторного создания базы данных, если значения не совпадают. |
client_id string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентификации (msi). Также может быть установлен с помощью переменной среды |
cloud_environment string added in azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, Default: |
collation string | Сортировка базы данных. Проверьте документацию PostgreSQL для возможных значений. Это устанавливается только при создании, используйте force_update для повторного создания базы данных, если значения не совпадают. |
disable_instance_discovery boolean added in azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого параметра в true полностью отключит как обнаружение экземпляров, так и проверку полномочий. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных полномочий из https://login.microsoft.com/ для проверки полномочий. Установив это значение в **True**, проверка полномочий отключается. В результате крайне важно убедиться, что настроенный узел полномочий действителен и заслуживает доверия. Устанавливается с помощью профиля файла учетных данных или переменной среды Варианты:
|
force_update boolean | При установке в При установке в Варианты:
|
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string / required | Имя базы данных. |
password string | Пароль пользователя Active Directory. Используйте, когда аутентификация выполняется с пользователем Active Directory, а не с принципалом службы. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
resource_group string / обязательно | Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала. |
secret string | Секрет клиента Azure. Используйте, когда аутентификация выполняется с принципалом службы. |
server_name string / обязательно | Имя сервера. |
state string | Утверждение состояния базы данных PostgreSQL. Используйте Выбои:
|
subscription_id string | Ваш идентификатор подписки Azure. |
tenant string | Идентификатор клиента Azure. Используйте, когда аутентификация выполняется с принципалом службы. |
thumbprint string добавлено в azure.azcollection 1.14.0 | Отпечаток уникального ключа, указанного в x509_certificate_path. Используйте, когда аутентификация выполняется с принципалом службы. Требуется, если определен x509_certificate_path. |
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 Database
azure_rm_postgresqldatabase:
resource_group: myResourceGroup
server_name: testserver
name: db1
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
id string | Идентификатор ресурса. Возвращаемое значение: всегда Пример: |
name string | Имя ресурса. Возвращаемое значение: всегда Пример: |
Ссылки на коллекции
© 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_postgresqldatabase_module.html