Partilhar via


Microsoft.Cache redis

Definição de recursos do bíceps

O tipo de recurso redis pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Cache/redis, adicione o seguinte Bíceps ao seu modelo.

resource symbolicname 'Microsoft.Cache/redis@2024-11-01' = {
  scope: resourceSymbolicName or scope
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    disableAccessKeyAuthentication: bool
    enableNonSslPort: bool
    minimumTlsVersion: 'string'
    publicNetworkAccess: 'string'
    redisConfiguration: {
      aad-enabled: 'string'
      aof-backup-enabled: 'string'
      aof-storage-connection-string-0: 'string'
      aof-storage-connection-string-1: 'string'
      authnotrequired: 'string'
      maxfragmentationmemory-reserved: 'string'
      maxmemory-delta: 'string'
      maxmemory-policy: 'string'
      maxmemory-reserved: 'string'
      notify-keyspace-events: 'string'
      preferred-data-persistence-auth-method: 'string'
      rdb-backup-enabled: 'string'
      rdb-backup-frequency: 'string'
      rdb-backup-max-snapshot-count: 'string'
      rdb-storage-connection-string: 'string'
      storage-subscription-id: 'string'
    }
    redisVersion: 'string'
    replicasPerMaster: int
    replicasPerPrimary: int
    shardCount: int
    sku: {
      capacity: int
      family: 'string'
      name: 'string'
    }
    staticIP: 'string'
    subnetId: 'string'
    tenantSettings: {
      {customized property}: 'string'
    }
    updateChannel: 'string'
    zonalAllocationPolicy: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
  zones: [
    'string'
  ]
}

Valores de propriedade

Microsoft.Cache/redis

Designação Descrição Valor
identidade A identidade do recurso. ManagedServiceIdentity
localização A geolocalização onde o recurso vive string (obrigatório)
Designação O nome do recurso string (obrigatório)
propriedades Propriedades do cache Redis. RedisCreatePropertiesOrRedisProperties (obrigatório)
âmbito Use ao criar um recurso em um escopo diferente do escopo de implantação. Defina essa propriedade como o nome simbólico de um recurso para aplicar o recurso de extensão .
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos
Zonas Uma lista de zonas de disponibilidade indicando de onde o recurso precisa vir. string[]

ManagedServiceIdentity

Designação Descrição Valor
tipo Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos). 'Nenhuma'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned' (obrigatório)
identidades atribuídas pelo utilizador O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores de dicionário podem ser objetos vazios ({}) em solicitações. UserAssignedIdentities

RedisCommonPropertiesRedisConfiguration

Designação Descrição Valor
Habilitado para AAD Especifica se a autenticação baseada em AAD foi habilitada ou desabilitada para o cache cadeia (de caracteres)
aof-backup-habilitado Especifica se o aof backup está habilitado cadeia (de caracteres)
aof-storage-connection-string-0 Primeira cadeia de conexão da conta de armazenamento cadeia (de caracteres)
aof-storage-connection-string-1 Segunda cadeia de conexão da conta de armazenamento cadeia (de caracteres)
authnotrequired Especifica se a autenticação está desabilitada. Definir esta propriedade é altamente desencorajado do ponto de vista da segurança; Você nunca deve desativar a autenticação usando esta propriedade! cadeia (de caracteres)
maxfragmentationmemória-reservado Valor em megabytes reservado para fragmentação por fragmento cadeia (de caracteres)
maxmemory-delta Valor em megabytes reservado para uso não cache por estilhaço, por exemplo, failover. cadeia (de caracteres)
política de memória máxima A estratégia de remoção usada quando seus dados não cabem dentro de seu limite de memória. cadeia (de caracteres)
maxmemory-reservado Valor em megabytes reservado para uso não cache por estilhaço, por exemplo, failover. cadeia (de caracteres)
notificar-eventos-do-espaço-de-chave Os eventos keyspace que devem ser monitorados. cadeia (de caracteres)
preferred-data-persistence-auth-method Método de autenticação preferencial para se comunicar com a conta de armazenamento usada para persistência de dados, especificar SAS ou ManagedIdentity, o valor padrão é SAS cadeia (de caracteres)
rdb-backup-habilitado Especifica se o backup RDB está habilitado cadeia (de caracteres)
rdb-backup-freqüência Especifica a frequência para criar backup rdb em minutos. Valores válidos: (15, 30, 60, 360, 720, 1440) cadeia (de caracteres)
rdb-backup-max-snapshot-count Especifica o número máximo de snapshots para backup rdb cadeia (de caracteres)
rdb-cadeia-de-conexão-armazenamento A cadeia de conexão da conta de armazenamento para armazenar o arquivo rdb cadeia (de caracteres)
ID de subscrição de armazenamento SubscriptionId da conta de armazenamento para persistência (aof/rdb) usando ManagedIdentity. cadeia (de caracteres)

