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 參數

名稱	位於	必要	類型	Description
databaseName	path	True	string	資料庫的名稱。
managedInstanceName	path	True	string	受控實例的名稱。
policyName	path	True	ManagedInstanceLongTermRetentionPolicyName	原則名稱。 應該一律為 Default。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。 名稱不區分大小寫。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。 此值必須是 UUID。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

回應

名稱	類型	Description
200 OK	ManagedInstanceLongTermRetentionPolicy	Azure 運作順利完成。
Other Status Codes	ErrorResponse	未預期的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow.

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Get the long term retention policy for the managed database.

範例要求

HTTP

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

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

定義

名稱	Description
BackupStorageAccessTier	LTR 備份的BackupStorageAccessTier
createdByType	建立資源的身分識別類型。
ErrorAdditionalInfo	資源管理錯誤附加資訊。
ErrorDetail	錯誤詳細資料。
ErrorResponse	錯誤回應
ManagedInstanceLongTermRetentionPolicy	長期保留原則。
ManagedInstanceLongTermRetentionPolicyName
systemData	與建立和上次修改資源相關的元數據。

BackupStorageAccessTier

列舉型別

LTR 備份的BackupStorageAccessTier

值	Description
Hot	熱的
Archive	檔案館

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

資源管理錯誤附加資訊。

名稱	類型	Description
info	object	附加資訊。
type	string	其他資訊類型。

ErrorDetail

Object

錯誤詳細資料。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤附加資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳情
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	錯誤物件。

ManagedInstanceLongTermRetentionPolicy

Object

長期保留原則。

名稱	類型	Description
id	string (arm-id)	資源的完整資源標識碼。 例如，“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
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 備份的年度保留原則。
systemData	systemData	Azure Resource Manager 包含 createdBy 與 modifiedBy 資訊的元資料。
type	string	資源的類型。 例如：「Microsoft。運算/虛擬機器」或「Microsoft」。儲存/儲存帳號」

ManagedInstanceLongTermRetentionPolicyName

列舉型別

值	Description
default	預設

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	資源上次修改的時間戳記 （UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。