Модуль azure.azcollection.azure_rm_postgresqlflexibledatabase_info — Получение фактов о гибкой базе данных Azure PostgreSQL

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: azure.azcollection.azure_rm_postgresqlflexibledatabase_info.

Новое в azure.azcollection 2.2.0

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

Описание

Получение фактов о гибкой базе данных PostgreSQL.

Требования

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

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

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
ad_user строка	Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
adfs_authority_url строка добавлено в azure.azcollection 0.0.1	URL-адрес службы Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной службой ADFS.
api_profile строка добавлено в azure.azcollection 0.0.1	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. По умолчанию: `"latest"`
auth_source строка добавлено в 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"`

server_name 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 путь добавлено в 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: List instance of PostgreSQL Flexible Database by server name
  azure_rm_postgresqlflexibledatabase_info:
    resource_group: myResourceGroup
    server_name: server_name

- name: Get instances of PostgreSQL Flexible Database
  azure_rm_postgresqlflexibledatabase_info:
    resource_group: myResourceGroup
    server_name: server_name
    name: database_name

Значения возврата

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

Ключ	Описание
database сложный	Список словарей, содержащих данные о PostgreSQL Flexible Database. Возвращается: всегда
charset строка	Кодировка символов базы данных. Возвращается: всегда Пример: `"UTF-8"`
collation строка	Сортировка базы данных. Возвращается: всегда Пример: `"en_US.utf8"`
id строка	Идентификатор ресурса гибкой базы данных postgresql. Возвращается: всегда Пример: `"/subscriptions/xxx-xxx/resourceGroups/testRG/providers/Microsoft.DBforPostgreSQL/flexibleServers/postfle9/databases/freddatabase"`
name строка	Имя ресурса. Возвращается: всегда Пример: `"freddatabase"`
system_data сложный	Системные метаданные, относящиеся к данному ресурсу. Возвращается: всегда
created_at строка	Отметка времени создания ресурса (UTC). Возвращается: всегда
created_by строка	Идентификатор, создавший ресурс. Возвращается: всегда
created_by_type строка	Тип идентификатора, создавшего ресурс. Возвращается: всегда
last_modified_at строка	Отметка времени последнего изменения ресурса (UTC). Возвращается: всегда
last_modified_by строка	Идентификатор, последний изменивший ресурс. Возвращается: всегда
last_modified_by_type строка	Тип идентификатора, последний изменившего ресурс. Возвращается: всегда
type строка	Тип ресурса. Возвращается: всегда Пример: `"Microsoft.DBforPostgreSQL/flexibleServers/databases"`

Авторы

xuzhang3 (@xuzhang3)
Fred-sun (@Fred-sun)

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

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