RedisCommonPropertiesTenantSettings

Designação Descrição Valor

RedisCreateParametersTags

Designação Descrição Valor

RedisCreatePropertiesOrRedisProperties

Designação Descrição Valor
disableAccessKeyAuthentication A autenticação no Redis através de chaves de acesso é desativada quando definida como true. O valor padrão é false. Bool
enableNonSslPort Especifica se a porta do servidor Redis não ssl (6379) está habilitada. Bool
minimumTlsVersion Opcional: requer que os clientes usem uma versão especificada do TLS (ou superior) para se conectar (por exemplo, '1.0', '1.1', '1.2') '1.0'
'1.1'
'1.2'
acesso à rede pública Se o acesso ao ponto de extremidade público é permitido ou não para esse cache. O valor é opcional, mas se passado, deve ser 'Ativado' ou 'Desativado'. Se 'Desativado', os pontos finais privados são o método de acesso exclusivo. 'Desativado'
'Habilitado'
redisConfiguration Todas as configurações do Redis. Poucas chaves possíveis: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta, maxmemory-policy,notify-keyspace-events, aof-backup-enabled, aof-storage-connection-string-0, aof-storage-connection-string-1 etc. RedisCommonPropertiesRedisConfiguration
redisversão Versão Redis. Este deve ser na forma 'major[.minor]' (apenas 'major' é necessário) ou o valor 'mais recente' que se refere à última versão estável do Redis que está disponível. Versões suportadas: 4.0, 6.0 (mais recente). O valor padrão é 'mais recente'. cadeia (de caracteres)
réplicasPerMaster O número de réplicas a serem criadas por primária. Int
réplicasPerPrimary O número de réplicas a serem criadas por primária. Int
Contagem de fragmentos O número de fragmentos a serem criados em um Cache de Cluster Premium. Int
SKU O SKU do cache Redis a ser implantado. Sku (obrigatório)
estáticaIP Endereço IP estático. Opcionalmente, pode ser especificado ao implantar um cache Redis dentro de uma Rede Virtual do Azure existente; atribuído automaticamente por padrão. cadeia de caracteres

Restrições:
Padrão = ^\d+\.\d+\.\d+\.\d+$
subnetId O ID de recurso completo de uma sub-rede em uma rede virtual para implantar o cache Redis. Formato de exemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft. {Rede|ClassicNetwork}/VirtualNetworks/vnet1/sub-redes/sub-rede1 cadeia de caracteres

Restrições:
Padrão = ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$
configurações de locatário Um dicionário de configurações de locatário RedisCommonPropertiesTenantSettings
updateChannel [en] Opcional: especifica o canal de atualização para as atualizações mensais do Cache Redis que seu Cache Redis receberá. Os caches que usam o canal de atualização 'Preview' obtêm as atualizações mais recentes do Redis pelo menos 4 semanas antes dos caches de canal 'Estável'. O valor padrão é 'Estável'. 'Pré-visualização'
'Estável'
zonalAllocationPolicy Opcional: especifica como as zonas de disponibilidade são alocadas para o cache Redis. 'Automático' permite redundância de zona e o Azure selecionará automaticamente zonas com base na disponibilidade e capacidade regionais. 'UserDefined' selecionará zonas de disponibilidade passadas por você usando o parâmetro 'zones'. 'NoZones' produzirá um cache não zonal. Se 'zonalAllocationPolicy' não for passado, ele será definido como 'UserDefined' quando as zonas forem passadas, caso contrário, ele será definido como 'Automatic' em regiões onde as zonas são suportadas e 'NoZones' em regiões onde as zonas não são suportadas. 'Automático'
'NoZones'
'Definido pelo usuário'

