Databases - Create

Referência

Serviço:: Redis Cache

Versão da API:: 2024-10-01

Cria um banco de dados

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

Parâmetros do URI

Name	Em	Necessá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 hífen(-). Não pode haver liderança, nem descida, nem hífenes consecutivas
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 do Pedido

Name	Tipo	Description
properties.clientProtocol	Protocol	Especifica se os clientes redis podem se conectar usando protocolos redis criptografados por TLS ou texto sem formatação. O padrão é criptografado por TLS.
properties.clusteringPolicy	ClusteringPolicy	Política de clustering - o padrão é OSSCluster. Especificado no momento da criação.
properties.evictionPolicy	EvictionPolicy	Política de despejo 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

Name	Tipo	Description
200 OK	Database	A base de dados foi/está a ser atualizada. Verifique provisioningState e resourceState para obter o status detalhado.
201 Created	Database	A base de dados foi/está a ser criada. Verifique provisioningState e resourceState para obter o status detalhado.
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

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

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

RedisEnterpriseDatabasesCreate

RedisEnterpriseDatabasesCreate With Active Geo Replication

RedisEnterpriseDatabasesCreate

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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"
      }
    ]
  }
}

Código de estado:: 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

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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"
        }
      ]
    }
  }
}

Código de estado:: 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"
        }
      ]
    }
  }
}

Definições

Name	Description
AofFrequency	Define a frequência com que os dados são gravados no disco.
ClusteringPolicy	Política de clustering - o padrão é OSSCluster. Especificado no momento da criação.
Database	Descreve um banco de dados no cluster RedisEnterprise
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
EvictionPolicy	Política de despejo Redis - o padrão é VolatileLRU
GeoReplication	Conjunto opcional de propriedades para configurar a replicação geográfica para este banco de dados.
LinkedDatabase	Base de dados ligada
LinkState	Estado da ligação entre os recursos da base 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 texto sem formatação. O padrão é criptografado por TLS.
ProvisioningState	Status atual do provisionamento
RdbFrequency	Define a frequência com que um instantâneo do banco de dados é criado.
ResourceState	Status atual do recurso

AofFrequency

Enumeração

Define a frequência com que os dados são gravados no disco.

Valor	Description
1s
always

ClusteringPolicy

Enumeração

Política de clustering - o padrão é OSSCluster. Especificado no momento da criação.

Valor	Description
EnterpriseCluster
OSSCluster

Database

Object

Descreve um banco de dados no cluster RedisEnterprise

Name	Tipo	Description
id	string	ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.clientProtocol	Protocol	Especifica se os clientes redis podem se conectar usando protocolos redis criptografados por TLS ou texto sem formatação. O padrão é criptografado por TLS.
properties.clusteringPolicy	ClusteringPolicy	Política de clustering - o padrão é OSSCluster. Especificado no momento da criação.
properties.evictionPolicy	EvictionPolicy	Política de despejo 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.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"

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

EvictionPolicy

Enumeração

Política de despejo Redis - o padrão é VolatileLRU

Valor	Description
AllKeysLFU
AllKeysLRU
AllKeysRandom
NoEviction
VolatileLFU
VolatileLRU
VolatileRandom
VolatileTTL

GeoReplication

Object

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

Name	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

Object

Base de dados ligada

Name	Tipo	Description
id	string (arm-id)	ID do recurso de um recurso de banco de dados a ser vinculado a esse banco de dados.
state	LinkState	Estado da ligação entre os recursos da base de dados.

LinkState

Enumeração

Estado da ligação entre os recursos da base de dados.

Valor	Description
LinkFailed
Linked
Linking
UnlinkFailed
Unlinking

Module

Object

Configurações do módulo

Name	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

Object

Configurações de persistência

Name	Tipo	Description
aofEnabled	boolean	Define se o AOF está habilitado.
aofFrequency	AofFrequency	Define a frequência com que os dados são gravados no disco.
rdbEnabled	boolean	Define se o RDB está habilitado.
rdbFrequency	RdbFrequency	Define a frequência com que um instantâneo do banco de dados é criado.

Protocol

Enumeração

Especifica se os clientes redis podem se conectar usando protocolos redis criptografados por TLS ou texto sem formatação. O padrão é criptografado por TLS.

Valor	Description
Encrypted
Plaintext

ProvisioningState

Enumeração

Status atual do provisionamento

Valor	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

RdbFrequency

Enumeração

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

Valor	Description
12h
1h
6h

ResourceState

Enumeração

Status atual do recurso

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

Partilhar via

Databases - Create

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

RedisEnterpriseDatabasesCreate

Pedido de amostra

Resposta da amostra

RedisEnterpriseDatabasesCreate With Active Geo Replication

Pedido de amostra

Resposta da amostra

Definições

AofFrequency

ClusteringPolicy

Database

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

EvictionPolicy

GeoReplication

LinkedDatabase

LinkState

Module

Persistence

Protocol

ProvisioningState

RdbFrequency

ResourceState

Recursos adicionais