azure_rm_sqlserver_facts – Получение фактов о SQL Server
Новая версия 2.5.
Краткое описание
- Получение фактов о SQL Server.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не сервисного принципала. | |
| adfs_authority_url строка добавлено в 2.6 | URL-адрес службы Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственной службой ADFS. | |
| api_profile строка добавлено в 2.5 | По умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. |
| append_tags логическое значение |
| Управляет тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. Если каноническое, любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. |
| auth_source строка добавлено в 2.5 |
| Управляет источником учетных данных для аутентификации. Если не указано, будет использоваться переменная среды ANSIBLE_AZURE_AUTH_SOURCE и по умолчанию будет auto если переменная не определена.auto будет следовать стандартному приоритету параметров модуля -> переменные среды -> профиль по умолчанию в файле учетных данных ~/.azure/credentials.При значении cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.Также можно задать через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.При значении msi, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID может использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка.msi была добавлена в Ansible 2.6. |
| cert_validation_mode строка добавлено в 2.5 |
| Управляет поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси-сервера HTTPS или подключении к Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. |
| client_id строка | Идентификатор клиента Azure. Используется при аутентификации с помощью сервисного принципала. | |
| cloud_environment строка добавлено в 2.4 | По умолчанию: "AzureCloud" | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес точки входа обнаружения метаданных (требуется для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT. |
| password - | Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не сервисного принципала. | |
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| resource_group - / обязательно | Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала. | |
| secret строка | Секретный ключ клиента Azure. Используется при аутентификации с помощью сервисного принципала. | |
| server_name - | Имя сервера. | |
| subscription_id строка | Идентификатор вашей подписки Azure. | |
| tags словарь | Словарь пар строка:строка для присвоения метаданных объекту. Метаданные теги объекта будут обновлены с предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false. | |
| 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 Server
azure_rm_sqlserver_facts:
resource_group: myResourceGroup
server_name: server_name
- name: List instances of SQL Server
azure_rm_sqlserver_facts:
resource_group: myResourceGroup
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| servers сложный | всегда | Список словарей результатов, где ключ — имя SQL-сервера, а значения — факты для этого SQL-сервера. | ||
| sqlserver_name сложный | Ключ — имя сервера, к которому относятся значения. | |||
| fully_qualified_domain_name строка | всегда | Полное доменное имя сервера. Пример: fully_qualified_domain_name | ||
| id строка | всегда | Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/sqlcrudtest-4645 | ||
| kind строка | всегда | Тип SQL-сервера. Это метаданные, используемые для интерфейса портала Azure. Пример: v12.0 | ||
| location строка | всегда | Расположение ресурса. Пример: japaneast | ||
| name строка | всегда | Имя ресурса. Пример: sqlcrudtest-4645 | ||
| state строка | всегда | Состояние сервера. Пример: Готово | ||
| type строка | всегда | Тип ресурса. Пример: Microsoft.Sql/servers | ||
| version строка | всегда | Версия сервера. Пример: 12.0 | ||
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.8/modules/azure_rm_sqlserver_facts_module.html
