你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.Cache redis 2020-12-01

项目
12/21/2024

Bicep 资源定义

可以使用目标操作部署 redis 资源类型：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.Cache/redis 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Cache/redis@2020-12-01' = {
  location: 'string'
  name: 'string'
  properties: {
    enableNonSslPort: bool
    minimumTlsVersion: 'string'
    publicNetworkAccess: 'string'
    redisConfiguration: {
      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'
      rdb-backup-enabled: 'string'
      rdb-backup-frequency: 'string'
      rdb-backup-max-snapshot-count: 'string'
      rdb-storage-connection-string: 'string'
    }
    redisVersion: 'string'
    replicasPerMaster: int
    replicasPerPrimary: int
    shardCount: int
    sku: {
      capacity: int
      family: 'string'
      name: 'string'
    }
    staticIP: 'string'
    subnetId: 'string'
    tenantSettings: {
      {customized property}: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
  zones: [
    'string'
  ]
}

属性值

Microsoft.Cache/redis

名字	描述	价值
位置	资源所在的地理位置	string （必需）
名字	资源名称	string （必需）
性能	Redis 缓存属性。	RedisCreatePropertiesOrRedisProperties （必需）
标签	资源标记	标记名称和值的字典。请参阅模板中的标记
区	一个可用性区域列表，表示资源需要来自何处。	string[]

RedisCommonPropertiesRedisConfiguration

名字	描述	价值
aof-backup-enabled	指定是否启用 aof 备份	字符串
aof-storage-connection-string-0	第一个存储帐户连接字符串	字符串
aof-storage-connection-string-1	第二个存储帐户连接字符串	字符串
authnotrequired	指定是否禁用身份验证。强烈建议不要从安全角度设置此属性。	字符串
maxfragmentationmemory-reserved	每个分片的碎片保留的以兆字节为单位的值	字符串
maxmemory-delta	为每个分片保留的非缓存使用量（例如故障转移）的值（以兆字节为单位）。	字符串
maxmemory-policy	当数据不符合其内存限制时使用的逐出策略。	字符串
maxmemory-reserved	为每个分片保留的非缓存使用量（例如故障转移）的值（以兆字节为单位）。	字符串
已启用 rdb-backup-enabled	指定是否启用 rdb 备份	字符串
rdb-backup-frequency	指定创建 rdb 备份的频率	字符串
rdb-backup-max-snapshot-count	指定 rdb 备份的最大快照数	字符串
rdb-storage-connection-string	用于存储 rdb 文件的存储帐户连接字符串	字符串

RedisCommonPropertiesTenantSettings

名字	描述	价值

RedisCreateParametersTags

名字	描述	价值

RedisCreatePropertiesOrRedisProperties

名字	描述	价值
enableNonSslPort	指定是否启用非 ssl Redis 服务器端口（6379）。	bool
minimumTlsVersion	可选：要求客户端使用指定的 TLS 版本（或更高版本）进行连接（例如，“1.0”、“1.1”、“1.2”）	'1.0' '1.1' '1.2'
publicNetworkAccess	是否允许对此缓存使用公共终结点访问。值是可选的，但如果传入，则必须为“Enabled”或“Disabled”。如果为“Disabled”，则专用终结点是独占访问方法。默认值为“Enabled”	“Disabled” “Enabled”
redisConfiguration	所有 Redis 设置。很少有可能的密钥：rdb-backup-enabled、rdb-storage-connection-string、rdb-backup-frequency、maxmemory-delta、maxmemory-policy、notify-keyspace-events、maxmemory-samples、slowlog-log-slow-than、slowlog-max-len ，list-max-ziplist-entries，list-max-ziplist-value，hash-max-ziplist-entries，hash-max-ziplist-value，set-max-intset-entries，zset-max-ziplist-entries，zset-max-ziplist-value etc.	RedisCommonPropertiesRedisConfiguration
redisVersion	Redis 版本。这应采用“major[.minor[.build]]”格式（仅需要“major”）或值“latest”，该值引用可用的最新稳定 Redis 版本。 PUT/PATCH 请求中仅使用主版本和次要版本。支持的版本：4.0、6.0。	字符串
replicasPerMaster	要为每个主要副本创建的副本数。	int
replicasPerPrimary	要为每个主要副本创建的副本数。	int
shardCount	在高级群集缓存上创建的分片数。	int
sku	要部署的 Redis 缓存的 SKU。	Sku（必需）
staticIP	静态 IP 地址。（可选）在现有 Azure 虚拟网络中部署 Redis 缓存时可以指定;默认情况下自动分配。	字符串约束： Pattern = `^\d+\.\d+\.\d+\.\d+$`
subnetId	要在其中部署 Redis 缓存的虚拟网络中子网的完整资源 ID。示例格式：/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft。{Network	ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1	字符串
tenantSettings	租户设置字典	RedisCommonPropertiesTenantSettings

Sku

名字	描述	价值
能力	要部署的 Redis 缓存的大小。有效值：对于 C（基本/标准）系列（0、1、2、3、4、5、6）、P（高级）系列（1、2、3、4）。	int （必需）
家庭	要使用的 SKU 系列。有效值：（C、P）。（C = 基本/标准，P = 高级）。	'C' “P”（必需）
名字	要部署的 Redis 缓存的类型。有效值：（基本、标准、高级）	“Basic” “Premium” “标准”（必需）

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件	描述
创建具有群集的高级 Redis 缓存	此模板演示如何在高级 Azure Redis 缓存实例中配置群集。
使用模板创建 Redis 缓存	此模板创建一个 Azure Redis 缓存，其中包含保存在存储帐户中的诊断数据。
使用 Microsoft Entra 身份验证创建 Redis 缓存。	此模板创建 Redis 缓存。然后将内置访问策略分配给 redis 用户。然后创建自定义访问策略。然后将自定义访问策略分配给另一个 Redis 用户。
使用模板创建 Web 应用和 Redis 缓存	此模板使用 Redis 缓存创建 Azure Web 应用。
创建部署到虚拟网络的高级 Redis 缓存	此模板演示如何将高级 Azure Redis 缓存实例部署到现有虚拟网络
创建具有数据持久性的高级 Redis 缓存	此模板演示如何在高级 Azure Redis 缓存实例中配置持久性。
使用外部 Azure Redis 缓存部署 API 管理	此模板演示如何使用外部 Azure Redis 缓存实例作为 API 管理外部缓存在消耗层中创建 Azure API 管理的实例。

ARM 模板资源定义

可以使用目标操作部署 redis 资源类型：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.Cache/redis 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Cache/redis",
  "apiVersion": "2020-12-01",
  "name": "string",
  "location": "string",
  "properties": {
    "enableNonSslPort": "bool",
    "minimumTlsVersion": "string",
    "publicNetworkAccess": "string",
    "redisConfiguration": {
      "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",
      "rdb-backup-enabled": "string",
      "rdb-backup-frequency": "string",
      "rdb-backup-max-snapshot-count": "string",
      "rdb-storage-connection-string": "string"
    },
    "redisVersion": "string",
    "replicasPerMaster": "int",
    "replicasPerPrimary": "int",
    "shardCount": "int",
    "sku": {
      "capacity": "int",
      "family": "string",
      "name": "string"
    },
    "staticIP": "string",
    "subnetId": "string",
    "tenantSettings": {
      "{customized property}": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  },
  "zones": [ "string" ]
}

属性值

Microsoft.Cache/redis

名字	描述	价值
apiVersion	API 版本	'2020-12-01'
位置	资源所在的地理位置	string （必需）
名字	资源名称	string （必需）
性能	Redis 缓存属性。	RedisCreatePropertiesOrRedisProperties （必需）
标签	资源标记	标记名称和值的字典。请参阅模板中的标记
类型	资源类型	“Microsoft.Cache/redis”
区	一个可用性区域列表，表示资源需要来自何处。	string[]

RedisCommonPropertiesRedisConfiguration

名字	描述	价值
aof-backup-enabled	指定是否启用 aof 备份	字符串
aof-storage-connection-string-0	第一个存储帐户连接字符串	字符串
aof-storage-connection-string-1	第二个存储帐户连接字符串	字符串
authnotrequired	指定是否禁用身份验证。强烈建议不要从安全角度设置此属性。	字符串
maxfragmentationmemory-reserved	每个分片的碎片保留的以兆字节为单位的值	字符串
maxmemory-delta	为每个分片保留的非缓存使用量（例如故障转移）的值（以兆字节为单位）。	字符串
maxmemory-policy	当数据不符合其内存限制时使用的逐出策略。	字符串
maxmemory-reserved	为每个分片保留的非缓存使用量（例如故障转移）的值（以兆字节为单位）。	字符串
已启用 rdb-backup-enabled	指定是否启用 rdb 备份	字符串
rdb-backup-frequency	指定创建 rdb 备份的频率	字符串
rdb-backup-max-snapshot-count	指定 rdb 备份的最大快照数	字符串
rdb-storage-connection-string	用于存储 rdb 文件的存储帐户连接字符串	字符串

RedisCommonPropertiesTenantSettings

名字	描述	价值

RedisCreateParametersTags

名字	描述	价值

RedisCreatePropertiesOrRedisProperties

名字	描述	价值
enableNonSslPort	指定是否启用非 ssl Redis 服务器端口（6379）。	bool
minimumTlsVersion	可选：要求客户端使用指定的 TLS 版本（或更高版本）进行连接（例如，“1.0”、“1.1”、“1.2”）	'1.0' '1.1' '1.2'
publicNetworkAccess	是否允许对此缓存使用公共终结点访问。值是可选的，但如果传入，则必须为“Enabled”或“Disabled”。如果为“Disabled”，则专用终结点是独占访问方法。默认值为“Enabled”	“Disabled” “Enabled”
redisConfiguration	所有 Redis 设置。很少有可能的密钥：rdb-backup-enabled、rdb-storage-connection-string、rdb-backup-frequency、maxmemory-delta、maxmemory-policy、notify-keyspace-events、maxmemory-samples、slowlog-log-slow-than、slowlog-max-len ，list-max-ziplist-entries，list-max-ziplist-value，hash-max-ziplist-entries，hash-max-ziplist-value，set-max-intset-entries，zset-max-ziplist-entries，zset-max-ziplist-value etc.	RedisCommonPropertiesRedisConfiguration
redisVersion	Redis 版本。这应采用“major[.minor[.build]]”格式（仅需要“major”）或值“latest”，该值引用可用的最新稳定 Redis 版本。 PUT/PATCH 请求中仅使用主版本和次要版本。支持的版本：4.0、6.0。	字符串
replicasPerMaster	要为每个主要副本创建的副本数。	int
replicasPerPrimary	要为每个主要副本创建的副本数。	int
shardCount	在高级群集缓存上创建的分片数。	int
sku	要部署的 Redis 缓存的 SKU。	Sku（必需）
staticIP	静态 IP 地址。（可选）在现有 Azure 虚拟网络中部署 Redis 缓存时可以指定;默认情况下自动分配。	字符串约束： Pattern = `^\d+\.\d+\.\d+\.\d+$`
subnetId	要在其中部署 Redis 缓存的虚拟网络中子网的完整资源 ID。示例格式：/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft。{Network	ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1	字符串
tenantSettings	租户设置字典	RedisCommonPropertiesTenantSettings

Sku

名字	描述	价值
能力	要部署的 Redis 缓存的大小。有效值：对于 C（基本/标准）系列（0、1、2、3、4、5、6）、P（高级）系列（1、2、3、4）。	int （必需）
家庭	要使用的 SKU 系列。有效值：（C、P）。（C = 基本/标准，P = 高级）。	'C' “P”（必需）
名字	要部署的 Redis 缓存的类型。有效值：（基本、标准、高级）	“Basic” “Premium” “标准”（必需）

快速入门模板

以下快速入门模板部署此资源类型。

模板	描述
创建具有群集的高级 Redis 缓存	此模板演示如何在高级 Azure Redis 缓存实例中配置群集。
使用模板创建 Redis 缓存	此模板创建一个 Azure Redis 缓存，其中包含保存在存储帐户中的诊断数据。
使用 Microsoft Entra 身份验证创建 Redis 缓存。	此模板创建 Redis 缓存。然后将内置访问策略分配给 redis 用户。然后创建自定义访问策略。然后将自定义访问策略分配给另一个 Redis 用户。
使用模板创建 Web 应用 + Redis 缓存 + SQL DB	此模板使用 Redis 缓存和 SQL 数据库创建 Azure Web 应用。
使用模板创建 Web 应用和 Redis 缓存	此模板使用 Redis 缓存创建 Azure Web 应用。
创建部署到虚拟网络的高级 Redis 缓存	此模板演示如何将高级 Azure Redis 缓存实例部署到现有虚拟网络
创建具有数据持久性的高级 Redis 缓存	此模板演示如何在高级 Azure Redis 缓存实例中配置持久性。
在虚拟网络中创建两个异地复制缓存	此模板演示如何将两个高级层 Azure Redis 缓存实例部署到单独的虚拟网络中，并将其与异地复制链接。
使用外部 Azure Redis 缓存部署 API 管理	此模板演示如何使用外部 Azure Redis 缓存实例作为 API 管理外部缓存在消耗层中创建 Azure API 管理的实例。
使用 ILB ASE eShop 网站	应用服务环境是 Azure 应用服务的高级服务计划选项，它提供完全隔离和专用的环境，用于大规模安全地运行 Azure 应用服务应用，包括 Web 应用、移动应用和 API 应用。
可缩放的 Umbraco CMS Web 应用	此模板提供了在 Azure 应用服务 Web 应用上部署 umbraco CMS Web 应用的简单方法。

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署 redis 资源类型：

资源组

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.Cache/redis 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Cache/redis@2020-12-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  zones = [
    "string"
  ]
  body = jsonencode({
    properties = {
      enableNonSslPort = bool
      minimumTlsVersion = "string"
      publicNetworkAccess = "string"
      redisConfiguration = {
        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"
        rdb-backup-enabled = "string"
        rdb-backup-frequency = "string"
        rdb-backup-max-snapshot-count = "string"
        rdb-storage-connection-string = "string"
      }
      redisVersion = "string"
      replicasPerMaster = int
      replicasPerPrimary = int
      shardCount = int
      sku = {
        capacity = int
        family = "string"
        name = "string"
      }
      staticIP = "string"
      subnetId = "string"
      tenantSettings = {
        {customized property} = "string"
      }
    }
  })
}

属性值

Microsoft.Cache/redis

名字	描述	价值
位置	资源所在的地理位置	string （必需）
名字	资源名称	string （必需）
性能	Redis 缓存属性。	RedisCreatePropertiesOrRedisProperties （必需）
标签	资源标记	标记名称和值的字典。
类型	资源类型	“Microsoft.Cache/redis@2020-12-01”
区	一个可用性区域列表，表示资源需要来自何处。	string[]

RedisCommonPropertiesRedisConfiguration

名字	描述	价值
aof-backup-enabled	指定是否启用 aof 备份	字符串
aof-storage-connection-string-0	第一个存储帐户连接字符串	字符串
aof-storage-connection-string-1	第二个存储帐户连接字符串	字符串
authnotrequired	指定是否禁用身份验证。强烈建议不要从安全角度设置此属性。	字符串
maxfragmentationmemory-reserved	每个分片的碎片保留的以兆字节为单位的值	字符串
maxmemory-delta	为每个分片保留的非缓存使用量（例如故障转移）的值（以兆字节为单位）。	字符串
maxmemory-policy	当数据不符合其内存限制时使用的逐出策略。	字符串
maxmemory-reserved	为每个分片保留的非缓存使用量（例如故障转移）的值（以兆字节为单位）。	字符串
已启用 rdb-backup-enabled	指定是否启用 rdb 备份	字符串
rdb-backup-frequency	指定创建 rdb 备份的频率	字符串
rdb-backup-max-snapshot-count	指定 rdb 备份的最大快照数	字符串
rdb-storage-connection-string	用于存储 rdb 文件的存储帐户连接字符串	字符串

RedisCommonPropertiesTenantSettings

名字	描述	价值

RedisCreateParametersTags

名字	描述	价值

RedisCreatePropertiesOrRedisProperties

名字	描述	价值
enableNonSslPort	指定是否启用非 ssl Redis 服务器端口（6379）。	bool
minimumTlsVersion	可选：要求客户端使用指定的 TLS 版本（或更高版本）进行连接（例如，“1.0”、“1.1”、“1.2”）	'1.0' '1.1' '1.2'
publicNetworkAccess	是否允许对此缓存使用公共终结点访问。值是可选的，但如果传入，则必须为“Enabled”或“Disabled”。如果为“Disabled”，则专用终结点是独占访问方法。默认值为“Enabled”	“Disabled” “Enabled”
redisConfiguration	所有 Redis 设置。很少有可能的密钥：rdb-backup-enabled、rdb-storage-connection-string、rdb-backup-frequency、maxmemory-delta、maxmemory-policy、notify-keyspace-events、maxmemory-samples、slowlog-log-slow-than、slowlog-max-len ，list-max-ziplist-entries，list-max-ziplist-value，hash-max-ziplist-entries，hash-max-ziplist-value，set-max-intset-entries，zset-max-ziplist-entries，zset-max-ziplist-value etc.	RedisCommonPropertiesRedisConfiguration
redisVersion	Redis 版本。这应采用“major[.minor[.build]]”格式（仅需要“major”）或值“latest”，该值引用可用的最新稳定 Redis 版本。 PUT/PATCH 请求中仅使用主版本和次要版本。支持的版本：4.0、6.0。	字符串
replicasPerMaster	要为每个主要副本创建的副本数。	int
replicasPerPrimary	要为每个主要副本创建的副本数。	int
shardCount	在高级群集缓存上创建的分片数。	int
sku	要部署的 Redis 缓存的 SKU。	Sku（必需）
staticIP	静态 IP 地址。（可选）在现有 Azure 虚拟网络中部署 Redis 缓存时可以指定;默认情况下自动分配。	字符串约束： Pattern = `^\d+\.\d+\.\d+\.\d+$`
subnetId	要在其中部署 Redis 缓存的虚拟网络中子网的完整资源 ID。示例格式：/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft。{Network	ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1	字符串
tenantSettings	租户设置字典	RedisCommonPropertiesTenantSettings

Sku

名字	描述	价值
能力	要部署的 Redis 缓存的大小。有效值：对于 C（基本/标准）系列（0、1、2、3、4、5、6）、P（高级）系列（1、2、3、4）。	int （必需）
家庭	要使用的 SKU 系列。有效值：（C、P）。（C = 基本/标准，P = 高级）。	'C' “P”（必需）
名字	要部署的 Redis 缓存的类型。有效值：（基本、标准、高级）	“Basic” “Premium” “标准”（必需）

通过

Microsoft.Cache redis 2020-12-01

Bicep 资源定义

资源格式

属性值

Microsoft.Cache/redis

RedisCommonPropertiesRedisConfiguration

RedisCommonPropertiesTenantSettings

RedisCreateParametersTags

RedisCreatePropertiesOrRedisProperties

Sku

快速入门示例

ARM 模板资源定义

资源格式

属性值

Microsoft.Cache/redis

RedisCommonPropertiesRedisConfiguration

RedisCommonPropertiesTenantSettings

RedisCreateParametersTags

RedisCreatePropertiesOrRedisProperties

Sku

快速入门模板

Terraform （AzAPI 提供程序）资源定义

资源格式

属性值

Microsoft.Cache/redis

RedisCommonPropertiesRedisConfiguration

RedisCommonPropertiesTenantSettings

RedisCreateParametersTags

RedisCreatePropertiesOrRedisProperties

Sku

反馈

其他资源