Storage Accounts - Restore Blob Ranges

Service:

Storage Resource Provider

API Version:

2023-01-01

指定した BLOB 範囲の BLOB を復元する

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/restoreBlobRanges?api-version=2023-01-01

URI パラメーター

名前	/	必須	型	説明
accountName	path	True	string	指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ～ 24 文字で、数字と小文字のみを使用する必要があります。 Regex pattern: ^[a-z0-9]+$
resourceGroupName	path	True	string	ユーザーのサブスクリプション内のリソース グループの名前。 名前の大文字と小文字は区別されます。 Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	ターゲット サブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。

要求本文

名前	必須	型	説明
blobRanges	True	BlobRestoreRange[]	復元する BLOB 範囲。
timeToRestore	True	string	指定した時刻に BLOB を復元します。

応答

名前	型	説明
200 OK	BlobRestoreStatus	OK -- 要求本文で指定されたのと同じプロパティを使用して BLOB 範囲が完全に復元されると返されます。
202 Accepted	BlobRestoreStatus	受け入れ済み -- BLOB 復元要求が受け入れられます。操作は非同期的に完了します。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
user_impersonation	ユーザー アカウントの借用

例

BlobRangesRestore

Sample Request

HTTP

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res9101/providers/Microsoft.Storage/storageAccounts/sto4445/restoreBlobRanges?api-version=2023-01-01

{
  "timeToRestore": "2019-04-20T15:30:00.0000000Z",
  "blobRanges": [
    {
      "startRange": "container/blobpath1",
      "endRange": "container/blobpath2"
    },
    {
      "startRange": "container2/blobpath3",
      "endRange": ""
    }
  ]
}

Java

import com.azure.resourcemanager.storage.models.BlobRestoreParameters;
import com.azure.resourcemanager.storage.models.BlobRestoreRange;
import java.time.OffsetDateTime;
import java.util.Arrays;

/** Samples for StorageAccounts RestoreBlobRanges. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/BlobRangesRestore.json
     */
    /**
     * Sample code: BlobRangesRestore.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void blobRangesRestore(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getStorageAccounts().restoreBlobRanges("res9101", "sto4445",
            new BlobRestoreParameters().withTimeToRestore(OffsetDateTime.parse("2019-04-20T15:30:00.0000000Z"))
                .withBlobRanges(Arrays.asList(
                    new BlobRestoreRange().withStartRange("container/blobpath1").withEndRange("container/blobpath2"),
                    new BlobRestoreRange().withStartRange("container2/blobpath3").withEndRange(""))),
            com.azure.core.util.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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.storage import StorageManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-storage
# USAGE
    python blob_ranges_restore.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = StorageManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.storage_accounts.begin_restore_blob_ranges(
        resource_group_name="res9101",
        account_name="sto4445",
        parameters={
            "blobRanges": [
                {"endRange": "container/blobpath2", "startRange": "container/blobpath1"},
                {"endRange": "", "startRange": "container2/blobpath3"},
            ],
            "timeToRestore": "2019-04-20T15:30:00.0000000Z",
        },
    ).result()
    print(response)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/BlobRangesRestore.json
if __name__ == "__main__":
    main()

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

Go

package armstorage_test

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storage/armstorage"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/0baf811c3c76c87b3c127d098519bd97141222dd/specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/BlobRangesRestore.json
func ExampleAccountsClient_BeginRestoreBlobRanges() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstorage.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewAccountsClient().BeginRestoreBlobRanges(ctx, "res9101", "sto4445", armstorage.BlobRestoreParameters{
		BlobRanges: []*armstorage.BlobRestoreRange{
			{
				EndRange:   to.Ptr("container/blobpath2"),
				StartRange: to.Ptr("container/blobpath1"),
			},
			{
				EndRange:   to.Ptr(""),
				StartRange: to.Ptr("container2/blobpath3"),
			}},
		TimeToRestore: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-04-20T15:30:00.000Z"); return t }()),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.BlobRestoreStatus = armstorage.BlobRestoreStatus{
	// 	Parameters: &armstorage.BlobRestoreParameters{
	// 		BlobRanges: []*armstorage.BlobRestoreRange{
	// 			{
	// 				EndRange: to.Ptr("container/blobpath2"),
	// 				StartRange: to.Ptr("container/blobpath1"),
	// 			},
	// 			{
	// 				EndRange: to.Ptr(""),
	// 				StartRange: to.Ptr("container2/blobpath3"),
	// 		}},
	// 		TimeToRestore: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-04-20T15:30:00.000Z"); return t}()),
	// 	},
	// 	RestoreID: to.Ptr("{restore_id}"),
	// 	Status: to.Ptr(armstorage.BlobRestoreProgressStatus("Succeeded")),
	// }
}

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

JavaScript

const { StorageManagementClient } = require("@azure/arm-storage");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Restore blobs in the specified blob ranges
 *
 * @summary Restore blobs in the specified blob ranges
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/BlobRangesRestore.json
 */
