Spec-Zone.ru › Ansible 2.11

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

Примечание

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

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

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

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

Краткое описание

  • Получение сведений об 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
строка
Идентификатор клиента 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, или выполнить вход перед запуском задач или книги задач с помощью 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

Возвращаемые значения

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

Ключ Возвращаемое значение Описание
databases
complex
всегда
Список словарей, содержащих факты для SQL базы данных.
collation
string
всегда
Кодировка базы данных.

Пример:
SQL_Latin1_General_CP1_CI_AS
id
string
всегда
Идентификатор ресурса.

Пример:
/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testrg/providers/Microsoft.Sql/servers/testserver/databases/testdb
kind
string
всегда
Тип базы данных. Эта метаданные используются для работы в портале Azure.

Пример:
v12.0,user
location
string
всегда
Расположение ресурса.

Пример:
southeastasia
name
string
всегда
Имя базы данных.

Пример:
testdb
sku
complex
всегда
Имя и уровень SKU.
capacity
integer
всегда
Емкость SKU.

Пример:
2
name
string
всегда
Имя SKU.

Пример:
BC_Gen4_2
tier
string
всегда
Уровень SKU.

Пример:
BusinessCritical
status
string
всегда
Статус базы данных.

Пример:
Online
tags
dictionary
всегда
Теги ресурса.

Пример:
{'taga': 'aaa', 'tagb': 'bbb'}
zone_redundant
boolean
всегда
Является ли база данных зонально избыточной, что означает, что реплики этой базы данных будут распределены по нескольким зонам доступности.

Пример:
True


Авторы

  • Zim Kalinowski (@zikalino)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/azure/azure_rm_sqldatabase_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API