1. Packages
  2. Packages
  3. Azure Classic
  4. API Docs
  5. redis
  6. Cache

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

azure.redis.Cache

azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

    Manages a Redis Cache.

    Default Redis Configuration Values

    Redis ValueBasicStandardPremium
    enable_authenticationtruetruetrue
    maxmemory_reserved250200
    maxfragmentationmemory_reserved250200
    maxmemory_delta250200
    maxmemory_policyvolatile-lruvolatile-lruvolatile-lru

    NOTE: The maxmemory_reserved, maxmemory_delta and maxfragmentationmemory_reserved settings are only available for Standard and Premium caches. More details are available in the Relevant Links section below.

    A patch_schedule block supports the following:

    • day_of_week (Required) the Weekday name - possible values include Monday, Tuesday, Wednesday etc.

    • start_hour_utc - (Optional) the Start Hour for maintenance in UTC - possible values range from 0 - 23.

    Note: The Patch Window lasts for 5 hours from the start_hour_utc.

    • maintenance_window - (Optional) The ISO 8601 timespan which specifies the amount of time the Redis Cache can be updated. Defaults to PT5H.

    Example Usage

    This example provisions a Standard Redis Cache.

    using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        // NOTE: the Name used for Redis needs to be globally unique
        var exampleCache = new Azure.Redis.Cache("exampleCache", new Azure.Redis.CacheArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            Capacity = 2,
            Family = "C",
            SkuName = "Standard",
            EnableNonSslPort = false,
            MinimumTlsVersion = "1.2",
            RedisConfiguration = ,
        });
    }

}

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/redis"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = redis.NewCache(ctx, "exampleCache", &redis.CacheArgs{
			Location:           exampleResourceGroup.Location,
			ResourceGroupName:  exampleResourceGroup.Name,
			Capacity:           pulumi.Int(2),
			Family:             pulumi.String("C"),
			SkuName:            pulumi.String("Standard"),
			EnableNonSslPort:   pulumi.Bool(false),
			MinimumTlsVersion:  pulumi.String("1.2"),
			RedisConfiguration: nil,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Example coming soon!

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
// NOTE: the Name used for Redis needs to be globally unique
const exampleCache = new azure.redis.Cache("exampleCache", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    capacity: 2,
    family: "C",
    skuName: "Standard",
    enableNonSslPort: false,
    minimumTlsVersion: "1.2",
    redisConfiguration: {},
});

    import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
# NOTE: the Name used for Redis needs to be globally unique
example_cache = azure.redis.Cache("exampleCache",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    capacity=2,
    family="C",
    sku_name="Standard",
    enable_non_ssl_port=False,
    minimum_tls_version="1.2",
    redis_configuration=azure.redis.CacheRedisConfigurationArgs())

    Example coming soon!

    Create Cache Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Cache(name: string, args: CacheArgs, opts?: CustomResourceOptions);
    @overload
