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	リソースを含むリソースグループの名前。この値は、Azure Resource Manager 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 - Hyperscale サービスレベルへの移行中にデータベースの長期的なバックアップリテンション期間を有効にすることはできません。 400 LtrConfigPolicyDuringVldbReverseMigration - Hyperscale からの逆移行中にデータベースの長期的なバックアップリテンション期間を有効にすることはできません。 400 DatabaseNamedReplicaBackupRetentionConfigurationNotSupported - ユーザーが名前付きレプリカでバックアップ保持ポリシーを構成しようとしました。 400 LTRNotSupportedForPerDBCMK - データベースレベルの CMK がプレビューで構成されている場合、長期的なバックアップリテンション期間はサポートされません。 400 LTRHyperscaleSetPolicyError - このデータベースの長期バックアップリテンション期間を有効にしているときにエラーが発生しました。長期的なバックアップリテンション期間を有効にするには、Microsoft サポートにお問い合わせください。 400 LTRArchiveStorageDisabledOnHyperscaleEdition - Hyperscale データベースでの長期保有バックアップのアーカイブが有効になっていません。 400 InvalidLTRImmutabilityWithImmutabilityNotSet - バックアップの不変性が有効になっていない場合、不変性ポリシーモードを設定できません。 400 LTRArchiveStorageFailedOnZoneRedundantBackupStorage - バックアップストレージアクセス層を "アーカイブ" に設定した長期保有ポリシーの設定は、ゾーン冗長バックアップストレージではサポートされていません。ローカル冗長ストレージまたは geo 冗長ストレージの種類を使用します。 400 LongTermRetentionPolicyNotSupported - このデータベースでは、長期保持はサポートされていません。 400 LongTermRetentionPolicyInvalid - 長期保持ポリシーが無効です。 404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソースグループとサブスクリプションに存在しません。 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした 404 ResourceNotFound - 要求されたリソースが見つかりませんでした。 409 ConflictingServerOperation - Server '{0}' は別の操作でビジー状態です。後で操作を試してください。

名前

型

説明

200 OK

ManagedInstanceLongTermRetentionPolicy

マネージドデータベースの LTR ポリシーが正常に取得されました。

Other Status Codes

ErrorResponse

エラー応答: ***

400 ManagedInstanceStoppingOrStopped - インスタンスが停止/停止状態にある間に送信された操作の競合
400 ManagedInstanceStarting - インスタンスが開始状態の間に送信された操作の競合
400 LtrConfigPolicyUnsupportedIfAutoPauseEnabled - 自動一時停止が有効になっている場合、サーバーレスデータベースの長期的なバックアップリテンション期間の有効化はサポートされません。
400 LtrConfigPolicyDuringVldbMigration - Hyperscale サービスレベルへの移行中にデータベースの長期的なバックアップリテンション期間を有効にすることはできません。
400 LtrConfigPolicyDuringVldbReverseMigration - Hyperscale からの逆移行中にデータベースの長期的なバックアップリテンション期間を有効にすることはできません。
400 DatabaseNamedReplicaBackupRetentionConfigurationNotSupported - ユーザーが名前付きレプリカでバックアップ保持ポリシーを構成しようとしました。
400 LTRNotSupportedForPerDBCMK - データベースレベルの CMK がプレビューで構成されている場合、長期的なバックアップリテンション期間はサポートされません。
400 LTRHyperscaleSetPolicyError - このデータベースの長期バックアップリテンション期間を有効にしているときにエラーが発生しました。長期的なバックアップリテンション期間を有効にするには、Microsoft サポートにお問い合わせください。
400 LTRArchiveStorageDisabledOnHyperscaleEdition - Hyperscale データベースでの長期保有バックアップのアーカイブが有効になっていません。
400 InvalidLTRImmutabilityWithImmutabilityNotSet - バックアップの不変性が有効になっていない場合、不変性ポリシーモードを設定できません。
400 LTRArchiveStorageFailedOnZoneRedundantBackupStorage - バックアップストレージアクセス層を "アーカイブ" に設定した長期保有ポリシーの設定は、ゾーン冗長バックアップストレージではサポートされていません。ローカル冗長ストレージまたは geo 冗長ストレージの種類を使用します。
400 LongTermRetentionPolicyNotSupported - このデータベースでは、長期保持はサポートされていません。
400 LongTermRetentionPolicyInvalid - 長期保持ポリシーが無効です。
404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソースグループとサブスクリプションに存在しません。
404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした
404 ResourceNotFound - 要求されたリソースが見つかりませんでした。
409 ConflictingServerOperation - Server '{0}' は別の操作でビジー状態です。後で操作を試してください。

例

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

{
  "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