Storage Accounts - Restore Blob Ranges

Referência

Service:: Storage Resource Provider

API Version:: 2023-01-01

Restaurar blobs nos intervalos de blobs especificados

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
accountName	path	True	string	O nome da conta de armazenamento no grupo de recursos especificado. Os nomes das contas de armazenamento têm de ter entre 3 e 24 carateres de comprimento e utilizar apenas números e letras minúsculas. Regex pattern: `^[a-z0-9]+$`
resourceGroupName	path	True	string	O nome do grupo de recursos na subscrição do utilizador. O nome não é sensível a maiúsculas e minúsculas. Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	O ID da subscrição de destino.
api-version	query	True	string	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
blobRanges	True	BlobRestoreRange[]	Intervalos de blobs a restaurar.
timeToRestore	True	string	Restaure o blob para a hora especificada.

Respostas

Name	Tipo	Description
200 OK	BlobRestoreStatus	OK - devolvido quando os intervalos de blobs são totalmente restaurados com as mesmas propriedades especificadas no corpo do pedido.
202 Accepted	BlobRestoreStatus	Aceite - Pedido de restauro de blobs aceite; A operação será concluída de forma assíncrona.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

BlobRangesRestore

Sample Request

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


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

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

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

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

Definições

Name	Description
BlobRestoreParameters	Parâmetros de restauro de blobs
BlobRestoreProgressStatus	O estado do progresso do restauro de blobs. Os valores possíveis são: - InProgress: indica que o restauro do blob está em curso. - Concluído: indica que o restauro do blob foi concluído com êxito. - Falha: indica que o restauro do blob falhou.
BlobRestoreRange	Intervalo de blobs
BlobRestoreStatus	Estado do restauro do blob.

BlobRestoreParameters

Parâmetros de restauro de blobs

Name	Tipo	Description
blobRanges	BlobRestoreRange[]	Intervalos de blobs a restaurar.
timeToRestore	string	Restaure o blob para a hora especificada.

BlobRestoreProgressStatus

O estado do progresso do restauro de blobs. Os valores possíveis são: - InProgress: indica que o restauro do blob está em curso. - Concluído: indica que o restauro do blob foi concluído com êxito. - Falha: indica que o restauro do blob falhou.

Name	Tipo	Description
Complete	string
Failed	string
InProgress	string

BlobRestoreRange

Intervalo de blobs

Name	Tipo	Description
endRange	string	Intervalo de fim do blob. Isto é exclusivo. Vazio significa fim da conta.
startRange	string	Intervalo de início do blob. Isto é inclusivo. Vazio significa início da conta.

BlobRestoreStatus

Estado do restauro do blob.

Name	Tipo	Description
failureReason	string	Motivo da falha quando o restauro do blob falha.
parameters	BlobRestoreParameters	Parâmetros do pedido de restauro de blobs.
restoreId	string	ID para controlar o pedido de restauro de blobs.
status	BlobRestoreProgressStatus	O estado do progresso do restauro de blobs. Os valores possíveis são: - InProgress: indica que o restauro do blob está em curso. - Concluído: indica que o restauro do blob foi concluído com êxito. - Falha: indica que o restauro do blob falhou.

Storage Accounts - Restore Blob Ranges

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

azure_auth

Scopes

Exemplos

BlobRangesRestore

Sample Request

Sample Response

Definições

BlobRestoreParameters

BlobRestoreProgressStatus

BlobRestoreRange

BlobRestoreStatus

Recursos adicionais