Databases - Create

Başvuru

Service:: Redis Cache

API Version:: 2024-02-01

Veritabanı oluşturur

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
clusterName	path	True	string	RedisEnterprise kümesinin adı.
databaseName	path	True	string	Veritabanının adı.
resourceGroupName	path	True	string	Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir.
subscriptionId	path	True	string	Hedef aboneliğin kimliği.
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name	Tür	Description
properties.clientProtocol	Protocol	Redis istemcilerinin TLS şifreli veya düz metin redis protokolleri kullanarak bağlanıp bağlanamayacağını belirtir. Varsayılan değer TLS ile şifrelenmiştir.
properties.clusteringPolicy	ClusteringPolicy	Kümeleme ilkesi - varsayılan değer OSSCluster'dır. Oluşturma zamanında belirtilir.
properties.evictionPolicy	EvictionPolicy	Redis çıkarma ilkesi - varsayılan: VolatileLRU
properties.geoReplication	GeoReplication	Bu veritabanı için coğrafi çoğaltmayı yapılandırmak için isteğe bağlı özellik kümesi.
properties.modules	Module[]	Bu veritabanında etkinleştirmek için isteğe bağlı redis modülleri kümesi - modüller yalnızca oluşturma zamanında eklenebilir.
properties.persistence	Persistence	Kalıcılık ayarları Kalıcılık ayarları
properties.port	integer	Veritabanı uç noktasının TCP bağlantı noktası. Oluşturma zamanında belirtilir. Varsayılan olarak kullanılabilir bir bağlantı noktası kullanır.

Yanıtlar

Name	Tür	Description
200 OK	Database	Veritabanı güncelleştiriliyor/güncelleştiriliyor. Ayrıntılı durum için provisioningState ve resourceState'i denetleyin.
201 Created	Database	Veritabanı oluşturuluyordu/oluşturuluyordu. Ayrıntılı durum için provisioningState ve resourceState'i denetleyin.
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 Flow.

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

Scopes

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

Örnekler

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

Tanımlar

Name	Description
AofFrequency	Verilerin diske yazıldığı sıklığı ayarlar.
ClusteringPolicy	Kümeleme ilkesi - varsayılan değer OSSCluster'dır. Oluşturma zamanında belirtilir.
Database	RedisEnterprise kümesindeki bir veritabanını açıklar
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
EvictionPolicy	Redis çıkarma ilkesi - varsayılan: VolatileLRU
GeoReplication	Bu veritabanı için coğrafi çoğaltmayı yapılandırmak için isteğe bağlı özellik kümesi.
LinkedDatabase	Bağlı Veritabanı
LinkState	Veritabanı kaynakları arasındaki bağlantının durumu.
Module	Modül ayarları
Persistence	Kalıcılık ayarları
Protocol	Redis istemcilerinin TLS şifreli veya düz metin redis protokolleri kullanarak bağlanıp bağlanamayacağını belirtir. Varsayılan değer TLS ile şifrelenmiştir.
ProvisioningState	Geçerli sağlama durumu
RdbFrequency	Veritabanının anlık görüntüsünün oluşturulma sıklığını ayarlar.
ResourceState	Geçerli kaynak durumu

AofFrequency

Verilerin diske yazıldığı sıklığı ayarlar.

Name	Tür	Description
1s	string
always	string

ClusteringPolicy

Kümeleme ilkesi - varsayılan değer OSSCluster'dır. Oluşturma zamanında belirtilir.

Name	Tür	Description
EnterpriseCluster	string
OSSCluster	string

Database

RedisEnterprise kümesindeki bir veritabanını açıklar