async function blobRangesRestore() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res9101";
  const accountName = "sto4445";
  const parameters = {
    blobRanges: [
      { endRange: "container/blobpath2", startRange: "container/blobpath1" },
      { endRange: "", startRange: "container2/blobpath3" },
    ],
    timeToRestore: new Date("2019-04-20T15:30:00.0000000Z"),
  };
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const result = await client.storageAccounts.beginRestoreBlobRangesAndWait(
    resourceGroupName,
    accountName,
    parameters
  );
  console.log(result);
}

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

{
  "status": "Succeeded",
  "restoreId": "{restore_id}",
  "parameters": {
    "timeToRestore": "2019-04-20T15:30:00.0000000Z",
    "blobRanges": [
      {
        "startRange": "container/blobpath1",
        "endRange": "container/blobpath2"
      },
      {
        "startRange": "container2/blobpath3",
        "endRange": ""
      }
    ]
  }
}

Status code:

202

location: https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res9101/providers/Microsoft.Storage/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2022-09-01

Response Body

{
  "status": "InProgress",
  "restoreId": "{restore_id}",
  "parameters": {
    "timeToRestore": "2019-04-20T15:30:00.0000000Z",
    "blobRanges": [
      {
        "startRange": "container/blobpath1",
        "endRange": "container/blobpath2"
      },
      {
        "startRange": "container2/blobpath3",
        "endRange": ""
      }
    ]
  }
}

定義

名前	説明
BlobRestoreParameters	BLOB 復元パラメーター
BlobRestoreProgressStatus	BLOB 復元の進行状況の状態。 使用できる値は次のとおりです。 - InProgress: BLOB の復元が進行中であることを示します。 - 完了: BLOB の復元が正常に完了したことを示します。 - 失敗: BLOB の復元が失敗したことを示します。
BlobRestoreRange	BLOB 範囲
BlobRestoreStatus	BLOB の復元の状態。

BlobRestoreParameters

BLOB 復元パラメーター

名前	型	説明
blobRanges	BlobRestoreRange[]	復元する BLOB 範囲。
timeToRestore	string	指定した時刻に BLOB を復元します。

BlobRestoreProgressStatus

BLOB 復元の進行状況の状態。 使用できる値は次のとおりです。 - InProgress: BLOB の復元が進行中であることを示します。 - 完了: BLOB の復元が正常に完了したことを示します。 - 失敗: BLOB の復元が失敗したことを示します。

名前	型	説明
Complete	string
Failed	string
InProgress	string

BlobRestoreRange

BLOB 範囲

名前	型	説明
endRange	string	BLOB の終了範囲。 これは排他的です。 空は、アカウントの終了を意味します。
startRange	string	BLOB の開始範囲。 これは包括的です。 空は、アカウントの開始を意味します。

BlobRestoreStatus

BLOB の復元の状態。

名前	型	説明
failureReason	string	BLOB の復元が失敗した場合のエラーの理由。
parameters	BlobRestoreParameters	BLOB 復元要求パラメーター。
restoreId	string	BLOB 復元要求を追跡するための ID。
status	BlobRestoreProgressStatus	BLOB 復元の進行状況の状態。 使用できる値は次のとおりです。 - InProgress: BLOB の復元が進行中であることを示します。 - 完了: BLOB の復元が正常に完了したことを示します。 - 失敗: BLOB の復元が失敗したことを示します。