azure_rm_sqlserver – Управление экземпляром SQL Server

Новое в версии 2.5.

Краткое описание
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения
Статус

Краткое описание

Создание, обновление и удаление экземпляра SQL Server

Требования

Ниже указаны требования к хосту, на котором выполняется этот модуль.

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user string		Имя пользователя Active Directory. Используйте при аутентификации с помощью пользователя Active Directory, а не субъекта безопасности.
adfs_authority_url string добавлено в 2.6		URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете собственный узел ADFS.
admin_password -		Пароль для входа администратора (требуется для создания сервера).
admin_username -		Имя пользователя администратора для сервера. После создания его нельзя изменить.
api_profile string добавлено в 2.5	Значение по умолчанию: "latest"	Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
append_tags boolean	Варианты: no yes ←	Используйте для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. Когда канонический, любые теги, которые не найдены в параметре тегов, будут удалены из метаданных объекта.
auth_source string добавлено в 2.5	Варианты: auto cli credential_file env msi	Управляет источником учетных данных для аутентификации. Если не указано, будет использоваться переменная среды 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 string добавлено в 2.5	Варианты: ignore validate	Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но когда используется прокси HTTPS или для Azure Stack, может потребоваться отключить это поведение, передав `ignore`. Также может быть установлено через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id string		Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности.
cloud_environment string добавлено в 2.4	Значение по умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть установлено через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
identity -		Тип удостоверения. Установите это значение в 'SystemAssigned', чтобы автоматически создать и назначить субъект Azure Active Directory для ресурса. Возможные значения включают: 'SystemAssigned'
location -		Расположение ресурса.
name - / required		Имя сервера.
password -		Пароль пользователя Active Directory. Используйте при аутентификации с помощью пользователя Active Directory, а не субъекта безопасности.
profile string		Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group - / required		Имя группы ресурсов, содержащей ресурс. Вы можете получить это значение из API Azure Resource Manager или портала.
secret string		Секретный ключ клиента Azure. Используйте при аутентификации с помощью субъекта безопасности.
state -	Варианты: absent present ←	Утверждает состояние сервера SQL. Используйте `present` для создания или обновления сервера и `absent` для удаления сервера.
subscription_id string		Ваш идентификатор подписки Azure.
tags dictionary		Словарь пар string:string для назначения в качестве метаданных объекту. Метаданные тегов объекта будут обновлены любыми предоставленными значениями. Чтобы удалить теги, установите для параметра append_tags значение false.
tenant string		Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности.
version -		Версия сервера. Например, '12.0'.

Примечания

Примечание

Для аутентификации с Azure вы можете передавать параметры, устанавливать переменные среды, использовать профиль, хранящийся в ~/.azure/credentials, или войти в систему перед выполнением задач или playbook с помощью 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: Create (or update) SQL Server
  azure_rm_sqlserver:
    resource_group: myResourceGroup
    name: server_name
    location: westus
    admin_username: mylogin
    admin_password: Testpasswordxyz12!

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
fully_qualified_domain_name строка	всегда	Полное доменное имя сервера. Пример: sqlcrudtest-4645.database.windows.net
id строка	всегда	Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/sqlcrudtest-4645
state строка	всегда	Состояние сервера. Пример: состояние
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_module.html