Referência

Designação Descrição Valor
capacidade O tamanho do cache Redis a ser implantado. Valores válidos: para a família C (Basic/Standard) (0, 1, 2, 3, 4, 5, 6), para a família P (Premium) (1, 2, 3, 4). int (obrigatório)
Família A família SKU a ser usada. Valores válidos: (C, P). (C = Básico/Padrão, P = Premium). «C»
'P' (obrigatório)
Designação O tipo de cache Redis a ser implantado. Valores válidos: (Básico, Standard, Premium) 'Básico'
'Premium'
'Standard' (obrigatório)

UserAssignedIdentities

Designação Descrição Valor

IdentidadeAtribuídaPeloUtilizador

Designação Descrição Valor

Exemplos de uso

Módulos verificados do Azure

Os seguintes de Módulos Verificados do Azure podem ser usados para implantar esse tipo de recurso.

Módulo Descrição
Cache Redis Módulo de recursos AVM para cache Redis

Exemplos de início rápido do Azure

Os seguintes modelos início rápido do Azure contêm exemplos de Bicep para implantar esse tipo de recurso.

Arquivo Bicep Descrição
Criar um Cache Redis Premium com clustering Este modelo mostra como configurar o clustering em uma instância premium do Cache Redis do Azure.
Criar um Cache Redis usando um modelo Este modelo cria um Cache Redis do Azure com dados de diagnóstico mantidos em uma conta de armazenamento.
Criar um cache Redis com a autenticação do Microsoft Entra. Este modelo cria um Cache Redis. Em seguida, atribui uma política de acesso interna a um usuário redis. Em seguida, cria uma política de acesso personalizada. E, em seguida, atribui a política de acesso personalizada a outro usuário do Redis.
Criar um Aplicativo Web mais Cache Redis usando um modelo Este modelo cria um Aplicativo Web do Azure com cache Redis.
Criar Cache Redis Premium implantado em uma Rede Virtual Este modelo mostra como implantar uma instância premium do Cache Redis do Azure em uma Rede Virtual existente
Criar cache Redis Premium com persistência de dados Este modelo mostra como configurar a persistência em uma instância premium do Cache Redis do Azure.
Implantar o Gerenciamento de API com um Cache do Azure externo para Redis Este modelo demonstra como criar uma instância do Gerenciamento de API do Azure na camada de Consumo com uma instância externa do Cache do Azure para Redis como o cache externo do Gerenciamento de API.

Definição de recurso de modelo ARM

O tipo de recurso redis pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Cache/redis, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.Cache/redis",
  "apiVersion": "2024-11-01",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "disableAccessKeyAuthentication": "bool",
    "enableNonSslPort": "bool",
    "minimumTlsVersion": "string",
    "publicNetworkAccess": "string",
    "redisConfiguration": {
      "aad-enabled": "string",
      "aof-backup-enabled": "string",
      "aof-storage-connection-string-0": "string",
      "aof-storage-connection-string-1": "string",
      "authnotrequired": "string",
      "maxfragmentationmemory-reserved": "string",
      "maxmemory-delta": "string",
      "maxmemory-policy": "string",
      "maxmemory-reserved": "string",
      "notify-keyspace-events": "string",
      "preferred-data-persistence-auth-method": "string",
      "rdb-backup-enabled": "string",
      "rdb-backup-frequency": "string",
      "rdb-backup-max-snapshot-count": "string",
      "rdb-storage-connection-string": "string",
      "storage-subscription-id": "string"
    },
    "redisVersion": "string",
    "replicasPerMaster": "int",
    "replicasPerPrimary": "int",
    "shardCount": "int",
    "sku": {
      "capacity": "int",
      "family": "string",
      "name": "string"
    },
    "staticIP": "string",
    "subnetId": "string",
    "tenantSettings": {
      "{customized property}": "string"
    },
    "updateChannel": "string",
    "zonalAllocationPolicy": "string"
  },
  "tags": {
    "{customized property}": "string"
  },
  "zones": [ "string" ]
}

