Модуль azure.azcollection.azure_rm_sqlelasticpool_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_sqlelasticpool_info.
Новое в azure.azcollection 1.14.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 | Имя пула эластичных баз данных. |
password string | Пароль пользователя Active Directory. Используйте при аутентификации с помощью пользователя Active Directory, а не субъекта безопасности. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
resource_group string / required | Имя группы ресурсов, содержащей ресурс. Вы можете получить это значение из API Azure Resource Manager или портала. |
secret string | Секретный ключ клиента Azure. Используйте при аутентификации с помощью субъекта безопасности. |
server_name string / required | Имя сервера. |
subscription_id string | Ваш идентификатор подписки Azure. |
tags list / elements=string | Ограничить результаты, указав список тегов. Формат тегов — ‘ключ’ или ‘ключ:значение’. |
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.
- Для аутентификации через принципала службы передайте 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 Elastic Pool
azure_rm_sqlelasticpool_info:
resource_group: testrg
server_name: testserver
name: testEP
- name: List instances of SQL Elastic Pool
azure_rm_sqlelasticpool_info:
resource_group: testrg
server_name: testserver
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
elastic_pool сложный | Список словарей, содержащих сведения о SQL Elastic Pool. Возвращается: всегда |
|
id строка |
Идентификатор ресурса. Возвращается: всегда Пример: |
|
license_type строка |
Тип лицензии для этого эластичного пула. Возвращается: всегда Пример: |
|
location строка |
Расположение ресурса. Возвращается: всегда Пример: |
|
maintenance_configuration_id строка |
Идентификатор конфигурации технического обслуживания, назначенный эластичному пулу. Возвращается: всегда Пример: |
|
max_size_bytes строка |
Предел хранилища для эластичного пула баз данных в байтах. Возвращается: всегда Пример: |
|
name строка |
Имя эластичного пула. Возвращается: всегда Пример: |
|
per_database_settings сложный |
Параметры для каждой базы данных в эластичном пуле. Возвращается: всегда |
|
max_capacity вещественное число |
Максимальная емкость, которую может использовать одна база данных. Возвращается: всегда Пример: |
|
min_capacity вещественное число |
Минимальная емкость, гарантированная для всех баз данных. Возвращается: всегда Пример: |
|
sku сложный |
Имя и уровень SKU. Возвращается: всегда |
|
capacity целое число |
Емкость SKU. Возвращается: всегда Пример: |
|
family строка |
Если у сервиса есть разные поколения оборудования для одного и того же SKU, то это может быть указано здесь. Возвращается: всегда Пример: |
|
name строка |
Название SKU. Возвращается: всегда Пример: |
|
size строка |
Размер конкретного SKU. Возвращается: всегда |
|
tier строка |
Уровень SKU. Возвращается: всегда Пример: |
|
tags словарь |
Теги ресурса. Возвращается: всегда Пример: |
|
zone_redundant boolean |
Является ли данная база данных зонально-избыточной, что означает, что реплики этой базы данных будут распределены по нескольким зонам доступности. Возвращаемое значение: всегда Пример: |
Ссылки на коллекцию
© 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_sqlelasticpool_info_module.html