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

Microsoft.Cache redis 2020-12-01

Bicep 资源定义

redis 资源类型可以使用面向以下对象的操作进行部署:

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

资源格式

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

resource symbolicname 'Microsoft.Cache/redis@2020-12-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
    {customized property}: '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'
      {customized property}: 'string'
    }
    redisVersion: 'string'
    replicasPerMaster: int
    replicasPerPrimary: int
    shardCount: int
    sku: {
      capacity: int
      family: 'string'
      name: 'string'
    }
    staticIP: 'string'
    subnetId: 'string'
    tenantSettings: {
      {customized property}: 'string'
    }
  }
  zones: [
    'string'
  ]
}

属性值

redis

名称 说明
name 资源名称 字符串 (必需)

字符限制:1-63

有效字符:
字母数字和连字符。

以字母数字开头和结尾。 不允许连续的连字符。

资源名称在 Azure 中必须是唯一的。
location 资源所在的地理位置 字符串 (必需)
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
properties Redis 缓存属性。 RedisCreatePropertiesOrRedisProperties (必需)
zones 表示资源需要来自的可用性区域列表。 string[]

RedisCreatePropertiesOrRedisProperties

名称 说明
enableNonSslPort 指定是否启用非 ssl Redis 服务器端口 (6379) 。 bool
minimumTlsVersion 可选:要求客户端使用指定的 TLS 版本 (或更高版本) 来连接 (,例如,“1.0”、“1.1”、“1.2”) '1.0'
'1.1'
'1.2'
publicNetworkAccess 是否允许对此缓存进行公共终结点访问。 值是可选的,但如果传入,则必须为“Enabled”或“Disabled”。 如果“已禁用”,则专用终结点是独占访问方法。 默认值为“Enabled” “Disabled”
“已启用”
redisConfiguration 所有 Redis 设置。 几个可能的密钥:rdb-backup-enabled、rdb-storage-connection-string、rdb-backup-frequency、maxmemory-delta、maxmemory-policy、notify-keyspace-events、maxmemory-samples、slowlog-log-slow-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 等。 RedisCommonPropertiesRedisConfiguration
redisVersion Redis 版本。 这应采用“major[.minor[.build]]”格式, (只需要“major”) 或值“latest”,它指的是可用的最新稳定 Redis 版本。 PUT/PATCH 请求中仅使用主版本和次要版本。 支持的版本:4.0、6.0。 string
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

RedisCommonPropertiesRedisConfiguration

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

SKU

名称 说明
容量 要部署的 Redis 缓存的大小。 有效值:对于 C (Basic/Standard) 系列 (0、1、2、3、4、5、6) ,对于 P (Premium) 系列 (1、2、3、4) 。 int (必需)
family 要使用的 SKU 系列。 有效值: (C、P) 。 (C = 基本/标准,P = 高级) 。 'C'
“P” (必需)
name 要部署的 Redis 缓存的类型。 有效值: (Basic、Standard、Premium) 'Basic'
“Premium”
需要“标准” ()

RedisCommonPropertiesTenantSettings

名称 说明
{customized property} 字符串

快速入门模板

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

模板 说明
可缩放的 Umbraco CMS Web 应用

部署到 Azure
此模板提供了一种在 Azure 应用服务 Web 应用 上部署 umbraco CMS Web 应用的简单方法。
使用 ILB ASE 的 eShop 网站

部署到 Azure
应用服务环境是 Azure 应用服务的一项高级服务计划选项,可提供完全隔离的专用环境来安全地大规模运行 Azure 应用服务应用,包括 Web 应用、移动应用和 API 应用。
使用外部Azure Cache for Redis部署API 管理

部署到 Azure
此模板演示如何在消耗层中创建 Azure API 管理实例,其中外部Azure Cache for Redis实例作为API 管理外部缓存。
使用模板创建 Redis 缓存

部署到 Azure
此模板创建 Azure Redis 缓存,其中诊断数据保存在存储帐户中。
使用 Microsoft Entra 身份验证创建 Redis 缓存。

部署到 Azure
此模板创建 Redis 缓存。 然后将内置访问策略分配给 redis 用户。 然后创建自定义访问策略。 然后将自定义访问策略分配给另一个 Redis 用户。
创建具有群集功能的高级 Redis 缓存

部署到 Azure
此模板演示如何在高级 Azure Redis 缓存实例中配置聚类分析。
创建具有数据暂留的高级 Redis 缓存

部署到 Azure
此模板演示如何在高级 Azure Redis 缓存实例中配置持久性。
Create Premium Redis Cache deployed into a Virtual Network(创建部署到虚拟网络中的高级 Redis 缓存)

部署到 Azure
此模板演示如何将高级 Azure Redis 缓存实例部署到现有虚拟网络
在虚拟网络中创建两个异地复制缓存

