Redis - Import Data

Hizmet:

Redis Cache

API Sürümü:

2024-11-01

Redis önbelleğine veri aktar.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
name	path	True	string	Redis önbelleğinin adı.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
subscriptionId	path	True	string minLength: 1	Hedef aboneliğin kimliği.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name	Gerekli	Tür	Description
files	True	string[]	dosyaları içeri aktarabilirsiniz.
format		string	Dosya biçimi.
preferred-data-archive-auth-method		string	Veri arşivi için kullanılan depolama hesabıyla iletişim kurmak, SAS veya ManagedIdentity belirtmek için tercih edilen kimlik doğrulama yöntemi, varsayılan değer SAS'dir
storage-subscription-id		string	Yönetilen Kimlik kullanılarak içeri aktaracak dosyaları içeren depolama kapsayıcısının abonelik kimliği.

Yanıtlar

Name	Tür	Description
200 OK		İçeri aktarma işlemi başarılı oldu.
202 Accepted		İçeri aktarma işlemi başarıyla sıralandı; Son sonucu yoklamak için Konum üst bilgisini izleyin.
204 No Content		İçeri aktarma işlemi başarılı oldu.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

RedisCacheImport

Örnek isteği

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redis/cache1/import?api-version=2024-11-01

{
  "format": "RDB",
  "files": [
    "http://fileuris.contoso.com/pathtofile1"
  ],
  "storage-subscription-id": "storageSubId"
}

Java

import com.azure.resourcemanager.redis.models.ImportRdbParameters;
import java.util.Arrays;

/**
 * Samples for Redis ImportData.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/redis/resource-manager/Microsoft.Cache/stable/2024-11-01/examples/RedisCacheImport.json
     */
    /**
     * Sample code: RedisCacheImport.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void redisCacheImport(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.redisCaches().manager().serviceClient().getRedis().importData("rg1", "cache1",
            new ImportRdbParameters().withFormat("RDB")
                .withFiles(Arrays.asList("http://fileuris.contoso.com/pathtofile1"))
                .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_import.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_import_data(
        resource_group_name="rg1",
        name="cache1",
        parameters={
            "files": ["http://fileuris.contoso.com/pathtofile1"],
            "format": "RDB",
            "storage-subscription-id": "storageSubId",
        },
    ).result()


# x-ms-original-file: specification/redis/resource-manager/Microsoft.Cache/stable/2024-11-01/examples/RedisCacheImport.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/45374f48f560b3337ed55735038f1e9bf8cbea65/specification/redis/resource-manager/Microsoft.Cache/stable/2024-11-01/examples/RedisCacheImport.json
func ExampleClient_BeginImportData() {
	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().BeginImportData(ctx, "rg1", "cache1", armredis.ImportRDBParameters{
		Format: to.Ptr("RDB"),
		Files: []*string{
			to.Ptr("http://fileuris.contoso.com/pathtofile1")},
		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");
require("dotenv/config");

/**
 * This sample demonstrates how to Import data into Redis cache.
 *
 * @summary Import data into Redis cache.
 * x-ms-original-file: specification/redis/resource-manager/Microsoft.Cache/stable/2024-11-01/examples/RedisCacheImport.json
 */
async function redisCacheImport() {
  const subscriptionId = process.env["REDIS_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["REDIS_RESOURCE_GROUP"] || "rg1";
  const name = "cache1";
  const parameters = {
    format: "RDB",
    files: ["http://fileuris.contoso.com/pathtofile1"],
    storageSubscriptionId: "storageSubId",
  };
  const credential = new DefaultAzureCredential();
  const client = new RedisManagementClient(credential, subscriptionId);
  const result = await client.redis.beginImportDataAndWait(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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Redis.Models;
using Azure.ResourceManager.Redis;

// Generated from example definition: specification/redis/resource-manager/Microsoft.Cache/stable/2024-11-01/examples/RedisCacheImport.json
// this example is just showing the usage of "Redis_ImportData" 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
ImportRdbContent content = new ImportRdbContent(new string[] { "http://fileuris.contoso.com/pathtofile1" })
{
    Format = "RDB",
    StorageSubscriptionId = "storageSubId",
};
await redis.ImportDataAsync(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

Örnek yanıt

Durum kodu:

200

Durum kodu:

202

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

Durum kodu:

204

Tanımlar

Name	Description
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
ImportRDBParameters	Redis içeri aktarma işlemi için parametreler.

ErrorAdditionalInfo

Object

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Object

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Object

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

ImportRDBParameters

Object

Redis içeri aktarma işlemi için parametreler.

Name	Tür	Description
files	string[]	dosyaları içeri aktarabilirsiniz.
format	string	Dosya biçimi.
preferred-data-archive-auth-method	string	Veri arşivi için kullanılan depolama hesabıyla iletişim kurmak, SAS veya ManagedIdentity belirtmek için tercih edilen kimlik doğrulama yöntemi, varsayılan değer SAS'dir
storage-subscription-id	string	Yönetilen Kimlik kullanılarak içeri aktaracak dosyaları içeren depolama kapsayıcısının abonelik kimliği.