Databases - Create

참조

Service:: Redis Cache

API Version:: 2024-02-01

데이터베이스 만들기

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redisEnterprise/{clusterName}/databases/{databaseName}?api-version=2024-02-01

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
clusterName	path	True	string	RedisEnterprise 클러스터의 이름입니다.
databaseName	path	True	string	데이터베이스의 이름입니다.
resourceGroupName	path	True	string	리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
subscriptionId	path	True	string	대상 구독의 ID입니다.
api-version	query	True	string	이 작업에 사용할 API 버전입니다.

요청 본문

Name	형식	Description
properties.clientProtocol	Protocol	Redis 클라이언트가 TLS 암호화 또는 일반 텍스트 redis 프로토콜을 사용하여 연결할 수 있는지 여부를 지정합니다. 기본값은 TLS 암호화입니다.
properties.clusteringPolicy	ClusteringPolicy	클러스터링 정책 - 기본값은 OSSCluster입니다. 생성 시 지정됩니다.
properties.evictionPolicy	EvictionPolicy	Redis 제거 정책 - 기본값은 VolatileLRU입니다.
properties.geoReplication	GeoReplication	이 데이터베이스에 대한 지역 복제를 구성하는 속성의 선택적 집합입니다.
properties.modules	Module[]	이 데이터베이스에서 사용하도록 설정할 선택적 redis 모듈 집합 - 모듈은 생성 시에만 추가할 수 있습니다.
properties.persistence	Persistence	지속성 설정 지속성 설정
properties.port	integer	데이터베이스 엔드포인트의 TCP 포트입니다. 생성 시 지정됩니다. 기본값은 사용 가능한 포트입니다.

응답

Name	형식	Description
200 OK	Database	데이터베이스가 업데이트되고 있습니다. 자세한 상태 대한 provisioningState 및 resourceState를 확인합니다.
201 Created	Database	데이터베이스가 만들어지고 있습니다. 자세한 상태 대한 provisioningState 및 resourceState를 확인합니다.
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

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	사용자 계정 가장

예제

RedisEnterpriseDatabasesCreate

RedisEnterpriseDatabasesCreate With Active Geo Replication

RedisEnterpriseDatabasesCreate

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default?api-version=2024-02-01

{
  "properties": {
    "clientProtocol": "Encrypted",
    "clusteringPolicy": "EnterpriseCluster",
    "evictionPolicy": "AllKeysLRU",
    "persistence": {
      "aofEnabled": true,
      "aofFrequency": "1s"
    },
    "port": 10000,
    "modules": [
      {
        "name": "RedisBloom",
        "args": "ERROR_RATE 0.00 INITIAL_SIZE 400"
      },
      {
        "name": "RedisTimeSeries",
        "args": "RETENTION_POLICY 20"
      },
      {
        "name": "RediSearch"
      }
    ]
  }
}

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.RedisEnterprise;
using Azure.ResourceManager.RedisEnterprise.Models;

// Generated from example definition: specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesCreate.json
// this example is just showing the usage of "Databases_Create" 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 RedisEnterpriseClusterResource created on azure
// for more information of creating RedisEnterpriseClusterResource, please refer to the document of RedisEnterpriseClusterResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string clusterName = "cache1";
ResourceIdentifier redisEnterpriseClusterResourceId = RedisEnterpriseClusterResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, clusterName);
RedisEnterpriseClusterResource redisEnterpriseCluster = client.GetRedisEnterpriseClusterResource(redisEnterpriseClusterResourceId);

// get the collection of this RedisEnterpriseDatabaseResource
RedisEnterpriseDatabaseCollection collection = redisEnterpriseCluster.GetRedisEnterpriseDatabases();

