Partager via

Databases - Create

Service:
Redis Cache
Version d'API:
2025-07-01

Crée une base de données

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

Paramètres URI

Nom Dans Obligatoire Type Description
clusterName
 path True

string

pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$

Nom du cluster Redis Enterprise. Le nom doit comporter 1 à 60 caractères. Caractères autorisés (A-Z, a-z, 0-9) et trait d’union(-). Il ne peut y avoir aucun trait d’union de début ni de fin ni de traits d’union consécutifs
databaseName
 path True

string

pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$

Nom de la base de données Redis Enterprise.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId
 path True

string

minLength: 1

ID de l’abonnement cible.
api-version
 query True

string

minLength: 1

Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom Type Description
properties.accessKeysAuthentication

accessKeysAuthentication

Cette propriété peut être activée/désactivée pour autoriser ou refuser l’accès avec les clés d’accès actuelles. Peut être mis à jour même après la création de la base de données. La valeur par défaut est Désactivée.
properties.clientProtocol

Protocol

Spécifie si les clients redis peuvent se connecter à l’aide de protocoles redis chiffrés ou en texte clair TLS. La valeur par défaut est chiffrée par TLS.
properties.clusteringPolicy

ClusteringPolicy

Stratégie de clustering : la valeur par défaut est OSSCluster. Cette propriété ne peut être mise à jour que si la valeur actuelle est NoCluster. Si la valeur est OSSCluster ou EnterpriseCluster, elle ne peut pas être mise à jour sans supprimer la base de données.
properties.deferUpgrade

DeferUpgradeSetting

Option de report de la mise à niveau lorsque la version la plus récente est publiée : la valeur par défaut est NotDeferred. Pour en savoir plus: https://aka.ms/redisversionupgrade
properties.evictionPolicy

EvictionPolicy

Stratégie d’éviction Redis : la valeur par défaut est VolatileLRU
properties.geoReplication

GeoReplication

Ensemble facultatif de propriétés pour configurer la géoréplication pour cette base de données.
properties.modules

Module[]

Ensemble facultatif de modules redis à activer dans cette base de données : les modules ne peuvent être ajoutés qu’au moment de la création.
properties.persistence

Persistence

Paramètres de persistance
Paramètres de persistance
properties.port

integer (int32)

Port TCP du point de terminaison de base de données. Spécifié au moment de la création. La valeur par défaut est un port disponible.

Réponses

Nom Type Description
200 OK

Database

La base de données a été ou est en cours de mise à jour. Vérifiez provisioningState et resourceState pour obtenir un état détaillé.
201 Created

Database

La base de données a été ou est en cours de création. Vérifiez provisioningState et resourceState pour obtenir un état détaillé.
Other Status Codes

ErrorResponse

Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

RedisEnterpriseDatabasesCreate
RedisEnterpriseDatabasesCreate No Cluster Cache
RedisEnterpriseDatabasesCreate With Active Geo Replication

RedisEnterpriseDatabasesCreate

Exemple de requête

PUT https://management.azure.com/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default?api-version=2025-07-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"
      }
    ],
    "deferUpgrade": "NotDeferred",
    "accessKeysAuthentication": "Enabled"
  }
}

Exemple de réponse

Code d’état:
200 
{
  "id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/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"
      }
    ],
    "deferUpgrade": "NotDeferred",
    "accessKeysAuthentication": "Enabled",
    "redisVersion": "6.0"
  }
}
Code d’état:
201 
{
  "id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/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"
      }
    ],
    "accessKeysAuthentication": "Enabled"
  }
}

RedisEnterpriseDatabasesCreate No Cluster Cache

Exemple de requête

PUT https://management.azure.com/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default?api-version=2025-07-01

{
  "properties": {
    "clientProtocol": "Encrypted",
    "clusteringPolicy": "NoCluster",
    "evictionPolicy": "NoEviction",
    "port": 10000
  }
}

Exemple de réponse

Code d’état:
201 
{
  "id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default",
  "name": "cache1/default",
  "type": "Microsoft.Cache/redisEnterprise/databases",
  "properties": {
    "clientProtocol": "Encrypted",
    "port": 10000,
    "provisioningState": "Creating",
    "resourceState": "Creating",
    "clusteringPolicy": "NoCluster",
    "evictionPolicy": "NoEviction",
    "deferUpgrade": "NotDeferred",
    "redisVersion": "7.2",
    "accessKeysAuthentication": "Enabled"
  }
}
Code d’état:
200 
{
  "id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default",
  "name": "cache1/default",
  "type": "Microsoft.Cache/redisEnterprise/databases",
  "properties": {
    "clientProtocol": "Encrypted",
    "port": 10000,
    "provisioningState": "Updating",
    "resourceState": "Updating",
    "clusteringPolicy": "NoCluster",
    "evictionPolicy": "NoEviction",
    "deferUpgrade": "NotDeferred",
    "redisVersion": "7.2",
    "accessKeysAuthentication": "Enabled"
  }
}

RedisEnterpriseDatabasesCreate With Active Geo Replication

Exemple de requête

