Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 3.18.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

string

Имя пользователя Active Directory. Используйте этот параметр для аутентификации с помощью пользователя Active Directory, а не субъекта-службы.

adfs_authority_url

string

добавлено в azure.azcollection 0.0.1

URL-адрес центра Azure AD. Используйте этот параметр для аутентификации по имени пользователя и паролю, если у вас есть собственный центр ADFS.

admin_password

string

Пароль учетной записи администратора SQL для сервера (обязателен при создании сервера).

admin_username

string

Имя пользователя учетной записи администратора SQL для сервера. После создания его нельзя изменить.

administrators

dictionary

добавлено в azure.azcollection 1.11.0

Идентификатор Azure Active Directory сервера.

administrator_type

string

Тип администратора Azure AD.

По умолчанию: "ActiveDirectory"

azure_ad_only_authentication

boolean

Аутентификация только через Azure AD включена.

Варианты:

  • false
  • true

login

string

Имя входа администратора Azure AD.

principal_type

string

Тип субъекта безопасности администратора Azure AD.

Варианты:

  • "User"
  • "Group"
  • "Application"

sid

string

SID (идентификатор объекта) администратора Azure AD.

tenant_id

string

Идентификатор клиента администратора Azure AD.

api_profile

string

добавлено в azure.azcollection 0.0.1

Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.

По умолчанию: "latest"

append_tags

boolean

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

Если поле является каноническим, все теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.

Варианты:

  • false
  • true ← (по умолчанию)

auth_source

string

добавлено в 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

string

добавлено в azure.azcollection 0.0.1

Управляет проверкой сертификатов для конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав ignore. Значение также можно задать в профиле файла учетных данных или с помощью переменной среды AZURE_CERT_VALIDATION.

Варианты:

  • "ignore"
  • "validate"

change_admin_password

boolean

добавлено в azure.azcollection 1.11.0

Следует ли обновить admin_password для существующего сервера. Если true, будет обновлено только значение пароля.

Варианты:

  • false ← (по умолчанию)
  • true

client_id

string

Идентификатор клиента Azure. Используйте для аутентификации с помощью субъекта-службы или управляемого удостоверения (msi).

Также можно задать с помощью переменной среды AZURE_CLIENT_ID.

cloud_environment

string

добавлено в azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, укажите имя среды (согласно Azure Python SDK, например AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (обязателен для Azure Stack). Значение также можно задать в профиле файла учетных данных или с помощью переменной среды AZURE_CLOUD_ENVIRONMENT.

По умолчанию: "AzureCloud"

disable_instance_discovery

boolean

добавлено в azure.azcollection 2.3.0

Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Установка значения true полностью отключает обнаружение экземпляра и проверку центра. Эта функция предназначена для сценариев, в которых невозможно связаться с конечной точкой метаданных, например в частных облаках или Azure Stack. Обнаружение экземпляра включает получение метаданных центра с сайта https://login.microsoft.com/ для проверки центра. Если задать значение **True**, проверка центра отключается. Поэтому крайне важно убедиться, что настроенный узел центра является допустимым и заслуживающим доверия.

Значение задается в профиле файла учетных данных или с помощью переменной среды AZURE_DISABLE_INSTANCE_DISCOVERY.

Варианты:

  • false ← (по умолчанию)
  • 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

добавлено в azure.azcollection 1.11.0

Требует от клиентов использования указанной версии TLS.

Варианты:

  • "1.0"
  • "1.1"
  • "1.2"

name

string / обязательный

Имя сервера.

oidc_token

string

добавлено в azure.azcollection 3.17.0

Токен OpenID Connect (OIDC) (JWT), непосредственно используемый для аутентификации рабочей нагрузки.

Этот токен обменивается в Azure AD с помощью федеративного удостоверения OIDC.

Полезен в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC.

Также можно задать с помощью переменной среды AZURE_FEDERATED_TOKEN.

oidc_token_file_path

path

добавлено в azure.azcollection 3.17.0

Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации рабочей нагрузки.

Файл должен содержать только необработанный токен.

Этот способ часто используется на платформах, которые сохраняют токены OIDC в виде файлов.

Также можно задать с помощью переменной среды AZURE_FEDERATED_TOKEN_FILE.

password

string

Пароль пользователя Active Directory. Используйте этот параметр для аутентификации с помощью пользователя Active Directory, а не субъекта-службы.

primary_user_assigned_identity_id

string

добавлено в azure.azcollection 2.7.0

Указывает основное удостоверение, назначенное пользователем.

Этот параметр обязателен при использовании типа управляемого удостоверения UserAssigned.

profile

string

Профиль безопасности из файла ~/.azure/credentials.

public_network_access

string

добавлено в azure.azcollection 1.11.0

Разрешен ли доступ к серверу через общедоступную конечную точку.

Варианты:

  • "Enabled"
  • "Disabled"

resource_group

string / обязательный

Имя группы ресурсов, содержащей ресурс. Это значение можно получить через API Azure Resource Manager или на портале.

restrict_outbound_network_access

string

добавлено в azure.azcollection 1.11.0

Следует ли ограничить исходящий сетевой доступ для этого сервера.

Варианты:

  • "Enabled"
  • "Disabled"

secret

string

Секрет клиента Azure. Используйте для аутентификации с помощью субъекта-службы.

state

string

Состояние сервера SQL. Используйте present для создания или обновления сервера и absent для его удаления.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)

