Compartilhar via


Databases - Create

Cria um banco de dados

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
clusterName
path True

string

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

O nome do cluster Redis Enterprise. O nome deve ter de 1 a 60 caracteres. Caracteres permitidos (A-Z, a-z, 0-9) e hifen(-). Não pode haver hífens à esquerda nem à direita nem consecutivos

databaseName
path True

string

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

O nome do banco de dados Redis Enterprise.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

subscriptionId
path True

string

minLength: 1

A ID da assinatura de destino.

api-version
query True

string

minLength: 1

A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome Tipo Description
properties.accessKeysAuthentication

accessKeysAuthentication

Essa propriedade pode ser Habilitada/Desabilitada para permitir ou negar acesso com as chaves de acesso atuais. Pode ser atualizado mesmo após a criação do banco de dados. O padrão é Desabilitado.

properties.clientProtocol

Protocol

Especifica se os clientes redis podem se conectar usando protocolos redis criptografados por TLS ou de texto não criptografado. O padrão é criptografado em TLS.

properties.clusteringPolicy

ClusteringPolicy

Política de clustering – o padrão é OSSCluster. Essa propriedade só poderá ser atualizada se o valor atual for NoCluster. Se o valor for OSSCluster ou EnterpriseCluster, ele não poderá ser atualizado sem excluir o banco de dados.

properties.deferUpgrade

DeferUpgradeSetting

Opção para adiar a atualização quando a versão mais recente for lançada – o padrão é NotDeferred. Saiba mais: https://aka.ms/redisversionupgrade

properties.evictionPolicy

EvictionPolicy

Política de remoção do Redis – o padrão é VolatileLRU

properties.geoReplication

GeoReplication

Conjunto opcional de propriedades para configurar a replicação geográfica para este banco de dados.

properties.modules

Module[]

Conjunto opcional de módulos redis para habilitar neste banco de dados – os módulos só podem ser adicionados no momento da criação.

properties.persistence

Persistence

Configurações de persistência
Configurações de persistência

properties.port

integer (int32)

Porta TCP do ponto de extremidade do banco de dados. Especificado no momento da criação. O padrão é uma porta disponível.

Respostas

Nome Tipo Description
200 OK

Database

O banco de dados foi/está sendo atualizado. Verifique provisioningState e resourceState para obter o status detalhado.

201 Created

Database

O banco de dados foi/está sendo criado. Verifique provisioningState e resourceState para obter o status detalhado.

Other Status Codes

ErrorResponse

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

RedisEnterpriseDatabasesCreate
RedisEnterpriseDatabasesCreate No Cluster Cache
RedisEnterpriseDatabasesCreate With Active Geo Replication

RedisEnterpriseDatabasesCreate

Solicitação de exemplo

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

Resposta de exemplo

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

Solicitação de exemplo

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

Resposta de exemplo

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

Solicitação de exemplo

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

Resposta de exemplo

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

Definições

Nome Description
accessKeysAuthentication

Essa propriedade pode ser Habilitada/Desabilitada para permitir ou negar acesso com as chaves de acesso atuais. Pode ser atualizado mesmo após a criação do banco de dados. O padrão é Desabilitado.

AofFrequency

Define a frequência em que os dados são gravados em disco. O padrão é '1s', que significa 'a cada segundo'. Observe que a configuração "sempre" foi preterida devido ao seu impacto no desempenho.

ClusteringPolicy

Política de clustering – o padrão é OSSCluster. Essa propriedade só poderá ser atualizada se o valor atual for NoCluster. Se o valor for OSSCluster ou EnterpriseCluster, ele não poderá ser atualizado sem excluir o banco de dados.

Database

Descreve um banco de dados no cluster do Redis Enterprise

DeferUpgradeSetting

Opção para adiar a atualização quando a versão mais recente for lançada – o padrão é NotDeferred. Saiba mais: https://aka.ms/redisversionupgrade

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

EvictionPolicy

Política de remoção do Redis – o padrão é VolatileLRU

GeoReplication

Conjunto opcional de propriedades para configurar a replicação geográfica para este banco de dados.

LinkedDatabase

Banco de dados vinculado

LinkState

Estado do link entre os recursos do banco de dados.

Module

Configurações do módulo

Persistence

Configurações de persistência

Protocol

Especifica se os clientes redis podem se conectar usando protocolos redis criptografados por TLS ou de texto não criptografado. O padrão é criptografado em TLS.

ProvisioningState

Status atual do provisionamento

RdbFrequency

Define a frequência na qual um instantâneo do banco de dados é criado.

ResourceState

Status atual do recurso

accessKeysAuthentication

Essa propriedade pode ser Habilitada/Desabilitada para permitir ou negar acesso com as chaves de acesso atuais. Pode ser atualizado mesmo após a criação do banco de dados. O padrão é Desabilitado.

Valor Description
Disabled
Enabled

AofFrequency

Define a frequência em que os dados são gravados em disco. O padrão é '1s', que significa 'a cada segundo'. Observe que a configuração "sempre" foi preterida devido ao seu impacto no desempenho.

Valor Description
1s
always

ClusteringPolicy

Política de clustering – o padrão é OSSCluster. Essa propriedade só poderá ser atualizada se o valor atual for NoCluster. Se o valor for OSSCluster ou EnterpriseCluster, ele não poderá ser atualizado sem excluir o banco de dados.