PUT https://management.azure.com/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default?api-version=2025-07-01

{
  "properties": {
    "clientProtocol": "Encrypted",
    "clusteringPolicy": "EnterpriseCluster",
    "evictionPolicy": "NoEviction",
    "port": 10000,
    "accessKeysAuthentication": "Enabled",
    "geoReplication": {
      "groupNickname": "groupName",
      "linkedDatabases": [
        {
          "id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default"
        },
        {
          "id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8e/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default"
        }
      ]
    }
  }
}

Exemple de réponse

Code d’état:
200 
{
  "id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/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/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8e/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default",
          "state": "Linking"
        },
        {
          "id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f2/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default",
          "state": "Linking"
        }
      ]
    },
    "deferUpgrade": "NotDeferred",
    "accessKeysAuthentication": "Enabled",
    "redisVersion": "6.0"
  }
}
Code d’état:
201 
{
  "id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/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/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8e/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default",
          "state": "Linking"
        },
        {
          "id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f2/resourceGroups/rg2/providers/Microsoft.Cache/redisEnterprise/cache2/databases/default",
          "state": "Linking"
        }
      ]
    },
    "deferUpgrade": "NotDeferred",
    "accessKeysAuthentication": "Enabled",
    "redisVersion": "6.0"
  }
}

Définitions

Nom Description
accessKeysAuthentication

Cette propriété peut être activée/désactivée pour autoriser ou refuser l’accès avec les clés d’accès actuelles. Peut être mis à jour même après la création de la base de données. La valeur par défaut est Désactivée.
AofFrequency

Définit la fréquence à laquelle les données sont écrites sur le disque. La valeur par défaut est « 1s », ce qui signifie « toutes les secondes ». Notez que le paramètre « always » est déconseillé, en raison de son impact sur les performances.
ClusteringPolicy

Stratégie de clustering : la valeur par défaut est OSSCluster. Cette propriété ne peut être mise à jour que si la valeur actuelle est NoCluster. Si la valeur est OSSCluster ou EnterpriseCluster, elle ne peut pas être mise à jour sans supprimer la base de données.
Database

Décrit une base de données sur le cluster Redis Enterprise
DeferUpgradeSetting

Option de report de la mise à niveau lorsque la version la plus récente est publiée : la valeur par défaut est NotDeferred. Pour en savoir plus: https://aka.ms/redisversionupgrade
ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail

Détail de l’erreur.
ErrorResponse

Réponse d’erreur
EvictionPolicy

Stratégie d’éviction Redis : la valeur par défaut est VolatileLRU
GeoReplication

Ensemble facultatif de propriétés pour configurer la géoréplication pour cette base de données.
LinkedDatabase

Base de données liée
LinkState

État du lien entre les ressources de la base de données.
Module

Paramètres de module
Persistence

Paramètres de persistance
Protocol

Spécifie si les clients redis peuvent se connecter à l’aide de protocoles redis chiffrés ou en texte clair TLS. La valeur par défaut est chiffrée par TLS.
ProvisioningState

État actuel du provisionnement
RdbFrequency

Définit la fréquence à laquelle un instantané de la base de données est créé.
ResourceState

État actuel de la ressource

accessKeysAuthentication

Énumération

Cette propriété peut être activée/désactivée pour autoriser ou refuser l’accès avec les clés d’accès actuelles. Peut être mis à jour même après la création de la base de données. La valeur par défaut est Désactivée.

Valeur Description
Disabled
Enabled

AofFrequency

Énumération

Définit la fréquence à laquelle les données sont écrites sur le disque. La valeur par défaut est « 1s », ce qui signifie « toutes les secondes ». Notez que le paramètre « always » est déconseillé, en raison de son impact sur les performances.

Valeur Description
1s
always

ClusteringPolicy

Énumération

Stratégie de clustering : la valeur par défaut est OSSCluster. Cette propriété ne peut être mise à jour que si la valeur actuelle est NoCluster. Si la valeur est OSSCluster ou EnterpriseCluster, elle ne peut pas être mise à jour sans supprimer la base de données.

Valeur Description
EnterpriseCluster

La stratégie de clustering d’entreprise utilise uniquement le protocole Redis classique, qui ne prend pas en charge les commandes de cluster Redis.
OSSCluster

La politique de clustering OSS suit la spécification de cluster Redis et exige que tous les clients prennent en charge le clustering Redis.
NoCluster

La stratégie NoCluster est utilisée pour les instances Redis non clusterisées qui ne nécessitent pas de fonctionnalités de clustering.

Database

Objet

Décrit une base de données sur le cluster Redis Enterprise

Nom Type Valeur par défaut Description
id

string

ID de ressource complet pour la ressource. ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Nom de la ressource
properties.accessKeysAuthentication

accessKeysAuthentication

Disabled

Cette propriété peut être activée/désactivée pour autoriser ou refuser l’accès avec les clés d’accès actuelles. Peut être mis à jour même après la création de la base de données. La valeur par défaut est Désactivée.
properties.clientProtocol

Protocol

