Модуль azure.azcollection.azure_rm_sqlmanagedinstance_info – Получение фактов о управляемых экземплярах Azure SQL
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования, см. Требования для подробностей.
Для использования в playbook, укажите: azure.azcollection.azure_rm_sqlmanagedinstance_info.
Введено в azure.azcollection 0.15.0
Описание
- Получение фактов о управляемых экземплярах Azure SQL.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- На хосте, который выполняет данный модуль, должна быть установлена коллекция azure.azcollection через galaxy
- Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены через pip на хосте, на котором выполняются модули из azure.azcollection
- Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection
Параметры
Параметр | Комментарии |
|---|---|
ad_user string | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности. |
adfs_authority_url string added in azure.azcollection 0.0.1 | URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете собственный узел ADFS. |
api_profile string added in azure.azcollection 0.0.1 | Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию Default: |
auth_source string added in azure.azcollection 0.0.1 | Управляет источником учетных данных для аутентификации. Также может быть установлен через переменную среды При установке в При установке в При установке в При установке в При установке в
Варианты:
|
cert_validation_mode string added in azure.azcollection 0.0.1 | Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси HTTPS или в Azure Stack может потребоваться отключить это поведение, передав Варианты:
|
client_id string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентификации (msi). Также может быть установлен через переменную среды |
cloud_environment string added in azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, Default: |
disable_instance_discovery boolean added in azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого параметра в true полностью отключит как обнаружение экземпляров, так и проверку полномочий. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных полномочий из https://login.microsoft.com/ для проверки полномочий. Установив это значение в **True**, проверка полномочий отключается. В результате крайне важно убедиться, что настроенный узел полномочий действителен и заслуживает доверия. Устанавливается через профиль файла учетных данных или переменную среды Варианты:
|
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string | Имя управляемого экземпляра SQL. |
password string | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
resource_group string | Имя группы ресурсов, содержащей ресурс. |
secret string | Секретный ключ клиента Azure. Используйте при аутентификации с помощью субъекта безопасности. |
subscription_id string | Ваш идентификатор подписки Azure. |
Теги список / элементы=строка | Ограничить результаты, указав список тегов. Формат тегов — ‘ключ’ или ‘ключ:значение’. |
арендатор строка | Идентификатор арендатора Azure. Используется при аутентификации с помощью Служебного принципала. |
отпечаток строка добавлен в azure.azcollection 1.14.0 | Отпечаток цифровой подписи закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью Служебного принципала. Требуется, если определен параметр x509_certificate_path. |
путь_к_сертификату_x509 путь добавлен в azure.azcollection 1.14.0 | Путь к X509-сертификату, используемому для создания служебного принципала в формате PEM. Сертификат должен быть добавлен к закрытому ключу. Используется при аутентификации с помощью Служебного принципала. |
Примечания
Примечание
- Для аутентификации в 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 SQL managed instance by name
azure_rm_sqlmanagedinstance_info:
resource_group: testrg
name: testinstancename
- name: List SQL managed instance by resource group
azure_rm_sqlmanagedinstance_info:
resource_group: testrg
- name: List SQL managed instance by subscription and filter by tags
azure_rm_sqlmanagedinstance_info:
tags:
- foo
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
sql_managed_instance complex | Список словарей, содержащих факты для управляемого экземпляра SQL. Возвращается: всегда |
|
administrator_login string |
Имя пользователя администратора для управляемого экземпляра. Возвращается: всегда Пример: |
|
administrators string |
Администратор Azure Active Directory сервера. Возвращается: всегда |
|
collation string |
Сортировка управляемого экземпляра SQL. Возвращается: всегда Пример: |
|
dns_zone string |
- Зона DNS, в которой находится управляемый экземпляр. Возвращается: всегда Пример: |
|
dns_zone_partner string |
Идентификатор ресурса другого управляемого экземпляра, зону DNS которого будет использовать этот управляемый экземпляр после создания. Возвращается: всегда |
|
fully_qualified_domain_name string |
Полностью квалифицированное доменное имя управляемого экземпляра. Возвращается: всегда Пример: |
|
id string |
Идентификатор ресурса. Возвращается: всегда Пример: |
|
identity complex |
Конфигурация удостоверения Azure Active Directory для ресурса. Возвращается: всегда |
|
principal_id string |
Идентификатор субъекта Azure Active Directory. Возвращается: всегда Пример: |
|
tenant_id string |
Идентификатор клиента Azure Active Directory. Возвращается: всегда Пример: |
|
type string |
Тип удостоверения. Возвращается: всегда Пример: |
|
user_assigned_identities string |
Идентификаторы ресурсов назначенных пользователем удостоверений для использования. Возвращается: всегда |
|
instance_pool_id string |
Идентификатор пула экземпляров, которому принадлежит этот управляемый сервер. Возвращается: всегда |
|
key_id string |
URI ключа CMK для использования при шифровании. Возвращается: всегда |
|
license_type string |
Тип лицензии. Возвращается: всегда Пример: |
|
location string |
Расположение ресурса. Возвращается: всегда Пример: |
|
maintenance_configuration_id string |
Указывает идентификатор конфигурации обслуживания, который необходимо применить к этому управляемому экземпляру. Возвращается: всегда Пример: |
|
managed_instance_create_mode string |
Указывает режим создания базы данных. Возвращается: всегда |
|
minimal_tls_version string |
Минимальная версия TLS. Допустимые значения «None», «1.0», «1.1», «1.2». Возвращается: всегда Пример: |
|
name string |
Имя управляемого экземпляра SQL. Возвращается: всегда Пример: |
|
primary_user_assigned_identity_id string |
Идентификатор ресурса назначенной пользователем идентификации, которая будет использоваться по умолчанию. Возвращается: всегда |
|
private_endpoint_connections list / elements=string |
Список подключений частной конечной точки к управляемому экземпляру. Возвращается: всегда Пример: |
|
provisioning_state string |
Статус управляемого экземпляра SQL. Возвращается: всегда Пример: |
|
proxy_override string |
Тип соединения, используемый для подключения к экземпляру. Возвращается: всегда Пример: |
|
public_data_endpoint_enabled boolean |
Включена ли общедоступная конечная точка данных. Возвращается: всегда Пример: |
|
restore_point_in_time string |
Указывает момент времени (формат ISO8601) исходной базы данных, которая будет восстановлена для создания новой базы данных. Возвращается: всегда |
|
sku complex |
ARM Resource SKU. Возвращается: всегда |
|
capacity integer |
Пропускная способность SKU. Возвращается: всегда Пример: |
|
family string |
Если у службы есть разные поколения оборудования для одного и того же SKU, это можно указать здесь. Возвращается: всегда Пример: |
|
name string |
Название SKU. Возвращается: всегда Пример: |
|
size string |
Размер конкретного SKU. Возвращается: всегда |
|
tier string |
Уровень SKU. Возвращается: всегда Пример: |
|
source_managed_instance_id string |
Идентификатор ресурса исходного управляемого экземпляра, связанного с операцией создания этого экземпляра. Возвращается: всегда |
|
состояние строка |
Состояние управляемого экземпляра. Возвращается: всегда Пример: |
|
тип_хранилища строка |
Тип хранилища, используемого для хранения резервных копий этого экземпляра. Возвращается: всегда Пример: |
|
размер_хранилища_в_гб целое число |
Размер хранилища в ГБ. Минимальное значение 32. Максимальное значение 8192. Возвращается: всегда Пример: |
|
идентификатор_подсети строка |
Идентификатор ресурса подсети для управляемого экземпляра. Возвращается: всегда Пример: |
|
теги словарь |
Теги ресурса. Возвращается: всегда Пример: |
|
идентификатор_временной_зоны строка |
Идентификатор временной зоны. Допустимые значения — поддерживаемые Windows временные зоны. Возвращается: всегда Пример: |
|
тип строка |
Тип управляемого экземпляра SQL. Возвращается: всегда Пример: |
|
v_ядра целое число |
Количество vCores. Допустимые значения 8, 16, 24, 32, 40, 64, 80. Возвращается: всегда Пример: |
|
зонально_избыточность логический |
Включена ли многозонная доступность. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_sqlmanagedinstance_info_module.html