Valores de propriedade

Microsoft.Cache/redis

Designação Descrição Valor
Versão da API A versão api '2024-11-01'
identidade A identidade do recurso. ManagedServiceIdentity
localização A geolocalização onde o recurso vive string (obrigatório)
Designação O nome do recurso string (obrigatório)
propriedades Propriedades do cache Redis. RedisCreatePropertiesOrRedisProperties (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos
tipo O tipo de recurso 'Microsoft.Cache/redis'
Zonas Uma lista de zonas de disponibilidade indicando de onde o recurso precisa vir. string[]

ManagedServiceIdentity

Designação Descrição Valor
tipo Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos). 'Nenhuma'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned' (obrigatório)
identidades atribuídas pelo utilizador O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores de dicionário podem ser objetos vazios ({}) em solicitações. UserAssignedIdentities

RedisCommonPropertiesRedisConfiguration

Designação Descrição Valor
Habilitado para AAD Especifica se a autenticação baseada em AAD foi habilitada ou desabilitada para o cache cadeia (de caracteres)
aof-backup-habilitado Especifica se o aof backup está habilitado cadeia (de caracteres)
aof-storage-connection-string-0 Primeira cadeia de conexão da conta de armazenamento cadeia (de caracteres)
aof-storage-connection-string-1 Segunda cadeia de conexão da conta de armazenamento cadeia (de caracteres)
authnotrequired Especifica se a autenticação está desabilitada. Definir esta propriedade é altamente desencorajado do ponto de vista da segurança; Você nunca deve desativar a autenticação usando esta propriedade! cadeia (de caracteres)
maxfragmentationmemória-reservado Valor em megabytes reservado para fragmentação por fragmento cadeia (de caracteres)
maxmemory-delta Valor em megabytes reservado para uso não cache por estilhaço, por exemplo, failover. cadeia (de caracteres)
política de memória máxima A estratégia de remoção usada quando seus dados não cabem dentro de seu limite de memória. cadeia (de caracteres)
maxmemory-reservado Valor em megabytes reservado para uso não cache por estilhaço, por exemplo, failover. cadeia (de caracteres)
notificar-eventos-do-espaço-de-chave Os eventos keyspace que devem ser monitorados. cadeia (de caracteres)
preferred-data-persistence-auth-method Método de autenticação preferencial para se comunicar com a conta de armazenamento usada para persistência de dados, especificar SAS ou ManagedIdentity, o valor padrão é SAS cadeia (de caracteres)
rdb-backup-habilitado Especifica se o backup RDB está habilitado cadeia (de caracteres)
rdb-backup-freqüência Especifica a frequência para criar backup rdb em minutos. Valores válidos: (15, 30, 60, 360, 720, 1440) cadeia (de caracteres)
rdb-backup-max-snapshot-count Especifica o número máximo de snapshots para backup rdb cadeia (de caracteres)
rdb-cadeia-de-conexão-armazenamento A cadeia de conexão da conta de armazenamento para armazenar o arquivo rdb cadeia (de caracteres)
ID de subscrição de armazenamento SubscriptionId da conta de armazenamento para persistência (aof/rdb) usando ManagedIdentity. cadeia (de caracteres)

RedisCommonPropertiesTenantSettings

Designação Descrição Valor

RedisCreateParametersTags

Designação Descrição Valor

RedisCreatePropertiesOrRedisProperties