Valor Description
EnterpriseCluster

A política de clustering corporativo usa apenas o protocolo redis clássico, que não dá suporte a comandos de cluster redis.

OSSCluster

A política de clustering do OSS segue a especificação do cluster do Redis e exige que todos os clientes ofereçam suporte ao clustering do Redis.

NoCluster

A política NoCluster é usada para instâncias do Redis não clusterizadas que não exigem recursos de clustering.

Database

Descreve um banco de dados no cluster do Redis Enterprise

Nome Tipo Valor padrão Description
id

string

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

O nome do recurso

properties.accessKeysAuthentication

accessKeysAuthentication

Disabled

Essa propriedade pode ser Habilitada/Desabilitada para permitir ou negar acesso com as chaves de acesso atuais. Pode ser atualizado mesmo após a criação do banco de dados. O padrão é Desabilitado.

properties.clientProtocol

Protocol

Especifica se os clientes redis podem se conectar usando protocolos redis criptografados por TLS ou de texto não criptografado. O padrão é criptografado em TLS.

properties.clusteringPolicy

ClusteringPolicy

Política de clustering – o padrão é OSSCluster. Essa propriedade só poderá ser atualizada se o valor atual for NoCluster. Se o valor for OSSCluster ou EnterpriseCluster, ele não poderá ser atualizado sem excluir o banco de dados.

properties.deferUpgrade

DeferUpgradeSetting

Opção para adiar a atualização quando a versão mais recente for lançada – o padrão é NotDeferred. Saiba mais: https://aka.ms/redisversionupgrade

properties.evictionPolicy

EvictionPolicy

Política de remoção do Redis – o padrão é VolatileLRU

properties.geoReplication

GeoReplication

Conjunto opcional de propriedades para configurar a replicação geográfica para este banco de dados.

properties.modules

Module[]

Conjunto opcional de módulos redis para habilitar neste banco de dados – os módulos só podem ser adicionados no momento da criação.

properties.persistence

Persistence

Configurações de persistência
Configurações de persistência

properties.port

integer (int32)

Porta TCP do ponto de extremidade do banco de dados. Especificado no momento da criação. O padrão é uma porta disponível.

properties.provisioningState

ProvisioningState

Status atual de provisionamento do banco de dados

properties.redisVersion

string

Versão do Redis em que o banco de dados está sendo executado, por exemplo, '6.0'

properties.resourceState

ResourceState

Status atual do recurso do banco de dados

type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

DeferUpgradeSetting

Opção para adiar a atualização quando a versão mais recente for lançada – o padrão é NotDeferred. Saiba mais: https://aka.ms/redisversionupgrade

Valor Description
Deferred
NotDeferred

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorResponse

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

EvictionPolicy

Política de remoção do Redis – o padrão é VolatileLRU

Valor Description
AllKeysLFU
AllKeysLRU
AllKeysRandom
VolatileLRU
VolatileLFU
VolatileTTL
VolatileRandom
NoEviction

GeoReplication

Conjunto opcional de propriedades para configurar a replicação geográfica para este banco de dados.

Nome Tipo Description
groupNickname

string

Nome do grupo de recursos de banco de dados vinculados

linkedDatabases

LinkedDatabase[]

Lista de recursos de banco de dados a serem vinculados a este banco de dados

LinkedDatabase

Banco de dados vinculado

Nome Tipo Description
id

string (arm-id)

ID de recurso de um recurso de banco de dados para vincular a esse banco de dados.

state

LinkState

Estado do link entre os recursos do banco de dados.

LinkState

Estado do link entre os recursos do banco de dados.

Valor Description
Linked
Linking
Unlinking
LinkFailed
UnlinkFailed

Module

Configurações do módulo

Nome Tipo Description
args

string

Opções de configuração para o módulo, por exemplo, "ERROR_RATE 0,01 INITIAL_SIZE 400".

name

string

O nome do módulo, por exemplo, 'RedisBloom', 'RediSearch', 'RedisTimeSeries'

version

string

A versão do módulo, por exemplo, '1.0'.

Persistence

Configurações de persistência

Nome Tipo Description
aofEnabled

boolean

Define se o AOF está habilitado. Observe que, no máximo, uma persistência de AOF ou RDB pode estar habilitada.

aofFrequency

AofFrequency

Define a frequência em que os dados são gravados em disco. O padrão é '1s', que significa 'a cada segundo'. Observe que a configuração "sempre" foi preterida devido ao seu impacto no desempenho.

rdbEnabled

boolean

Define se o RDB está habilitado. Observe que, no máximo, uma persistência de AOF ou RDB pode estar habilitada.

rdbFrequency

RdbFrequency

Define a frequência na qual um instantâneo do banco de dados é criado.

Protocol

Especifica se os clientes redis podem se conectar usando protocolos redis criptografados por TLS ou de texto não criptografado. O padrão é criptografado em TLS.

Valor Description
Encrypted
Plaintext

ProvisioningState

Status atual do provisionamento

Valor Description
Succeeded
Failed
Canceled
Creating
Updating
Deleting

RdbFrequency

Define a frequência na qual um instantâneo do banco de dados é criado.

Valor Description
1h
6h
12h

ResourceState

Status atual do recurso

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