Модуль azure.azcollection.azure_rm_sqlmanagedinstance_info — получение сведений об управляемом экземпляре Azure SQL
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: 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 добавлено в azure.azcollection 0.0.1 | URL-адрес центра Azure AD. Используется при аутентификации по имени пользователя и паролю, если у вас собственный центр ADFS. |
api_profile string добавлено в azure.azcollection 0.0.1 | Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию По умолчанию: |
auth_source string добавлено в azure.azcollection 0.0.1 | Определяет источник учетных данных для аутентификации. Также можно задать с помощью переменной среды Если задано значение Если задано значение Если задано значение Если задано значение Если задано значение Параметр Варианты:
|
cert_validation_mode string добавлено в azure.azcollection 0.0.1 | Управляет проверкой сертификатов конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании HTTPS-прокси или Azure Stack эту проверку может потребоваться отключить, передав Варианты:
|
client_id string | Идентификатор клиента Azure. Используется при аутентификации с помощью субъекта-службы или управляемого удостоверения (msi). Также можно задать с помощью переменной среды |
cloud_environment string добавлено в azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, — имя среды (согласно определению в Azure Python SDK, например, По умолчанию: |
disable_instance_discovery boolean добавлено в azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Если задать значение true, обнаружение экземпляра и проверка центра будут полностью отключены. Эта функция предназначена для сценариев, в которых невозможно обратиться к конечной точке метаданных, например в частных облаках или Azure Stack. При обнаружении экземпляра метаданные центра извлекаются с сайта https://login.microsoft.com/ для проверки центра. Если задать значение **True**, проверка центра будет отключена. Поэтому крайне важно убедиться в достоверности и надежности настроенного узла центра. Задается в профиле файла учетных данных или с помощью переменной среды Варианты:
|
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string | Имя управляемого экземпляра SQL. |
oidc_token string добавлено в azure.azcollection 3.17.0 | Прямой токен OpenID Connect (OIDC) (JWT), используемый для аутентификации по идентификатору рабочей нагрузки. Этот токен обменивается с Azure AD посредством федеративного удостоверения OIDC. Полезен в системах CI (например, GitHub Actions и Azure DevOps), где платформа напрямую предоставляет токен OIDC. Также можно задать с помощью переменной среды |
oidc_token_file_path path добавлено в azure.azcollection 3.17.0 | Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации по идентификатору рабочей нагрузки. Файл должен содержать только необработанный токен. Этот способ часто используется на платформах, которые сохраняют токены OIDC в файлах. Также можно задать с помощью переменной среды |
password string | Пароль пользователя Active Directory. Используется для аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
profile string | Профиль безопасности из файла ~/.azure/credentials. |
resource_group string | Имя группы ресурсов, содержащей ресурс. |
secret string | Секрет клиента Azure. Используется при аутентификации с помощью субъекта-службы. |
subscription_id string | Идентификатор вашей подписки Azure. |
tags list / элементы=string | Ограничивает результаты с помощью списка тегов. Задавайте теги в формате «key» или «key:value». |
tenant string | Идентификатор клиента Azure. Используется при аутентификации с помощью субъекта-службы. |
thumbprint string добавлено в azure.azcollection 1.14.0 | Отпечаток закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью субъекта-службы. Обязателен, если задан x509_certificate_path. |
x509_certificate_path path добавлено в azure.azcollection 1.14.0 | Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы. Сертификат должен быть добавлен в конец файла закрытого ключа. Используется при аутентификации с помощью субъекта-службы. |
Примечания
Примечание
- Для аутентификации в Azure можно передать параметры, задать переменные среды, использовать профиль, сохраненный в ~/.azure/credentials, или войти в систему до выполнения задач или плейбука с помощью
az login. - Также возможна аутентификация с помощью субъекта-службы или пользователя Active Directory.
- Для аутентификации через OIDC передайте client_id, tenant и oidc_token или oidc_token_file_path либо задайте переменные среды AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN или AZURE_FEDERATED_TOKEN_FILE.
- Для аутентификации с помощью субъекта-службы передайте 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 / элементы=string |
Список подключений к частным конечным точкам управляемого экземпляра. Возвращается: всегда Пример: |
|
provisioning_state string |
Состояние управляемого экземпляра SQL. Возвращается: всегда Пример: |
|
proxy_override string |
Тип подключения для соединения с экземпляром. Возвращается: всегда Пример: |
|
public_data_endpoint_enabled boolean |
Указывает, включена ли общедоступная конечная точка данных. Возвращается: всегда Пример: |
|
restore_point_in_time string |
Указывает момент времени (в формате ISO8601) для исходной базы данных, на который она будет восстановлена при создании новой базы данных. Возвращается: всегда |
|
sku complex |
Артикул ресурса ARM. Возвращается: всегда |
|
capacity integer |
Емкость артикула. Возвращается: всегда Пример: |
|
family string |
Если в службе представлены разные поколения оборудования для одного артикула, эта информация указывается здесь. Возвращается: всегда Пример: |
|
name string |
Название артикула. Возвращается: всегда Пример: |
|
size string |
Размер конкретного артикула. Возвращается: всегда |
|
tier string |
Уровень артикула. Возвращается: всегда Пример: |
|
source_managed_instance_id string |
Идентификатор ресурса исходного управляемого экземпляра, связанного с операцией создания этого экземпляра. Возвращается: всегда |
|
state string |
Состояние управляемого экземпляра. Возвращается: всегда Пример: |
|
storage_account_type string |
Тип учетной записи хранения, используемой для хранения резервных копий этого экземпляра. Возвращается: всегда Пример: |
|
storage_size_in_gb integer |
Объем хранилища в ГБ. Минимальное значение — 32. Максимальное значение — 8192. Возвращается: всегда Пример: |
|
subnet_id string |
Идентификатор ресурса подсети для управляемого экземпляра. Возвращается: всегда Пример: |
|
tags dictionary |
Теги ресурса. Возвращается: всегда Пример: |
|
timezone_id string |
Идентификатор часового пояса. Допустимые значения — часовые пояса, поддерживаемые Windows. Возвращается: всегда Пример: |
|
type string |
Тип управляемого экземпляра SQL. Возвращается: всегда Пример: |
|
v_cores integer |
Количество виртуальных ядер (vCore). Допустимые значения: 8, 16, 24, 32, 40, 64, 80. Возвращается: всегда Пример: |
|
zone_redundant boolean |
Указывает, включен ли режим с несколькими зонами доступности. Возвращается: всегда Пример: |
Ссылки коллекции
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/azure/azcollection/azure_rm_sqlmanagedinstance_info_module.html