Designação Descrição Valor
disableAccessKeyAuthentication A autenticação no Redis através de chaves de acesso é desativada quando definida como true. O valor padrão é false. Bool
enableNonSslPort Especifica se a porta do servidor Redis não ssl (6379) está habilitada. Bool
minimumTlsVersion Opcional: requer que os clientes usem uma versão especificada do TLS (ou superior) para se conectar (por exemplo, '1.0', '1.1', '1.2') '1.0'
'1.1'
'1.2'
acesso à rede pública Se o acesso ao ponto de extremidade público é permitido ou não para esse cache. O valor é opcional, mas se passado, deve ser 'Ativado' ou 'Desativado'. Se 'Desativado', os pontos finais privados são o método de acesso exclusivo. 'Desativado'
'Habilitado'
redisConfiguration Todas as configurações do Redis. Poucas chaves possíveis: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta, maxmemory-policy,notify-keyspace-events, aof-backup-enabled, aof-storage-connection-string-0, aof-storage-connection-string-1 etc. RedisCommonPropertiesRedisConfiguration
redisversão Versão Redis. Este deve ser na forma 'major[.minor]' (apenas 'major' é necessário) ou o valor 'mais recente' que se refere à última versão estável do Redis que está disponível. Versões suportadas: 4.0, 6.0 (mais recente). O valor padrão é 'mais recente'. cadeia (de caracteres)
réplicasPerMaster O número de réplicas a serem criadas por primária. Int
réplicasPerPrimary O número de réplicas a serem criadas por primária. Int
Contagem de fragmentos O número de fragmentos a serem criados em um Cache de Cluster Premium. Int
SKU O SKU do cache Redis a ser implantado. Sku (obrigatório)
estáticaIP Endereço IP estático. Opcionalmente, pode ser especificado ao implantar um cache Redis dentro de uma Rede Virtual do Azure existente; atribuído automaticamente por padrão. cadeia de caracteres

Restrições:
Padrão = ^\d+\.\d+\.\d+\.\d+$
subnetId O ID de recurso completo de uma sub-rede em uma rede virtual para implantar o cache Redis. Formato de exemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft. {Rede|ClassicNetwork}/VirtualNetworks/vnet1/sub-redes/sub-rede1 cadeia de caracteres

Restrições:
Padrão = ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$
configurações de locatário Um dicionário de configurações de locatário RedisCommonPropertiesTenantSettings
updateChannel [en] Opcional: especifica o canal de atualização para as atualizações mensais do Cache Redis que seu Cache Redis receberá. Os caches que usam o canal de atualização 'Preview' obtêm as atualizações mais recentes do Redis pelo menos 4 semanas antes dos caches de canal 'Estável'. O valor padrão é 'Estável'. 'Pré-visualização'
'Estável'
zonalAllocationPolicy Opcional: especifica como as zonas de disponibilidade são alocadas para o cache Redis. 'Automático' permite redundância de zona e o Azure selecionará automaticamente zonas com base na disponibilidade e capacidade regionais. 'UserDefined' selecionará zonas de disponibilidade passadas por você usando o parâmetro 'zones'. 'NoZones' produzirá um cache não zonal. Se 'zonalAllocationPolicy' não for passado, ele será definido como 'UserDefined' quando as zonas forem passadas, caso contrário, ele será definido como 'Automatic' em regiões onde as zonas são suportadas e 'NoZones' em regiões onde as zonas não são suportadas. 'Automático'
'NoZones'
'Definido pelo usuário'

Referência

Designação Descrição Valor
capacidade O tamanho do cache Redis a ser implantado. Valores válidos: para a família C (Basic/Standard) (0, 1, 2, 3, 4, 5, 6), para a família P (Premium) (1, 2, 3, 4). int (obrigatório)
Família A família SKU a ser usada. Valores válidos: (C, P). (C = Básico/Padrão, P = Premium). «C»
'P' (obrigatório)
Designação O tipo de cache Redis a ser implantado. Valores válidos: (Básico, Standard, Premium) 'Básico'
'Premium'
'Standard' (obrigatório)

UserAssignedIdentities

Designação Descrição Valor

IdentidadeAtribuídaPeloUtilizador

Designação Descrição Valor

Exemplos de uso

Modelos de início rápido do Azure

Os seguintes modelos de início rápido do Azure implantar esse tipo de recurso.

Modelo Descrição
Criar um Cache Redis Premium com clustering

