你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Managed Instance Long Term Retention Policies - Get

服务:: SQL Database

API 版本:: 2023-08-01

获取托管数据库的长期保留策略。

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

URI 参数

名称	在	必需	类型	说明
databaseName	path	True	string	数据库的名称。
managedInstanceName	path	True	string	托管实例的名称。
policyName	path	True	ManagedInstanceLongTermRetentionPolicyName	策略名称。应始终为默认值。
resourceGroupName	path	True	string	包含资源的资源组的名称。可以从 Azure 资源管理器 API 或门户获取此值。
subscriptionId	path	True	string	标识 Azure 订阅的订阅 ID。
api-version	query	True	string	要用于请求的 API 版本。

响应

名称	类型	说明
200 OK	ManagedInstanceLongTermRetentionPolicy	已成功获取托管数据库的 LTR 策略。
Other Status Codes	ErrorResponse	错误响应： *** 400 ManagedInstanceStoppingOrStopped - 实例处于停止/停止状态时提交的冲突作 400 ManagedInstanceStarting - 实例处于启动状态时提交的冲突作 400 LtrConfigPolicyUnsupportedIfAutoPauseEnabled - 如果启用自动暂停，则不支持为无服务器数据库启用长期备份保留。 400 LtrConfigPolicyDuringVldbMigration - 不支持在迁移到超大规模服务层级期间为数据库启用长期备份保留。 400 LtrConfigPolicyDuringVldbReverseMigration - 不支持在从超大规模反向迁移期间为数据库启用长期备份保留。 400 DatabaseNamedReplicaBackupRetentionConfigurationNotSupported - 用户尝试在命名副本上配置备份保留策略。 400 LTRNotSupportedForPerDBCMK - 在预览版中配置数据库级 CMK 时不支持长期备份保留。 400 LTRHyperscaleSetPolicyError - 为此数据库启用长期备份保留时出错。请联系Microsoft支持来启用长期备份保留。 400 LTRArchiveStorageDisabledOnHyperscaleEdition - 未在超大规模数据库上存档长期保留备份。区域冗余备份存储不支持将备份存储访问层设置为“存档”的长期保留策略 400 LTRArchiveStorageFailedOnZoneRedundantBackupStorage - 设置长期保留策略。使用本地冗余或异地冗余存储类型。 400 LongTermRetentionPolicyNotSupported - 此数据库不支持长期保留。 400 LongTermRetentionPolicyInvalid - 长期保留策略无效。 404 ServerNotInSubscriptionResourceGroup - 指定的服务器在指定的资源组和订阅中不存在。 404 SubscriptionDoesNotHaveServer - 找不到请求的服务器 404 ResourceNotFound - 找不到请求的资源。 409 ConflictingServerOperation - 服务器“{0}”正忙于另一个作。请稍后尝试作。

名称

类型

说明

200 OK

ManagedInstanceLongTermRetentionPolicy

已成功获取托管数据库的 LTR 策略。

Other Status Codes

ErrorResponse

错误响应： ***

400 ManagedInstanceStoppingOrStopped - 实例处于停止/停止状态时提交的冲突作
400 ManagedInstanceStarting - 实例处于启动状态时提交的冲突作
400 LtrConfigPolicyUnsupportedIfAutoPauseEnabled - 如果启用自动暂停，则不支持为无服务器数据库启用长期备份保留。
400 LtrConfigPolicyDuringVldbMigration - 不支持在迁移到超大规模服务层级期间为数据库启用长期备份保留。
400 LtrConfigPolicyDuringVldbReverseMigration - 不支持在从超大规模反向迁移期间为数据库启用长期备份保留。
400 DatabaseNamedReplicaBackupRetentionConfigurationNotSupported - 用户尝试在命名副本上配置备份保留策略。
400 LTRNotSupportedForPerDBCMK - 在预览版中配置数据库级 CMK 时不支持长期备份保留。
400 LTRHyperscaleSetPolicyError - 为此数据库启用长期备份保留时出错。请联系Microsoft支持来启用长期备份保留。
400 LTRArchiveStorageDisabledOnHyperscaleEdition - 未在超大规模数据库上存档长期保留备份。
区域冗余备份存储不支持将备份存储访问层设置为“存档”的长期保留策略 400 LTRArchiveStorageFailedOnZoneRedundantBackupStorage - 设置长期保留策略。使用本地冗余或异地冗余存储类型。
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=2023-08-01

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ManagedInstanceLongTermRetentionPolicyGet.json
// this example is just showing the usage of "ManagedInstanceLongTermRetentionPolicies_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ManagedInstanceLongTermRetentionPolicyResource created on azure
// for more information of creating ManagedInstanceLongTermRetentionPolicyResource, please refer to the document of ManagedInstanceLongTermRetentionPolicyResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "testResourceGroup";
string managedInstanceName = "testInstance";
string databaseName = "testDatabase";
ManagedInstanceLongTermRetentionPolicyName policyName = ManagedInstanceLongTermRetentionPolicyName.Default;
ResourceIdentifier managedInstanceLongTermRetentionPolicyResourceId = ManagedInstanceLongTermRetentionPolicyResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, managedInstanceName, databaseName, policyName);
ManagedInstanceLongTermRetentionPolicyResource managedInstanceLongTermRetentionPolicy = client.GetManagedInstanceLongTermRetentionPolicyResource(managedInstanceLongTermRetentionPolicyResourceId);

// invoke the operation
ManagedInstanceLongTermRetentionPolicyResource result = await managedInstanceLongTermRetentionPolicy.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ManagedInstanceLongTermRetentionPolicyData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 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	LTR 备份的 BackupStorageAccessTier
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ManagedInstanceLongTermRetentionPolicy	长期保留策略。
ManagedInstanceLongTermRetentionPolicyName	策略名称。应始终为默认值。

BackupStorageAccessTier

枚举

LTR 备份的 BackupStorageAccessTier

值	说明
Hot
Archive

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

ManagedInstanceLongTermRetentionPolicy

Object

长期保留策略。

名称	类型	说明
id	string	资源 ID。
name	string	资源名称。
properties.backupStorageAccessTier	BackupStorageAccessTier	LTR 备份的 BackupStorageAccessTier
properties.monthlyRetention	string	ISO 8601 格式的 LTR 备份的每月保留策略。
properties.weekOfYear	integer (int32)	采用 ISO 8601 格式的年度备份的一周。
properties.weeklyRetention	string	ISO 8601 格式的 LTR 备份的每周保留策略。
properties.yearlyRetention	string	ISO 8601 格式的 LTR 备份的年度保留策略。
type	string	资源类型。

ManagedInstanceLongTermRetentionPolicyName

枚举

策略名称。应始终为默认值。

值	说明
default

通过

Managed Instance Long Term Retention Policies - Get

URI 参数

响应

示例

Get the long term retention policy for the managed database.

示例请求

示例响应

定义

BackupStorageAccessTier

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ManagedInstanceLongTermRetentionPolicy

ManagedInstanceLongTermRetentionPolicyName