Databases - Create

Riferimento

Servizio:: Redis Cache

Versione API:: 2024-02-01

Crea un database

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
clusterName	path	True	string	Nome del cluster RedisEnterprise.
databaseName	path	True	string	Nome del database.
resourceGroupName	path	True	string	Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Tipo	Descrizione
properties.clientProtocol	Protocol	Specifica se i client redis possono connettersi usando protocolli redis crittografati o crittografati con TLS. Il valore predefinito è tls crittografato.
properties.clusteringPolicy	ClusteringPolicy	Criteri di clustering: il valore predefinito è OSSCluster. Specificato in fase di creazione.
properties.evictionPolicy	EvictionPolicy	Criteri di rimozione Redis: il valore predefinito è VolatileLRU
properties.geoReplication	GeoReplication	Set facoltativo di proprietà per configurare la replica geografica per questo database.
properties.modules	Module[]	Set facoltativo di moduli redis da abilitare in questo database: i moduli possono essere aggiunti solo in fase di creazione.
properties.persistence	Persistence	Impostazioni di persistenza Impostazioni di persistenza
properties.port	integer	Porta TCP dell'endpoint del database. Specificato in fase di creazione. Il valore predefinito è una porta disponibile.

Risposte

Nome	Tipo	Descrizione
200 OK	Database	Il database è stato/viene aggiornato. Controllare il provisioningState e resourceState per lo stato dettagliato.
201 Created	Database	Il database è stato creato/viene creato. Controllare il provisioningState e resourceState per lo stato dettagliato.
Other Status Codes	ErrorResponse	Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

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

Risposta di esempio

Codice di stato:: 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"
      }
    ]
  }
}

Codice di stato:: 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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
        }
      ]
    }
  }
}

Codice di stato:: 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"
        }
      ]
    }
  }
}

Definizioni

Nome	Descrizione
AofFrequency	Imposta la frequenza in cui i dati vengono scritti su disco.
ClusteringPolicy	Criteri di clustering: il valore predefinito è OSSCluster. Specificato in fase di creazione.
Database	Descrive un database nel cluster RedisEnterprise
ErrorAdditionalInfo	Informazioni aggiuntive sulla gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
EvictionPolicy	Criteri di rimozione Redis: il valore predefinito è VolatileLRU
GeoReplication	Set facoltativo di proprietà per configurare la replica geografica per questo database.
LinkedDatabase	Database collegato
LinkState	Stato del collegamento tra le risorse del database.
Module	Impostazioni del modulo
Persistence	Impostazioni di persistenza
Protocol	Specifica se i client redis possono connettersi usando protocolli redis crittografati o crittografati con TLS. Il valore predefinito è tls crittografato.
ProvisioningState	Stato di provisioning corrente
RdbFrequency	Imposta la frequenza in cui viene creato uno snapshot del database.
ResourceState	Stato della risorsa corrente

AofFrequency

Imposta la frequenza in cui i dati vengono scritti su disco.

Nome	Tipo	Descrizione
1s	string
always	string

ClusteringPolicy

Criteri di clustering: il valore predefinito è OSSCluster. Specificato in fase di creazione.

Nome	Tipo	Descrizione
EnterpriseCluster	string
OSSCluster	string

Database

Descrive un database nel cluster RedisEnterprise

Nome	Tipo	Descrizione
id	string	ID di risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	nome della risorsa.
properties.clientProtocol	Protocol	Specifica se i client redis possono connettersi usando protocolli redis crittografati o crittografati con TLS. Il valore predefinito è tls crittografato.
properties.clusteringPolicy	ClusteringPolicy	Criteri di clustering: il valore predefinito è OSSCluster. Specificato in fase di creazione.
properties.evictionPolicy	EvictionPolicy	Criteri di rimozione Redis: il valore predefinito è VolatileLRU
properties.geoReplication	GeoReplication	Set facoltativo di proprietà per configurare la replica geografica per questo database.
properties.modules	Module[]	Set facoltativo di moduli redis da abilitare in questo database: i moduli possono essere aggiunti solo in fase di creazione.
properties.persistence	Persistence	Impostazioni di persistenza Impostazioni di persistenza
properties.port	integer	Porta TCP dell'endpoint del database. Specificato in fase di creazione. Il valore predefinito è una porta disponibile.
properties.provisioningState	ProvisioningState	Stato di provisioning corrente del database
properties.resourceState	ResourceState	Stato corrente della risorsa del database
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

EvictionPolicy

Criteri di rimozione Redis: il valore predefinito è VolatileLRU

Nome	Tipo	Descrizione
AllKeysLFU	string
AllKeysLRU	string
AllKeysRandom	string
NoEviction	string
VolatileLFU	string
VolatileLRU	string
VolatileRandom	string
VolatileTTL	string

GeoReplication

Set facoltativo di proprietà per configurare la replica geografica per questo database.

Nome	Tipo	Descrizione
groupNickname	string	Nome per il gruppo di risorse del database collegato
linkedDatabases	LinkedDatabase[]	Elenco delle risorse del database da collegare con questo database

LinkedDatabase

Database collegato

Nome	Tipo	Descrizione
id	string	ID risorsa di una risorsa di database da collegare al database.
state	LinkState	Stato del collegamento tra le risorse del database.

LinkState

Stato del collegamento tra le risorse del database.

Nome	Tipo	Descrizione
LinkFailed	string
Linked	string
Linking	string
UnlinkFailed	string
Unlinking	string

Module

Impostazioni del modulo

Nome	Tipo	Descrizione
args	string	Opzioni di configurazione per il modulo, ad esempio 'ERROR_RATE 0,01 INITIAL_SIZE 400'.
name	string	Nome del modulo, ad esempio 'RedisBloom', 'RediSearch', 'RedisTimeSeries'
version	string	Versione del modulo, ad esempio '1.0'.

Persistence

Impostazioni di persistenza

Nome	Tipo	Descrizione
aofEnabled	boolean	Imposta se AOF è abilitato.
aofFrequency	AofFrequency	Imposta la frequenza in cui i dati vengono scritti su disco.
rdbEnabled	boolean	Imposta se RDB è abilitato.
rdbFrequency	RdbFrequency	Imposta la frequenza in cui viene creato uno snapshot del database.

Protocol

Specifica se i client redis possono connettersi usando protocolli redis crittografati o crittografati con TLS. Il valore predefinito è tls crittografato.

Nome	Tipo	Descrizione
Encrypted	string
Plaintext	string

ProvisioningState

Stato di provisioning corrente

Nome	Tipo	Descrizione
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

RdbFrequency

Imposta la frequenza in cui viene creato uno snapshot del database.

Nome	Tipo	Descrizione
12h	string
1h	string
6h	string

ResourceState

Stato della risorsa corrente

Nome	Tipo	Descrizione
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

Condividi tramite

Databases - Create

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

RedisEnterpriseDatabasesCreate

Esempio di richiesta

Risposta di esempio

RedisEnterpriseDatabasesCreate With Active Geo Replication

Esempio di richiesta

Risposta di esempio

Definizioni

AofFrequency

ClusteringPolicy

Database

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

EvictionPolicy

GeoReplication

LinkedDatabase

LinkState

Module

Persistence

Protocol

ProvisioningState

RdbFrequency

ResourceState

Risorse aggiuntive