Implantar no Azure
Este modelo mostra como configurar o clustering em uma instância premium do Cache Redis do Azure.
Criar um Cache Redis usando um modelo

Implantar no Azure
Este modelo cria um Cache Redis do Azure com dados de diagnóstico mantidos em uma conta de armazenamento.
Criar um cache Redis com a autenticação do Microsoft Entra.

Implantar no Azure
Este modelo cria um Cache Redis. Em seguida, atribui uma política de acesso interna a um usuário redis. Em seguida, cria uma política de acesso personalizada. E, em seguida, atribui a política de acesso personalizada a outro usuário do Redis.
Criar um aplicativo Web + Cache Redis + Banco de Dados SQL com um modelo

Implantar no Azure
Este modelo cria um Aplicativo Web do Azure com cache Redis e um Banco de Dados SQL.
Criar um Aplicativo Web mais Cache Redis usando um modelo

Implantar no Azure
Este modelo cria um Aplicativo Web do Azure com cache Redis.
Criar Cache Redis Premium implantado em uma Rede Virtual

Implantar no Azure
Este modelo mostra como implantar uma instância premium do Cache Redis do Azure em uma Rede Virtual existente
Criar cache Redis Premium com persistência de dados

Implantar no Azure
Este modelo mostra como configurar a persistência em uma instância premium do Cache Redis do Azure.
Crie dois caches replicados geograficamente em uma rede virtual

Implantar no Azure
Este modelo mostra como implantar duas instâncias do Cache do Azure para Redis de camada Premium em Redes Virtuais separadas e vinculá-las à replicação geográfica.
Implantar o Gerenciamento de API com um Cache do Azure externo para Redis

Implantar no Azure
Este modelo demonstra como criar uma instância do Gerenciamento de API do Azure na camada de Consumo com uma instância externa do Cache do Azure para Redis como o cache externo do Gerenciamento de API.
site eShop com ILB ASE

Implantar no Azure
Um Ambiente do Serviço de Aplicativo é uma opção de plano de serviço Premium do Serviço de Aplicativo do Azure que fornece um ambiente totalmente isolado e dedicado para executar com segurança aplicativos do Serviço de Aplicativo do Azure em alta escala, incluindo Aplicativos Web, Aplicativos Móveis e Aplicativos de API.
Umbraco CMS Web App escalável

Implantar no Azure
Este modelo fornece uma maneira fácil de implantar o aplicativo Web UMBRACO CMS nos Aplicativos Web do Serviço de Aplicativo do Azure.

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso redis pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Cache/redis, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Cache/redis@2024-11-01"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      disableAccessKeyAuthentication = bool
      enableNonSslPort = bool
      minimumTlsVersion = "string"
      publicNetworkAccess = "string"
      redisConfiguration = {
        aad-enabled = "string"
        aof-backup-enabled = "string"
        aof-storage-connection-string-0 = "string"
        aof-storage-connection-string-1 = "string"
        authnotrequired = "string"
        maxfragmentationmemory-reserved = "string"
        maxmemory-delta = "string"
        maxmemory-policy = "string"
        maxmemory-reserved = "string"
        notify-keyspace-events = "string"
        preferred-data-persistence-auth-method = "string"
        rdb-backup-enabled = "string"
        rdb-backup-frequency = "string"
        rdb-backup-max-snapshot-count = "string"
        rdb-storage-connection-string = "string"
        storage-subscription-id = "string"
      }
      redisVersion = "string"
      replicasPerMaster = int
      replicasPerPrimary = int
      shardCount = int
      sku = {
        capacity = int
        family = "string"
        name = "string"
      }
      staticIP = "string"
      subnetId = "string"
      tenantSettings = {
        {customized property} = "string"
      }
      updateChannel = "string"
      zonalAllocationPolicy = "string"
    }
    zones = [
      "string"
    ]
  }
}

Valores de propriedade

Microsoft.Cache/redis

