azure_rm_sqlserver - Управление экземпляром SQL Server
Новое в версии 2.5.
Обзор
- Создание, обновление и удаление экземпляра SQL Server
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом. | |
| adfs_authority_url (добавлено в 2.6) | По умолчанию: null | URL-адрес авторизации Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственной авторизацией ADFS. |
| admin_password | Пароль администратора (необходим для создания сервера). | |
| admin_username | Имя пользователя администратора для сервера. После создания его нельзя изменить. | |
| api_profile (добавлено в 2.5) | По умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят работать с Azure Stack. |
| append_tags bool |
| Управляет тем, является ли поле тегов каноническим или оно просто добавляет к существующим тегам. Если каноническое, любые теги, отсутствующие в параметре 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. |
| identity | Тип идентификатора. Установите значение 'SystemAssigned', чтобы автоматически создать и назначить главный элемент Azure Active Directory для ресурса. Возможные значения включают: 'SystemAssigned' | |
| location | Расположение ресурса. | |
| name обязательно | Имя сервера. | |
| password | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом. | |
| profile | Профиль безопасности, находящийся в файле ~/.azure/credentials. | |
| resource_group обязательно | Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала. | |
| secret | Секрет Azure-клиента. Используется при аутентификации с сервисным принципалом. | |
| state (добавлено в 2.6) |
| Утверждает состояние SQL-сервера. Используйте 'present' для создания или обновления сервера и 'absent' для удаления сервера. |
| subscription_id | Идентификатор вашей подписки Azure. | |
| tags | Словарь пар строка:строка для назначения метаданных объекту. Метаданные теги объекта будут обновлены с любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в false. | |
| tenant | Идентификатор Azure-тенанта. Используется при аутентификации с сервисным принципалом. | |
| version | Версия сервера. Например, '12.0'. |
Примечания
Примечание
- Для аутентификации с 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: Create (or update) SQL Server
azure_rm_sqlserver:
resource_group: resource_group
name: server_name
location: westus
admin_username: mylogin
admin_password: Testpasswordxyz12!
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| fully_qualified_domain_name str | всегда | Полное доменное имя сервера. Пример: sqlcrudtest-4645.database.windows.net |
| id str | всегда | Идентификатор ресурса. Пример: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645 |
| state str | всегда | Состояние сервера. Пример: state |
| version str | всегда | Версия сервера. Пример: 12.0 |
Статус
Этот модуль помечен как экспериментальный, что означает, что его интерфейс не гарантированно будет обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как сообщественный, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/azure_rm_sqlserver_module.html
