azure.azcollection.azure_rm_sqldatabase_info – Получение сведений об Azure SQL Database

Примечание

Этот плагин входит в коллекцию azure.azcollection (версия 1.3.1).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

Чтобы использовать его в книге задач, укажите: azure.azcollection.azure_rm_sqldatabase_info.

Новое в версии 0.1.2: из azure.azcollection

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

Обзор

Получение сведений об Azure SQL Database.

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user строка		Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала.
adfs_authority_url строка добавлен в 0.0.1 azure.azcollection		URL-адрес авторитета Azure AD. Используется при аутентификации с именем пользователя/паролем и собственном авторитете ADFS.
api_profile строка добавлен в 0.0.1 azure.azcollection	По умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
auth_source строка добавлен в 0.0.1 azure.azcollection	Варианты: auto ← cli credential_file env msi	Определяет источник данных для аутентификации. Также можно задать через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При установке в `auto` (значение по умолчанию) приоритет имеет: параметры модуля -> `env` -> `credential_file` -> `cli`. При установке в `env`, данные для аутентификации будут взяты из переменных окружения. При установке в `credential_file`, профиль будет взят из `~/.azure/credentials`. При установке в `cli`, данные для аутентификации будут взяты из профиля Azure CLI. `subscription_id` или переменная окружения `AZURE_SUBSCRIPTION_ID` можно использовать для идентификации идентификатора подписки, если их несколько, в противном случае используется по умолчанию az cli подписка. При установке в `msi`, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. `subscription_id` или переменная окружения `AZURE_SUBSCRIPTION_ID` можно использовать для идентификации идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка. `msi` был добавлен в Ansible 2.6.
cert_validation_mode строка добавлен в 0.0.1 azure.azcollection	Варианты: ignore validate	Управляет поведением проверки сертификатов для Azure-точек конечного доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси HTTPS или с Azure Stack, возможно, потребуется отключить это поведение, передав `ignore`. Также можно задать через профиль файла параметров или переменную окружения `AZURE_CERT_VALIDATION`.
client_id строка		ID клиента Azure. Используется при аутентификации с помощью служебного принципала.
cloud_environment строка добавлен в 0.0.1 azure.azcollection	По умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес точки конечного доступа для обнаружения метаданных (необходим для Azure Stack). Также можно задать через профиль файла параметров или переменную окружения `AZURE_CLOUD_ENVIRONMENT`.
elastic_pool_name строка		Имя эластичного пула.
name строка		Имя базы данных.
password строка		Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group строка / обязательно		Имя группы ресурсов, содержащей ресурс. Вы можете получить это значение из API Azure Resource Manager или портала.
secret строка		Секрет клиента Azure. Используется при аутентификации с помощью служебного принципала.
server_name строка / обязательно		Имя сервера.
subscription_id строка		Ваш идентификатор подписки Azure.
tags строка		Ограничьте результаты, предоставив список тегов. Форматируйте теги как 'ключ' или 'ключ:значение'.
tenant строка		ID клиента Azure. Используется при аутентификации с помощью служебного принципала.

Примечания

Примечание

Для аутентификации в 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. Также возможно добавить дополнительные профили. Укажите профиль, передав profile или установив AZURE_PROFILE в окружении.

См. также

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

Примеры

- name: Get instance of SQL Database
  azure_rm_sqldatabase_info:
    resource_group: testrg
    server_name: testserver
    name: testdb

- name: List instances of SQL Database
  azure_rm_sqldatabase_info:
    resource_group: testrg
    server_name: testserver
    elastic_pool_name: testep

- name: List instances of SQL Database
  azure_rm_sqldatabase_info:
    resource_group: testrg
    server_name: testserver

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

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

Ключевые значения			Возвращаемое значение	Описание
базы данных сложный тип			всегда	Список словарей, содержащих факты для базы данных SQL.
	сопоставление строка		всегда	Сопоставление базы данных. Пример: SQL_Latin1_General_CP1_CI_AS
	идентификатор строка		всегда	Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testrg/providers/Microsoft.Sql/servers/testserver/databases/testdb
	тип строка		всегда	Тип базы данных. Эта метаданные используются для работы с порталом Azure. Пример: v12.0,user
	местоположение строка		всегда	Местоположение ресурса. Пример: southeastasia
	название строка		всегда	Название базы данных. Пример: testdb
	sku сложный тип		всегда	Имя и уровень SKU.
		емкость целое число	всегда	Емкость SKU. Пример: 2
		название строка	всегда	Имя SKU. Пример: BC_Gen4_2
		уровень строка	всегда	Уровень SKU. Пример: BusinessCritical
	статус строка		всегда	Статус базы данных. Пример: Online
	метки словарь		всегда	Метки ресурса. Пример: {'taga': 'aaa', 'tagb': 'bbb'}
	zone_redundant булево значение		всегда	Указание о том, является ли база данных зонально избыточной, что означает, что реплики этой базы данных будут распределены по нескольким зонам доступности. Пример: True

Авторы

Zim Kalinowski (@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.10/collections/azure/azcollection/azure_rm_sqldatabase_info_module.html