Spécifie si les clients redis peuvent se connecter à l’aide de protocoles redis chiffrés ou en texte clair TLS. La valeur par défaut est chiffrée par TLS.
properties.clusteringPolicy

ClusteringPolicy

Stratégie de clustering : la valeur par défaut est OSSCluster. Cette propriété ne peut être mise à jour que si la valeur actuelle est NoCluster. Si la valeur est OSSCluster ou EnterpriseCluster, elle ne peut pas être mise à jour sans supprimer la base de données.
properties.deferUpgrade

DeferUpgradeSetting

Option de report de la mise à niveau lorsque la version la plus récente est publiée : la valeur par défaut est NotDeferred. Pour en savoir plus: https://aka.ms/redisversionupgrade
properties.evictionPolicy

EvictionPolicy

Stratégie d’éviction Redis : la valeur par défaut est VolatileLRU
properties.geoReplication

GeoReplication

Ensemble facultatif de propriétés pour configurer la géoréplication pour cette base de données.
properties.modules

Module[]

Ensemble facultatif de modules redis à activer dans cette base de données : les modules ne peuvent être ajoutés qu’au moment de la création.
properties.persistence

Persistence

Paramètres de persistance
Paramètres de persistance
properties.port

integer (int32)

Port TCP du point de terminaison de base de données. Spécifié au moment de la création. La valeur par défaut est un port disponible.
properties.provisioningState

ProvisioningState

État actuel de l’approvisionnement de la base de données
properties.redisVersion

string

Version de Redis sur laquelle la base de données s’exécute, par exemple « 6.0 »
properties.resourceState

ResourceState

État actuel des ressources de la base de données
type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

DeferUpgradeSetting

Énumération

Option de report de la mise à niveau lorsque la version la plus récente est publiée : la valeur par défaut est NotDeferred. Pour en savoir plus: https://aka.ms/redisversionupgrade

Valeur Description
Deferred
NotDeferred

ErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires.
type

string

Type d’informations supplémentaire.

ErrorDetail

Objet

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.
code

string

Code d’erreur.
details

ErrorDetail[]

Détails de l’erreur.
message

string

Message d’erreur.
target

string

Cible d’erreur.

ErrorResponse

Objet

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet d’erreur.

EvictionPolicy

Énumération

Stratégie d’éviction Redis : la valeur par défaut est VolatileLRU

Valeur Description
AllKeysLFU
AllKeysLRU
AllKeysRandom
VolatileLRU
VolatileLFU
VolatileTTL
VolatileRandom
NoEviction

GeoReplication

Objet

Ensemble facultatif de propriétés pour configurer la géoréplication pour cette base de données.

Nom Type Description
groupNickname

string

Nom du groupe de ressources de base de données liées
linkedDatabases

LinkedDatabase[]

Liste des ressources de base de données à lier à cette base de données

LinkedDatabase

Objet

Base de données liée

Nom Type Description
id

string (arm-id)

ID de ressource d’une ressource de base de données à lier à cette base de données.
state

LinkState

État du lien entre les ressources de la base de données.

LinkState

Énumération

État du lien entre les ressources de la base de données.

Valeur Description
Linked
Linking
Unlinking
LinkFailed
UnlinkFailed

Module

Objet

Paramètres de module

Nom Type Description
args

string

Options de configuration pour le module, par exemple « ERROR_RATE 0,01 INITIAL_SIZE 400 ».
name

string

Nom du module, par exemple « RedisBloom », « RediSearch », « RedisTimeSeries »
version

string

La version du module, par exemple '1.0'.

Persistence

Objet

Paramètres de persistance

Nom Type Description
aofEnabled

boolean

Définit si AOF est activé. Notez qu’au maximum l’une des persistances AOF ou RDB peut être activée.
aofFrequency

AofFrequency

Définit la fréquence à laquelle les données sont écrites sur le disque. La valeur par défaut est « 1s », ce qui signifie « toutes les secondes ». Notez que le paramètre « always » est déconseillé, en raison de son impact sur les performances.
rdbEnabled

boolean

Définit si RDB est activé. Notez qu’au maximum l’une des persistances AOF ou RDB peut être activée.
rdbFrequency

RdbFrequency

Définit la fréquence à laquelle un instantané de la base de données est créé.

Protocol

Énumération

Spécifie si les clients redis peuvent se connecter à l’aide de protocoles redis chiffrés ou en texte clair TLS. La valeur par défaut est chiffrée par TLS.

Valeur Description
Encrypted
Plaintext

ProvisioningState

Énumération

État actuel du provisionnement

Valeur Description
Succeeded
Failed
Canceled
Creating
Updating
Deleting

RdbFrequency

Énumération

Définit la fréquence à laquelle un instantané de la base de données est créé.

Valeur Description
1h
6h
12h

ResourceState

Énumération

État actuel de la ressource

Valeur Description
Running
Creating
CreateFailed
Updating
UpdateFailed
Deleting
DeleteFailed
Enabling
EnableFailed
Disabling
DisableFailed
Disabled
Scaling
ScalingFailed
Moving