модуль azure.azcollection.azure_rm_mysqlflexibleserver_info – Получение сведений о гибком сервере Azure MySQL
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля нужны дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_mysqlflexibleserver_info.
Добавлено в azure.azcollection 2.6.0
Краткое описание
- Получение сведений о гибком сервере MySQL.
Требования
На хосте, выполняющем этот модуль, должны быть соблюдены следующие требования.
- python >= 2.7
- На хосте, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection из Galaxy
- Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены на хосте, выполняющем модули из azure.azcollection, с помощью pip
- Полные инструкции по установке можно найти здесь: 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. |
api_profile string добавлено в azure.azcollection 0.0.1 | Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию По умолчанию: |
auth_source string добавлено в azure.azcollection 0.0.1 | Определяет источник учетных данных для аутентификации. Можно также задать с помощью переменной окружения Если задано значение Если задано значение Если задано значение Если задано значение Если задано значение Параметр Варианты:
|
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**, проверка центра будет отключена. Поэтому крайне важно убедиться, что настроенный узел центра является действительным и надежным. Значение задается в профиле файла учетных данных или с помощью переменной окружения Варианты:
|
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string | Имя сервера. |
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 или на портале. |
secret string | Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы. |
subscription_id string | Идентификатор вашей подписки Azure. |
tags list / элементы=string | Ограничьте результаты, указав список тегов. Формат тегов: «ключ» или «ключ:значение». |
tenant string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы. |
thumbprint string добавлено в azure.azcollection 1.14.0 | Отпечаток закрытого ключа, указанного в x509_certificate_path. Используйте при аутентификации с помощью субъекта-службы. Обязательный параметр, если задан x509_certificate_path. |
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: Get instance of MySQL Flexible Server
azure_rm_mysqlflexibleserver_info:
resource_group: myResourceGroup
name: server_name
- name: List instances of MySQL Flexible Server and filter by tags
azure_rm_mysqlflexibleserver_info:
resource_group: myResourceGroup
- name: List instances of MySQL Flexible Server
azure_rm_mysqlflexibleserver_info:
resource_group: myResourceGroup
tags:
- key
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
servers complex | Список словарей с фактами о серверах MySQL. Возвращается: всегда |
|
administrator_login 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 |
Состояние сервера, видимое пользователю. Возвращается: всегда Пример: |
|
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_info_module.html