Storage Accounts - Restore Blob Ranges

Service:

Storage Resource Provider

API Version:

2023-01-01

Memulihkan blob dalam rentang blob yang ditentukan

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
accountName	path	True	string	Nama akun penyimpanan dalam grup sumber daya yang ditentukan. Nama akun penyimpanan harus sepanjang antara 3 dan 24 karakter dan hanya menggunakan angka dan huruf kecil. Regex pattern: ^[a-z0-9]+$
resourceGroupName	path	True	string	Nama grup sumber daya dalam langganan pengguna. Nama tidak peka huruf besar/kecil. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	ID langganan target.
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
blobRanges	True	BlobRestoreRange[]	Rentang blob untuk dipulihkan.
timeToRestore	True	string	Pulihkan blob ke waktu yang ditentukan.

Respons

Nama	Jenis	Deskripsi
200 OK	BlobRestoreStatus	OK -- dikembalikan ketika rentang blob dipulihkan sepenuhnya dengan properti yang sama yang ditentukan dalam isi permintaan.
202 Accepted	BlobRestoreStatus	Diterima -- Permintaan pemulihan blob diterima; operasi akan selesai secara asinkron.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

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

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

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": ""
      }
    ]
  }
}

Definisi

Nama	Deskripsi
BlobRestoreParameters	Parameter pemulihan blob
BlobRestoreProgressStatus	Status kemajuan pemulihan blob. Nilai yang mungkin adalah: - InProgress: Menunjukkan bahwa pemulihan blob sedang berlangsung. - Selesai: Menunjukkan bahwa pemulihan blob telah berhasil diselesaikan. - Gagal: Menunjukkan bahwa pemulihan blob gagal.
BlobRestoreRange	Rentang blob
BlobRestoreStatus	Status pemulihan blob.

BlobRestoreParameters

Parameter pemulihan blob

Nama	Jenis	Deskripsi
blobRanges	BlobRestoreRange[]	Rentang blob untuk dipulihkan.
timeToRestore	string	Pulihkan blob ke waktu yang ditentukan.

BlobRestoreProgressStatus

Status kemajuan pemulihan blob. Nilai yang mungkin adalah: - InProgress: Menunjukkan bahwa pemulihan blob sedang berlangsung. - Selesai: Menunjukkan bahwa pemulihan blob telah berhasil diselesaikan. - Gagal: Menunjukkan bahwa pemulihan blob gagal.

Nama	Jenis	Deskripsi
Complete	string
Failed	string
InProgress	string

BlobRestoreRange

Rentang blob

Nama	Jenis	Deskripsi
endRange	string	Rentang akhir blob. Ini eksklusif. Kosong berarti akhir akun.
startRange	string	Rentang mulai blob. Ini inklusif. Kosong berarti akun dimulai.

BlobRestoreStatus

Status pemulihan blob.

Nama	Jenis	Deskripsi
failureReason	string	Alasan kegagalan ketika pemulihan blob gagal.
parameters	BlobRestoreParameters	Parameter permintaan pemulihan blob.
restoreId	string	Id untuk melacak permintaan pemulihan blob.
status	BlobRestoreProgressStatus	Status kemajuan pemulihan blob. Nilai yang mungkin adalah: - InProgress: Menunjukkan bahwa pemulihan blob sedang berlangsung. - Selesai: Menunjukkan bahwa pemulihan blob telah berhasil diselesaikan. - Gagal: Menunjukkan bahwa pemulihan blob gagal.