azure_rm_mysqlserver – Управление экземпляром MySQL Server.
Новое в версии 2.5.
Обзор
- Создание, обновление и удаление экземпляра MySQL Server.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| ad_user - | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы. | ||
| adfs_authority_url - добавлен в 2.6 | По умолчанию: null | URL-адрес полномочий Azure AD. Используется при аутентификации с именем пользователя/паролем и наличии собственного авторитета ADFS. | |
| admin_password - | Пароль администратора. | ||
| admin_username - | Имя пользователя администратора сервера. Может быть указано только при создании сервера (и требуется для создания). | ||
| 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. | |
| create_mode - | По умолчанию: "Default" | Режим создания SQL Server | |
| enforce_ssl boolean |
| Включить принудительное использование SSL. | |
| location - | Расположение ресурса. Если не задано, используется расположение из группы ресурсов по умолчанию. | ||
| name - / обязательно | Имя сервера. | ||
| password - | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы. | ||
| profile - | Профиль безопасности, найденный в файле ~/.azure/credentials. | ||
| resource_group - / обязательно | Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала. | ||
| secret - | Секрет клиента Azure. Используется при аутентификации с принципалом службы. | ||
| sku - | SKU (цена) сервера. | ||
| capacity - | Ёмкость масштабирования вверх/вниз, представляющая вычислительные единицы сервера. | ||
| name - | Имя sku, обычно буквенно-цифровой код, например, P3. | ||
| size - | Код размера, подлежащий интерпретации ресурсом в соответствии с требованиями. | ||
| tier - |
| Уровень конкретного SKU, например, Basic. | |
| state - |
| Утверждает состояние MySQL Server. Используйте 'present' для создания или обновления сервера, а 'absent' для его удаления. | |
| storage_mb - | Максимальный размер хранилища, разрешенный для сервера. | ||
| subscription_id - | Ваш идентификатор Azure-подписки. | ||
| tenant - | Идентификатор Azure-аренды. Используется при аутентификации с принципалом службы. | ||
| version - |
| Версия сервера. | |
Примечания
Примечание
- Для аутентификации в 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: Create (or update) MySQL Server
azure_rm_mysqlserver:
resource_group: TestGroup
name: testserver
sku:
name: GP_Gen4_2
tier: GeneralPurpose
capacity: 2
location: eastus
storage_mb: 1024
enforce_ssl: True
version: 5.6
admin_username: cloudsa
admin_password: password
Возвращаемые значения
Общие значения возвращаемых данных документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| fully_qualified_domain_name строка | всегда | Полное доменное имя сервера. Пример: mysqlsrv1b6dd89593.mysql.database.azure.com |
| id строка | всегда | Идентификатор ресурса Пример: /subscriptions/12345678-1234-1234-1234-123412341234/testrg/providers/Microsoft.DBforMySQL/servers/mysqlsrv1b6dd89593 |
| state строка | всегда | Состояние сервера, видимое пользователю. Возможные значения: Ready, Dropping, Disabled.
Пример: Готово |
| version строка | всегда | Версия сервера. Возможные значения: 5.6, 5.7.
Пример: 5.6 |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Данный модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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_module.html