Модуль azure.azcollection.azure_rm_sqlmidatabase_info — Получение фактов о базе данных Azure SQL управляемого экземпляра

Примечание

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

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

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

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

Новая функция в azure.azcollection 2.4.0

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

Описание

Получение фактов о базе данных Azure SQL управляемого экземпляра.

Требования

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

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 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"`
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. Варианты: `"auto"` ← (по умолчанию) `"cli"` `"credential_file"` `"env"` `"msi"`
cert_validation_mode string added in 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 added in azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть установлен с помощью профиля файла учетных данных или переменной среды `AZURE_CLOUD_ENVIRONMENT`. Default: `"AzureCloud"`
database_name string	Имя базы данных управляемого экземпляра SQL.
disable_instance_discovery boolean added in azure.azcollection 2.3.0	Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных центра проверки подлинности с https://login.microsoft.com/ для проверки центра проверки подлинности. Установив это значение в True, проверка центра проверки подлинности отключается. В результате очень важно убедиться, что настроенный узел центра проверки подлинности является действительным и заслуживающим доверия. Устанавливается с помощью профиля файла учетных данных или переменной среды `AZURE_DISABLE_INSTANCE_DISCOVERY`. Варианты: `false` ← (по умолчанию) `true`
log_mode string	Родительский аргумент.
log_path string	Родительский аргумент.
managed_instance_name string / required	Имя управляемого экземпляра SQL.
password string	Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным субъектом безопасности.
profile string	Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group string / required	Имя группы ресурсов, содержащей ресурс.
secret string	Секретный ключ клиента Azure. Используйте при аутентификации с помощью субъекта безопасности.

subscription_id string	Ваш идентификатор подписки Azure.
tags list / elements=string	Ограничить результаты, предоставив список тегов. Форматируйте теги как 'ключ' или 'ключ:значение'.
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.
Для аутентификации через служебного принципала передайте 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: Get SQL managed instance database by name
  azure_rm_sqlmidatabase_info:
    resource_group: testrg
    managed_instance_name: testinstancename
    database_name: newdatabase

Значения возврата

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

Ключ	Описание
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 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_info_module.html