部署到 Azure
此模板演示如何将两个高级层Azure Cache for Redis实例部署到单独的虚拟网络中,并将其与异地复制相关联。
使用模板创建 Web 应用 + Redis 缓存 + SQL DB

部署到 Azure
此模板使用 Redis 缓存和SQL 数据库创建 Azure Web 应用。
使用模板创建 Web 应用和 Redis 缓存

部署到 Azure
此模板使用 Redis 缓存创建 Azure Web 应用。

ARM 模板资源定义

redis 资源类型可以使用面向以下对象的操作进行部署:

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

资源格式

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

{
  "type": "Microsoft.Cache/redis",
  "apiVersion": "2020-12-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
    "{customized property}": "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",
      "{customized property}": "string"
    },
    "redisVersion": "string",
    "replicasPerMaster": "int",
    "replicasPerPrimary": "int",
    "shardCount": "int",
    "sku": {
      "capacity": "int",
      "family": "string",
      "name": "string"
    },
    "staticIP": "string",
    "subnetId": "string",
    "tenantSettings": {
      "{customized property}": "string"
    }
  },
  "zones": [ "string" ]
}

属性值

redis

名称 说明 Value
type 资源类型 “Microsoft.Cache/redis”
apiVersion 资源 API 版本 '2020-12-01'
name 资源名称 字符串 (必需)

字符限制:1-63

有效字符:
字母数字和连字符。

以字母数字开头和结尾。 不允许连续的连字符。

资源名称在 Azure 中必须是唯一的。
location 资源所在的地理位置 字符串 (必需)
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
properties Redis 缓存属性。 RedisCreatePropertiesOrRedisProperties (必需)
zones 表示资源需要来自的可用性区域列表。 string[]

RedisCreatePropertiesOrRedisProperties

名称 说明
enableNonSslPort 指定是否启用非 ssl Redis 服务器端口 (6379) 。 bool
minimumTlsVersion 可选:要求客户端使用指定的 TLS 版本 (或更高版本) 来连接 (,例如,“1.0”、“1.1”、“1.2”) '1.0'
'1.1'
'1.2'
publicNetworkAccess 是否允许对此缓存进行公共终结点访问。 值是可选的,但如果传入,则必须为“Enabled”或“Disabled”。 如果“已禁用”,则专用终结点是独占访问方法。 默认值为“Enabled” “Disabled”
“已启用”
redisConfiguration 所有 Redis 设置。 几个可能的密钥:rdb-backup-enabled、rdb-storage-connection-string、rdb-backup-frequency、maxmemory-delta、maxmemory-policy、notify-keyspace-events、maxmemory-samples、slowlog-log-slow-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 等。 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 string
tenantSettings 租户设置字典 RedisCommonPropertiesTenantSettings

RedisCommonPropertiesRedisConfiguration

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

SKU

名称 说明
容量 要部署的 Redis 缓存的大小。 有效值:对于 C (Basic/Standard) 系列 (0、1、2、3、4、5、6) ,对于 P (Premium) 系列 (1、2、3、4) 。 int (必需)
family 要使用的 SKU 系列。 有效值: (C、P) 。 (C = 基本/标准,P = 高级) 。 'C'
“P” (必需)
name 要部署的 Redis 缓存的类型。 有效值: (Basic、Standard、Premium) 'Basic'
“Premium”
需要“标准” ()

RedisCommonPropertiesTenantSettings

名称 说明
{customized property} 字符串

快速入门模板

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

模板 说明
可缩放的 Umbraco CMS Web 应用

部署到 Azure
此模板提供了一种在 Azure 应用服务 Web 应用 上部署 umbraco CMS Web 应用的简单方法。
使用 ILB ASE 的 eShop 网站

部署到 Azure
应用服务环境是 Azure 应用服务的一项高级服务计划选项,可提供完全隔离的专用环境来安全地大规模运行 Azure 应用服务应用,包括 Web 应用、移动应用和 API 应用。
使用外部Azure Cache for Redis部署API 管理

部署到 Azure
此模板演示如何在消耗层中创建 Azure API 管理实例,其中外部Azure Cache for Redis实例作为API 管理外部缓存。
使用模板创建 Redis 缓存

部署到 Azure
此模板创建 Azure Redis 缓存,其中诊断数据保存在存储帐户中。
使用 Microsoft Entra 身份验证创建 Redis 缓存。

部署到 Azure
此模板创建 Redis 缓存。 然后将内置访问策略分配给 redis 用户。 然后创建自定义访问策略。 然后将自定义访问策略分配给另一个 Redis 用户。
创建具有群集功能的高级 Redis 缓存

部署到 Azure
此模板演示如何在高级 Azure Redis 缓存实例中配置聚类分析。
创建具有数据暂留的高级 Redis 缓存

