community.azure.azure_rm_mysqlserver_info – Получение фактов сервера Azure MySQL
Примечание
Этот плагин является частью коллекции community.azure (версия 1.0.0).
Для его установки используйте: ansible-galaxy collection install community.azure.
Для использования в playbook укажите: community.azure.azure_rm_mysqlserver_info.
Краткое описание
- Получение фактов сервера MySQL.
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы. | |
| adfs_authority_url строка добавлен в 0.0.1 azure.azcollection | URL-адрес авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной службой ADFS. | |
| api_profile строка добавлен в 0.0.1 azure.azcollection | По умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. |
| auth_source строка добавлен в 0.0.1 azure.azcollection |
| Управляет источником учетных данных для аутентификации. Также может быть задан через переменную среды 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. |
| cert_validation_mode строка добавлен в 0.0.1 azure.azcollection |
| Управляет поведением проверки сертификатов для конечных точек Azure. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси HTTPS или обращении к Azure Stack, возможно потребуется отключить это поведение, передав ignore. Также может быть задан через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. |
| client_id строка | ID клиента Azure. Используйте при аутентификации с принципалом службы. | |
| cloud_environment строка добавлен в 0.0.1 azure.azcollection | По умолчанию: "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. Используйте при аутентификации с принципалом службы. | |
| subscription_id строка | Идентификатор вашей подписки Azure. | |
| tags список / элементы=строка | Ограничение результатов с помощью списка тегов. Формат тегов: 'ключ' или 'ключ:значение'. | |
| tenant строка | Идентификатор арендатора Azure. Используйте при аутентификации с принципалом службы. |
Примечания
Примечание
- Для аутентификации с Azure можно передать параметры, установить переменные среды, использовать профиль, сохранённый в ~/.azure/credentials, или войти в систему перед запуском задач или playbook с помощью
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 Server
community.azure.azure_rm_mysqlserver_info:
resource_group: myResourceGroup
name: server_name
- name: List instances of MySQL Server
community.azure.azure_rm_mysqlserver_info:
resource_group: myResourceGroup
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| серверы сложный | всегда | Список словарей, содержащих данные о серверах MySQL. | ||
| имя_пользователя_админа строка | всегда | Имя пользователя администратора сервера. Пример: serveradmin | ||
| enforce_ssl булево | всегда | Включить принудительное использование SSL. | ||
| полное_имя_домена строка | всегда | Полное доменное имя сервера. Пример: myabdud1223.mys.database.azure.com | ||
| id строка | всегда | Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforMySQL/servers/myabdud1223 | ||
| местоположение строка | всегда | Расположение ресурса. Пример: eastus | ||
| имя строка | всегда | Имя ресурса. Пример: myabdud1223 | ||
| группа_ресурсов строка | всегда | Имя группы ресурсов. Пример: myResourceGroup | ||
| sku сложный | всегда | SKU сервера. | ||
| емкость целое число | всегда | Масштабируемая емкость. Пример: 2 | ||
| имя строка | всегда | Имя SKU. Пример: GP_Gen4_2 | ||
| уровень строка | всегда | Уровень конкретного SKU. Пример: GeneralPurpose | ||
| хранилище_мб целое число | всегда | Максимальное хранилище, разрешенное для сервера. Пример: 128000 | ||
| теги словарь | успех | Присвоенные теги ресурса. Словарь пар строка:строка. Пример: {'tag1': 'abc'} | ||
| состояние_видимое_пользователю строка | всегда | Состояние сервера, видимое пользователю. Пример: Готово | ||
| версия строка | всегда | Версия сервера. Пример: 9.6 | ||
Авторы
- 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.10/collections/community/azure/azure_rm_mysqlserver_info_module.html