azure_rm_sqlserver_facts — Получение фактов о SQL Server.
Новая версия 2.5.
Описание
- Получение фактов о SQL Server.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user | Значение по умолчанию: None | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо сервисного принципала. |
| api_profile (добавлено в 2.5) |
| Выбирает профиль API для использования при общении с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. |
| auth_source (добавлено в 2.5) |
| Управление источником учетных данных для аутентификации. auto будет следовать по умолчанию приоритету параметров модуля -> переменных среды -> профиля по умолчанию в файле учетных данных ~/.azure/credentials. При установке значения cli, учетные данные будут получены из профиля Azure CLI по умолчанию.Также может быть установлено через переменную среды ANSIBLE_AZURE_AUTH_SOURCE. |
| cert_validation_mode (добавлено в 2.5) |
None | Управление поведением проверки сертификатов для Azure-точек конечного доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или при подключении к Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть задано через профиль в файле учетных данных или через переменную среды AZURE_CERT_VALIDATION. |
| client_id | Значение по умолчанию: None | Идентификатор клиента Azure. Используется при аутентификации с помощью сервисного принципала. |
| cloud_environment (добавлено в 2.4) | Значение по умолчанию: AzureCloud | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес точки конечного доступа для обнаружения метаданных (требуется для Azure Stack). Также может быть задано через профиль в файле учетных данных или через переменную среды AZURE_CLOUD_ENVIRONMENT. |
| password | Значение по умолчанию: None | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо сервисного принципала. |
| profile | Значение по умолчанию: None | Профиль безопасности, найденный в файле ~/.azure/credentials. |
| resource_group обязательно | Имя группы ресурсов, содержащей ресурс. Вы можете получить это значение из API Azure Resource Manager или портала. | |
| secret | Значение по умолчанию: None | Секрет клиента Azure. Используется при аутентификации с помощью сервисного принципала. |
| server_name | Имя сервера. | |
| subscription_id | Значение по умолчанию: None | Ваш идентификатор подписки Azure. |
| tenant | Значение по умолчанию: None | Идентификатор клиента Azure. Используется при аутентификации с помощью сервисного принципала. |
Примечания
Примечание
- Для аутентификации с Azure вы можете передать параметры, установить переменные среды или использовать профиль, хранящийся в ~/.azure/credentials. Аутентификация возможна с помощью сервисного принципала или пользователя 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 в среде.
Примеры
- name: Get instance of SQL Server
azure_rm_sqlserver_facts:
resource_group: resource_group_name
server_name: server_name
- name: List instances of SQL Server
azure_rm_sqlserver_facts:
resource_group: resource_group_name
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращаемое | Описание | ||
|---|---|---|---|---|
| servers сложный | всегда | Список результатов словарей, где ключ — имя SQL Server, а значения — факты для этого SQL Server. | ||
| sqlserver_name сложный | Ключ — имя сервера, к которому относятся значения. | |||
| kind str | всегда | Тип SQL Server. Это метаданные, используемые для работы с порталом Azure. Пример: v12.0 | ||
| name str | всегда | Имя ресурса. Пример: sqlcrudtest-4645 | ||
| state str | всегда | Состояние сервера. Пример: Ready | ||
| version str | всегда | Версия сервера. Пример: 12.0 | ||
| location str | всегда | Расположение ресурса. Пример: japaneast | ||
| fully_qualified_domain_name str | всегда | Полное доменное имя сервера. Пример: fully_qualified_domain_name | ||
| type str | всегда | Тип ресурса. Пример: Microsoft.Sql/servers | ||
| id str | всегда | Идентификатор ресурса. Пример: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645 | ||
Статус
Этот модуль помечен как предварительный, что означает, что его интерфейс не гарантированно будет обратной совместимостью.
Автор
- 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.5/modules/azure_rm_sqlserver_facts_module.html
