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

Примечание

Этот плагин входит в коллекцию azure.azcollection (версия 1.4.0).

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

Для использования в книге задач укажите: 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 строка	Варианты: absent present ←	Состояние SQL сервера. Используйте `present` для создания или обновления сервера и `absent` для удаления сервера.
subscription_id строка		Идентификатор вашей Azure-подписки.
tags словарь		Словарь пар строка:строка для назначения метаданных объекту. Метаданные теги объекта будут обновлены предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false.
tenant строка		Идентификатор Azure-арендатора. Используется при аутентификации с помощью принципала службы.
version строка		Версия сервера. Например, `12.0`.

Примечания

Примечание

Для аутентификации с 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: 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

Авторы

Зим Калиновский (@zikalino)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_sqlserver_module.html