azure_rm_mysqldatabase_info – Получение фактов о базе данных Azure MySQL
Новая версия с 2.9.
Обзор
- Получение фактов о базе данных MySQL.
Псевдонимы: azure_rm_mysqldatabase_facts
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо сервисного принципала. | |
| adfs_authority_url строка добавлен в 2.6 | URL-адрес авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем, если у вас есть собственный ADFS-сервис авторизации. | |
| api_profile строка добавлен в 2.5 | Значение по умолчанию: "latest" | Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. |
| auth_source строка добавлен в 2.5 |
| Определяет источник данных для аутентификации. Если не указано, будет использована переменная среды ANSIBLE_AZURE_AUTH_SOURCE, по умолчанию auto если переменная не определена.auto будет следовать умолчанию: параметры модуля -> переменные среды -> профиль по умолчанию в файле ключей ~/.azure/credentials.
При установке в cli, данные будут браться из профиля Azure CLI по умолчанию.Можно также установить через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.
При установке в msi, хост-машина должна быть Azure-ресурсом с включённым расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID может использоваться для указания идентификатора подписки, если ресурс имеет доступ к нескольким подпискам, в противном случае выбирается первая.msi был добавлен в Ansible 2.6. |
| cert_validation_mode строка добавлен в 2.5 |
| Определяет поведение проверки сертификатов для Azure-точек конечных ресурсов. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или подключении к Azure Stack может потребоваться отключить это поведение, передав ignore. Можно также установить через профиль в файле ключей или переменную среды AZURE_CERT_VALIDATION. |
| client_id строка | Идентификатор клиента Azure. Используется при аутентификации с помощью сервисного принципала. | |
| cloud_environment строка добавлен в 2.4 | Значение по умолчанию: "AzureCloud" | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес точки конечного ресурса для обнаружения метаданных (требуется для Azure Stack). Также можно установить через профиль в файле ключей или переменную среды AZURE_CLOUD_ENVIRONMENT. |
| name строка | Имя базы данных. | |
| password строка | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо сервисного принципала. | |
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| resource_group строка / обязательно | Имя группы ресурсов, содержащей ресурс. Вы можете получить это значение из API Azure Resource Manager или портала. | |
| secret строка | Секретный ключ клиента Azure. Используется при аутентификации с помощью сервисного принципала. | |
| server_name строка / обязательно | Имя сервера. | |
| subscription_id строка | Идентификатор вашей подписки Azure. | |
| tenant строка | Идентификатор клиента Azure. Используется при аутентификации с помощью сервисного принципала. |
Примечания
Примечание
- Для аутентификации в 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: Get instance of MySQL Database
azure_rm_mysqldatabase_info:
resource_group: myResourceGroup
server_name: server_name
name: database_name
- name: List instances of MySQL Database
azure_rm_mysqldatabase_info:
resource_group: myResourceGroup
server_name: server_name
Возвращаемые значения
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| databases сложный | всегда | Список словарей, содержащих факты о базах данных MySQL. | |
| charset строка | всегда | Кодировка символов базы данных. Пример: utf8 | |
| collation строка | всегда | Сортировка базы данных. Пример: English_United States.1252 | |
| id строка | всегда | Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforMySQL/servers/testser ver/databases/db1 | |
| name строка | всегда | Имя ресурса. Пример: db1 | |
| resource_group строка | всегда | Имя группы ресурсов. Пример: testrg | |
| server_name строка | всегда | Имя сервера. Пример: testserver | |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Zim Kalinowski (@zikalino)
Подсказка
Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/azure_rm_mysqldatabase_info_module.html