Databases - Create

Odwołanie

Service:: Redis Cache

API Version:: 2024-02-01

Tworzy bazę danych

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
clusterName	path	True	string	Nazwa klastra RedisEnterprise.
databaseName	path	True	string	Nazwa bazy danych.
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	Typ	Opis
properties.clientProtocol	Protocol	Określa, czy klienci usługi Redis mogą łączyć się przy użyciu protokołów redis szyfrowanych protokołami TLS lub zwykłego tekstu. Wartość domyślna to TLS-encrypted.
properties.clusteringPolicy	ClusteringPolicy	Zasady klastrowania — wartość domyślna to OSSCluster. Określony w czasie tworzenia.
properties.evictionPolicy	EvictionPolicy	Zasady eksmisji usługi Redis — wartość domyślna to VolatileLRU
properties.geoReplication	GeoReplication	Opcjonalny zestaw właściwości do konfigurowania replikacji geograficznej dla tej bazy danych.
properties.modules	Module[]	Opcjonalny zestaw modułów redis do włączenia w tej bazie danych — moduły można dodawać tylko w czasie tworzenia.
properties.persistence	Persistence	Ustawienia trwałości Ustawienia trwałości
properties.port	integer	Port TCP punktu końcowego bazy danych. Określony w czasie tworzenia. Domyślnie jest używany dostępny port.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Database	Baza danych była/jest aktualizowana. Sprawdź stan provisioningState i resourceState.
201 Created	Database	Baza danych została utworzona/utworzona. Sprawdź stan provisioningState i resourceState.
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

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

Definicje

Nazwa	Opis
AofFrequency	Ustawia częstotliwość zapisywania danych na dysku.
ClusteringPolicy	Zasady klastrowania — wartość domyślna to OSSCluster. Określony w czasie tworzenia.
Database	Opisuje bazę danych w klastrze RedisEnterprise
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
EvictionPolicy	Zasady eksmisji usługi Redis — wartość domyślna to VolatileLRU
GeoReplication	Opcjonalny zestaw właściwości do konfigurowania replikacji geograficznej dla tej bazy danych.
LinkedDatabase	Połączona baza danych
LinkState	Stan połączenia między zasobami bazy danych.
Module	Ustawienia modułu
Persistence	Ustawienia trwałości
Protocol	Określa, czy klienci usługi Redis mogą łączyć się przy użyciu protokołów redis szyfrowanych protokołami TLS lub zwykłego tekstu. Wartość domyślna to TLS-encrypted.
ProvisioningState	Bieżący stan aprowizacji
RdbFrequency	Ustawia częstotliwość tworzenia migawki bazy danych.
ResourceState	Bieżący stan zasobu

AofFrequency

Ustawia częstotliwość zapisywania danych na dysku.

Nazwa	Typ	Opis
1s	string
always	string

ClusteringPolicy

Zasady klastrowania — wartość domyślna to OSSCluster. Określony w czasie tworzenia.

Nazwa	Typ	Opis
EnterpriseCluster	string
OSSCluster	string

Database

Opisuje bazę danych w klastrze RedisEnterprise

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties.clientProtocol	Protocol	Określa, czy klienci usługi Redis mogą łączyć się przy użyciu protokołów redis szyfrowanych protokołami TLS lub zwykłego tekstu. Wartość domyślna to TLS-encrypted.
properties.clusteringPolicy	ClusteringPolicy	Zasady klastrowania — wartość domyślna to OSSCluster. Określony w czasie tworzenia.
properties.evictionPolicy	EvictionPolicy	Zasady eksmisji usługi Redis — wartość domyślna to VolatileLRU
properties.geoReplication	GeoReplication	Opcjonalny zestaw właściwości do konfigurowania replikacji geograficznej dla tej bazy danych.
properties.modules	Module[]	Opcjonalny zestaw modułów redis do włączenia w tej bazie danych — moduły można dodawać tylko w czasie tworzenia.
properties.persistence	Persistence	Ustawienia trwałości Ustawienia trwałości
properties.port	integer	Port TCP punktu końcowego bazy danych. Określony w czasie tworzenia. Domyślnie jest używany dostępny port.
properties.provisioningState	ProvisioningState	Bieżący stan aprowizacji bazy danych
properties.resourceState	ResourceState	Bieżący stan zasobu bazy danych
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

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.

EvictionPolicy

Zasady eksmisji usługi Redis — wartość domyślna to VolatileLRU

Nazwa	Typ	Opis
AllKeysLFU	string
AllKeysLRU	string
AllKeysRandom	string
NoEviction	string
VolatileLFU	string
VolatileLRU	string
VolatileRandom	string
VolatileTTL	string

GeoReplication

Opcjonalny zestaw właściwości do konfigurowania replikacji geograficznej dla tej bazy danych.

Nazwa	Typ	Opis
groupNickname	string	Nazwa grupy połączonych zasobów bazy danych
linkedDatabases	LinkedDatabase[]	Lista zasobów bazy danych do połączenia z tą bazą danych

LinkedDatabase

Połączona baza danych

Nazwa	Typ	Opis
id	string	Identyfikator zasobu bazy danych do połączenia z tą bazą danych.
state	LinkState	Stan połączenia między zasobami bazy danych.

LinkState

Stan połączenia między zasobami bazy danych.

Nazwa	Typ	Opis
LinkFailed	string
Linked	string
Linking	string
UnlinkFailed	string
Unlinking	string

Module

Ustawienia modułu

Nazwa	Typ	Opis
args	string	Opcje konfiguracji modułu, np. "ERROR_RATE 0.01 INITIAL_SIZE 400".
name	string	Nazwa modułu, np. "RedisBloom", "RediSearch", "RedisTimeSeries"
version	string	Wersja modułu, np. "1.0".

Persistence

Ustawienia trwałości

Nazwa	Typ	Opis
aofEnabled	boolean	Ustawia, czy włączono funkcję AOF.
aofFrequency	AofFrequency	Ustawia częstotliwość zapisywania danych na dysku.
rdbEnabled	boolean	Ustawia, czy baza danych RDB jest włączona.
rdbFrequency	RdbFrequency	Ustawia częstotliwość tworzenia migawki bazy danych.

Protocol

Określa, czy klienci usługi Redis mogą łączyć się przy użyciu protokołów redis szyfrowanych protokołami TLS lub zwykłego tekstu. Wartość domyślna to TLS-encrypted.

Nazwa	Typ	Opis
Encrypted	string
Plaintext	string

ProvisioningState

Bieżący stan aprowizacji

Nazwa	Typ	Opis
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

RdbFrequency

Ustawia częstotliwość tworzenia migawki bazy danych.

Nazwa	Typ	Opis
12h	string
1h	string
6h	string

ResourceState

Bieżący stan zasobu

Nazwa	Typ	Opis
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

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Scopes

Przykłady

RedisEnterpriseDatabasesCreate

Sample Request

Sample Response

RedisEnterpriseDatabasesCreate With Active Geo Replication

Sample Request

Sample Response

Definicje

AofFrequency

ClusteringPolicy

Database

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

EvictionPolicy

GeoReplication

LinkedDatabase

LinkState

Module

Persistence

Protocol

ProvisioningState

RdbFrequency

ResourceState

Dodatkowe zasoby