Name	Tür	Description
id	string	Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Kaynağın adı
properties.clientProtocol	Protocol	Redis istemcilerinin TLS şifreli veya düz metin redis protokolleri kullanarak bağlanıp bağlanamayacağını belirtir. Varsayılan değer TLS ile şifrelenmiştir.
properties.clusteringPolicy	ClusteringPolicy	Kümeleme ilkesi - varsayılan değer OSSCluster'dır. Oluşturma zamanında belirtilir.
properties.evictionPolicy	EvictionPolicy	Redis çıkarma ilkesi - varsayılan: VolatileLRU
properties.geoReplication	GeoReplication	Bu veritabanı için coğrafi çoğaltmayı yapılandırmak için isteğe bağlı özellik kümesi.
properties.modules	Module[]	Bu veritabanında etkinleştirmek için isteğe bağlı redis modülleri kümesi - modüller yalnızca oluşturma zamanında eklenebilir.
properties.persistence	Persistence	Kalıcılık ayarları Kalıcılık ayarları
properties.port	integer	Veritabanı uç noktasının TCP bağlantı noktası. Oluşturma zamanında belirtilir. Varsayılan olarak kullanılabilir bir bağlantı noktası kullanır.
properties.provisioningState	ProvisioningState	Veritabanının geçerli sağlama durumu
properties.resourceState	ResourceState	Veritabanının geçerli kaynak durumu
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

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

ErrorDetail

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

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

EvictionPolicy

Redis çıkarma ilkesi - varsayılan: VolatileLRU

Name	Tür	Description
AllKeysLFU	string
AllKeysLRU	string
AllKeysRandom	string
NoEviction	string
VolatileLFU	string
VolatileLRU	string
VolatileRandom	string
VolatileTTL	string

GeoReplication

Bu veritabanı için coğrafi çoğaltmayı yapılandırmak için isteğe bağlı özellik kümesi.

Name	Tür	Description
groupNickname	string	Bağlantılı veritabanı kaynakları grubunun adı
linkedDatabases	LinkedDatabase[]	Bu veritabanına bağlanacak veritabanı kaynaklarının listesi

LinkedDatabase

Bağlı Veritabanı

Name	Tür	Description
id	string	Bu veritabanına bağlanacak veritabanı kaynağının kaynak kimliği.
state	LinkState	Veritabanı kaynakları arasındaki bağlantının durumu.

LinkState

Veritabanı kaynakları arasındaki bağlantının durumu.

Name	Tür	Description
LinkFailed	string
Linked	string
Linking	string
UnlinkFailed	string
Unlinking	string

Module

Modül ayarları

Name	Tür	Description
args	string	Modülün yapılandırma seçenekleri: 'ERROR_RATE 0,01 INITIAL_SIZE 400'.
name	string	Modülün adı, örneğin 'RedisBloom', 'RediSearch', 'RedisTimeSeries'
version	string	Modülün sürümü, örneğin '1.0'.

Persistence

Kalıcılık ayarları

Name	Tür	Description
aofEnabled	boolean	AOF'nin etkinleştirilip etkinleştirilmediğini ayarlar.
aofFrequency	AofFrequency	Verilerin diske yazıldığı sıklığı ayarlar.
rdbEnabled	boolean	RDB'nin etkinleştirilip etkinleştirilmediğini ayarlar.
rdbFrequency	RdbFrequency	Veritabanının anlık görüntüsünün oluşturulma sıklığını ayarlar.

Protocol

Redis istemcilerinin TLS şifreli veya düz metin redis protokolleri kullanarak bağlanıp bağlanamayacağını belirtir. Varsayılan değer TLS ile şifrelenmiştir.

Name	Tür	Description
Encrypted	string
Plaintext	string

ProvisioningState

Geçerli sağlama durumu

Name	Tür	Description
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

RdbFrequency

Veritabanının anlık görüntüsünün oluşturulma sıklığını ayarlar.

Name	Tür	Description
12h	string
1h	string
6h	string

ResourceState

Geçerli kaynak durumu

Name	Tür	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

Aracılığıyla paylaş

Databases - Create

URI Parametreleri

İstek Gövdesi

Yanıtlar

Güvenlik

azure_auth

Scopes

Örnekler

RedisEnterpriseDatabasesCreate

Sample Request

Sample Response

RedisEnterpriseDatabasesCreate With Active Geo Replication

Sample Request

Sample Response

Tanımlar

AofFrequency

ClusteringPolicy

Database

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

EvictionPolicy

GeoReplication

LinkedDatabase

LinkState

Module

Persistence

Protocol

ProvisioningState

RdbFrequency

ResourceState

Ek kaynaklar