Модуль azure.azcollection.azure_rm_mysqlserver — Управление экземпляром MySQL Server
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.
Чтобы использовать его в книге задач, укажите: azure.azcollection.azure_rm_mysqlserver.
Новая функция в azure.azcollection 0.1.2
Описание
- Создание, обновление и удаление экземпляра MySQL Server.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- На хосте, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection через galaxy
- Все пакеты python, перечисленные в файле requirements.txt коллекции, должны быть установлены через pip на хосте, на котором выполняются модули из azure.azcollection
- Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection
Параметры
Параметр | Комментарии |
|---|---|
ad_user string | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности. |
adfs_authority_url string added in azure.azcollection 0.0.1 | URL-адрес узла Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственным узлом ADFS. |
admin_password string | Пароль для входа администратора. |
admin_username string | Имя входа администратора сервера. Может быть указано только при создании сервера (и обязательно для создания). |
api_profile string added in azure.azcollection 0.0.1 | Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию По умолчанию: |
append_tags boolean | Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. В каноническом режиме любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта. Варианты:
|
auth_source string added in azure.azcollection 0.0.1 | Управляет источником учетных данных для аутентификации. Также может быть установлено через переменную среды При установке в При установке в При установке в При установке в При установке в Параметр Варианты:
|
cert_validation_mode string added in azure.azcollection 0.0.1 | Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси HTTPS или в Azure Stack может потребоваться отключить это поведение, передав Варианты:
|
client_id string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентичности (msi). Также может быть установлено через переменную среды |
cloud_environment string added in azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, По умолчанию: |
create_mode string | Режим создания SQL Server. По умолчанию: |
disable_instance_discovery boolean added in azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку полномочий. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных полномочий с https://login.microsoft.com/ для проверки полномочий. Установив это значение в **True**, проверка полномочий отключается. В результате важно убедиться, что настроенный узел полномочий является действительным и заслуживающим доверия. Устанавливается через профиль файла учетных данных или переменную среды Варианты:
|
enforce_ssl boolean | Включить принудительное использование SSL. Варианты:
|
location string | Расположение ресурса. Если не указано, по умолчанию используется расположение из группы ресурсов. |
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string / обязательно | Имя сервера. |
password string | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо служебного принципала. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
resource_group string / обязательно | Имя группы ресурсов, содержащей ресурс. Вы можете получить это значение из API Azure Resource Manager или портала. |
restarted boolean | Установите в Варианты:
|
secret string | Секрет Azure клиента. Используйте при аутентификации со служебным принципалом. |
sku dictionary | SKU (уровень ценообразования) сервера. |
|
capacity string |
Ёмкость масштабирования вверх/вниз, представляющая вычислительные единицы сервера. |
|
name string |
Имя sku, как правило, уровень + семейство + ядра, например |
|
size integer |
Код размера, который ресурс интерпретирует соответствующим образом. |
|
tier string |
Уровень конкретного SKU, например Варианты:
|
state string | Установите состояние MySQL-сервера. Используйте Варианты:
|
storage_profile dictionary | Свойства профиля хранения сервера. |
|
backup_retention_days integer |
Дни хранения резервных копий для сервера |
|
geo_redundant_backup string |
Включить или выключить гео-резервное копирование для резервного копирования сервера. Варианты:
|
|
storage_autogrow string |
Включить автоматическое расширение хранилища. Варианты:
|
|
storage_mb integer |
Максимальный размер хранилища, разрешённый для сервера. |
subscription_id string | Идентификатор вашей подписки Azure. |
tags dictionary | Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные теги объекта будут обновлены с предоставленными значениями. Для удаления тегов установите параметр append_tags в false. В настоящее время зоны Azure DNS и службы Traffic Manager также не позволяют использовать пробелы в теге. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 тегов на ресурсах. |
tenant string | Идентификатор Azure-аренды. Используйте при аутентификации со служебным принципалом. |
thumbprint string добавлен в azure.azcollection 1.14.0 | Отпечаток частного ключа, указанного в x509_certificate_path. Используйте при аутентификации со служебным принципалом. Требуется, если задан x509_certificate_path. |
версия строка | Версия сервера. Варианты:
|
x509_certificate_path путь добавлено в azure.azcollection 1.14.0 | Путь к сертификату X509, используемому для создания служебного принципала в формате PEM. Сертификат должен быть присоединен к закрытому ключу. Используйте при аутентификации с помощью служебного принципала. |
Примечания
Примечание
- Для аутентификации с 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. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или установив AZURE_PROFILE в среде.
См. также
См. также
- Вход с помощью Azure CLI
-
Как выполнить аутентификацию с помощью команды
az login.
Примеры
- name: Create (or update) MySQL Server
azure_rm_mysqlserver:
resource_group: myResourceGroup
name: testserver
sku:
name: B_Gen5_1
tier: Basic
location: eastus
storage_profile:
storage_mb: 51200
backup_retention_days: 7
geo_redundant_backup: Disabled
storage_autogrow: Disabled
enforce_ssl: true
version: 5.7
admin_username: cloudsa
admin_password: password
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие — поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
fully_qualified_domain_name строка | Полное доменное имя сервера. Возвращается: всегда Пример: |
id строка | Идентификатор ресурса. Возвращается: всегда Пример: |
состояние строка | Состояние сервера, видимое пользователю. Возможные значения включают Возвращается: всегда Пример: |
версия строка | Версия сервера. Возможные значения включают Возвращается: всегда Пример: |
Ссылки на сборку
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_mysqlserver_module.html