subscription_id

string

Идентификатор вашей подписки Azure.

tags

dictionary

Словарь пар строка:строка, назначаемых объекту в качестве метаданных.

Метаданные тегов объекта будут обновлены с учетом всех предоставленных значений.

Чтобы удалить теги, установите для параметра append_tags значение false.

В настоящее время зоны Azure DNS и службы Traffic Manager также не допускают пробелы в тегах.

Azure Front Door не поддерживает использование

Azure Automation и Azure CDN поддерживают не более 15 тегов для ресурсов.

tenant

string

Идентификатор клиента Azure. Используйте для аутентификации с помощью субъекта-службы.

thumbprint

string

добавлено в azure.azcollection 1.14.0

Отпечаток закрытого ключа, указанного в x509_certificate_path.

Используйте для аутентификации с помощью субъекта-службы.

Обязателен, если задан x509_certificate_path.

version

string

Версия сервера. Например, 12.0.

x509_certificate_path

path

добавлено в azure.azcollection 1.14.0

Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы.

Закрытый ключ должен быть добавлен после сертификата.

Используйте для аутентификации с помощью субъекта-службы.

Примечания

Примечание

  • Для аутентификации в Azure можно передать параметры, задать переменные среды, использовать профиль из ~/.azure/credentials или выполнить вход перед запуском задач или плейбука с помощью az login.
  • Также можно пройти аутентификацию с помощью субъекта-службы или пользователя Active Directory.
  • Для аутентификации через OIDC передайте client_id, tenant и oidc_token либо oidc_token_file_path или задайте переменные среды AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN либо AZURE_FEDERATED_TOKEN_FILE.
  • Для аутентификации с помощью субъекта-службы передайте 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: "{{ password }}"

- name: Change SQL Server admin password
  azure_rm_sqlserver:
    resource_group: myResourceGroup
    name: server_name
    location: westus
    admin_password: "{{ password }}"
    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: "{{ password }}"
    administrators:
      principal_type: Group
      login: MySqlAdminGroup
      sid: "{{ MySqlAdminGroup.object_id }}"
      tenant_id: "{{ my_tenant_id }}"
      azure_ad_only_authentication: false

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

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

Ключ

Описание

fully_qualified_domain_name

string

Полное доменное имя сервера.

Возвращается: всегда

Пример: "sqlcrudtest-4645.database.windows.net"

id

string

Идентификатор ресурса.

Возвращается: всегда

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/sqlcrudtest-4645"

state

string

Состояние сервера.

Возвращается: всегда

Пример: "state"

version

string

Версия сервера.

Возвращается: всегда

Пример: "12.0"

Авторы

  • Zim Kalinowski (@zikalino)

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

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API