Designação Descrição Valor
identidade A identidade do recurso. ManagedServiceIdentity
localização A geolocalização onde o recurso vive string (obrigatório)
Designação O nome do recurso string (obrigatório)
parent_id A ID do recurso ao qual aplicar esse recurso de extensão. string (obrigatório)
propriedades Propriedades do cache Redis. RedisCreatePropertiesOrRedisProperties (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags.
tipo O tipo de recurso "Microsoft.Cache/redis@2024-11-01"
Zonas Uma lista de zonas de disponibilidade indicando de onde o recurso precisa vir. string[]

ManagedServiceIdentity

Designação Descrição Valor
tipo Tipo de identidade de serviço gerenciado (onde os tipos SystemAssigned e UserAssigned são permitidos). 'Nenhuma'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned' (obrigatório)
identidades atribuídas pelo utilizador O conjunto de identidades atribuídas pelo usuário associadas ao recurso. As chaves do dicionário userAssignedIdentities serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Os valores de dicionário podem ser objetos vazios ({}) em solicitações. UserAssignedIdentities

RedisCommonPropertiesRedisConfiguration

Designação Descrição Valor
Habilitado para AAD Especifica se a autenticação baseada em AAD foi habilitada ou desabilitada para o cache cadeia (de caracteres)
aof-backup-habilitado Especifica se o aof backup está habilitado cadeia (de caracteres)
aof-storage-connection-string-0 Primeira cadeia de conexão da conta de armazenamento cadeia (de caracteres)
aof-storage-connection-string-1 Segunda cadeia de conexão da conta de armazenamento cadeia (de caracteres)
authnotrequired Especifica se a autenticação está desabilitada. Definir esta propriedade é altamente desencorajado do ponto de vista da segurança; Você nunca deve desativar a autenticação usando esta propriedade! cadeia (de caracteres)
maxfragmentationmemória-reservado Valor em megabytes reservado para fragmentação por fragmento cadeia (de caracteres)
maxmemory-delta Valor em megabytes reservado para uso não cache por estilhaço, por exemplo, failover. cadeia (de caracteres)
política de memória máxima A estratégia de remoção usada quando seus dados não cabem dentro de seu limite de memória. cadeia (de caracteres)
maxmemory-reservado Valor em megabytes reservado para uso não cache por estilhaço, por exemplo, failover. cadeia (de caracteres)
notificar-eventos-do-espaço-de-chave Os eventos keyspace que devem ser monitorados. cadeia (de caracteres)
preferred-data-persistence-auth-method Método de autenticação preferencial para se comunicar com a conta de armazenamento usada para persistência de dados, especificar SAS ou ManagedIdentity, o valor padrão é SAS cadeia (de caracteres)
rdb-backup-habilitado Especifica se o backup RDB está habilitado cadeia (de caracteres)
rdb-backup-freqüência Especifica a frequência para criar backup rdb em minutos. Valores válidos: (15, 30, 60, 360, 720, 1440) cadeia (de caracteres)
rdb-backup-max-snapshot-count Especifica o número máximo de snapshots para backup rdb cadeia (de caracteres)
rdb-cadeia-de-conexão-armazenamento A cadeia de conexão da conta de armazenamento para armazenar o arquivo rdb cadeia (de caracteres)
ID de subscrição de armazenamento SubscriptionId da conta de armazenamento para persistência (aof/rdb) usando ManagedIdentity. cadeia (de caracteres)

RedisCommonPropertiesTenantSettings

Designação Descrição Valor

RedisCreateParametersTags

Designação Descrição Valor

RedisCreatePropertiesOrRedisProperties

Designação Descrição Valor
disableAccessKeyAuthentication A autenticação no Redis através de chaves de acesso é desativada quando definida como true. O valor padrão é false. Bool
enableNonSslPort Especifica se a porta do servidor Redis não ssl (6379) está habilitada. Bool
minimumTlsVersion Opcional: requer que os clientes usem uma versão especificada do TLS (ou superior) para se conectar (por exemplo, '1.0', '1.1', '1.2') '1.0'
'1.1'
'1.2'
acesso à rede pública Se o acesso ao ponto de extremidade público é permitido ou não para esse cache. O valor é opcional, mas se passado, deve ser 'Ativado' ou 'Desativado'. Se 'Desativado', os pontos finais privados são o método de acesso exclusivo. 'Desativado'
'Habilitado'
redisConfiguration Todas as configurações do Redis. Poucas chaves possíveis: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta, maxmemory-policy,notify-keyspace-events, aof-backup-enabled, aof-storage-connection-string-0, aof-storage-connection-string-1 etc. RedisCommonPropertiesRedisConfiguration
redisversão Versão Redis. Este deve ser na forma 'major[.minor]' (apenas 'major' é necessário) ou o valor 'mais recente' que se refere à última versão estável do Redis que está disponível. Versões suportadas: 4.0, 6.0 (mais recente). O valor padrão é 'mais recente'. cadeia (de caracteres)
réplicasPerMaster O número de réplicas a serem criadas por primária. Int
réplicasPerPrimary O número de réplicas a serem criadas por primária. Int
Contagem de fragmentos O número de fragmentos a serem criados em um Cache de Cluster Premium. Int
SKU O SKU do cache Redis a ser implantado. Sku (obrigatório)
estáticaIP Endereço IP estático. Opcionalmente, pode ser especificado ao implantar um cache Redis dentro de uma Rede Virtual do Azure existente; atribuído automaticamente por padrão. cadeia de caracteres

Restrições:
Padrão = ^\d+\.\d+\.\d+\.\d+$
subnetId O ID de recurso completo de uma sub-rede em uma rede virtual para implantar o cache Redis. Formato de exemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft. {Rede|ClassicNetwork}/VirtualNetworks/vnet1/sub-redes/sub-rede1 cadeia de caracteres

Restrições:
Padrão = ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$
configurações de locatário Um dicionário de configurações de locatário RedisCommonPropertiesTenantSettings
updateChannel [en] Opcional: especifica o canal de atualização para as atualizações mensais do Cache Redis que seu Cache Redis receberá. Os caches que usam o canal de atualização 'Preview' obtêm as atualizações mais recentes do Redis pelo menos 4 semanas antes dos caches de canal 'Estável'. O valor padrão é 'Estável'. 'Pré-visualização'
'Estável'
zonalAllocationPolicy Opcional: especifica como as zonas de disponibilidade são alocadas para o cache Redis. 'Automático' permite redundância de zona e o Azure selecionará automaticamente zonas com base na disponibilidade e capacidade regionais. 'UserDefined' selecionará zonas de disponibilidade passadas por você usando o parâmetro 'zones'. 'NoZones' produzirá um cache não zonal. Se 'zonalAllocationPolicy' não for passado, ele será definido como 'UserDefined' quando as zonas forem passadas, caso contrário, ele será definido como 'Automatic' em regiões onde as zonas são suportadas e 'NoZones' em regiões onde as zonas não são suportadas. 'Automático'
'NoZones'
'Definido pelo usuário'

Referência

Designação Descrição Valor
capacidade O tamanho do cache Redis a ser implantado. Valores válidos: para a família C (Basic/Standard) (0, 1, 2, 3, 4, 5, 6), para a família P (Premium) (1, 2, 3, 4). int (obrigatório)
Família A família SKU a ser usada. Valores válidos: (C, P). (C = Básico/Padrão, P = Premium). «C»
'P' (obrigatório)
Designação O tipo de cache Redis a ser implantado. Valores válidos: (Básico, Standard, Premium) 'Básico'
'Premium'
'Standard' (obrigatório)

UserAssignedIdentities

Designação Descrição Valor

IdentidadeAtribuídaPeloUtilizador

Designação Descrição Valor

Exemplos de uso

Amostras Terraform

Um exemplo básico de implantação do Cache Redis.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "eastus"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "redis" {
  type      = "Microsoft.Cache/redis@2023-04-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      sku = {
        capacity = 2
        family   = "C"
        name     = "Standard"
      }
      enableNonSslPort  = true
      minimumTlsVersion = "1.2"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Módulos verificados do Azure

Os seguintes de Módulos Verificados do Azure podem ser usados para implantar esse tipo de recurso.

Módulo Descrição
Cache Redis Módulo de recursos AVM para cache Redis