community.azure.azure_rm_sqldatabase_facts – Получение фактов о базе данных Azure SQL

Примечание

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

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

Для использования в playbook, укажите: community.azure.azure_rm_sqldatabase_facts.

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

Описание

Получение фактов о базе данных Azure SQL.

Требования

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

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 строка		Идентификатор клиента 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 SQL Database
  community.azure.azure_rm_sqldatabase_info:
    resource_group: testrg
    server_name: testserver
    name: testdb

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

- name: List instances of SQL Database
  community.azure.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/community/azure/azure_rm_sqldatabase_facts_module.html