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

Примечание

Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные зависимости, см. Требования для получения подробностей.

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

Новый в azure.azcollection 0.1.2

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

Описание

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

Требования

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

python >= 2.7
На хосте, на котором выполняется этот модуль, должна быть установлена коллекция azure.azcollection через galaxy.
Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены через pip на хосте, на котором выполняются модули из azure.azcollection.
Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр	Комментарии
ad_user строка	Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала.
adfs_authority_url строка добавлен в azure.azcollection 0.0.1	URL-адрес авторизации Azure AD. Используется при аутентификации с именем пользователя/паролем и собственной авторизацией ADFS.
admin_password строка	Пароль учетной записи администратора SQL для сервера (требуется для создания сервера).
admin_username строка	Имя пользователя учетной записи администратора SQL для сервера. После создания его нельзя изменить.
administrators словарь добавлен в azure.azcollection 1.11.0	Идентификатор Azure Active Directory для сервера.
administrator_type строка	Тип администратора Azure AD. По умолчанию: `"ActiveDirectory"`
azure_ad_only_authentication логическое	Включена аутентификация только по Azure AD. Выбор: `false` `true`
login строка	Имя входа администратора Azure AD.
principal_type строка	Тип принципала администратора Azure AD. Выбор: `"User"` `"Group"` `"Application"`
sid строка	SID (идентификатор объекта) администратора Azure AD.
tenant_id строка	Идентификатор клиента Azure AD администратора.
api_profile строка добавлен в azure.azcollection 0.0.1	Выбирает профиль API для взаимодействия с Azure-службами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. По умолчанию: `"latest"`
append_tags логическое	Управляет тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. Выбор: `false` `true` ← (по умолчанию)
auth_source строка добавлен в azure.azcollection 0.0.1	Управляет источником учетных данных для аутентификации. Также может быть задан через переменную среды `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. Выбор: `"auto"` ← (по умолчанию) `"cli"` `"credential_file"` `"env"` `"msi"`
cert_validation_mode строка добавлен в azure.azcollection 0.0.1	Управляет поведением проверки сертификата для Azure-точек конечного доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или работе с Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть задан через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION` Выбор: `"ignore"` `"validate"`
change_admin_password логическое добавлен в azure.azcollection 1.11.0	Определяет, нужно ли обновлять admin_password для существующего сервера. Если `true`, то обновляется только пароль. Выбор: `false` ← (по умолчанию) `true`

client_id string	Идентификатор клиента Azure. Используется при аутентификации с помощью субъекта безопасности или управляемой идентичности (msi). Также может быть установлен через переменную среды `AZURE_CLIENT_ID`.
cloud_environment string added in azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть установлен через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`. Default: `"AzureCloud"`
disable_instance_discovery boolean added in azure.azcollection 2.3.0	Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку полномочий. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных полномочий из https://login.microsoft.com/ для проверки полномочий. Установив это значение в True, проверка полномочий отключается. В результате очень важно убедиться, что настроенный узел полномочий является действительным и заслуживающим доверия. Устанавливается через профиль файла учетных данных или переменную среды `AZURE_DISABLE_INSTANCE_DISCOVERY`. Choices: `false` ← (default) `true`
identity any	Указывает управляемую идентичность, которая будет использоваться с SqlServer. Если строка, тип управляемой идентичности основан на имени. Возможные значения включают `SystemAssigned` и `None`. Если словарь с ключами type, user_assigned_identities Возможные значения для type включают `SystemAssigned, C(UserAssigned`, `SystemAssigned, UserAssigned` и `None`. Возможные значения для user_assigned_identities включают словарь с id и append. Возможные значения для id - это список идентификаторов назначенных пользователю идентичностей Возможные значения для append - это логическое значение True для добавления идентификаторов или False для перезаписи новыми id. Формат строки устарел, и в дальнейшем следует использовать новый формат словаря.
location string	Расположение ресурса.
log_mode string	Родительский аргумент.
log_path string	Родительский аргумент.
minimal_tls_version string added in azure.azcollection 1.11.0	Требовать от клиентов использования указанной версии TLS. Choices: `"1.0"` `"1.1"` `"1.2"`
name string / required	Имя сервера.
password string	Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с субъектом безопасности.
primary_user_assigned_identity_id string added in azure.azcollection 2.7.0	Указывает основную назначенную пользователю управляемую идентичность для использования. Это необходимо, если вы используете тип управляемой идентичности UserAssigned
profile string	Профиль безопасности, найденный в файле ~/.azure/credentials.
public_network_access string added in azure.azcollection 1.11.0	Разрешен ли доступ к общедоступной конечной точке для сервера. Choices: `"Enabled"` `"Disabled"`
resource_group string / required	Имя группы ресурсов, содержащей ресурс. Вы можете получить это значение из API Azure Resource Manager или портала.
restrict_outbound_network-access string added in azure.azcollection 1.11.0	Ограничивать ли исходящий сетевой доступ для этого сервера. Choices: `"Enabled"` `"Disabled"`
secret string	Секретный ключ клиента Azure. Используется при аутентификации с помощью субъекта безопасности.
state string	Состояние сервера SQL. Используйте `present` для создания или обновления сервера и используйте `absent` для удаления сервера. Choices: `"absent"` `"present"` ← (default)
subscription_id string	Ваш идентификатор подписки Azure.

метки словарь	Словарь пар "строка:строка" для назначения метаданных объекту. Метаданные метки объекта будут обновлены всеми предоставленными значениями. Чтобы удалить метки, установите параметр append_tags в значение false. В настоящее время зоны Azure DNS и службы Traffic Manager также не допускают использование пробелов в метке. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 меток для ресурсов.
арендатор строка	Идентификатор арендатора Azure. Используется при аутентификации с помощью принципала службы.
отпечаток_ключа строка добавлен в azure.azcollection 1.14.0	Отпечаток частного ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью принципала службы. Требуется, если определён x509_certificate_path.
версия строка	Версия сервера. Например `12.0`.
x509_certificate_path путь добавлен в azure.azcollection 1.14.0	Путь к X509-сертификату, используемому для создания принципала службы в формате PEM. Сертификат должен быть добавлен к закрытому ключу. Используется при аутентификации с помощью принципала службы.

Примечания

Примечание

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

- name: Change SQL Server admin password
  azure_rm_sqlserver:
    resource_group: myResourceGroup
    name: server_name
    location: westus
    admin_password: NewPasswordx123!
    change_admin_password: true

- name: Create SQL Server with Azure Active Directory admin
  azure_rm_sqlserver:
    resource_group: myResourceGroup
    name: server_name
    location: westus
    admin_username: mylogin
    admin_password: Testpasswordxyz12!
    administrators:
      principal_type: Group
      login: MySqlAdminGroup
      sid: "{{ MySqlAdminGroup.object_id }}"
      tenant_id: "{{ my_tenant_id }}"
      azure_ad_only_authentication: false

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

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

Ключ	Описание
полное_доменное_имя строка	Полное доменное имя сервера. Возвращается: всегда Пример: `"sqlcrudtest-4645.database.windows.net"`
id строка	Идентификатор ресурса. Возвращается: всегда Пример: `"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/sqlcrudtest-4645"`
состояние строка	Состояние сервера. Возвращается: всегда Пример: `"state"`
версия строка	Версия сервера. Возвращается: всегда Пример: `"12.0"`

Авторы

Zim Kalinowski (@zikalino)

Ссылки на коллекцию

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