azure_rm_mariadbserver_info – Получение фактов о сервере Azure MariaDB

Новая версия с 2.9.

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Значения возврата
Статус

Обзор

Получение фактов о сервере MariaDB.

Псевдонимы: azure_rm_mariadbserver_facts

Требования

Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user строка		Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо службы.
adfs_authority_url строка добавлено в 2.6		URL-адрес службы Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной службой ADFS.
api_profile строка добавлено в 2.5	Значение по умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-службами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
auth_source строка добавлено в 2.5	Варианты: auto cli credential_file env msi	Управляет источником учетных данных для аутентификации. Если не указано, используется переменная среды 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	Варианты: ignore validate	Управляет поведением проверки сертификатов для 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`.
name строка		Имя сервера.
password строка		Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо службы.
profile строка		Профиль безопасности в файле ~/.azure/credentials.
resource_group строка / обязательно		Имя группы ресурсов, содержащей ресурс. Вы можете получить это значение из API Azure Resource Manager или портала.
secret строка		Секрет клиента Azure. Используйте при аутентификации с помощью службы.
subscription_id строка		Идентификатор вашей подписки Azure.
tags список		Ограничить результаты, указав список тегов. Формат тегов 'ключ' или 'ключ:значение'.
tenant строка		Идентификатор Azure-арендатора. Используйте при аутентификации с помощью службы.

Примечания

Примечание

Для аутентификации с Azure вы можете передать параметры, установить переменные среды, использовать профиль, сохранённый в ~/.azure/credentials, или войти перед выполнением задач или выполнения playbook с 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. Также можно добавить дополнительные профили. Укажите профиль, передав profile или установив AZURE_PROFILE в среде.

См. также

Вход в Azure CLI: Как войти с помощью команды az login.

Примеры

- name: Get instance of MariaDB Server
  azure_rm_mariadbserver_info:
    resource_group: myResourceGroup
    name: server_name

- name: List instances of MariaDB Server
  azure_rm_mariadbserver_info:
    resource_group: myResourceGroup

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:

Ключ			Возвращаемое значение	Описание
servers complex			всегда	Список словарей, содержащих данные о серверах MariaDB.
	admin_username string		всегда	Имя пользователя администратора сервера. Пример: serveradmin
	enforce_ssl boolean		всегда	Включить принудительное использование SSL.
	fully_qualified_domain_name string		всегда	Полное доменное имя сервера. Пример: myabdud1223.mys.database.azure.com
	id string		всегда	Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforMariaDB/servers/myabdud1223
	location string		всегда	Расположение ресурса. Пример: eastus
	name string		всегда	Имя ресурса. Пример: myabdud1223
	resource_group string		всегда	Имя группы ресурсов. Пример: myResourceGroup
	sku complex		всегда	SKU сервера.
		capacity integer	всегда	Емкость масштабирования. Пример: 2
		name string	всегда	Имя SKU. Пример: GP_Gen4_2
		tier string	всегда	Уровень данного SKU. Пример: GeneralPurpose
	storage_mb integer		всегда	Максимальный объем хранилища, разрешенный для сервера. Пример: 128000
	tags dictionary			Теги, назначенные ресурсу. Словарь пар строка:строка. Пример: {'tag1': 'abc'}
	user_visible_state string		всегда	Состояние сервера, видимое пользователю. Пример: Ready
	version string		всегда	Версия сервера. Пример: 9.6

Статус

Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Zim Kalinowski (@zikalino)
Matti Ranta (@techknowlogick)

Подсказка

Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/azure_rm_mariadbserver_info_module.html