Поделиться через

Managed Instance Long Term Retention Policies - Get

Служба:
SQL Database
Версия API:
2025-01-01

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/backupLongTermRetentionPolicies/default?api-version=2025-01-01

Параметры URI

Имя В Обязательно Тип Описание
databaseName
 path True

string

Имя базы данных.
managedInstanceName
 path True

string

Имя управляемого экземпляра.
policyName
 path True

ManagedInstanceLongTermRetentionPolicyName

Имя политики. Всегда должно быть по умолчанию.
resourceGroupName
 path True

string

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

string

Идентификатор подписки, идентифицирующий подписку Azure.
api-version
 query True

string

Версия API, используемая для запроса.

Ответы

Имя Тип Описание
200 OK

ManagedInstanceLongTermRetentionPolicy

Успешно получил политику LTR для управляемой базы данных.
Other Status Codes

ErrorResponse

Ответы на ошибки: ***

  • 400 ManagedInstanceStoppingOrStoppingOrStopped — конфликтующая операция, отправленная во время остановки или остановки экземпляра

  • 400 ManagedInstanceStarting — конфликтующая операция, отправленная во время запуска экземпляра

  • 400 LtrConfigPolicyUnsupportedIfAutoPauseEnabled. Включение долгосрочного хранения резервных копий для бессерверной базы данных не поддерживается, если включена автоматическая приостановка.

  • 400 LtrConfigPolicyDuringVldbMigration. Включение долгосрочного хранения резервных копий для базы данных во время миграции на уровень служб Гипермасштабирования не поддерживается.

  • 400 LtrConfigPolicyDuringVldbReverseMigration. Включение долгосрочного хранения резервных копий для базы данных во время обратной миграции с гипермасштабирования не поддерживается.

  • 400 DatabaseNamedReplicaBackupRetentionConfigurationNotSupported — пользователь попытался настроить политику хранения резервных копий в именованной реплике.

  • 400 LTRNotSupportedForPerDBCMK — долгосрочное хранение резервных копий не поддерживается при настройке CMK на уровне базы данных в предварительной версии.

  • 400 LTRHyperscaleSetPolicyError — произошла ошибка при включении долгосрочного хранения резервных копий для этой базы данных. Обратитесь в службу поддержки Майкрософт, чтобы включить долгосрочное хранение резервных копий.

  • 400 LTRArchiveStorageDisabledOnHyperscaleEdition — архивация долгосрочных резервных копий хранения в базах данных гипермасштабирования не включена.

  • 400 InvalidLTRImmutabilityWithImmutabilityNotSet — невозможно задать режим политики неизменяемости, если резервное копирование неизменяемости не включено.

  • 400 LTRArchiveStorageFailedOnZoneRedundantBackupStorage. Установка долгосрочной политики хранения с уровнем доступа к хранилищу резервных копий, для которого задано значение "archive", не поддерживается в хранилище резервных копий, избыточном между зонами. Используйте локальные избыточные или геоизбыточные типы хранилища.

  • 400 LongTermRetentionPolicyNotSupported — долгосрочное хранение не поддерживается в этой базе данных.

  • 400 LongTermRetentionPolicyInvalid — политика долгосрочного хранения недопустима.

  • 404 ServerNotInSubscriptionResourceGroup — указанный сервер не существует в указанной группе ресурсов и подписке.

  • 404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден

  • 404 ResourceNotFound — запрошенный ресурс не найден.

  • 409 ConflictingServerOperation — сервер "{0}" занят другой операцией. Повторите операцию позже.

Примеры

Get the long term retention policy for the managed database.

Образец запроса

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testResourceGroup/providers/Microsoft.Sql/managedInstances/testInstance/databases/testDatabase/backupLongTermRetentionPolicies/default?api-version=2025-01-01

Пример ответа

Код состояния:
200 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testResourceGroup/providers/Microsoft.Sql//managedInstances/testInstance/databases/testDatabase/backupLongTermRetentionPolicies/default",
  "name": "default",
  "type": "Microsoft.Sql/resourceGroups/managedInstances/databases/backupLongTermRetentionPolicies",
  "properties": {
    "weeklyRetention": "P1M",
    "monthlyRetention": "P1Y",
    "yearlyRetention": "P5Y",
    "weekOfYear": 5,
    "backupStorageAccessTier": "Archive"
  }
}

Определения

Имя Описание
BackupStorageAccessTier

BackupStorageAccessTier для резервных копий LTR
ErrorAdditionalInfo

Ошибка управления ресурсами дополнительная информация.
ErrorDetail

Детали ошибки.
ErrorResponse

Ответ на ошибку
ManagedInstanceLongTermRetentionPolicy

Долгосрочная политика хранения.
ManagedInstanceLongTermRetentionPolicyName

Имя политики. Всегда должно быть по умолчанию.

BackupStorageAccessTier

Перечисление

BackupStorageAccessTier для резервных копий LTR

Значение Описание
Hot
Archive

ErrorAdditionalInfo

Объект

Ошибка управления ресурсами дополнительная информация.

Имя Тип Описание
info

object

Дополнительная информация.
type

string

Тип дополнительной информации.

ErrorDetail

Объект

Детали ошибки.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Ошибка дополнительная информация.
code

string

Код ошибки.
details

ErrorDetail[]

Сведения об ошибке.
message

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

ErrorResponse

Объект

Ответ на ошибку

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

ManagedInstanceLongTermRetentionPolicy

Объект

Долгосрочная политика хранения.

Имя Тип Описание
id

string

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

string

Имя ресурса.
properties.backupStorageAccessTier

BackupStorageAccessTier

BackupStorageAccessTier для резервных копий LTR
properties.monthlyRetention

string

Ежемесячная политика хранения для резервной копии LTR в формате ISO 8601.
properties.weekOfYear

integer (int32)

Неделя года для ежегодного резервного копирования в формате ISO 8601.
properties.weeklyRetention

string

Еженедельная политика хранения для резервной копии LTR в формате ISO 8601.
properties.yearlyRetention

string

Ежегодная политика хранения для резервной копии LTR в формате ISO 8601.
type

string

Тип ресурса.

ManagedInstanceLongTermRetentionPolicyName

Перечисление

Имя политики. Всегда должно быть по умолчанию.

Значение Описание
default