// invoke the operation
string databaseName = "default";
RedisEnterpriseDatabaseData data = new RedisEnterpriseDatabaseData()
{
    ClientProtocol = RedisEnterpriseClientProtocol.Encrypted,
    Port = 10000,
    ClusteringPolicy = RedisEnterpriseClusteringPolicy.EnterpriseCluster,
    EvictionPolicy = RedisEnterpriseEvictionPolicy.AllKeysLru,
    Persistence = new RedisPersistenceSettings()
    {
        IsAofEnabled = true,
        AofFrequency = PersistenceSettingAofFrequency.OneSecond,
    },
    Modules =
    {
    new RedisEnterpriseModule("RedisBloom")
    {
    Args = "ERROR_RATE 0.00 INITIAL_SIZE 400",
    },new RedisEnterpriseModule("RedisTimeSeries")
    {
    Args = "RETENTION_POLICY 20",
    },new RedisEnterpriseModule("RediSearch")
    },
};
ArmOperation<RedisEnterpriseDatabaseResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, databaseName, data);
RedisEnterpriseDatabaseResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
RedisEnterpriseDatabaseData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default",
  "name": "cache1/default",
  "type": "Microsoft.Cache/redisEnterprise/databases",
  "properties": {
    "provisioningState": "Updating",
    "resourceState": "Updating",
    "clientProtocol": "Encrypted",
    "clusteringPolicy": "EnterpriseCluster",
    "evictionPolicy": "AllKeysLRU",
    "persistence": {
      "aofEnabled": true,
      "aofFrequency": "1s"
    },
    "port": 10000,
    "modules": [
      {
        "name": "RedisBloom",
        "args": "ERROR_RATE 0.00 INITIAL_SIZE 400",
        "version": "1.0.0"
      },
      {
        "name": "RedisTimeSeries",
        "args": "RETENTION_POLICY 20",
        "version": "1.0.0"
      },
      {
        "name": "RediSearch",
        "args": "",
        "version": "1.0.0"
      }
    ]
  }
}

Status code:: 201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/db1",
  "name": "cache1/db1",
  "type": "Microsoft.Cache/redisEnterprise/databases",
  "properties": {
    "provisioningState": "Creating",
    "resourceState": "Creating",
    "clientProtocol": "Encrypted",
    "clusteringPolicy": "EnterpriseCluster",
    "evictionPolicy": "AllKeysLRU",
    "persistence": {
      "aofEnabled": true,
      "aofFrequency": "1s"
    },
    "port": 10000,
    "modules": [
      {
        "name": "RedisBloom",
        "args": "ERROR_RATE 0.00 INITIAL_SIZE 400",
        "version": "1.0.0"
      },
      {
        "name": "RedisTimeSeries",
        "args": "RETENTION_POLICY 20",
        "version": "1.0.0"
      },
      {
        "name": "RediSearch",
        "args": "",
        "version": "1.0.0"
      }
    ]
  }
}

RedisEnterpriseDatabasesCreate With Active Geo Replication

Sample Request

HTTP
dotnet

PUT https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default?api-version=2024-02-01

{
  "properties": {
    "clientProtocol": "Encrypted",
    "clusteringPolicy": "EnterpriseCluster",
    "evictionPolicy": "NoEviction",
    "port": 10000,
    "geoReplication": {
      "groupNickname": "groupName",
      "linkedDatabases": [
        {
          "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default"
        },
        {
          "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default"
        }
      ]
    }
  }
}

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.RedisEnterprise;
using Azure.ResourceManager.RedisEnterprise.Models;

// Generated from example definition: specification/redisenterprise/resource-manager/Microsoft.Cache/stable/2024-02-01/examples/RedisEnterpriseDatabasesCreateWithGeoReplication.json
// this example is just showing the usage of "Databases_Create" 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 RedisEnterpriseClusterResource created on azure
// for more information of creating RedisEnterpriseClusterResource, please refer to the document of RedisEnterpriseClusterResource
string subscriptionId = "subid1";
string resourceGroupName = "rg1";
string clusterName = "cache1";
ResourceIdentifier redisEnterpriseClusterResourceId = RedisEnterpriseClusterResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, clusterName);
RedisEnterpriseClusterResource redisEnterpriseCluster = client.GetRedisEnterpriseClusterResource(redisEnterpriseClusterResourceId);

// get the collection of this RedisEnterpriseDatabaseResource
RedisEnterpriseDatabaseCollection collection = redisEnterpriseCluster.GetRedisEnterpriseDatabases();

