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

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_sqlmidbshorttermretentionpolicy_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 строка	Имя пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы.
adfs_authority_url строка добавлено в azure.azcollection 0.0.1	URL-адрес центра полномочий Azure AD. Используйте при аутентификации с помощью имени пользователя и пароля, если у вас есть собственный центр полномочий ADFS.
api_profile строка добавлено в azure.azcollection 0.0.1	Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию `latest` подходит для общедоступных облаков; в будущем другие значения позволят использовать Azure Stack. По умолчанию: `"latest"`
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"`
client_id строка	Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы или управляемого удостоверения (msi). Также можно задать с помощью переменной среды `AZURE_CLIENT_ID`.
cloud_environment строка добавлено в azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США, укажите имя среды (согласно определению в Azure Python SDK, например `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес конечной точки обнаружения метаданных (обязательно для Azure Stack). Значение также можно задать в профиле файла учетных данных или с помощью переменной среды `AZURE_CLOUD_ENVIRONMENT`. По умолчанию: `"AzureCloud"`
database_name строка / обязательный	Имя базы данных управляемого экземпляра SQL.
disable_instance_discovery логический добавлено в azure.azcollection 2.3.0	Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Если задать значение true, обнаружение экземпляра и проверка центра полномочий будут полностью отключены. Эта возможность предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например в частных облаках или Azure Stack. Процесс обнаружения экземпляра включает получение метаданных центра полномочий с сайта https://login.microsoft.com/ для проверки центра полномочий. Если задать значение True, проверка центра полномочий будет отключена. Поэтому крайне важно убедиться, что настроенный хост центра полномочий является действительным и заслуживающим доверия. Значение можно задать в профиле файла учетных данных или с помощью переменной среды `AZURE_DISABLE_INSTANCE_DISCOVERY`. Варианты: `false` ← (по умолчанию) `true`
log_mode строка	Родительский аргумент.
log_path строка	Родительский аргумент.
managed_instance_name строка / обязательный	Имя управляемого экземпляра SQL.
oidc_token строка добавлено в 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 путь добавлено в azure.azcollection 3.17.0	Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки. Файл должен содержать только необработанный токен. Этот способ часто используется на платформах, которые сохраняют токены OIDC в виде файлов. Также можно задать с помощью переменной среды `AZURE_FEDERATED_TOKEN_FILE`.
password строка	Пароль пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы.
policy_name строка	Имя политики краткосрочного хранения данных управляемого экземпляра SQL. Варианты: `"default"`
profile строка	Профиль безопасности из файла ~/.azure/credentials.
resource_group строка / обязательный	Имя группы ресурсов, содержащей ресурс.
secret строка	Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы.
subscription_id строка	Идентификатор вашей подписки Azure.
tenant строка	Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы.
thumbprint строка добавлено в 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.
Для аутентификации через 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: Get SQL managed instance short term retention policy by name
  azure_rm_sqlmidbshorttermretentionpolicy_info:
    resource_group: testrg
    managed_instance_name: testinstancename
    database_name: newdatabase
    policy_name: default

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

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

Ключ	Описание
short_term_retention_policy сложный тип	Словарь, содержащий сведения о политиках краткосрочного хранения данных управляемого экземпляра SQL. Возвращается: всегда
database_name строка	Имя базы данных управляемого экземпляра SQL. Возвращается: всегда Пример: `"newdatabase"`
id строка	Идентификатор ресурса. Возвращается: всегда Пример: `"/subscriptions/xxx-xxx/resourceGroups/testRG/providers/Microsoft.Sql/ managedInstances/fredsqlmi/databases/newdatabase/backupShortTermRetentionPolicies/default"`
managed_instance_name строка	Имя управляемого экземпляра SQL. Возвращается: всегда Пример: `"testmanagedinstance"`
policy_name строка	Имя политики краткосрочного хранения данных управляемого экземпляра SQL. Возвращается: всегда Пример: `"default"`
resource_group строка	Группа ресурсов, связанная с ресурсом. Возвращается: всегда Пример: `"testRG"`
retention_days целое число	Срок хранения резервных копий в днях. Это количество дней, в течение которых доступно восстановление на момент времени. Возвращается: всегда Пример: `7`
type строка	Тип политики краткосрочного хранения данных управляемого экземпляра SQL. Возвращается: всегда Пример: `"Microsoft.Sql/managedInstances/databases/backupShortTermRetentionPolicies"`

Авторы

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_sqlmidbshorttermretentionpolicy_info_module.html