Модуль azure.azcollection.azure_rm_mysqlflexibleserver – управление экземпляром MySQL Flexible Server
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_mysqlflexibleserver.
Добавлено в azure.azcollection 2.7.0
Краткое описание
- Создание, обновление и удаление экземпляра MySQL Flexible 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 добавлено в azure.azcollection 0.0.1 | URL-адрес центра Azure AD. Используется при аутентификации по имени пользователя и паролю, если у вас есть собственный центр ADFS. |
administrator_login string | Имя учетной записи администратора сервера. Можно указать только при создании сервера (обязательно для создания). |
administrator_login_password string | Пароль учетной записи администратора. |
api_profile string добавлено в azure.azcollection 0.0.1 | Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию По умолчанию: |
append_tags boolean | Позволяет определить, является ли поле тегов каноническим или только дополняет существующие теги. Если поле является каноническим, все теги, отсутствующие в параметре tags, будут удалены из метаданных объекта. Варианты:
|
auth_source string добавлено в azure.azcollection 0.0.1 | Определяет источник учетных данных для аутентификации. Можно также задать с помощью переменной среды Если установлено значение Если установлено значение Если установлено значение Если установлено значение Если установлено значение Параметр Варианты:
|
availability_zone string | Сведения о зоне доступности сервера. |
backup dictionary | Свойства сервера, относящиеся к резервному копированию. |
|
backup_retention_days integer |
Количество дней хранения резервных копий сервера. |
|
geo_redundant_backup string |
Включено ли геоизбыточное резервное копирование. Варианты:
|
cert_validation_mode string добавлено в azure.azcollection 0.0.1 | Управляет проверкой сертификатов конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав Варианты:
|
client_id string | Идентификатор клиента Azure. Используется при аутентификации с помощью субъекта-службы или управляемого удостоверения (msi). Можно также задать с помощью переменной среды |
cloud_environment string добавлено в azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, укажите имя среды (согласно определению в Azure Python SDK, например По умолчанию: |
disable_instance_discovery boolean добавлено в azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Если задать значение true, обнаружение экземпляра и проверка центра будут полностью отключены. Эта возможность предназначена для сценариев, в которых невозможно обратиться к конечной точке метаданных, например в частных облаках или Azure Stack. Обнаружение экземпляра включает получение метаданных центра с сайта https://login.microsoft.com/ для проверки центра. При задании значения **True** проверка центра отключается. Поэтому крайне важно убедиться, что настроенный хост центра является действительным и заслуживающим доверия. Задается в профиле файла учетных данных или с помощью переменной среды Варианты:
|
high_availability dictionary | Свойства сервера, относящиеся к высокой доступности. |
|
mode string |
Режим высокой доступности сервера. Варианты:
|
|
standby_availability_zone string |
Зона доступности резервного сервера. |
location string | Расположение ресурса. Если не задано, по умолчанию используется расположение группы ресурсов. |
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string / обязательно | Имя сервера. |
network dictionary | Свойства сервера, относящиеся к сети. |
|
delegated_subnet_resource_id string |
Идентификатор ресурса делегированной подсети, используемой для настройки виртуальной сети для сервера. |
|
private_dns_zone_resource_id string |
Идентификатор ресурса частной зоны DNS. |
oidc_token string добавлено в azure.azcollection 3.17.0 | Токен OpenID Connect (OIDC) (JWT), непосредственно используемый для аутентификации с помощью удостоверения рабочей нагрузки. Этот токен обменивается с Azure AD с использованием федеративного удостоверения OIDC. Полезен в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC. Можно также задать с помощью переменной среды |
oidc_token_file_path path добавлено в azure.azcollection 3.17.0 | Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки. Файл должен содержать только исходный токен. Этот способ часто используется на платформах, которые сохраняют токены OIDC в виде файлов. Можно также задать с помощью переменной среды |
password string | Пароль пользователя Active Directory. Используется при аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
profile string | Профиль безопасности из файла ~/.azure/credentials. |
resource_group string / обязательно | Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или на портале. |
restore_point_in_time string | Время создания точки восстановления (формат ISO8601), указывающее время, на которое нужно выполнить восстановление. Обязательно, если указан параметр |
secret string | Секрет клиента Azure. Используется при аутентификации с помощью субъекта-службы. |
sku dictionary | SKU (ценовая категория) сервера. |
|
name string / обязательно |
Имя SKU, например Standard_D32s_v3. |
|
tier string / обязательно |
Уровень соответствующего SKU. Варианты:
|
source_server_resource_id string | Идентификатор исходного сервера MySQL. Обязательно, если указан параметр |
state string | Убедитесь, что MySQL Flexible Server находится в нужном состоянии. Используйте Варианты:
|
status string | Задайте состояние сервера. Варианты:
|
storage dictionary | Свойства профиля хранилища сервера. |
|
auto_grow string |
Включить или отключить автоматическое увеличение хранилища. Варианты:
|
|
iops integer |
Количество операций ввода-вывода в секунду (IOPS) хранилища сервера. |
|
storage_size_gb 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. |
version string | Версия сервера. Варианты:
|
x509_certificate_path path добавлено в azure.azcollection 1.14.0 | Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы. Сертификат должен быть добавлен после закрытого ключа. Используется при аутентификации с помощью субъекта-службы. |
Примечания
Примечание
- Для аутентификации в Azure можно передать параметры, задать переменные среды, использовать профиль, сохранённый в ~/.azure/credentials, или выполнить вход перед запуском задач или плейбука с помощью
az login. - Аутентификация также возможна с помощью субъекта-службы или пользователя Active Directory.
- Для аутентификации через OIDC передайте client_id, tenant и oidc_token или oidc_token_file_path либо задайте переменные среды AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN или AZURE_FEDERATED_TOKEN_FILE.
- Для аутентификации через субъект-службу передайте 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: Create mysql flexible server
azure_rm_mysqlflexibleserver:
resource_group: "{{ resource_group }}"
name: postflexible{{ rpfx }}
sku:
name: Standard_D2ds_v4
tier: GeneralPurpose
administrator_login: azureuser
administrator_login_password: Fred@0329
location: northeurope
version: 5.7
storage:
storage_size_gb: 128
iops: 500
auto_grow: Enabled
high_availability:
mode: ZoneRedundant
standby_availability_zone: 3
backup:
backup_retention_days: 7
geo_redundant_backup: Disabled
availability_zone: 1
- name: Restore MySQL flexible server from a point-in-time backup
azure_rm_mysqlflexibleserver:
resource_group: "{{ resource_group }}"
name: postflexible-restore{{ rpfx }}
source_server_resource_id: "{{ mysql_flexible_server_id }}"
restore_point_in_time: "2026-02-26T02:27:14Z"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
servers complex | Сведения о гибких серверах. Возвращается: всегда |
|
administrator_login_password string |
Имя учётной записи администратора сервера. Возвращается: всегда Пример: |
|
availability_zone string |
Сведения о зоне доступности сервера. Возвращается: всегда Пример: |
|
backup complex |
Свойства сервера, связанные с резервным копированием. Возвращается: при успешном выполнении |
|
backup_retention_days integer |
Количество дней хранения резервных копий сервера. Возвращается: всегда Пример: |
|
geo_redundant_backup string |
Указывает, включено ли геоизбыточное резервное копирование. Возвращается: всегда Пример: |
|
fully_qualified_domain_name string |
Полное доменное имя сервера. Возвращается: всегда Пример: |
|
high_availability complex |
Свойства сервера, связанные с высокой доступностью. Возвращается: всегда |
|
mode string |
Режим высокой доступности сервера. Возвращается: всегда Пример: |
|
standby_availability_zone string |
Зона доступности резервного сервера. Возвращается: всегда Пример: |
|
id string |
Идентификатор ресурса. Возвращается: всегда Пример: |
|
location string |
Расположение ресурса. Возвращается: всегда Пример: |
|
name string |
Имя ресурса. Возвращается: всегда Пример: |
|
network complex |
Свойства сервера, связанные с сетью. Возвращается: всегда |
|
delegated_subnet_resource_id string |
Идентификатор ресурса делегированной подсети, используемой для настройки виртуальной сети сервера. Возвращается: всегда |
|
private_dns_zone_resource_id string |
Идентификатор ресурса частной зоны DNS. Возвращается: всегда |
|
resource_group string |
Имя группы ресурсов. Возвращается: всегда Пример: |
|
restore_point_in_time string |
Время создания точки восстановления (в формате ISO8601), указывающее момент времени, на который нужно восстановить данные. Возвращается: всегда |
|
sku complex |
Артикул SKU сервера. Возвращается: всегда |
|
name string |
Имя SKU. Возвращается: всегда Пример: |
|
tier string |
Уровень данного SKU. Возвращается: всегда Пример: |
|
source_server_resource_id string |
Идентификатор исходного сервера MySQL. Возвращается: всегда |
|
state string |
Состояние сервера, отображаемое пользователю. Возвращается: всегда Пример: |
|
status string |
Задать состояние сервера. Возвращается: при успешном выполнении Возможные возвращаемые значения:
|
|
storage complex |
Свойства сервера, связанные с хранилищем. Возвращается: всегда |
|
auto_grow string |
Указывает, включено ли автоматическое увеличение объёма хранилища. Возвращается: всегда Пример: |
|
iops integer |
Количество операций ввода-вывода в секунду (IOPS) для хранилища сервера. Возвращается: всегда Пример: |
|
storage_size_gb integer |
Максимальный допустимый объём хранилища сервера. Возвращается: всегда Пример: |
|
tags dictionary |
Теги, назначенные ресурсу. Словарь пар «строка:строка». Возвращается: всегда Пример: |
|
type string |
Тип ресурса. Возвращается: всегда Пример: |
|
version string |
Версия сервера. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/azure/azcollection/azure_rm_mysqlflexibleserver_module.html