Redis - Export Data

Service:

Redis Cache

API Version:

2023-08-01

Eksportowanie danych z pamięci podręcznej Redis Cache do obiektów blob w kontenerze.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/export?api-version=2023-08-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
name	path	True	string	Nazwa pamięci podręcznej Redis Cache.
resourceGroupName	path	True	string	Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
container	True	string	Nazwa kontenera do wyeksportowania.
prefix	True	string	Prefiks do użycia dla wyeksportowanych plików.
format		string	Format pliku.
preferred-data-archive-auth-method		string	Preferowana metoda uwierzytelniania do komunikowania się z kontem magazynu używanym na potrzeby archiwizacji danych, określenie sygnatury dostępu współdzielonego lub tożsamości zarządzanej, wartość domyślna to SAS
storage-subscription-id		string	Identyfikator subskrypcji kontenera magazynu dla danych do wyeksportowania przy użyciu identyfikatora ManagedIdentity.

Odpowiedzi

Nazwa	Typ	Opis
200 OK		Operacja eksportowania powiodła się.
202 Accepted		Operacja eksportowania została pomyślnie w kolejce; postępuj zgodnie z nagłówka Location, aby sondować wynik końcowy.
204 No Content		Operacja eksportowania powiodła się.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

RedisCacheExport

Sample Request

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redis/cache1/export?api-version=2023-08-01

{
  "format": "RDB",
  "prefix": "datadump1",
  "container": "https://contosostorage.blob.core.window.net/urltoBlobContainer?sasKeyParameters",
  "storage-subscription-id": "storageSubId"
}

Java

import com.azure.resourcemanager.redis.models.ExportRdbParameters;

/** Samples for Redis ExportData. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/redis/resource-manager/Microsoft.Cache/stable/2023-08-01/examples/RedisCacheExport.json
     */
    /**
     * Sample code: RedisCacheExport.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void redisCacheExport(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.redisCaches().manager().serviceClient().getRedis().exportData("rg1", "cache1",
            new ExportRdbParameters().withFormat("RDB").withPrefix("datadump1")
                .withContainer("https://contosostorage.blob.core.window.net/urltoBlobContainer?sasKeyParameters")
                .withStorageSubscriptionId("storageSubId"),
            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.redis import RedisManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-redis
# USAGE
    python redis_cache_export.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 = RedisManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    client.redis.begin_export_data(
        resource_group_name="rg1",
        name="cache1",
        parameters={
            "container": "https://contosostorage.blob.core.window.net/urltoBlobContainer?sasKeyParameters",
            "format": "RDB",
            "prefix": "datadump1",
            "storage-subscription-id": "storageSubId",
        },
    ).result()


# x-ms-original-file: specification/redis/resource-manager/Microsoft.Cache/stable/2023-08-01/examples/RedisCacheExport.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 armredis_test

import (
	"context"
	"log"

	"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/redis/armredis/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/20312e2b31df58f0ea7560e87062d62aa92f0a14/specification/redis/resource-manager/Microsoft.Cache/stable/2023-08-01/examples/RedisCacheExport.json
func ExampleClient_BeginExportData() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armredis.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewClient().BeginExportData(ctx, "rg1", "cache1", armredis.ExportRDBParameters{
		Format:                to.Ptr("RDB"),
		Container:             to.Ptr("https://contosostorage.blob.core.window.net/urltoBlobContainer?sasKeyParameters"),
		Prefix:                to.Ptr("datadump1"),
		StorageSubscriptionID: to.Ptr("storageSubId"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

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 { RedisManagementClient } = require("@azure/arm-rediscache");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Export data from the redis cache to blobs in a container.
 *
 * @summary Export data from the redis cache to blobs in a container.
 * x-ms-original-file: specification/redis/resource-manager/Microsoft.Cache/stable/2023-08-01/examples/RedisCacheExport.json
 */
async function redisCacheExport() {
  const subscriptionId = process.env["REDIS_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["REDIS_RESOURCE_GROUP"] || "rg1";
  const name = "cache1";
  const parameters = {
    format: "RDB",
    container: "https://contosostorage.blob.core.window.net/urltoBlobContainer?sasKeyParameters",
    prefix: "datadump1",
    storageSubscriptionId: "storageSubId",
  };
  const credential = new DefaultAzureCredential();
  const client = new RedisManagementClient(credential, subscriptionId);
  const result = await client.redis.beginExportDataAndWait(resourceGroupName, name, 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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Redis;
using Azure.ResourceManager.Redis.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/redis/resource-manager/Microsoft.Cache/stable/2023-08-01/examples/RedisCacheExport.json
// this example is just showing the usage of "Redis_ExportData" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this RedisResource created on azure
// for more information of creating RedisResource, please refer to the document of RedisResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string name = "cache1";
ResourceIdentifier redisResourceId = RedisResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
RedisResource redis = client.GetRedisResource(redisResourceId);

// invoke the operation
ExportRdbContent content = new ExportRdbContent("datadump1", "https://contosostorage.blob.core.window.net/urltoBlobContainer?sasKeyParameters")
{
    Format = "RDB",
    StorageSubscriptionId = "storageSubId",
};
await redis.ExportDataAsync(WaitUntil.Completed, content);

Console.WriteLine($"Succeeded");

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 code:

202

location: https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult...

Status code:

204

Definicje

Nazwa	Opis
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
ExportRDBParameters	Parametry operacji eksportowania usługi Redis.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt error.

ExportRDBParameters

Parametry operacji eksportowania usługi Redis.

Nazwa	Typ	Opis
container	string	Nazwa kontenera do wyeksportowania.
format	string	Format pliku.
preferred-data-archive-auth-method	string	Preferowana metoda uwierzytelniania do komunikowania się z kontem magazynu używanym na potrzeby archiwizacji danych, określenie sygnatury dostępu współdzielonego lub tożsamości zarządzanej, wartość domyślna to SAS
prefix	string	Prefiks do użycia dla wyeksportowanych plików.
storage-subscription-id	string	Identyfikator subskrypcji kontenera magazynu dla danych do wyeksportowania przy użyciu identyfikatora ManagedIdentity.