Storage Accounts - Restore Blob Ranges

Service:

Storage Resource Provider

API Version:

2023-01-01

Blobok visszaállítása a megadott blobtartományokban

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
accountName	path	True	string	A tárfiók neve a megadott erőforráscsoportban. A tárfiókok nevének 3–24 karakter hosszúságúnak kell lennie, és csak számokat és kisbetűket kell használnia. Regex pattern: ^[a-z0-9]+$
resourceGroupName	path	True	string	A felhasználó előfizetésén belüli erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	A cél-előfizetés azonosítója.
api-version	query	True	string	A művelethez használandó API-verzió.

Kérelem törzse

Name	Kötelező	Típus	Description
blobRanges	True	BlobRestoreRange[]	Visszaállítandó blobtartományok.
timeToRestore	True	string	Blob visszaállítása a megadott időpontra.

Válaszok

Name	Típus	Description
200 OK	BlobRestoreStatus	OK – akkor adja vissza, ha a blobtartományok teljes visszaállítása a kérelem törzsében megadott tulajdonságokkal történik.
202 Accepted	BlobRestoreStatus	Elfogadva – Blob-visszaállítási kérelem elfogadva; művelet aszinkron módon fejeződik be.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

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

Definíciók

Name	Description
BlobRestoreParameters	Blob-visszaállítási paraméterek
BlobRestoreProgressStatus	A blobok visszaállításának állapota. Lehetséges értékek: - Bejövő forgalom: Azt jelzi, hogy a blobok visszaállítása folyamatban van. - Kész: Azt jelzi, hogy a blob visszaállítása sikeresen befejeződött. - Sikertelen: Azt jelzi, hogy a blob visszaállítása sikertelen.
BlobRestoreRange	Blobtartomány
BlobRestoreStatus	Blob-visszaállítás állapota.

BlobRestoreParameters

Blob-visszaállítási paraméterek

Name	Típus	Description
blobRanges	BlobRestoreRange[]	Visszaállítandó blobtartományok.
timeToRestore	string	Blob visszaállítása a megadott időpontra.

BlobRestoreProgressStatus

A blobok visszaállításának állapota. Lehetséges értékek: - Bejövő forgalom: Azt jelzi, hogy a blobok visszaállítása folyamatban van. - Kész: Azt jelzi, hogy a blob visszaállítása sikeresen befejeződött. - Sikertelen: Azt jelzi, hogy a blob visszaállítása sikertelen.

Name	Típus	Description
Complete	string
Failed	string
InProgress	string

BlobRestoreRange

Blobtartomány

Name	Típus	Description
endRange	string	Blobok zárótartománya. Ez exkluzív. Az üres azt jelenti, hogy a fiók vége.
startRange	string	Blob kezdőtartománya. Ez befogadó. Az üres azt jelenti, hogy a fiók kezdete.

BlobRestoreStatus

Blob-visszaállítás állapota.

Name	Típus	Description
failureReason	string	Hiba oka, ha a blob visszaállítása sikertelen.
parameters	BlobRestoreParameters	Blob-visszaállítási kérelem paraméterei.
restoreId	string	Blob-visszaállítási kérelem nyomon követésének azonosítója.
status	BlobRestoreProgressStatus	A blobok visszaállításának állapota. Lehetséges értékek: - Bejövő forgalom: Azt jelzi, hogy a blobok visszaállítása folyamatban van. - Kész: Azt jelzi, hogy a blob visszaállítása sikeresen befejeződött. - Sikertelen: Azt jelzi, hogy a blob visszaállítása sikertelen.