Long Term Retention Backups - Update By Resource Group

リファレンス

Service:: SQL Database

API Version:: 2021-11-01

既存の長期保有期間のバックアップを更新します。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/longTermRetentionServers/{longTermRetentionServerName}/longTermRetentionDatabases/{longTermRetentionDatabaseName}/longTermRetentionBackups/{backupName}/update?api-version=2021-11-01

URI パラメーター

名前	/	必須	型	説明
backupName	path	True	string	バックアップ名。
locationName	path	True	string	データベースの場所。
longTermRetentionDatabaseName	path	True	string	データベースの名前
longTermRetentionServerName	path	True	string	サーバーの名前
resourceGroupName	path	True	string	リソースが含まれているリソースグループの名前。この値は、Azure リソースマネージャー API またはポータルから取得できます。
subscriptionId	path	True	string	Azure サブスクリプションを識別するサブスクリプション ID。
api-version	query	True	string	要求で使用する API のバージョン。

要求本文

名前	型	説明
properties.requestedBackupStorageRedundancy	BackupStorageRedundancy	コピーしたバックアップのストレージ冗長の種類

応答

名前	型	説明
200 OK	LongTermRetentionBackupOperationResult	バックアップが正常に更新されました。
202 Accepted		バックアップの更新が進行中です。
Other Status Codes		エラー応答: *** 400 InvalidLongTermRetentionBackupId - SQL DB の長期保有バックアップ識別子が無効です。 400 InvalidParameterValue - パラメーターに無効な値が指定されました。 400 LongTermRetentionMismatchingSubscriptionId - 指定されたサブスクリプション ID が、他の入力の ID と一致しませんでした 400 LongTermRetentionMismatchingResourceGroupName - 指定されたリソースグループ名が、他の入力の名前と一致しませんでした 400 LongTermRetentionMismatchingServerName - 指定されたサーバー名が、他の入力の名前と一致しませんでした 400 LongTermRetentionMigrationRequestNotSupported - サブスクリプションは LTR バックアップ移行機能を使用できません。 400 LongTermRetentionMigrationCrossClusterRequestNotSupported - ソースとターゲットのサブスクリプションは、LTR バックアップコピー機能の通信を許可されていません。 400 LongTermRetentionMigrationParameterMissing - 操作に必要なパラメーターがありません。 400 LongTermRetentionMigrationSameServerNotSupported - 同じサーバー内で LTR バックアップをコピーする場合、LTR コピー機能はサポートされていません。 400 LongTermRetentionMigrationTargetServerNotFound - ターゲットサーバーが存在しないか、LTR バックアップコピー操作の準備ができていません。 400 LongTermRetentionMigrationTargetDatabaseNotFound - ターゲットデータベースがサーバー上に存在しません。 400 LongTermRetentionMigrationStorageTypeNotSupported - ターゲットリージョンでは、指定されたバックアップストレージ冗長はサポートされていません。 400 LongTermRetentionMigrationStorageMismatch - データベースのアクティブバックアップ冗長性が、お客様が要求したバックアップ冗長性と一致しません。 400 LongTermRetentionMigrationDatabaseTypeNotSupported - LTR 移行は、マネージドインスタンスと DB LTR バックアップAzure SQLでのみサポートされます。 400 LongTermRetentionMigrationBackupStorageRedundancyNotAllowed - LTR コピー操作でバックアップストレージの冗長性を変更することはできません。 400 LongTermRetentionMigrationSubscriptionNotFound - サブスクリプションが見つかりませんでした。 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした 404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソースグループとサブスクリプションに存在しません。 404 ResourceNotFound - 要求されたリソースが見つかりませんでした。 404 LongTermRetentionMigrationBackupNotFound - 指定された LTR バックアップが存在しません。 404 OperationIdNotFound - Id を持つ操作が存在しません。 409 LongTermRetentionMigrationRequestConflict - この LTR バックアップの競合操作はまだ進行中です。 409 LongTermRetentionMigrationBackupConflict - ターゲットデータベースのバックアップ時間が同じ別の LTR バックアップが存在します。 409 OperationCancelled - 操作がユーザーによって取り消されました。 409 OperationInterrupted - 同じリソースに対する別の操作によって中断されたため、リソースに対する操作を完了できませんでした。 429 SubscriptionTooManyCreateUpdateRequests - 使用可能なリソースによって処理できる最大要求数を超える要求。 429 SubscriptionTooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。 500 LongTermRetentionMigrationRequestFailedToStartOnTarget - ターゲットリージョンで LTR バックアップコピー要求を開始できませんでした。 500 LongTermRetentionMigrationRequestCopyFailed - LTR バックアップ BLOB のコピー操作が失敗しました。 500 LongTermRetentionMigrationRestoreVerExceeded - 最大試行回数に達した後、復元の検証に失敗しました。 500 LongTermRetentionMigrationRestoreVerFailed - 復元の検証に失敗しました。 500 OperationTimedOut - 操作がタイムアウトし、自動的にロールバックされました。操作をやり直してください。 503 TooManyRequests - 使用可能なリソースによって処理できる最大要求数を超える要求。

