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 (добавлен в 2.6) | По умолчанию: "Default" | Режим создания SQL Server | |
| enforce_ssl bool |
| Включить принудительное использование SSL. | |
| location | Расположение ресурса. Если не указано, используется расположение из группы ресурсов по умолчанию. | ||
| name обязательно | Имя сервера. | ||
| password | Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не с учетной записью службы. | ||
| profile | Профиль безопасности, найденный в файле ~/.azure/credentials. | ||
| resource_group обязательно | Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала. | ||
| secret | Секрет клиента Azure. Используется при аутентификации с помощью учетной записи службы. | ||
| sku | SKU (уровень ценообразования) сервера. | ||
| name | Имя sku, обычно код в формате буква + цифра, например, P3. | ||
| tier |
| Уровень конкретного SKU, например, Basic. | |
| capacity | Емкость масштабирования вверх/вниз, представляющая вычислительные единицы сервера. | ||
| size | Код размера, который интерпретируется ресурсом в соответствии с правилами. | ||
| state (добавлен в 2.6) |
| Установите состояние 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: MYSQLB50
tier: Basic
capacity: 100
location: eastus
storage_mb: 1024
enforce_ssl: True
admin_username: cloudsa
admin_password: password
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| fully_qualified_domain_name str | всегда | Полное доменное имя сервера. Пример: mysqlsrv1b6dd89593.mysql.database.azure.com |
| id str | всегда | Идентификатор ресурса Пример: /subscriptions/12345678-1234-1234-1234-123412341234/testrg/providers/Microsoft.DBforMySQL/servers/mysqlsrv1b6dd89593 |
| state str | всегда | Состояние сервера, видимое пользователю. Возможные значения: Ready, Dropping, Disabled
Пример: Готов |
| version str | всегда | Версия сервера. Возможные значения: 5.6, 5.7
Пример: 5.6 |
Статус
Этот модуль помечен как экспериментальный, что означает, что он не гарантирует обратной совместимости интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщественный, что означает, что он поддерживается сообществом Ansible. Подробнее см. Техническое обслуживание и поддержка модулей.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- Зим Калиновский (@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.6/modules/azure_rm_mysqlserver_module.html