// invoke the operation
string databaseName = "default";
RedisEnterpriseDatabaseData data = new RedisEnterpriseDatabaseData()
{
    ClientProtocol = RedisEnterpriseClientProtocol.Encrypted,
    Port = 10000,
    ClusteringPolicy = RedisEnterpriseClusteringPolicy.EnterpriseCluster,
    EvictionPolicy = RedisEnterpriseEvictionPolicy.NoEviction,
    GeoReplication = new RedisEnterpriseDatabaseGeoReplication()
    {
        GroupNickname = "groupName",
        LinkedDatabases =
        {
        new RedisEnterpriseLinkedDatabase()
        {
        Id = new ResourceIdentifier("/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default"),
        },new RedisEnterpriseLinkedDatabase()
        {
        Id = new ResourceIdentifier("/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default"),
        }
        },
    },
};
ArmOperation<RedisEnterpriseDatabaseResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, databaseName, data);
RedisEnterpriseDatabaseResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
RedisEnterpriseDatabaseData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

{
  "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default",
  "name": "cache1/default",
  "type": "Microsoft.Cache/redisEnterprise/databases",
  "properties": {
    "provisioningState": "Updating",
    "resourceState": "Updating",
    "clientProtocol": "Encrypted",
    "clusteringPolicy": "EnterpriseCluster",
    "evictionPolicy": "NoEviction",
    "port": 10000,
    "geoReplication": {
      "groupNickname": "groupName",
      "linkedDatabases": [
        {
          "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default",
          "state": "Linking"
        },
        {
          "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default",
          "state": "Linking"
        }
      ]
    }
  }
}

Status code:: 201

{
  "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/db1",
  "name": "cache1/db1",
  "type": "Microsoft.Cache/redisEnterprise/databases",
  "properties": {
    "provisioningState": "Creating",
    "resourceState": "Creating",
    "clientProtocol": "Plaintext",
    "clusteringPolicy": "EnterpriseCluster",
    "evictionPolicy": "NoEviction",
    "port": 10000,
    "geoReplication": {
      "groupNickname": "groupName",
      "linkedDatabases": [
        {
          "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default",
          "state": "Linking"
        },
        {
          "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default",
          "state": "Linking"
        }
      ]
    }
  }
}

정의

Name	Description
AofFrequency	데이터가 디스크에 기록되는 빈도를 설정합니다.
ClusteringPolicy	클러스터링 정책 - 기본값은 OSSCluster입니다. 생성 시 지정됩니다.
Database	RedisEnterprise 클러스터의 데이터베이스에 대해 설명합니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
EvictionPolicy	Redis 제거 정책 - 기본값은 VolatileLRU입니다.
GeoReplication	이 데이터베이스에 대한 지역 복제를 구성하는 속성의 선택적 집합입니다.
LinkedDatabase	연결된 데이터베이스
LinkState	데이터베이스 리소스 간의 링크 상태입니다.
Module	모듈 설정
Persistence	지속성 설정
Protocol	Redis 클라이언트가 TLS 암호화 또는 일반 텍스트 redis 프로토콜을 사용하여 연결할 수 있는지 여부를 지정합니다. 기본값은 TLS 암호화입니다.
ProvisioningState	현재 프로비저닝 상태
RdbFrequency	데이터베이스의 스냅샷 생성되는 빈도를 설정합니다.
ResourceState	현재 리소스 상태

AofFrequency

데이터가 디스크에 기록되는 빈도를 설정합니다.

Name	형식	Description
1s	string
always	string

ClusteringPolicy

클러스터링 정책 - 기본값은 OSSCluster입니다. 생성 시 지정됩니다.

Name	형식	Description
EnterpriseCluster	string
OSSCluster	string

Database

