Модуль azure.azcollection.azure_rm_sqlmidatabase — управление базами данных SQL Managed Instance

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_sqlmidatabase.

Добавлено в azure.azcollection 2.4.0

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

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

Управление базами данных SQL Managed Instance.

Требования

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

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.
api_profile string добавлено в azure.azcollection 0.0.1	Выбирает профиль API для взаимодействия со службами Azure. Значение `latest` по умолчанию подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. По умолчанию: `"latest"`
append_tags boolean	Определяет, является ли поле тегов каноническим или дополняет существующие теги. Если поле является каноническим, все теги, отсутствующие в параметре 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"`
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"`
collation string	Параметры сортировки базы данных Azure SQL Managed Database. Например, `SQL_Latin1_General_CP1_CI_AS` или `Latin1_General_100_CS_AS_SC`.
database_name string / обязательно	Имя базы данных SQL Managed Instance.
disable_instance_discovery boolean добавлено в azure.azcollection 2.3.0	Определяет, будет ли выполняться обнаружение экземпляра при попытке аутентификации. Если задать значение true, обнаружение экземпляра и проверка центра авторизации будут полностью отключены. Эта возможность предназначена для сценариев, в которых невозможно подключиться к конечной точке метаданных, например в частных облаках или Azure Stack. Процесс обнаружения экземпляра предполагает получение метаданных центра авторизации с сайта https://login.microsoft.com/ для проверки центра авторизации. Если задать значение True, проверка центра авторизации будет отключена. Поэтому важно убедиться, что настроенный узел центра авторизации является действительным и заслуживающим доверия. Задается в профиле файла учетных данных или с помощью переменной окружения `AZURE_DISABLE_INSTANCE_DISCOVERY`. Варианты: `false` ← (по умолчанию) `true`
location string	Расположение ресурса.
log_mode string	Родительский аргумент.
log_path string	Родительский аргумент.
managed_instance_name string / обязательно	Имя экземпляра SQL Managed Instance.
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, а не субъекта-службы.
profile string	Профиль безопасности из файла ~/.azure/credentials.
resource_group string / обязательно	Имя группы ресурсов, содержащей ресурс.
secret string	Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы.
state string	Состояние базы данных SQL Managed Database. Используйте `present` для создания или обновления runbook автоматизации, а `absent` — для удаления. Варианты: `"present"` ← (по умолчанию) `"absent"`
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.
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 a SQL managed instance database
  azure_rm_sqlmidatabase:
    resource_group: testrg
    managed_instance_name: testinstancename
    database_name: newdatabase
    collation: SQL_Latin1_General_CP1_CI_AS
    location: eastus
    tags:
      key2: value2

- name: Delete the SQL managed instance database
  azure_rm_sqlmidatabase:
    resource_group: testrg
    managed_instance_name: testinstancename
    database_name: newdatabase
    state: absent

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

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

Ключ	Описание
database complex	Словарь, содержащий сведения о базе данных SQL Managed Instance. Возвращается: всегда
auto_complete_restore boolean	Следует ли автоматически завершить восстановление этой управляемой базы данных. Возвращается: всегда
catalog_collation string	Порядок сортировки каталога метаданных. Возвращается: всегда
create_date string	Дата создания базы данных. Возвращается: всегда Пример: `"2024-05-06T23:59:49.770Z"`
create_mode string	Режим создания управляемой базы данных. Возвращается: всегда
database_name string	Имя базы данных SQL MI. Возвращается: всегда Пример: `"fredtest"`
default_secondary_location string	Парный географический регион. Возвращается: всегда Пример: `"westus"`
id string	Идентификатор ресурса. Возвращается: всегда Пример: `"/subscriptions/xxx-xxxx/resourceGroups/testRG/providers/Microsoft.Sql/managedInstances/fredsqlmin/databases/fredtest"`
last_backup_name string	Имя последнего файла резервной копии для восстановления этой управляемой базы данных. Возвращается: всегда
location string	Расположение ресурса. Возвращается: всегда Пример: `"eastus"`
long_term_retention_backup_resource_id string	Имя резервной копии для долгосрочного хранения, используемой для восстановления этой управляемой базы данных. Возвращается: всегда
managed_instance_name string	Имя управляемого экземпляра SQL. Возвращается: всегда Пример: `"fredsqlmin"`
recoverable_database_id string	Идентификатор ресурса восстанавливаемой базы данных, связанной с этой базой данных. Возвращается: всегда
resource_group string	Группа ресурсов, к которой относится ресурс. Возвращается: всегда Пример: `"testRG"`
restorable_dropped_database_id string	Идентификатор ресурса удаленной базы данных, которую можно восстановить. Возвращается: всегда
restore_point_in_time string	Указывает момент времени (в формате ISO8601) для исходной базы данных. Возвращается: всегда
source_database_id string	Идентификатор ресурса исходной базы данных, связанной с операцией создания этой базы данных. Возвращается: всегда
status string	Состояние базы данных. Возвращается: всегда Пример: `"online"`
storage_container_sas_token string	Указывает токен SAS контейнера хранилища. Возвращается: всегда
storage_container_uri string	Указывает URI контейнера хранилища, в котором находятся резервные копии для этого восстановления. Возвращается: всегда
tags string	Теги ресурса Возвращается: всегда Пример: `"{'key1': 'value1'}"`
type string	Тип ресурса. Возвращается: всегда Пример: `"Microsoft.Sql/managedInstances/databases"`

Авторы

xuzhang3 (@xuzhang3)
Fred-sun (@Fred-sun)

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

© 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_sqlmidatabase_module.html