def Cache(resource_name: str,
          args: CacheArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Cache(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          capacity: Optional[int] = None,
          sku_name: Optional[str] = None,
          family: Optional[str] = None,
          resource_group_name: Optional[str] = None,
          name: Optional[str] = None,
          replicas_per_master: Optional[int] = None,
          patch_schedules: Optional[Sequence[CachePatchScheduleArgs]] = None,
          private_static_ip_address: Optional[str] = None,
          public_network_access_enabled: Optional[bool] = None,
          redis_configuration: Optional[CacheRedisConfigurationArgs] = None,
          redis_version: Optional[str] = None,
          minimum_tls_version: Optional[str] = None,
          replicas_per_primary: Optional[int] = None,
          location: Optional[str] = None,
          shard_count: Optional[int] = None,
          enable_non_ssl_port: Optional[bool] = None,
          subnet_id: Optional[str] = None,
          tags: Optional[Mapping[str, str]] = None,
          tenant_settings: Optional[Mapping[str, str]] = None,
          zones: Optional[Sequence[str]] = None)
    func NewCache(ctx *Context, name string, args CacheArgs, opts ...ResourceOption) (*Cache, error)
    public Cache(string name, CacheArgs args, CustomResourceOptions? opts = null)
    public Cache(String name, CacheArgs args)
public Cache(String name, CacheArgs args, CustomResourceOptions options)

    type: azure:redis:Cache
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args CacheArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CacheArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CacheArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CacheArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CacheArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var azureCacheResource = new Azure.Redis.Cache("azureCacheResource", new()
{
    Capacity = 0,
    SkuName = "string",
    Family = "string",
    ResourceGroupName = "string",
    Name = "string",
    ReplicasPerMaster = 0,
    PatchSchedules = new[]
    {
        new Azure.Redis.Inputs.CachePatchScheduleArgs
        {
            DayOfWeek = "string",
            MaintenanceWindow = "string",
            StartHourUtc = 0,
        },
    },
    PrivateStaticIpAddress = "string",
    PublicNetworkAccessEnabled = false,
    RedisConfiguration = new Azure.Redis.Inputs.CacheRedisConfigurationArgs
    {
        AofBackupEnabled = false,
        AofStorageConnectionString0 = "string",
        AofStorageConnectionString1 = "string",
        EnableAuthentication = false,
        Maxclients = 0,
        MaxfragmentationmemoryReserved = 0,
        MaxmemoryDelta = 0,
        MaxmemoryPolicy = "string",
        MaxmemoryReserved = 0,
        NotifyKeyspaceEvents = "string",
        RdbBackupEnabled = false,
        RdbBackupFrequency = 0,
        RdbBackupMaxSnapshotCount = 0,
        RdbStorageConnectionString = "string",
    },
    RedisVersion = "string",
    MinimumTlsVersion = "string",
    ReplicasPerPrimary = 0,
    Location = "string",
    ShardCount = 0,
    EnableNonSslPort = false,
    SubnetId = "string",
    Tags = 
    {
        { "string", "string" },
    },
    TenantSettings = 
    {
        { "string", "string" },
    },
    Zones = new[]
    {
        "string",
    },
});

    example, err := redis.NewCache(ctx, "azureCacheResource", &redis.CacheArgs{
	Capacity:          pulumi.Int(0),
	SkuName:           pulumi.String("string"),
	Family:            pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	Name:              pulumi.String("string"),
	ReplicasPerMaster: pulumi.Int(0),
	PatchSchedules: redis.CachePatchScheduleArray{
		&redis.CachePatchScheduleArgs{
			DayOfWeek:         pulumi.String("string"),
			MaintenanceWindow: pulumi.String("string"),
			StartHourUtc:      pulumi.Int(0),
		},
	},
	PrivateStaticIpAddress:     pulumi.String("string"),
	PublicNetworkAccessEnabled: pulumi.Bool(false),
	RedisConfiguration: &redis.CacheRedisConfigurationArgs{
		AofBackupEnabled:               pulumi.Bool(false),
		AofStorageConnectionString0:    pulumi.String("string"),
		AofStorageConnectionString1:    pulumi.String("string"),
		EnableAuthentication:           pulumi.Bool(false),
		Maxclients:                     pulumi.Int(0),
		MaxfragmentationmemoryReserved: pulumi.Int(0),
		MaxmemoryDelta:                 pulumi.Int(0),
		MaxmemoryPolicy:                pulumi.String("string"),
		MaxmemoryReserved:              pulumi.Int(0),
		NotifyKeyspaceEvents:           pulumi.String("string"),
		RdbBackupEnabled:               pulumi.Bool(false),
		RdbBackupFrequency:             pulumi.Int(0),
		RdbBackupMaxSnapshotCount:      pulumi.Int(0),
		RdbStorageConnectionString:     pulumi.String("string"),
	},
	RedisVersion:       pulumi.String("string"),
	MinimumTlsVersion:  pulumi.String("string"),
	ReplicasPerPrimary: pulumi.Int(0),
	Location:           pulumi.String("string"),
	ShardCount:         pulumi.Int(0),
	EnableNonSslPort:   pulumi.Bool(false),
	SubnetId:           pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TenantSettings: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Zones: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var azureCacheResource = new com.pulumi.azure.redis.Cache("azureCacheResource", com.pulumi.azure.redis.CacheArgs.builder()
    .capacity(0)
    .skuName("string")
    .family("string")
    .resourceGroupName("string")
    .name("string")
    .replicasPerMaster(0)
    .patchSchedules(CachePatchScheduleArgs.builder()
        .dayOfWeek("string")
        .maintenanceWindow("string")
        .startHourUtc(0)
        .build())
    .privateStaticIpAddress("string")
    .publicNetworkAccessEnabled(false)
    .redisConfiguration(CacheRedisConfigurationArgs.builder()
        .aofBackupEnabled(false)
        .aofStorageConnectionString0("string")
        .aofStorageConnectionString1("string")
        .enableAuthentication(false)
        .maxclients(0)
        .maxfragmentationmemoryReserved(0)
        .maxmemoryDelta(0)
        .maxmemoryPolicy("string")
        .maxmemoryReserved(0)
        .notifyKeyspaceEvents("string")
        .rdbBackupEnabled(false)
        .rdbBackupFrequency(0)
        .rdbBackupMaxSnapshotCount(0)
        .rdbStorageConnectionString("string")
        .build())
    .redisVersion("string")
    .minimumTlsVersion("string")
    .replicasPerPrimary(0)
    .location("string")
    .shardCount(0)
    .enableNonSslPort(false)
    .subnetId("string")
    .tags(Map.of("string", "string"))
    .tenantSettings(Map.of("string", "string"))
    .zones("string")
    .build());

    azure_cache_resource = azure.redis.Cache("azureCacheResource",
    capacity=0,
    sku_name="string",
    family="string",
    resource_group_name="string",
    name="string",
    replicas_per_master=0,
    patch_schedules=[{
        "day_of_week": "string",
        "maintenance_window": "string",
        "start_hour_utc": 0,
    }],
    private_static_ip_address="string",
    public_network_access_enabled=False,
    redis_configuration={
        "aof_backup_enabled": False,
        "aof_storage_connection_string0": "string",
        "aof_storage_connection_string1": "string",
        "enable_authentication": False,
        "maxclients": 0,
        "maxfragmentationmemory_reserved": 0,
        "maxmemory_delta": 0,
        "maxmemory_policy": "string",
        "maxmemory_reserved": 0,
        "notify_keyspace_events": "string",
        "rdb_backup_enabled": False,
        "rdb_backup_frequency": 0,
        "rdb_backup_max_snapshot_count": 0,
        "rdb_storage_connection_string": "string",
    },
    redis_version="string",
    minimum_tls_version="string",
    replicas_per_primary=0,
    location="string",
    shard_count=0,
    enable_non_ssl_port=False,
    subnet_id="string",
    tags={
        "string": "string",
    },
    tenant_settings={
        "string": "string",
    },
    zones=["string"])

    const azureCacheResource = new azure.redis.Cache("azureCacheResource", {
    capacity: 0,
    skuName: "string",
    family: "string",
    resourceGroupName: "string",
    name: "string",
    replicasPerMaster: 0,
    patchSchedules: [{
        dayOfWeek: "string",
        maintenanceWindow: "string",
        startHourUtc: 0,
    }],
    privateStaticIpAddress: "string",
    publicNetworkAccessEnabled: false,
    redisConfiguration: {
        aofBackupEnabled: false,
        aofStorageConnectionString0: "string",
        aofStorageConnectionString1: "string",
        enableAuthentication: false,
        maxclients: 0,
        maxfragmentationmemoryReserved: 0,
        maxmemoryDelta: 0,
        maxmemoryPolicy: "string",
        maxmemoryReserved: 0,
        notifyKeyspaceEvents: "string",
        rdbBackupEnabled: false,
        rdbBackupFrequency: 0,
        rdbBackupMaxSnapshotCount: 0,
        rdbStorageConnectionString: "string",
    },
    redisVersion: "string",
    minimumTlsVersion: "string",
    replicasPerPrimary: 0,
    location: "string",
    shardCount: 0,
    enableNonSslPort: false,
    subnetId: "string",
    tags: {
        string: "string",
    },
    tenantSettings: {
        string: "string",
    },
    zones: ["string"],
});

    type: azure:redis:Cache
properties:
    capacity: 0
    enableNonSslPort: false
    family: string
    location: string
    minimumTlsVersion: string
    name: string
    patchSchedules:
        - dayOfWeek: string
          maintenanceWindow: string
          startHourUtc: 0
    privateStaticIpAddress: string
    publicNetworkAccessEnabled: false
    redisConfiguration:
        aofBackupEnabled: false
        aofStorageConnectionString0: string
        aofStorageConnectionString1: string
        enableAuthentication: false
        maxclients: 0
        maxfragmentationmemoryReserved: 0
        maxmemoryDelta: 0
        maxmemoryPolicy: string
        maxmemoryReserved: 0
        notifyKeyspaceEvents: string
        rdbBackupEnabled: false
        rdbBackupFrequency: 0
        rdbBackupMaxSnapshotCount: 0
        rdbStorageConnectionString: string
    redisVersion: string
    replicasPerMaster: 0
    replicasPerPrimary: 0
    resourceGroupName: string
    shardCount: 0
    skuName: string
    subnetId: string
    tags:
        string: string
    tenantSettings:
        string: string
    zones:
        - string

    Cache Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Cache resource accepts the following input properties:

    Capacity int
    The size of the Redis cache to deploy. Valid values for a SKU family of C (Basic/Standard) are 0, 1, 2, 3, 4, 5, 6, and for P (Premium) family are 1, 2, 3, 4.
    Family string
    The SKU family/pricing group to use. Valid values are C (for Basic/Standard SKU family) and P (for Premium)
    ResourceGroupName string
    The name of the resource group in which to create the Redis instance.
    SkuName string
    The SKU of Redis to use. Possible values are Basic, Standard and Premium.
    EnableNonSslPort bool
    Enable the non-SSL port (6379) - disabled by default.
    Location string
    The location of the resource group.
    MinimumTlsVersion string
    The minimum TLS version. Defaults to 1.0.
    Name string
    The name of the Redis instance. Changing this forces a new resource to be created.
    PatchSchedules List<CachePatchSchedule>
    A list of patch_schedule blocks as defined below.
    PrivateStaticIpAddress string
    The Static IP Address to assign to the Redis Cache when hosted inside the Virtual Network. Changing this forces a new resource to be created.
    PublicNetworkAccessEnabled bool
    Whether or not public network access is allowed for this Redis Cache. true means this resource could be accessed by both public and private endpoint. false means only private endpoint access is allowed. Defaults to true.
    RedisConfiguration CacheRedisConfiguration
    A redis_configuration as defined below - with some limitations by SKU - defaults/details are shown below.
    RedisVersion string
    Redis version. Only major version needed. Valid values: 4, 6.
    ReplicasPerMaster int
    Amount of replicas to create per master for this Redis Cache.
    ReplicasPerPrimary int
    Amount of replicas to create per primary for this Redis Cache. If both replicas_per_primary and replicas_per_master are set, they need to be equal.
    ShardCount int
    Only available when using the Premium SKU The number of Shards to create on the Redis Cluster.
    SubnetId string
    Only available when using the Premium SKU The ID of the Subnet within which the Redis Cache should be deployed. This Subnet must only contain Azure Cache for Redis instances without any other type of resources. Changing this forces a new resource to be created.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    TenantSettings Dictionary<string, string>
    A mapping of tenant settings to assign to the resource.
    Zones List<string>
    A list of a one or more Availability Zones, where the Redis Cache should be allocated.
    Capacity int
    The size of the Redis cache to deploy. Valid values for a SKU family of C (Basic/Standard) are 0, 1, 2, 3, 4, 5, 6, and for P (Premium) family are 1, 2, 3, 4.
    Family string
    The SKU family/pricing group to use. Valid values are C (for Basic/Standard SKU family) and P (for Premium)
    ResourceGroupName string
    The name of the resource group in which to create the Redis instance.
    SkuName string
    The SKU of Redis to use. Possible values are Basic, Standard and Premium.
    EnableNonSslPort bool
    Enable the non-SSL port (6379) - disabled by default.
    Location string
    The location of the resource group.
    MinimumTlsVersion string
    The minimum TLS version. Defaults to 1.0.
    Name string
    The name of the Redis instance. Changing this forces a new resource to be created.
    PatchSchedules []CachePatchScheduleArgs
    A list of patch_schedule blocks as defined below.
    PrivateStaticIpAddress string
    The Static IP Address to assign to the Redis Cache when hosted inside the Virtual Network. Changing this forces a new resource to be created.
    PublicNetworkAccessEnabled bool
    Whether or not public network access is allowed for this Redis Cache. true means this resource could be accessed by both public and private endpoint. false means only private endpoint access is allowed. Defaults to true.
    RedisConfiguration CacheRedisConfigurationArgs
    A redis_configuration as defined below - with some limitations by SKU - defaults/details are shown below.
    RedisVersion string
    Redis version. Only major version needed. Valid values: 4, 6.
    ReplicasPerMaster int
    Amount of replicas to create per master for this Redis Cache.
    ReplicasPerPrimary int
    Amount of replicas to create per primary for this Redis Cache. If both replicas_per_primary and replicas_per_master are set, they need to be equal.
    ShardCount int
    Only available when using the Premium SKU The number of Shards to create on the Redis Cluster.
    SubnetId string
    Only available when using the Premium SKU The ID of the Subnet within which the Redis Cache should be deployed. This Subnet must only contain Azure Cache for Redis instances without any other type of resources. Changing this forces a new resource to be created.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    TenantSettings map[string]string
    A mapping of tenant settings to assign to the resource.
    Zones []string
    A list of a one or more Availability Zones, where the Redis Cache should be allocated.
    capacity Integer
    The size of the Redis cache to deploy. Valid values for a SKU family of C (Basic/Standard) are 0, 1, 2, 3, 4, 5, 6, and for P (Premium) family are 1, 2, 3, 4.
    family String
    The SKU family/pricing group to use. Valid values are C (for Basic/Standard SKU family) and P (for Premium)
    resourceGroupName String
    The name of the resource group in which to create the Redis instance.
    skuName String
    The SKU of Redis to use. Possible values are Basic, Standard and Premium.
    enableNonSslPort Boolean
    Enable the non-SSL port (6379) - disabled by default.
    location String
    The location of the resource group.
    minimumTlsVersion String
    The minimum TLS version. Defaults to 1.0.
    name String
    The name of the Redis instance. Changing this forces a new resource to be created.
    patchSchedules List<CachePatchSchedule>
    A list of patch_schedule blocks as defined below.
    privateStaticIpAddress String
    The Static IP Address to assign to the Redis Cache when hosted inside the Virtual Network. Changing this forces a new resource to be created.
    publicNetworkAccessEnabled Boolean
    Whether or not public network access is allowed for this Redis Cache. true means this resource could be accessed by both public and private endpoint. false means only private endpoint access is allowed. Defaults to true.
    redisConfiguration CacheRedisConfiguration
    A redis_configuration as defined below - with some limitations by SKU - defaults/details are shown below.
    redisVersion String
    Redis version. Only major version needed. Valid values: 4, 6.
    replicasPerMaster Integer
    Amount of replicas to create per master for this Redis Cache.
    replicasPerPrimary Integer
    Amount of replicas to create per primary for this Redis Cache. If both replicas_per_primary and replicas_per_master are set, they need to be equal.
    shardCount Integer
    Only available when using the Premium SKU The number of Shards to create on the Redis Cluster.
    subnetId String
    Only available when using the Premium SKU The ID of the Subnet within which the Redis Cache should be deployed. This Subnet must only contain Azure Cache for Redis instances without any other type of resources. Changing this forces a new resource to be created.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    tenantSettings Map<String,String>
    A mapping of tenant settings to assign to the resource.
    zones List<String>
    A list of a one or more Availability Zones, where the Redis Cache should be allocated.
    capacity number
    The size of the Redis cache to deploy. Valid values for a SKU family of C (Basic/Standard) are 0, 1, 2, 3, 4, 5, 6, and for P (Premium) family are 1, 2, 3, 4.
    family string
    The SKU family/pricing group to use. Valid values are C (for Basic/Standard SKU family) and P (for Premium)
    resourceGroupName string
    The name of the resource group in which to create the Redis instance.
    skuName string
    The SKU of Redis to use. Possible values are Basic, Standard and Premium.
    enableNonSslPort boolean
    Enable the non-SSL port (6379) - disabled by default.
    location string
    The location of the resource group.
    minimumTlsVersion string
    The minimum TLS version. Defaults to 1.0.
    name string
    The name of the Redis instance. Changing this forces a new resource to be created.
    patchSchedules CachePatchSchedule[]
    A list of patch_schedule blocks as defined below.
    privateStaticIpAddress string
    The Static IP Address to assign to the Redis Cache when hosted inside the Virtual Network. Changing this forces a new resource to be created.
    publicNetworkAccessEnabled boolean
    Whether or not public network access is allowed for this Redis Cache. true means this resource could be accessed by both public and private endpoint. false means only private endpoint access is allowed. Defaults to true.
    redisConfiguration CacheRedisConfiguration
    A redis_configuration as defined below - with some limitations by SKU - defaults/details are shown below.
    redisVersion string
    Redis version. Only major version needed. Valid values: 4, 6.
    replicasPerMaster number
    Amount of replicas to create per master for this Redis Cache.
    replicasPerPrimary number
    Amount of replicas to create per primary for this Redis Cache. If both replicas_per_primary and replicas_per_master are set, they need to be equal.
    shardCount number
    Only available when using the Premium SKU The number of Shards to create on the Redis Cluster.
    subnetId string
    Only available when using the Premium SKU The ID of the Subnet within which the Redis Cache should be deployed. This Subnet must only contain Azure Cache for Redis instances without any other type of resources. Changing this forces a new resource to be created.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    tenantSettings {[key: string]: string}
    A mapping of tenant settings to assign to the resource.
    zones string[]
    A list of a one or more Availability Zones, where the Redis Cache should be allocated.
    capacity int
    The size of the Redis cache to deploy. Valid values for a SKU family of C (Basic/Standard) are 0, 1, 2, 3, 4, 5, 6, and for P (Premium) family are 1, 2, 3, 4.
    family str
    The SKU family/pricing group to use. Valid values are C (for Basic/Standard SKU family) and P (for Premium)
    resource_group_name str
    The name of the resource group in which to create the Redis instance.
    sku_name str
    The SKU of Redis to use. Possible values are Basic, Standard and Premium.
    enable_non_ssl_port bool
    Enable the non-SSL port (6379) - disabled by default.
    location str
    The location of the resource group.
    minimum_tls_version str
    The minimum TLS version. Defaults to 1.0.
    name str
    The name of the Redis instance. Changing this forces a new resource to be created.
    patch_schedules Sequence[CachePatchScheduleArgs]
    A list of patch_schedule blocks as defined below.
    private_static_ip_address str
    The Static IP Address to assign to the Redis Cache when hosted inside the Virtual Network. Changing this forces a new resource to be created.
    public_network_access_enabled bool
    Whether or not public network access is allowed for this Redis Cache. true means this resource could be accessed by both public and private endpoint. false means only private endpoint access is allowed. Defaults to true.
    redis_configuration CacheRedisConfigurationArgs
    A redis_configuration as defined below - with some limitations by SKU - defaults/details are shown below.
    redis_version str
    Redis version. Only major version needed. Valid values: 4, 6.
    replicas_per_master int
    Amount of replicas to create per master for this Redis Cache.
    replicas_per_primary int
    Amount of replicas to create per primary for this Redis Cache. If both replicas_per_primary and replicas_per_master are set, they need to be equal.
    shard_count int
    Only available when using the Premium SKU The number of Shards to create on the Redis Cluster.
    subnet_id str
    Only available when using the Premium SKU The ID of the Subnet within which the Redis Cache should be deployed. This Subnet must only contain Azure Cache for Redis instances without any other type of resources. Changing this forces a new resource to be created.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    tenant_settings Mapping[str, str]
    A mapping of tenant settings to assign to the resource.
    zones Sequence[str]
    A list of a one or more Availability Zones, where the Redis Cache should be allocated.
    capacity Number
    The size of the Redis cache to deploy. Valid values for a SKU family of C (Basic/Standard) are 0, 1, 2, 3, 4, 5, 6, and for P (Premium) family are 1, 2, 3, 4.
    family String
    The SKU family/pricing group to use. Valid values are C (for Basic/Standard SKU family) and P (for Premium)
    resourceGroupName String
    The name of the resource group in which to create the Redis instance.
    skuName String
    The SKU of Redis to use. Possible values are Basic, Standard and Premium.
    enableNonSslPort Boolean
    Enable the non-SSL port (6379) - disabled by default.
    location String
    The location of the resource group.
    minimumTlsVersion String
    The minimum TLS version. Defaults to 1.0.
    name String
    The name of the Redis instance. Changing this forces a new resource to be created.
    patchSchedules List<Property Map>
    A list of patch_schedule blocks as defined below.
    privateStaticIpAddress String
    The Static IP Address to assign to the Redis Cache when hosted inside the Virtual Network. Changing this forces a new resource to be created.
    publicNetworkAccessEnabled Boolean
    Whether or not public network access is allowed for this Redis Cache. true means this resource could be accessed by both public and private endpoint. false means only private endpoint access is allowed. Defaults to true.
    redisConfiguration Property Map
    A redis_configuration as defined below - with some limitations by SKU - defaults/details are shown below.
    redisVersion String
    Redis version. Only major version needed. Valid values: 4, 6.
    replicasPerMaster Number
    Amount of replicas to create per master for this Redis Cache.
    replicasPerPrimary Number
    Amount of replicas to create per primary for this Redis Cache. If both replicas_per_primary and replicas_per_master are set, they need to be equal.
    shardCount Number
    Only available when using the Premium SKU The number of Shards to create on the Redis Cluster.
    subnetId String
    Only available when using the Premium SKU The ID of the Subnet within which the Redis Cache should be deployed. This Subnet must only contain Azure Cache for Redis instances without any other type of resources. Changing this forces a new resource to be created.
    tags Map<String>
    A mapping of tags to assign to the resource.
    tenantSettings Map<String>
    A mapping of tenant settings to assign to the resource.
    zones List<String>
    A list of a one or more Availability Zones, where the Redis Cache should be allocated.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Cache resource produces the following output properties:

    Hostname string
    The Hostname of the Redis Instance
    Id string
    The provider-assigned unique ID for this managed resource.
    Port int
    The non-SSL Port of the Redis Instance
    PrimaryAccessKey string
    The Primary Access Key for the Redis Instance
    PrimaryConnectionString string
    The primary connection string of the Redis Instance.
    SecondaryAccessKey string
    The Secondary Access Key for the Redis Instance
    SecondaryConnectionString string
    The secondary connection string of the Redis Instance.
    SslPort int
    The SSL Port of the Redis Instance
    Hostname string
    The Hostname of the Redis Instance
    Id string
    The provider-assigned unique ID for this managed resource.
    Port int
    The non-SSL Port of the Redis Instance
    PrimaryAccessKey string
    The Primary Access Key for the Redis Instance
    PrimaryConnectionString string
    The primary connection string of the Redis Instance.
    SecondaryAccessKey string
    The Secondary Access Key for the Redis Instance
    SecondaryConnectionString string
    The secondary connection string of the Redis Instance.
    SslPort int
    The SSL Port of the Redis Instance
    hostname String
    The Hostname of the Redis Instance
    id String
    The provider-assigned unique ID for this managed resource.
    port Integer
    The non-SSL Port of the Redis Instance
    primaryAccessKey String
    The Primary Access Key for the Redis Instance
    primaryConnectionString String
    The primary connection string of the Redis Instance.
    secondaryAccessKey String
    The Secondary Access Key for the Redis Instance
    secondaryConnectionString String
    The secondary connection string of the Redis Instance.
    sslPort Integer
    The SSL Port of the Redis Instance
    hostname string
    The Hostname of the Redis Instance
    id string
    The provider-assigned unique ID for this managed resource.
    port number
    The non-SSL Port of the Redis Instance
    primaryAccessKey string
    The Primary Access Key for the Redis Instance
    primaryConnectionString string
    The primary connection string of the Redis Instance.
    secondaryAccessKey string
    The Secondary Access Key for the Redis Instance
    secondaryConnectionString string
    The secondary connection string of the Redis Instance.
    sslPort number
    The SSL Port of the Redis Instance
    hostname str
    The Hostname of the Redis Instance
    id str
    The provider-assigned unique ID for this managed resource.
    port int
    The non-SSL Port of the Redis Instance
    primary_access_key str
    The Primary Access Key for the Redis Instance
    primary_connection_string str
    The primary connection string of the Redis Instance.
    secondary_access_key str
    The Secondary Access Key for the Redis Instance
    secondary_connection_string str
    The secondary connection string of the Redis Instance.
    ssl_port int
    The SSL Port of the Redis Instance
    hostname String
    The Hostname of the Redis Instance
    id String
    The provider-assigned unique ID for this managed resource.
    port Number
    The non-SSL Port of the Redis Instance
    primaryAccessKey String
    The Primary Access Key for the Redis Instance
    primaryConnectionString String
    The primary connection string of the Redis Instance.
    secondaryAccessKey String
    The Secondary Access Key for the Redis Instance
    secondaryConnectionString String
    The secondary connection string of the Redis Instance.
    sslPort Number
    The SSL Port of the Redis Instance

    Look up Existing Cache Resource

    Get an existing Cache resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: CacheState, opts?: CustomResourceOptions): Cache
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        capacity: Optional[int] = None,
        enable_non_ssl_port: Optional[bool] = None,
        family: Optional[str] = None,
        hostname: Optional[str] = None,
        location: Optional[str] = None,
        minimum_tls_version: Optional[str] = None,
        name: Optional[str] = None,
        patch_schedules: Optional[Sequence[CachePatchScheduleArgs]] = None,
        port: Optional[int] = None,
        primary_access_key: Optional[str] = None,
        primary_connection_string: Optional[str] = None,
        private_static_ip_address: Optional[str] = None,
        public_network_access_enabled: Optional[bool] = None,
        redis_configuration: Optional[CacheRedisConfigurationArgs] = None,
        redis_version: Optional[str] = None,
        replicas_per_master: Optional[int] = None,
        replicas_per_primary: Optional[int] = None,
        resource_group_name: Optional[str] = None,
        secondary_access_key: Optional[str] = None,
        secondary_connection_string: Optional[str] = None,
        shard_count: Optional[int] = None,
        sku_name: Optional[str] = None,
        ssl_port: Optional[int] = None,
        subnet_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tenant_settings: Optional[Mapping[str, str]] = None,
        zones: Optional[Sequence[str]] = None) -> Cache
    func GetCache(ctx *Context, name string, id IDInput, state *CacheState, opts ...ResourceOption) (*Cache, error)
    public static Cache Get(string name, Input<string> id, CacheState? state, CustomResourceOptions? opts = null)
    public static Cache get(String name, Output<String> id, CacheState state, CustomResourceOptions options)
    resources:  _:    type: azure:redis:Cache    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Capacity int
    The size of the Redis cache to deploy. Valid values for a SKU family of C (Basic/Standard) are 0, 1, 2, 3, 4, 5, 6, and for P (Premium) family are 1, 2, 3, 4.
    EnableNonSslPort bool
    Enable the non-SSL port (6379) - disabled by default.
    Family string
    The SKU family/pricing group to use. Valid values are C (for Basic/Standard SKU family) and P (for Premium)
    Hostname string
    The Hostname of the Redis Instance
    Location string
    The location of the resource group.
    MinimumTlsVersion string
    The minimum TLS version. Defaults to 1.0.
    Name string
    The name of the Redis instance. Changing this forces a new resource to be created.
    PatchSchedules List<CachePatchSchedule>
    A list of patch_schedule blocks as defined below.
    Port int
    The non-SSL Port of the Redis Instance
    PrimaryAccessKey string
    The Primary Access Key for the Redis Instance
    PrimaryConnectionString string
    The primary connection string of the Redis Instance.
    PrivateStaticIpAddress string
    The Static IP Address to assign to the Redis Cache when hosted inside the Virtual Network. Changing this forces a new resource to be created.
    PublicNetworkAccessEnabled bool
    Whether or not public network access is allowed for this Redis Cache. true means this resource could be accessed by both public and private endpoint. false means only private endpoint access is allowed. Defaults to true.
    RedisConfiguration CacheRedisConfiguration
    A redis_configuration as defined below - with some limitations by SKU - defaults/details are shown below.
    RedisVersion string
    Redis version. Only major version needed. Valid values: 4, 6.
    ReplicasPerMaster int
    Amount of replicas to create per master for this Redis Cache.
    ReplicasPerPrimary int
    Amount of replicas to create per primary for this Redis Cache. If both replicas_per_primary and replicas_per_master are set, they need to be equal.
    ResourceGroupName string
    The name of the resource group in which to create the Redis instance.
    SecondaryAccessKey string
    The Secondary Access Key for the Redis Instance
    SecondaryConnectionString string
    The secondary connection string of the Redis Instance.
    ShardCount int
    Only available when using the Premium SKU The number of Shards to create on the Redis Cluster.
    SkuName string
    The SKU of Redis to use. Possible values are Basic, Standard and Premium.
    SslPort int
    The SSL Port of the Redis Instance
    SubnetId string
    Only available when using the Premium SKU The ID of the Subnet within which the Redis Cache should be deployed. This Subnet must only contain Azure Cache for Redis instances without any other type of resources. Changing this forces a new resource to be created.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    TenantSettings Dictionary<string, string>
    A mapping of tenant settings to assign to the resource.
    Zones List<string>
    A list of a one or more Availability Zones, where the Redis Cache should be allocated.
    Capacity int
    The size of the Redis cache to deploy. Valid values for a SKU family of C (Basic/Standard) are 0, 1, 2, 3, 4, 5, 6, and for P (Premium) family are 1, 2, 3, 4.
    EnableNonSslPort bool
    Enable the non-SSL port (6379) - disabled by default.
    Family string
    The SKU family/pricing group to use. Valid values are C (for Basic/Standard SKU family) and P (for Premium)
    Hostname string
    The Hostname of the Redis Instance
    Location string
    The location of the resource group.
    MinimumTlsVersion string
    The minimum TLS version. Defaults to 1.0.
    Name string
    The name of the Redis instance. Changing this forces a new resource to be created.
    PatchSchedules []CachePatchScheduleArgs
    A list of patch_schedule blocks as defined below.
    Port int
    The non-SSL Port of the Redis Instance
    PrimaryAccessKey string
    The Primary Access Key for the Redis Instance
    PrimaryConnectionString string
    The primary connection string of the Redis Instance.
    PrivateStaticIpAddress string
    The Static IP Address to assign to the Redis Cache when hosted inside the Virtual Network. Changing this forces a new resource to be created.
    PublicNetworkAccessEnabled bool
    Whether or not public network access is allowed for this Redis Cache. true means this resource could be accessed by both public and private endpoint. false means only private endpoint access is allowed. Defaults to true.
    RedisConfiguration CacheRedisConfigurationArgs
    A redis_configuration as defined below - with some limitations by SKU - defaults/details are shown below.
    RedisVersion string
    Redis version. Only major version needed. Valid values: 4, 6.
    ReplicasPerMaster int
    Amount of replicas to create per master for this Redis Cache.
    ReplicasPerPrimary int
    Amount of replicas to create per primary for this Redis Cache. If both replicas_per_primary and replicas_per_master are set, they need to be equal.
    ResourceGroupName string
    The name of the resource group in which to create the Redis instance.
    SecondaryAccessKey string
    The Secondary Access Key for the Redis Instance
    SecondaryConnectionString string
    The secondary connection string of the Redis Instance.
    ShardCount int
    Only available when using the Premium SKU The number of Shards to create on the Redis Cluster.
    SkuName string
    The SKU of Redis to use. Possible values are Basic, Standard and Premium.
    SslPort int
    The SSL Port of the Redis Instance
    SubnetId string
    Only available when using the Premium SKU The ID of the Subnet within which the Redis Cache should be deployed. This Subnet must only contain Azure Cache for Redis instances without any other type of resources. Changing this forces a new resource to be created.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    TenantSettings map[string]string
    A mapping of tenant settings to assign to the resource.
    Zones []string
    A list of a one or more Availability Zones, where the Redis Cache should be allocated.
    capacity Integer
    The size of the Redis cache to deploy. Valid values for a SKU family of C (Basic/Standard) are 0, 1, 2, 3, 4, 5, 6, and for P (Premium) family are 1, 2, 3, 4.
    enableNonSslPort Boolean
    Enable the non-SSL port (6379) - disabled by default.
    family String
    The SKU family/pricing group to use. Valid values are C (for Basic/Standard SKU family) and P (for Premium)
    hostname String
    The Hostname of the Redis Instance
    location String
    The location of the resource group.
    minimumTlsVersion String
    The minimum TLS version. Defaults to 1.0.
    name String
    The name of the Redis instance. Changing this forces a new resource to be created.
    patchSchedules List<CachePatchSchedule>
    A list of patch_schedule blocks as defined below.
    port Integer
    The non-SSL Port of the Redis Instance
    primaryAccessKey String
    The Primary Access Key for the Redis Instance
    primaryConnectionString String
    The primary connection string of the Redis Instance.
    privateStaticIpAddress String
    The Static IP Address to assign to the Redis Cache when hosted inside the Virtual Network. Changing this forces a new resource to be created.
    publicNetworkAccessEnabled Boolean
    Whether or not public network access is allowed for this Redis Cache. true means this resource could be accessed by both public and private endpoint. false means only private endpoint access is allowed. Defaults to true.
    redisConfiguration CacheRedisConfiguration
    A redis_configuration as defined below - with some limitations by SKU - defaults/details are shown below.
    redisVersion String
    Redis version. Only major version needed. Valid values: 4, 6.
    replicasPerMaster Integer
    Amount of replicas to create per master for this Redis Cache.
    replicasPerPrimary Integer
    Amount of replicas to create per primary for this Redis Cache. If both replicas_per_primary and replicas_per_master are set, they need to be equal.
    resourceGroupName String
    The name of the resource group in which to create the Redis instance.
    secondaryAccessKey String
    The Secondary Access Key for the Redis Instance
    secondaryConnectionString String
    The secondary connection string of the Redis Instance.
    shardCount Integer
    Only available when using the Premium SKU The number of Shards to create on the Redis Cluster.
    skuName String
    The SKU of Redis to use. Possible values are Basic, Standard and Premium.
    sslPort Integer
    The SSL Port of the Redis Instance
    subnetId String
    Only available when using the Premium SKU The ID of the Subnet within which the Redis Cache should be deployed. This Subnet must only contain Azure Cache for Redis instances without any other type of resources. Changing this forces a new resource to be created.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    tenantSettings Map<String,String>
    A mapping of tenant settings to assign to the resource.
    zones List<String>
    A list of a one or more Availability Zones, where the Redis Cache should be allocated.
    capacity number
    The size of the Redis cache to deploy. Valid values for a SKU family of C (Basic/Standard) are 0, 1, 2, 3, 4, 5, 6, and for P (Premium) family are 1, 2, 3, 4.
    enableNonSslPort boolean
    Enable the non-SSL port (6379) - disabled by default.
    family string
    The SKU family/pricing group to use. Valid values are C (for Basic/Standard SKU family) and P (for Premium)
    hostname string
    The Hostname of the Redis Instance
    location string
    The location of the resource group.
    minimumTlsVersion string
    The minimum TLS version. Defaults to 1.0.
    name string
    The name of the Redis instance. Changing this forces a new resource to be created.
    patchSchedules CachePatchSchedule[]
    A list of patch_schedule blocks as defined below.
    port number
    The non-SSL Port of the Redis Instance
    primaryAccessKey string
    The Primary Access Key for the Redis Instance
    primaryConnectionString string
    The primary connection string of the Redis Instance.
    privateStaticIpAddress string
    The Static IP Address to assign to the Redis Cache when hosted inside the Virtual Network. Changing this forces a new resource to be created.
    publicNetworkAccessEnabled boolean
    Whether or not public network access is allowed for this Redis Cache. true means this resource could be accessed by both public and private endpoint. false means only private endpoint access is allowed. Defaults to true.
    redisConfiguration CacheRedisConfiguration
    A redis_configuration as defined below - with some limitations by SKU - defaults/details are shown below.
    redisVersion string
    Redis version. Only major version needed. Valid values: 4, 6.
    replicasPerMaster number
    Amount of replicas to create per master for this Redis Cache.
    replicasPerPrimary number
    Amount of replicas to create per primary for this Redis Cache. If both replicas_per_primary and replicas_per_master are set, they need to be equal.
    resourceGroupName string
    The name of the resource group in which to create the Redis instance.
    secondaryAccessKey string
    The Secondary Access Key for the Redis Instance
    secondaryConnectionString string
    The secondary connection string of the Redis Instance.
    shardCount number
    Only available when using the Premium SKU The number of Shards to create on the Redis Cluster.
    skuName string
    The SKU of Redis to use. Possible values are Basic, Standard and Premium.
    sslPort number
    The SSL Port of the Redis Instance
    subnetId string
    Only available when using the Premium SKU The ID of the Subnet within which the Redis Cache should be deployed. This Subnet must only contain Azure Cache for Redis instances without any other type of resources. Changing this forces a new resource to be created.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    tenantSettings {[key: string]: string}
    A mapping of tenant settings to assign to the resource.
    zones string[]
    A list of a one or more Availability Zones, where the Redis Cache should be allocated.
    capacity int
    The size of the Redis cache to deploy. Valid values for a SKU family of C (Basic/Standard) are 0, 1, 2, 3, 4, 5, 6, and for P (Premium) family are 1, 2, 3, 4.
    enable_non_ssl_port bool
    Enable the non-SSL port (6379) - disabled by default.
    family str
    The SKU family/pricing group to use. Valid values are C (for Basic/Standard SKU family) and P (for Premium)
    hostname str
    The Hostname of the Redis Instance
    location str
    The location of the resource group.
    minimum_tls_version str
    The minimum TLS version. Defaults to 1.0.
    name str
    The name of the Redis instance. Changing this forces a new resource to be created.
    patch_schedules Sequence[CachePatchScheduleArgs]
    A list of patch_schedule blocks as defined below.
    port int
    The non-SSL Port of the Redis Instance
    primary_access_key str
    The Primary Access Key for the Redis Instance
    primary_connection_string str
    The primary connection string of the Redis Instance.
    private_static_ip_address str
    The Static IP Address to assign to the Redis Cache when hosted inside the Virtual Network. Changing this forces a new resource to be created.
    public_network_access_enabled bool
    Whether or not public network access is allowed for this Redis Cache. true means this resource could be accessed by both public and private endpoint. false means only private endpoint access is allowed. Defaults to true.
    redis_configuration CacheRedisConfigurationArgs
    A redis_configuration as defined below - with some limitations by SKU - defaults/details are shown below.
    redis_version str
    Redis version. Only major version needed. Valid values: 4, 6.
    replicas_per_master int
    Amount of replicas to create per master for this Redis Cache.
    replicas_per_primary int
    Amount of replicas to create per primary for this Redis Cache. If both replicas_per_primary and replicas_per_master are set, they need to be equal.
    resource_group_name str
    The name of the resource group in which to create the Redis instance.
    secondary_access_key str
    The Secondary Access Key for the Redis Instance
    secondary_connection_string str
    The secondary connection string of the Redis Instance.
    shard_count int
    Only available when using the Premium SKU The number of Shards to create on the Redis Cluster.
    sku_name str
    The SKU of Redis to use. Possible values are Basic, Standard and Premium.
    ssl_port int
    The SSL Port of the Redis Instance
    subnet_id str
    Only available when using the Premium SKU The ID of the Subnet within which the Redis Cache should be deployed. This Subnet must only contain Azure Cache for Redis instances without any other type of resources. Changing this forces a new resource to be created.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    tenant_settings Mapping[str, str]
    A mapping of tenant settings to assign to the resource.
    zones Sequence[str]
    A list of a one or more Availability Zones, where the Redis Cache should be allocated.
    capacity Number
    The size of the Redis cache to deploy. Valid values for a SKU family of C (Basic/Standard) are 0, 1, 2, 3, 4, 5, 6, and for P (Premium) family are 1, 2, 3, 4.
    enableNonSslPort Boolean
    Enable the non-SSL port (6379) - disabled by default.
    family String
    The SKU family/pricing group to use. Valid values are C (for Basic/Standard SKU family) and P (for Premium)
    hostname String
    The Hostname of the Redis Instance
    location String
    The location of the resource group.
    minimumTlsVersion String
    The minimum TLS version. Defaults to 1.0.
    name String
    The name of the Redis instance. Changing this forces a new resource to be created.
    patchSchedules List<Property Map>
    A list of patch_schedule blocks as defined below.
    port Number
    The non-SSL Port of the Redis Instance
    primaryAccessKey String
    The Primary Access Key for the Redis Instance
    primaryConnectionString String
    The primary connection string of the Redis Instance.
    privateStaticIpAddress String
    The Static IP Address to assign to the Redis Cache when hosted inside the Virtual Network. Changing this forces a new resource to be created.
    publicNetworkAccessEnabled Boolean
    Whether or not public network access is allowed for this Redis Cache. true means this resource could be accessed by both public and private endpoint. false means only private endpoint access is allowed. Defaults to true.
    redisConfiguration Property Map
    A redis_configuration as defined below - with some limitations by SKU - defaults/details are shown below.
    redisVersion String
    Redis version. Only major version needed. Valid values: 4, 6.
    replicasPerMaster Number
    Amount of replicas to create per master for this Redis Cache.
    replicasPerPrimary Number
    Amount of replicas to create per primary for this Redis Cache. If both replicas_per_primary and replicas_per_master are set, they need to be equal.
    resourceGroupName String
    The name of the resource group in which to create the Redis instance.
    secondaryAccessKey String
    The Secondary Access Key for the Redis Instance
    secondaryConnectionString String
    The secondary connection string of the Redis Instance.
    shardCount Number
    Only available when using the Premium SKU The number of Shards to create on the Redis Cluster.
    skuName String
    The SKU of Redis to use. Possible values are Basic, Standard and Premium.
    sslPort Number
    The SSL Port of the Redis Instance
    subnetId String
    Only available when using the Premium SKU The ID of the Subnet within which the Redis Cache should be deployed. This Subnet must only contain Azure Cache for Redis instances without any other type of resources. Changing this forces a new resource to be created.
    tags Map<String>
    A mapping of tags to assign to the resource.
    tenantSettings Map<String>
    A mapping of tenant settings to assign to the resource.
    zones List<String>
    A list of a one or more Availability Zones, where the Redis Cache should be allocated.

    Supporting Types

    CachePatchSchedule, CachePatchScheduleArgs

    CacheRedisConfiguration, CacheRedisConfigurationArgs

    AofBackupEnabled bool
    Enable or disable AOF persistence for this Redis Cache.
    AofStorageConnectionString0 string
    First Storage Account connection string for AOF persistence.
    AofStorageConnectionString1 string
    Second Storage Account connection string for AOF persistence.
    EnableAuthentication bool
    If set to false, the Redis instance will be accessible without authentication. Defaults to true.
    Maxclients int
    Returns the max number of connected clients at the same time.
    MaxfragmentationmemoryReserved int
    Value in megabytes reserved to accommodate for memory fragmentation. Defaults are shown below.
    MaxmemoryDelta int
    The max-memory delta for this Redis instance. Defaults are shown below.
    MaxmemoryPolicy string
    How Redis will select what to remove when maxmemory is reached. Defaults are shown below.
    MaxmemoryReserved int
    Value in megabytes reserved for non-cache usage e.g. failover. Defaults are shown below.
    NotifyKeyspaceEvents string
    Keyspace notifications allows clients to subscribe to Pub/Sub channels in order to receive events affecting the Redis data set in some way. Reference
    RdbBackupEnabled bool
    Is Backup Enabled? Only supported on Premium SKU's.
    RdbBackupFrequency int
    The Backup Frequency in Minutes. Only supported on Premium SKU's. Possible values are: 15, 30, 60, 360, 720 and 1440.
    RdbBackupMaxSnapshotCount int
    The maximum number of snapshots to create as a backup. Only supported for Premium SKU's.
    RdbStorageConnectionString string
    The Connection String to the Storage Account. Only supported for Premium SKU's. In the format: DefaultEndpointsProtocol=https;BlobEndpoint=${azurerm_storage_account.example.primary_blob_endpoint};AccountName=${azurerm_storage_account.example.name};AccountKey=${azurerm_storage_account.example.primary_access_key}.
    AofBackupEnabled bool
    Enable or disable AOF persistence for this Redis Cache.
    AofStorageConnectionString0 string
    First Storage Account connection string for AOF persistence.
    AofStorageConnectionString1 string
    Second Storage Account connection string for AOF persistence.
    EnableAuthentication bool
    If set to false, the Redis instance will be accessible without authentication. Defaults to true.
    Maxclients int
    Returns the max number of connected clients at the same time.
    MaxfragmentationmemoryReserved int
    Value in megabytes reserved to accommodate for memory fragmentation. Defaults are shown below.
    MaxmemoryDelta int
    The max-memory delta for this Redis instance. Defaults are shown below.
    MaxmemoryPolicy string
    How Redis will select what to remove when maxmemory is reached. Defaults are shown below.
    MaxmemoryReserved int
    Value in megabytes reserved for non-cache usage e.g. failover. Defaults are shown below.
    NotifyKeyspaceEvents string
    Keyspace notifications allows clients to subscribe to Pub/Sub channels in order to receive events affecting the Redis data set in some way. Reference
    RdbBackupEnabled bool
    Is Backup Enabled? Only supported on Premium SKU's.
    RdbBackupFrequency int
    The Backup Frequency in Minutes. Only supported on Premium SKU's. Possible values are: 15, 30, 60, 360, 720 and 1440.
    RdbBackupMaxSnapshotCount int
    The maximum number of snapshots to create as a backup. Only supported for Premium SKU's.
    RdbStorageConnectionString string
    The Connection String to the Storage Account. Only supported for Premium SKU's. In the format: DefaultEndpointsProtocol=https;BlobEndpoint=${azurerm_storage_account.example.primary_blob_endpoint};AccountName=${azurerm_storage_account.example.name};AccountKey=${azurerm_storage_account.example.primary_access_key}.
    aofBackupEnabled Boolean
    Enable or disable AOF persistence for this Redis Cache.
    aofStorageConnectionString0 String
    First Storage Account connection string for AOF persistence.
    aofStorageConnectionString1 String
    Second Storage Account connection string for AOF persistence.
    enableAuthentication Boolean
    If set to false, the Redis instance will be accessible without authentication. Defaults to true.
    maxclients Integer
    Returns the max number of connected clients at the same time.
    maxfragmentationmemoryReserved Integer
    Value in megabytes reserved to accommodate for memory fragmentation. Defaults are shown below.
    maxmemoryDelta Integer
    The max-memory delta for this Redis instance. Defaults are shown below.
    maxmemoryPolicy String
    How Redis will select what to remove when maxmemory is reached. Defaults are shown below.
    maxmemoryReserved Integer
    Value in megabytes reserved for non-cache usage e.g. failover. Defaults are shown below.
    notifyKeyspaceEvents String
    Keyspace notifications allows clients to subscribe to Pub/Sub channels in order to receive events affecting the Redis data set in some way. Reference
    rdbBackupEnabled Boolean
    Is Backup Enabled? Only supported on Premium SKU's.
    rdbBackupFrequency Integer
    The Backup Frequency in Minutes. Only supported on Premium SKU's. Possible values are: 15, 30, 60, 360, 720 and 1440.
    rdbBackupMaxSnapshotCount Integer
    The maximum number of snapshots to create as a backup. Only supported for Premium SKU's.
    rdbStorageConnectionString String
    The Connection String to the Storage Account. Only supported for Premium SKU's. In the format: DefaultEndpointsProtocol=https;BlobEndpoint=${azurerm_storage_account.example.primary_blob_endpoint};AccountName=${azurerm_storage_account.example.name};AccountKey=${azurerm_storage_account.example.primary_access_key}.
    aofBackupEnabled boolean
    Enable or disable AOF persistence for this Redis Cache.
    aofStorageConnectionString0 string
    First Storage Account connection string for AOF persistence.
    aofStorageConnectionString1 string
    Second Storage Account connection string for AOF persistence.
    enableAuthentication boolean
    If set to false, the Redis instance will be accessible without authentication. Defaults to true.
    maxclients number
    Returns the max number of connected clients at the same time.
    maxfragmentationmemoryReserved number
    Value in megabytes reserved to accommodate for memory fragmentation. Defaults are shown below.
    maxmemoryDelta number
    The max-memory delta for this Redis instance. Defaults are shown below.
    maxmemoryPolicy string
    How Redis will select what to remove when maxmemory is reached. Defaults are shown below.
    maxmemoryReserved number
    Value in megabytes reserved for non-cache usage e.g. failover. Defaults are shown below.
    notifyKeyspaceEvents string
    Keyspace notifications allows clients to subscribe to Pub/Sub channels in order to receive events affecting the Redis data set in some way. Reference
    rdbBackupEnabled boolean
    Is Backup Enabled? Only supported on Premium SKU's.
    rdbBackupFrequency number
    The Backup Frequency in Minutes. Only supported on Premium SKU's. Possible values are: 15, 30, 60, 360, 720 and 1440.
    rdbBackupMaxSnapshotCount number
    The maximum number of snapshots to create as a backup. Only supported for Premium SKU's.
    rdbStorageConnectionString string
    The Connection String to the Storage Account. Only supported for Premium SKU's. In the format: DefaultEndpointsProtocol=https;BlobEndpoint=${azurerm_storage_account.example.primary_blob_endpoint};AccountName=${azurerm_storage_account.example.name};AccountKey=${azurerm_storage_account.example.primary_access_key}.
    aof_backup_enabled bool
    Enable or disable AOF persistence for this Redis Cache.
    aof_storage_connection_string0 str
    First Storage Account connection string for AOF persistence.
    aof_storage_connection_string1 str
    Second Storage Account connection string for AOF persistence.
    enable_authentication bool
    If set to false, the Redis instance will be accessible without authentication. Defaults to true.
    maxclients int
    Returns the max number of connected clients at the same time.
    maxfragmentationmemory_reserved int
    Value in megabytes reserved to accommodate for memory fragmentation. Defaults are shown below.
    maxmemory_delta int
    The max-memory delta for this Redis instance. Defaults are shown below.
    maxmemory_policy str
    How Redis will select what to remove when maxmemory is reached. Defaults are shown below.
    maxmemory_reserved int
    Value in megabytes reserved for non-cache usage e.g. failover. Defaults are shown below.
    notify_keyspace_events str
    Keyspace notifications allows clients to subscribe to Pub/Sub channels in order to receive events affecting the Redis data set in some way. Reference
    rdb_backup_enabled bool
    Is Backup Enabled? Only supported on Premium SKU's.
    rdb_backup_frequency int
    The Backup Frequency in Minutes. Only supported on Premium SKU's. Possible values are: 15, 30, 60, 360, 720 and 1440.
    rdb_backup_max_snapshot_count int
    The maximum number of snapshots to create as a backup. Only supported for Premium SKU's.
    rdb_storage_connection_string str
    The Connection String to the Storage Account. Only supported for Premium SKU's. In the format: DefaultEndpointsProtocol=https;BlobEndpoint=${azurerm_storage_account.example.primary_blob_endpoint};AccountName=${azurerm_storage_account.example.name};AccountKey=${azurerm_storage_account.example.primary_access_key}.
    aofBackupEnabled Boolean
    Enable or disable AOF persistence for this Redis Cache.
    aofStorageConnectionString0 String
    First Storage Account connection string for AOF persistence.
    aofStorageConnectionString1 String
    Second Storage Account connection string for AOF persistence.
    enableAuthentication Boolean
    If set to false, the Redis instance will be accessible without authentication. Defaults to true.
    maxclients Number
    Returns the max number of connected clients at the same time.
    maxfragmentationmemoryReserved Number
    Value in megabytes reserved to accommodate for memory fragmentation. Defaults are shown below.
    maxmemoryDelta Number
    The max-memory delta for this Redis instance. Defaults are shown below.
    maxmemoryPolicy String
    How Redis will select what to remove when maxmemory is reached. Defaults are shown below.
    maxmemoryReserved Number
    Value in megabytes reserved for non-cache usage e.g. failover. Defaults are shown below.
    notifyKeyspaceEvents String
    Keyspace notifications allows clients to subscribe to Pub/Sub channels in order to receive events affecting the Redis data set in some way. Reference
    rdbBackupEnabled Boolean
    Is Backup Enabled? Only supported on Premium SKU's.
    rdbBackupFrequency Number
    The Backup Frequency in Minutes. Only supported on Premium SKU's. Possible values are: 15, 30, 60, 360, 720 and 1440.
    rdbBackupMaxSnapshotCount Number
    The maximum number of snapshots to create as a backup. Only supported for Premium SKU's.
    rdbStorageConnectionString String
    The Connection String to the Storage Account. Only supported for Premium SKU's. In the format: DefaultEndpointsProtocol=https;BlobEndpoint=${azurerm_storage_account.example.primary_blob_endpoint};AccountName=${azurerm_storage_account.example.name};AccountKey=${azurerm_storage_account.example.primary_access_key}.

    Import

    Redis Cache’s can be imported using the resource id, e.g.

     $ pulumi import azure:redis/cache:Cache cache1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Cache/Redis/cache1

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-azure
      Try Pulumi Cloud free. Your team will thank you.