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

Примечание

Этот плагин является частью коллекции azure.azcollection (версия 1.3.1).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

Для использования в playbook, укажите: azure.azcollection.azure_rm_sqlserver.

Новое в версии 0.1.2: azure.azcollection

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

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

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

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user строка		Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с субъектом безопасности.
adfs_authority_url строка добавлено в 0.0.1 azure.azcollection		URL-адрес узла проверки подлинности Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и имеет собственный узел проверки подлинности ADFS.
admin_password строка		Пароль для входа администратора (требуется для создания сервера).
admin_username строка		Имя пользователя администратора для сервера. После создания его нельзя изменить.
api_profile строка добавлено в 0.0.1 azure.azcollection	Значение по умолчанию: "latest"	Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
append_tags логическое	Варианты: нет да ←	Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. Когда канонический, любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлено в 0.0.1 azure.azcollection	Варианты: авто ← cli credential_file env msi	Управляет источником учетных данных, используемых для аутентификации. Может быть также установлена через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. Когда установлено в `auto` (по умолчанию), приоритет имеет параметры модуля -> `env` -> `credential_file` -> `cli`. Когда установлено в `env`, учетные данные будут считаны из переменных среды Когда установлено в `credential_file`, профиль будет считаться из `~/.azure/credentials`. Когда установлено в `cli`, учетные данные будут получены из профиля Azure CLI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для определения идентификатора подписки, если присутствует более одного, в противном случае используется подписка az cli по умолчанию. Когда установлено в `msi`, хост-машина должна быть ресурсом Azure с включенным расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к более чем одной подписке, в противном случае выбирается первая подписка. `msi` был добавлен в Ansible 2.6.
cert_validation_mode строка добавлено в 0.0.1 azure.azcollection	Варианты: ignore validate	Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или в Azure Stack может потребоваться отключить это поведение, передав `ignore`. Может быть также установлено через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка		Идентификатор клиента Azure. Используется при аутентификации с субъектом безопасности.
cloud_environment строка добавлено в 0.0.1 azure.azcollection	Значение по умолчанию: "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 строка	Варианты: отсутствует присутствует ←	Состояние сервера SQL. Используйте `present` для создания или обновления сервера и используйте `absent` для удаления сервера.
subscription_id строка		Ваш идентификатор подписки Azure.
tags словарь		Словарь пар строка:строка для присвоения в качестве метаданных объекту. Метаданные тегов объекта будут обновлены любыми предоставленными значениями. Чтобы удалить теги, установите параметр append_tags в значение false.
tenant строка		Идентификатор клиента 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 строка	всегда	Состояние сервера. Пример: state
version строка	всегда	Версия сервера. Пример: 12.0

Авторы

Зим Калиновский (@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.10/collections/azure/azcollection/azure_rm_sqlserver_module.html