Databases - Create

Référence

Service:: Redis Cache

Version d'API:: 2024-10-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=2024-10-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.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. Spécifié au moment de la création.
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é/est mise à jour. Vérifiez provisioningState et resourceState pour obtenir un état détaillé.
201 Created	Database	La base de données a été/est créée. 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 With Active Geo Replication

RedisEnterpriseDatabasesCreate

Exemple de requête

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default?api-version=2024-10-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"
      }
    ]
  }
}

Exemple de réponse

Code d’état:: 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"
      }
    ]
  }
}

Code d’état:: 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

Exemple de requête

HTTP

PUT https://management.azure.com/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default?api-version=2024-10-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"
        }
      ]
    }
  }
}

Exemple de réponse

Code d’état:: 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"
        }
      ]
    }
  }
}

Code d’état:: 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"
        }
      ]
    }
  }
}

Définitions

Nom	Description
AofFrequency	Définit la fréquence à laquelle les données sont écrites sur le disque.
ClusteringPolicy	Stratégie de clustering : la valeur par défaut est OSSCluster. Spécifié au moment de la création.
Database	Décrit une base de données sur le cluster RedisEnterprise
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 base de données.
Module	Paramètres du 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 de l’approvisionnement
RdbFrequency	Définit la fréquence à laquelle un instantané de la base de données est créé.
ResourceState	État actuel de la ressource

AofFrequency

Énumération

Définit la fréquence à laquelle les données sont écrites sur le disque.

Valeur	Description
1s
always

ClusteringPolicy

Énumération

Stratégie de clustering : la valeur par défaut est OSSCluster. Spécifié au moment de la création.

Valeur	Description
EnterpriseCluster
OSSCluster

Database

Object

Décrit une base de données sur le cluster RedisEnterprise

Nom	Type	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.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. Spécifié au moment de la création.
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.resourceState	ResourceState	État actuel de la ressource de la base de données
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

ErrorAdditionalInfo

Object

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

Object

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

Object

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
NoEviction
VolatileLFU
VolatileLRU
VolatileRandom
VolatileTTL

GeoReplication

Object

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

Object

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 base de données.

LinkState

Énumération

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

Valeur	Description
LinkFailed
Linked
Linking
UnlinkFailed
Unlinking

Module

Object

Paramètres du 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	Version du module, par exemple « 1.0 ».

Persistence

Object

Paramètres de persistance

Nom	Type	Description
aofEnabled	boolean	Définit si AOF est activé.
aofFrequency	AofFrequency	Définit la fréquence à laquelle les données sont écrites sur le disque.
rdbEnabled	boolean	Définit si RDB est activé.
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 de l’approvisionnement

Valeur	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

RdbFrequency

Énumération

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

Valeur	Description
12h
1h
6h

ResourceState

Énumération

État actuel de la ressource

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

Partager via

Databases - Create

Paramètres URI

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

RedisEnterpriseDatabasesCreate

Exemple de requête

Exemple de réponse

RedisEnterpriseDatabasesCreate With Active Geo Replication

Exemple de requête

Exemple de réponse

Définitions

AofFrequency

ClusteringPolicy

Database

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

EvictionPolicy

GeoReplication

LinkedDatabase

LinkState

Module

Persistence

Protocol

ProvisioningState

RdbFrequency

ResourceState

Ressources supplémentaires