名前

型

説明

200 OK

LongTermRetentionBackupOperationResult

バックアップが正常に更新されました。

202 Accepted

バックアップの更新が進行中です。

Other Status Codes

エラー応答: ***

400 InvalidLongTermRetentionBackupId - SQL DB の長期保有バックアップ識別子が無効です。
400 InvalidParameterValue - パラメーターに無効な値が指定されました。
400 LongTermRetentionMismatchingSubscriptionId - 指定されたサブスクリプション ID が、他の入力の ID と一致しませんでした
400 LongTermRetentionMismatchingResourceGroupName - 指定されたリソースグループ名が、他の入力の名前と一致しませんでした
400 LongTermRetentionMismatchingServerName - 指定されたサーバー名が、他の入力の名前と一致しませんでした
400 LongTermRetentionMigrationRequestNotSupported - サブスクリプションは LTR バックアップ移行機能を使用できません。
400 LongTermRetentionMigrationCrossClusterRequestNotSupported - ソースとターゲットのサブスクリプションは、LTR バックアップコピー機能の通信を許可されていません。
400 LongTermRetentionMigrationParameterMissing - 操作に必要なパラメーターがありません。
400 LongTermRetentionMigrationSameServerNotSupported - 同じサーバー内で LTR バックアップをコピーする場合、LTR コピー機能はサポートされていません。
400 LongTermRetentionMigrationTargetServerNotFound - ターゲットサーバーが存在しないか、LTR バックアップコピー操作の準備ができていません。
400 LongTermRetentionMigrationTargetDatabaseNotFound - ターゲットデータベースがサーバー上に存在しません。
400 LongTermRetentionMigrationStorageTypeNotSupported - ターゲットリージョンでは、指定されたバックアップストレージ冗長はサポートされていません。
400 LongTermRetentionMigrationStorageMismatch - データベースのアクティブバックアップ冗長性が、お客様が要求したバックアップ冗長性と一致しません。
400 LongTermRetentionMigrationDatabaseTypeNotSupported - LTR 移行は、マネージドインスタンスと DB LTR バックアップAzure SQLでのみサポートされます。
400 LongTermRetentionMigrationBackupStorageRedundancyNotAllowed - LTR コピー操作でバックアップストレージの冗長性を変更することはできません。
400 LongTermRetentionMigrationSubscriptionNotFound - サブスクリプションが見つかりませんでした。
404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした
404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソースグループとサブスクリプションに存在しません。
404 ResourceNotFound - 要求されたリソースが見つかりませんでした。
404 LongTermRetentionMigrationBackupNotFound - 指定された LTR バックアップが存在しません。
404 OperationIdNotFound - Id を持つ操作が存在しません。
409 LongTermRetentionMigrationRequestConflict - この LTR バックアップの競合操作はまだ進行中です。
409 LongTermRetentionMigrationBackupConflict - ターゲットデータベースのバックアップ時間が同じ別の LTR バックアップが存在します。
409 OperationCancelled - 操作がユーザーによって取り消されました。
409 OperationInterrupted - 同じリソースに対する別の操作によって中断されたため、リソースに対する操作を完了できませんでした。
429 SubscriptionTooManyCreateUpdateRequests - 使用可能なリソースによって処理できる最大要求数を超える要求。
429 SubscriptionTooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。
500 LongTermRetentionMigrationRequestFailedToStartOnTarget - ターゲットリージョンで LTR バックアップコピー要求を開始できませんでした。
500 LongTermRetentionMigrationRequestCopyFailed - LTR バックアップ BLOB のコピー操作が失敗しました。
500 LongTermRetentionMigrationRestoreVerExceeded - 最大試行回数に達した後、復元の検証に失敗しました。
500 LongTermRetentionMigrationRestoreVerFailed - 復元の検証に失敗しました。
500 OperationTimedOut - 操作がタイムアウトし、自動的にロールバックされました。操作をやり直してください。
503 TooManyRequests - 使用可能なリソースによって処理できる最大要求数を超える要求。

