azure_rm_mysqlserver_facts – Получение фактов о сервере Azure MySQL.
Новое в версии 2.7.
Синопсис
- Получение фактов о сервере MySQL.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user - | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы. | |
| adfs_authority_url - добавлено в 2.6 | По умолчанию: null | 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. Используется при аутентификации с принципалом службы. | |
| subscription_id - | Ваш идентификатор подписки Azure. | |
| tags - | Ограничение результатов путём предоставления списка тегов. Формат тегов - 'ключ' или 'ключ:значение'. | |
| tenant - | Идентификатор Azure-тенанта. Используется при аутентификации с принципалом службы. |
Примечания
Примечание
- Для аутентификации с Azure вы можете передать параметры, задать переменные среды или использовать профиль, сохранённый в ~/.azure/credentials. Аутентификация возможна с помощью принципала службы или пользователя 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 в среде.
Примеры
- name: Get instance of MySQL Server
azure_rm_mysqlserver_facts:
resource_group: resource_group_name
name: server_name
- name: List instances of MySQL Server
azure_rm_mysqlserver_facts:
resource_group: resource_group_name
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для данного модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| servers сложный | всегда | Список словарей, содержащих данные о серверах MySQL. | ||
| fully_qualified_domain_name строка | всегда | Полное доменное имя сервера. Пример: myabdud1223.mys.database.azure.com | ||
| id строка | всегда | Идентификатор ресурса Пример: /subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/myabdud1223 | ||
| location строка | всегда | Расположение ресурса. Пример: eastus | ||
| name строка | всегда | Имя ресурса. Пример: myabdud1223 | ||
| sku сложный | всегда | SKU сервера. | ||
| capacity целое число | всегда | Масштабируемость. Пример: 2 | ||
| name строка | всегда | Имя SKU Пример: GP_Gen4_2 | ||
| tier строка | всегда | Уровень конкретного SKU Пример: GeneralPurpose | ||
| user_visible_state строка | всегда | Состояние сервера, видимое пользователю. Пример: Ready | ||
| version строка | всегда | Версия сервера. Пример: 9.6 | ||
Статус
- Данному модулю не гарантируется обратная совместимость интерфейса. [превью]
- Данный модуль поддерживается сообществом 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.7/modules/azure_rm_mysqlserver_facts_module.html