RedisEnterprise 클러스터의 데이터베이스에 대해 설명합니다.

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	리소스의 이름입니다.
properties.clientProtocol	Protocol	Redis 클라이언트가 TLS 암호화 또는 일반 텍스트 redis 프로토콜을 사용하여 연결할 수 있는지 여부를 지정합니다. 기본값은 TLS 암호화입니다.
properties.clusteringPolicy	ClusteringPolicy	클러스터링 정책 - 기본값은 OSSCluster입니다. 생성 시 지정됩니다.
properties.evictionPolicy	EvictionPolicy	Redis 제거 정책 - 기본값은 VolatileLRU입니다.
properties.geoReplication	GeoReplication	이 데이터베이스에 대한 지역 복제를 구성하는 속성의 선택적 집합입니다.
properties.modules	Module[]	이 데이터베이스에서 사용하도록 설정할 선택적 redis 모듈 집합 - 모듈은 생성 시에만 추가할 수 있습니다.
properties.persistence	Persistence	지속성 설정 지속성 설정
properties.port	integer	데이터베이스 엔드포인트의 TCP 포트입니다. 생성 시 지정됩니다. 기본값은 사용 가능한 포트입니다.
properties.provisioningState	ProvisioningState	데이터베이스의 현재 프로비전 상태
properties.resourceState	ResourceState	데이터베이스의 현재 리소스 상태
type	string	리소스 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

오류 응답

Name	형식	Description
error	ErrorDetail	Error 개체.

EvictionPolicy

Redis 제거 정책 - 기본값은 VolatileLRU입니다.

Name	형식	Description
AllKeysLFU	string
AllKeysLRU	string
AllKeysRandom	string
NoEviction	string
VolatileLFU	string
VolatileLRU	string
VolatileRandom	string
VolatileTTL	string

GeoReplication

이 데이터베이스에 대한 지역 복제를 구성하는 속성의 선택적 집합입니다.

Name	형식	Description
groupNickname	string	연결된 데이터베이스 리소스 그룹의 이름
linkedDatabases	LinkedDatabase[]	이 데이터베이스와 연결할 데이터베이스 리소스 목록

LinkedDatabase

연결된 데이터베이스

Name	형식	Description
id	string	이 데이터베이스와 연결할 데이터베이스 리소스의 리소스 ID입니다.
state	LinkState	데이터베이스 리소스 간의 링크 상태입니다.

LinkState

데이터베이스 리소스 간의 링크 상태입니다.

Name	형식	Description
LinkFailed	string
Linked	string
Linking	string
UnlinkFailed	string
Unlinking	string

Module

모듈 설정

Name	형식	Description
args	string	모듈에 대한 구성 옵션(예: 'ERROR_RATE 0.01 INITIAL_SIZE 400').
name	string	모듈의 이름(예: 'RedisBloom', 'RediSearch', 'RedisTimeSeries'
version	string	모듈의 버전입니다(예: '1.0').

Persistence

지속성 설정

Name	형식	Description
aofEnabled	boolean	AOF를 사용할 수 있는지 여부를 설정합니다.
aofFrequency	AofFrequency	데이터가 디스크에 기록되는 빈도를 설정합니다.
rdbEnabled	boolean	RDB를 사용할 수 있는지 여부를 설정합니다.
rdbFrequency	RdbFrequency	데이터베이스의 스냅샷 생성되는 빈도를 설정합니다.

Protocol

Redis 클라이언트가 TLS 암호화 또는 일반 텍스트 redis 프로토콜을 사용하여 연결할 수 있는지 여부를 지정합니다. 기본값은 TLS 암호화입니다.

Name	형식	Description
Encrypted	string
Plaintext	string

ProvisioningState

현재 프로비저닝 상태

Name	형식	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

RdbFrequency

데이터베이스의 스냅샷 생성되는 빈도를 설정합니다.

Name	형식	Description
12h	string
1h	string
6h	string

ResourceState

현재 리소스 상태

Name	형식	Description
CreateFailed	string
Creating	string
DeleteFailed	string
Deleting	string
DisableFailed	string
Disabled	string
Disabling	string
EnableFailed	string
Enabling	string
Running	string
Scaling	string
ScalingFailed	string
UpdateFailed	string
Updating	string

Share via

Databases - Create

URI 매개 변수

요청 본문

응답

보안

azure_auth

Scopes

예제

RedisEnterpriseDatabasesCreate

Sample Request

Sample Response

RedisEnterpriseDatabasesCreate With Active Geo Replication

Sample Request

Sample Response

정의

AofFrequency

ClusteringPolicy

Database

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

EvictionPolicy

GeoReplication

LinkedDatabase

LinkState

Module

Persistence

Protocol

ProvisioningState

RdbFrequency

ResourceState

추가 리소스