Модуль azure.azcollection.azure_rm_sqlmidatabase — Управление базами данных SQL управляемого экземпляра

Примечание

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

Требования

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

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

Параметры

Parameter	Комментарии
ad_user string	Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным субъектом безопасности.
adfs_authority_url string added in azure.azcollection 0.0.1	URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете собственный узел ADFS.
api_profile string added in azure.azcollection 0.0.1	Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. Default: `"latest"`
append_tags boolean	Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. Когда каноническое, любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта. Choices: `false` `true` ← (default)
auth_source string added in 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. Choices: `"auto"` ← (default) `"cli"` `"credential_file"` `"env"` `"msi"`
cert_validation_mode string added in azure.azcollection 0.0.1	Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси HTTPS или для Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть установлено через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`. Choices: `"ignore"` `"validate"`
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"`
collation string	Сортировка базы данных Azure SQL Managed Database для использования. Например `SQL_Latin1_General_CP1_CI_AS` или `Latin1_General_100_CS_AS_SC`.
database_name string / required	Имя базы данных экземпляра SQL, управляемой.
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`
location string	Расположение ресурса.
log_mode string	Родительский аргумент.
log_path string	Родительский аргумент.
managed_instance_name string / required	Имя экземпляра SQL, управляемого.

пароль строка	Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала.
профиль строка	Профиль безопасности, найденный в файле ~/.azure/credentials.
группа_ресурсов строка / обязательно	Имя группы ресурсов, содержащей ресурс.
секрет строка	Секрет Azure клиента. Используется при аутентификации с помощью служебного принципала.
состояние строка	Состояние SQL управляемой базы данных. Используйте `present` для создания или обновления сценария автоматизации и `absent` для удаления. Варианты: `"present"` ← (по умолчанию) `"absent"`
идентификатор_подписки строка	Ваш идентификатор подписки 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.
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 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	Имя резервной копии Long Term Retention, которая будет использоваться для восстановления этой управляемой базы данных. Возвращается: всегда
managed_instance_name string	Имя экземпляра SQL Managed Instance. Возвращается: всегда Пример: `"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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_sqlmidatabase_module.html