部署到 Azure
此模板演示如何在高级 Azure Redis 缓存实例中配置持久性。
Create Premium Redis Cache deployed into a Virtual Network(创建部署到虚拟网络中的高级 Redis 缓存)

部署到 Azure
此模板演示如何将高级 Azure Redis 缓存实例部署到现有虚拟网络
在虚拟网络中创建两个异地复制缓存

部署到 Azure
此模板演示如何将两个高级层Azure Cache for Redis实例部署到单独的虚拟网络中,并将其与异地复制相关联。
使用模板创建 Web 应用 + Redis 缓存 + SQL DB

部署到 Azure
此模板使用 Redis 缓存和SQL 数据库创建 Azure Web 应用。
使用模板创建 Web 应用和 Redis 缓存

部署到 Azure
此模板使用 Redis 缓存创建 Azure Web 应用。

Terraform (AzAPI 提供程序) 资源定义

redis 资源类型可以使用面向以下对象的操作进行部署:

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Cache/redis@2020-12-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
    {customized property} = "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"
        {customized property} = "string"
      }
      redisVersion = "string"
      replicasPerMaster = int
      replicasPerPrimary = int
      shardCount = int
      sku = {
        capacity = int
        family = "string"
        name = "string"
      }
      staticIP = "string"
      subnetId = "string"
      tenantSettings = {
        {customized property} = "string"
      }
    }
    zones = [
      "string"
    ]
  })
}

属性值

redis

名称 说明 Value
type 资源类型 “Microsoft.Cache/redis@2020-12-01”
name 资源名称 字符串 (必需)

字符限制:1-63

有效字符:
字母数字和连字符。

以字母数字开头和结尾。 不允许连续的连字符。

资源名称在 Azure 中必须是唯一的。
location 资源所在的地理位置 字符串 (必需)
parent_id 若要部署到资源组,请使用该资源组的 ID。 字符串 (必需)
标记 资源标记。 标记名称和值的字典。
properties Redis 缓存属性。 RedisCreatePropertiesOrRedisProperties (必需)
zones 表示资源需要来自的可用性区域列表。 string[]

RedisCreatePropertiesOrRedisProperties

名称 说明
enableNonSslPort 指定是否启用非 ssl Redis 服务器端口 (6379) 。 bool
minimumTlsVersion 可选:要求客户端使用指定的 TLS 版本 (或更高版本) 来连接 (,例如,“1.0”、“1.1”、“1.2”) "1.0"
"1.1"
"1.2"
publicNetworkAccess 是否允许对此缓存进行公共终结点访问。 值是可选的,但如果传入,则必须为“Enabled”或“Disabled”。 如果“已禁用”,则专用终结点是独占访问方法。 默认值为“Enabled” “Disabled”
“已启用”
redisConfiguration 所有 Redis 设置。 几个可能的密钥:rdb-backup-enabled、rdb-storage-connection-string、rdb-backup-frequency、maxmemory-delta、maxmemory-policy、notify-keyspace-events、maxmemory-samples、slowlog-log-slow-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 等。 RedisCommonPropertiesRedisConfiguration
redisVersion Redis 版本。 这应采用“major[.minor[.build]]”格式, (只需要“major”) 或值“latest”,它指的是可用的最新稳定 Redis 版本。 PUT/PATCH 请求中仅使用主版本和次要版本。 支持的版本:4.0、6.0。 string
replicasPerMaster 每个主数据库要创建的副本数。 int
replicasPerPrimary 每个主数据库要创建的副本数。 int
shardCount 要对高级群集缓存创建的分片数。 int
sku 要部署的 Redis 缓存的 SKU。 需要 sku ()
staticIP 静态 IP 地址。 (可选)在现有 Azure 虚拟网络中部署 Redis 缓存时可以指定;默认情况下自动分配。 string

约束:
Pattern = ^\d+\.\d+\.\d+\.\d+$
subnetId 虚拟网络中要在其中部署 Redis 缓存的子网的完整资源 ID。 示例格式:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft。{Network,ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1 字符串
tenantSettings 租户设置字典 RedisCommonPropertiesTenantSettings

RedisCommonPropertiesRedisConfiguration

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

SKU

名称 说明
容量 要部署的 Redis 缓存的大小。 有效值:对于 C (Basic/Standard) 系列 (0、1、2、3、4、5、6) ,对于 P (Premium) 系列 (1、2、3、4) 。 int (必需)
family 要使用的 SKU 系列。 有效值: (C、P) 。 (C = 基本/标准,P = 高级) 。 "C"
“P” (必需)
name 要部署的 Redis 缓存的类型。 有效值: (Basic、Standard、Premium) "Basic"
“Premium”
需要“标准” ()

RedisCommonPropertiesTenantSettings

名称 说明
{customized property} 字符串