Databases - Create

Referencia

Servicio:: Redis Cache

Versión de la API:: 2024-10-01

Crea una base de datos

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
clusterName	path	True	string pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$	Nombre del clúster de Redis Enterprise. El nombre debe tener entre 1 y 60 caracteres. Caracteres permitidos (A-Z, a-z, 0-9) y guion(-). No puede haber guiones iniciales ni finales ni consecutivos
databaseName	path	True	string pattern: ^(?=.{1,60}$)[A-Za-z0-9]+(-[A-Za-z0-9]+)*$	Nombre de la base de datos de Redis Enterprise.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Tipo	Description
properties.clientProtocol	Protocol	Especifica si los clientes de Redis pueden conectarse mediante protocolos de redis cifrados mediante TLS o con texto no cifrado. El valor predeterminado es TLS cifrado.
properties.clusteringPolicy	ClusteringPolicy	Directiva de agrupación en clústeres: el valor predeterminado es OSSCluster. Especificado en tiempo de creación.
properties.evictionPolicy	EvictionPolicy	Directiva de expulsión de Redis: el valor predeterminado es VolatileLRU
properties.geoReplication	GeoReplication	Conjunto opcional de propiedades para configurar la replicación geográfica para esta base de datos.
properties.modules	Module[]	Conjunto opcional de módulos de redis que se habilitarán en esta base de datos: los módulos solo se pueden agregar en tiempo de creación.
properties.persistence	Persistence	Configuración de persistencia Configuración de persistencia
properties.port	integer (int32)	Puerto TCP del punto de conexión de la base de datos. Especificado en tiempo de creación. El valor predeterminado es un puerto disponible.

Respuestas

Nombre	Tipo	Description
200 OK	Database	La base de datos estaba o se está actualizando. Compruebe provisioningState y resourceState para obtener un estado detallado.
201 Created	Database	La base de datos se creó o se está creando. Compruebe provisioningState y resourceState para obtener un estado detallado.
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

RedisEnterpriseDatabasesCreate

RedisEnterpriseDatabasesCreate With Active Geo Replication

RedisEnterpriseDatabasesCreate

Solicitud de ejemplo

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

Respuesta de muestra

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

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre	Description
AofFrequency	Establece la frecuencia con la que se escriben los datos en el disco.
ClusteringPolicy	Directiva de agrupación en clústeres: el valor predeterminado es OSSCluster. Especificado en tiempo de creación.
Database	Describe una base de datos en el clúster de RedisEnterprise
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
EvictionPolicy	Directiva de expulsión de Redis: el valor predeterminado es VolatileLRU
GeoReplication	Conjunto opcional de propiedades para configurar la replicación geográfica para esta base de datos.
LinkedDatabase	Base de datos vinculada
LinkState	Estado del vínculo entre los recursos de la base de datos.
Module	Configuración del módulo
Persistence	Configuración de persistencia
Protocol	Especifica si los clientes de Redis pueden conectarse mediante protocolos de redis cifrados mediante TLS o con texto no cifrado. El valor predeterminado es TLS cifrado.
ProvisioningState	Estado de aprovisionamiento actual
RdbFrequency	Establece la frecuencia con la que se crea una instantánea de la base de datos.
ResourceState	Estado actual de los recursos

AofFrequency

Enumeración

Establece la frecuencia con la que se escriben los datos en el disco.

Valor	Description
1s
always

ClusteringPolicy

Enumeración

Directiva de agrupación en clústeres: el valor predeterminado es OSSCluster. Especificado en tiempo de creación.

Valor	Description
EnterpriseCluster
OSSCluster

Database

Object

Describe una base de datos en el clúster de RedisEnterprise

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso
properties.clientProtocol	Protocol	Especifica si los clientes de Redis pueden conectarse mediante protocolos de redis cifrados mediante TLS o con texto no cifrado. El valor predeterminado es TLS cifrado.
properties.clusteringPolicy	ClusteringPolicy	Directiva de agrupación en clústeres: el valor predeterminado es OSSCluster. Especificado en tiempo de creación.
properties.evictionPolicy	EvictionPolicy	Directiva de expulsión de Redis: el valor predeterminado es VolatileLRU
properties.geoReplication	GeoReplication	Conjunto opcional de propiedades para configurar la replicación geográfica para esta base de datos.
properties.modules	Module[]	Conjunto opcional de módulos de redis que se habilitarán en esta base de datos: los módulos solo se pueden agregar en tiempo de creación.
properties.persistence	Persistence	Configuración de persistencia Configuración de persistencia
properties.port	integer (int32)	Puerto TCP del punto de conexión de la base de datos. Especificado en tiempo de creación. El valor predeterminado es un puerto disponible.
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento actual de la base de datos
properties.resourceState	ResourceState	Estado actual del recurso de la base de datos
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

EvictionPolicy

Enumeración

Directiva de expulsión de Redis: el valor predeterminado es VolatileLRU

Valor	Description
AllKeysLFU
AllKeysLRU
AllKeysRandom
NoEviction
VolatileLFU
VolatileLRU
VolatileRandom
VolatileTTL

GeoReplication

Object

Conjunto opcional de propiedades para configurar la replicación geográfica para esta base de datos.

Nombre	Tipo	Description
groupNickname	string	Nombre del grupo de recursos de base de datos vinculados
linkedDatabases	LinkedDatabase[]	Lista de recursos de base de datos para vincular con esta base de datos

LinkedDatabase

Object

Base de datos vinculada

Nombre	Tipo	Description
id	string (arm-id)	Identificador de recurso de un recurso de base de datos que se va a vincular con esta base de datos.
state	LinkState	Estado del vínculo entre los recursos de la base de datos.

LinkState

Enumeración

Estado del vínculo entre los recursos de la base de datos.

Valor	Description
LinkFailed
Linked
Linking
UnlinkFailed
Unlinking

Module

Object

Configuración del módulo

Nombre	Tipo	Description
args	string	Opciones de configuración para el módulo, por ejemplo, "ERROR_RATE 0,01 INITIAL_SIZE 400".
name	string	Nombre del módulo, por ejemplo, "RedisBloom", "RediSearch", "RedisTimeSeries"
version	string	La versión del módulo, por ejemplo, "1.0".

Persistence

Object

Configuración de persistencia

Nombre	Tipo	Description
aofEnabled	boolean	Establece si AOF está habilitado.
aofFrequency	AofFrequency	Establece la frecuencia con la que se escriben los datos en el disco.
rdbEnabled	boolean	Establece si RDB está habilitado.
rdbFrequency	RdbFrequency	Establece la frecuencia con la que se crea una instantánea de la base de datos.

Protocol

Enumeración

Especifica si los clientes de Redis pueden conectarse mediante protocolos de redis cifrados mediante TLS o con texto no cifrado. El valor predeterminado es TLS cifrado.

Valor	Description
Encrypted
Plaintext

ProvisioningState

Enumeración

Estado de aprovisionamiento actual

Valor	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

RdbFrequency

Enumeración

Establece la frecuencia con la que se crea una instantánea de la base de datos.

Valor	Description
12h
1h
6h

ResourceState

Enumeración

Estado actual de los recursos

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

Compartir a través de

Databases - Create

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

RedisEnterpriseDatabasesCreate

Solicitud de ejemplo

Respuesta de muestra

RedisEnterpriseDatabasesCreate With Active Geo Replication

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AofFrequency

ClusteringPolicy

Database

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

EvictionPolicy

GeoReplication

LinkedDatabase

LinkState

Module

Persistence

Protocol

ProvisioningState

RdbFrequency

ResourceState

Recursos adicionales