Модуль azure.azcollection.azure_rm_postgresqlflexibleserver_info — получение сведений об Azure PostgreSQL Flexible Server
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля нужны дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_postgresqlflexibleserver_info.
Добавлено в 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 string | Имя пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
adfs_authority_url string добавлено в azure.azcollection 0.0.1 | URL-адрес центра Azure AD. Используйте при аутентификации по имени пользователя и паролю с собственным центром ADFS. |
api_profile string добавлено в azure.azcollection 0.0.1 | Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию По умолчанию: |
auth_source string добавлено в azure.azcollection 0.0.1 | Определяет источник учетных данных для аутентификации. Также можно задать с помощью переменной среды Если задано значение Если задано значение Если задано значение Если задано значение Если задано значение Параметр Варианты:
|
cert_validation_mode string добавлено в azure.azcollection 0.0.1 | Управляет проверкой сертификатов для конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав Варианты:
|
client_id string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы или управляемого удостоверения (msi). Также можно задать с помощью переменной среды |
cloud_environment string добавлено в azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, — имя среды (как определено в Azure Python SDK, например, По умолчанию: |
disable_instance_discovery boolean добавлено в azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Если задать значение true, обнаружение экземпляра и проверка центра будут полностью отключены. Эта функция предназначена для сценариев, в которых невозможно подключиться к конечной точке метаданных, например в частных облаках или Azure Stack. Для обнаружения экземпляра извлекаются метаданные центра с сайта https://login.microsoft.com/, чтобы проверить центр. Если задать значение **True**, проверка центра отключается. Поэтому крайне важно убедиться, что настроенный узел центра является допустимым и заслуживающим доверия. Значение задается в профиле файла учетных данных или с помощью переменной среды Варианты:
|
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. Также можно задать с помощью переменной среды |
oidc_token_file_path path добавлено в azure.azcollection 3.17.0 | Путь к файлу с токеном OpenID Connect (OIDC) (JWT), используемым для аутентификации удостоверения рабочей нагрузки. Файл должен содержать только необработанный токен. Этот способ часто используется на платформах, которые сохраняют токены OIDC в виде файлов. Также можно задать с помощью переменной среды |
password string | Пароль пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
profile string | Профиль безопасности из файла ~/.azure/credentials. |
resource_group string | Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или на портале. |
secret string | Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы. |
subscription_id string | Идентификатор вашей подписки Azure. |
tags list / элементы типа string | Ограничивает результаты с помощью списка тегов. Указывайте теги в формате «ключ» или «ключ:значение». |
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.
- Для аутентификации через OIDC передайте client_id, tenant и oidc_token либо oidc_token_file_path или задайте переменные среды AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN либо AZURE_FEDERATED_TOKEN_FILE.
- Для аутентификации с помощью субъекта-службы передайте 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: Get instance of PostgreSQL Flexible Server
azure_rm_postgresqlflexibleserver_info:
resource_group: myResourceGroup
name: server_name
- name: List instances of PostgreSQL Flexible Server
azure_rm_postgresqlflexibleserver_info:
resource_group: myResourceGroup
tags:
- key
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
servers complex | Список словарей, содержащих сведения о серверах PostgreSQL Flexible. Возвращается: всегда |
|
administrator_login string |
Имя учетной записи администратора сервера. Возвращается: всегда Пример: |
|
auth_config dictionary |
Свойства AuthConfig сервера. Возвращается: всегда Пример: |
|
availability_zone string |
Сведения о зоне доступности сервера. Возвращается: всегда Пример: |
|
backup complex | Свойства резервного копирования сервера. Возвращается: всегда |
|
backup_retention_days integer | Срок хранения резервных копий сервера в днях. Возвращается: всегда Пример: |
|
geo_redundant_backup string | Показывает, включено ли для сервера геоизбыточное резервное копирование. Возвращается: всегда Пример: |
|
fully_qualified_domain_name string | Полное доменное имя гибкого сервера. Возвращается: всегда Пример: |
|
high_availability complex | Свойства высокой доступности сервера. Возвращается: всегда |
|
mode string | Режим высокой доступности (HA) сервера. Возвращается: всегда Пример: |
|
standby_availability_zone string | Сведения о зоне доступности резервного экземпляра. Возвращается: всегда |
|
id string | Идентификатор ресурса гибкого сервера PostgreSQL. Возвращается: всегда Пример: |
|
identity complex | Удостоверение сервера. Возвращается: если доступно |
|
type string | Тип управляемого удостоверения Возвращается: всегда Пример: |
|
user_assigned_identities complex | Назначенные пользователем управляемые удостоверения и их параметры Возвращается: всегда |
|
id dictionary | Словарь идентификаторов назначенных пользователем удостоверений, связанных с ресурсом Возвращается: всегда |
|
location string | Расположение ресурса. Возвращается: всегда Пример: |
|
maintenance_window complex | Свойства окна обслуживания сервера. Возвращается: всегда |
|
custom_window string | Показывает, включено или отключено пользовательское окно обслуживания. Возвращается: всегда Пример: |
|
day_of_week integer | День недели для окна обслуживания. Возвращается: всегда Пример: |
|
start_hour integer | Час начала окна обслуживания. Возвращается: всегда Пример: |
|
start_minute integer | Минута начала окна обслуживания. Возвращается: всегда Пример: |
|
name string | Имя ресурса. Возвращается: всегда Пример: |
|
network complex | Сетевые свойства сервера. Возвращается: всегда |
|
delegated_subnet_resource_id string | Идентификатор ресурса ARM делегированной подсети. Возвращается: всегда |
|
private_dns_zone_arm_resource_id string | Идентификатор ресурса ARM частной зоны DNS. Возвращается: всегда |
|
public_network_access string | Показывает, включен ли доступ через общедоступную сеть. Возвращается: всегда Пример: |
|
point_in_time_utc string | Время создания точки восстановления (формат ISO8601). Возвращается: всегда |
|
resource_group string | Имя группы ресурсов. Возвращается: всегда Пример: |
|
sku complex | Артикул сервера (SKU). Возвращается: всегда |
|
name string | Имя SKU. Возвращается: всегда Пример: |
|
tier string | Уровень указанного SKU. Возвращается: всегда Пример: |
|
source_server_resource_id string | Идентификатор исходного сервера, из которого выполняется восстановление. Возвращается: всегда |
|
storage complex | Максимальный объем хранилища, доступный для сервера. Возвращается: всегда |
|
storage_size_gb integer | Максимальный объем хранилища, доступный для сервера. Возвращается: всегда Пример: |
|
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 | Теги, назначенные ресурсу. Словарь пар «строка:строка». Возвращается: всегда Пример: |
|
version string | Версия Flexible Server. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/azure/azcollection/azure_rm_postgresqlflexibleserver_info_module.html