例

Update the long term retention backup.

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testResourceGroup/providers/Microsoft.Sql/locations/japaneast/longTermRetentionServers/testserver/longTermRetentionDatabases/testDatabase/longTermRetentionBackups/55555555-6666-7777-8888-999999999999;131637960820000000/update?api-version=2021-11-01

{
  "properties": {
    "requestedBackupStorageRedundancy": "Geo"
  }
}


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.models.BackupStorageRedundancy;
import com.azure.resourcemanager.sql.models.UpdateLongTermRetentionBackupParameters;

/** Samples for LongTermRetentionBackups UpdateByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * ResourceGroupBasedLongTermRetentionBackupUpdate.json
     */
    /**
     * Sample code: Update the long term retention backup.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateTheLongTermRetentionBackup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getLongTermRetentionBackups().updateByResourceGroup(
            "testResourceGroup", "japaneast", "testserver", "testDatabase",
            "55555555-6666-7777-8888-999999999999;131637960820000000", new UpdateLongTermRetentionBackupParameters()
                .withRequestedBackupStorageRedundancy(BackupStorageRedundancy.GEO),
            Context.NONE);
    }
}

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

Sample Response

Status code:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testResourceGroup/providers/Microsoft.Sql/locations/japanEast/longTermRetentionBackupOperationResults/a1aa7c77-961b-4fbb-bcd6-aa9acfcd1706",
  "name": "a1aa7c77-961b-4fbb-bcd6-aa9acfcd1706",
  "type": "Microsoft.Sql/locations/longTermRetentionBackupOperationResults",
  "properties": {
    "requestId": "a1aa7c77-961b-4fbb-bcd6-aa9acfcd1706",
    "fromBackupResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testResourceGroup/providers/Microsoft.Sql/locations/japanEast/longTermRetentionServers/testserver/longterRetentionDatabases/testDatabase/longTermRetentionBackups/55555555-6666-7777-8888-999999999999;131637960820000000",
    "operationType": "UpdateBackup",
    "status": "Succeeded",
    "targetBackupStorageRedundancy": "Geo"
  }
}

Status code:: 202

定義

名前	説明
BackupStorageRedundancy	コピーしたバックアップのストレージ冗長の種類
LongTermRetentionBackupOperationResult	LongTermRetentionBackup 操作の結果リソース。
UpdateLongTermRetentionBackupParameters	長期保有バックアップの更新操作を実行するために必要な情報が含まれます。

BackupStorageRedundancy

コピーしたバックアップのストレージ冗長の種類

名前	型	説明
Geo	string
GeoZone	string
Local	string
Zone	string

LongTermRetentionBackupOperationResult

LongTermRetentionBackup 操作の結果リソース。

名前	型	説明
id	string	リソースの ID
name	string	リソース名。
properties.fromBackupResourceId	string	ソースバックアップリソース ID
properties.message	string	進行状況メッセージ
properties.operationType	string	操作の種類。
properties.requestId	string	要求 ID。
properties.status	string	操作の状態
properties.targetBackupStorageRedundancy	BackupStorageRedundancy	コピーしたバックアップのストレージ冗長の種類
properties.toBackupResourceId	string	ターゲットバックアップリソース ID
type	string	リソースの種類。

UpdateLongTermRetentionBackupParameters

長期保有バックアップの更新操作を実行するために必要な情報が含まれます。

名前	型	説明
properties.requestedBackupStorageRedundancy	BackupStorageRedundancy	コピーしたバックアップのストレージ冗長の種類

Long Term Retention Backups - Update By Resource Group

URI パラメーター

要求本文

応答

例

Update the long term retention backup.

Sample Request

Sample Response

定義

BackupStorageRedundancy

LongTermRetentionBackupOperationResult

UpdateLongTermRetentionBackupParameters

その他のリソース