Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. redis
  5. Cache

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

azure.redis.Cache

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

    Manages a Redis Cache.

    Note: Redis version 4 is being retired and no longer supports creating new instances. Version 4 will be removed in a future release. Redis Version 4 Retirement

    Example Usage

    This example provisions a Standard Redis Cache.

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

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

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
# NOTE: the Name used for Redis needs to be globally unique
example_cache = azure.redis.Cache("example",
    name="example-cache",
    location=example.location,
    resource_group_name=example.name,
    capacity=2,
    family="C",
    sku_name="Standard",
    non_ssl_port_enabled=False,
    minimum_tls_version="1.2",
    redis_configuration={})

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		// NOTE: the Name used for Redis needs to be globally unique
		_, err = redis.NewCache(ctx, "example", &redis.CacheArgs{
			Name:               pulumi.String("example-cache"),
			Location:           example.Location,
			ResourceGroupName:  example.Name,
			Capacity:           pulumi.Int(2),
			Family:             pulumi.String("C"),
			SkuName:            pulumi.String("Standard"),
			NonSslPortEnabled:  pulumi.Bool(false),
			MinimumTlsVersion:  pulumi.String("1.2"),
			RedisConfiguration: &redis.CacheRedisConfigurationArgs{},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    // NOTE: the Name used for Redis needs to be globally unique
    var exampleCache = new Azure.Redis.Cache("example", new()
    {
        Name = "example-cache",
        Location = example.Location,
        ResourceGroupName = example.Name,
        Capacity = 2,
        Family = "C",
        SkuName = "Standard",
        NonSslPortEnabled = false,
        MinimumTlsVersion = "1.2",
        RedisConfiguration = null,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.redis.Cache;
import com.pulumi.azure.redis.CacheArgs;
import com.pulumi.azure.redis.inputs.CacheRedisConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        // NOTE: the Name used for Redis needs to be globally unique
        var exampleCache = new Cache("exampleCache", CacheArgs.builder()
            .name("example-cache")
            .location(example.location())
            .resourceGroupName(example.name())
            .capacity(2)
            .family("C")
            .skuName("Standard")
            .nonSslPortEnabled(false)
            .minimumTlsVersion("1.2")
            .redisConfiguration()
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  # NOTE: the Name used for Redis needs to be globally unique
  exampleCache:
    type: azure:redis:Cache
    name: example
    properties:
      name: example-cache
      location: ${example.location}
      resourceGroupName: ${example.name}
      capacity: 2
      family: C
      skuName: Standard
      nonSslPortEnabled: false
      minimumTlsVersion: '1.2'
      redisConfiguration: {}

    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,
          resource_group_name: Optional[str] = None,
          capacity: Optional[int] = None,
          family: Optional[str] = None,
          sku_name: Optional[str] = None,
          minimum_tls_version: Optional[str] = None,
          replicas_per_master: Optional[int] = None,
          name: Optional[str] = None,
          non_ssl_port_enabled: Optional[bool] = 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,
          access_keys_authentication_enabled: Optional[bool] = None,
          replicas_per_primary: Optional[int] = None,
          location: Optional[str] = None,
          shard_count: Optional[int] = None,
          identity: Optional[CacheIdentityArgs] = 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()
{
    ResourceGroupName = "string",
    Capacity = 0,
    Family = "string",
    SkuName = "string",
    MinimumTlsVersion = "string",
    ReplicasPerMaster = 0,
    Name = "string",
    NonSslPortEnabled = false,
    PatchSchedules = new[]
    {
        new Azure.Redis.Inputs.CachePatchScheduleArgs
        {
            DayOfWeek = "string",
            MaintenanceWindow = "string",
            StartHourUtc = 0,
        },
    },
    PrivateStaticIpAddress = "string",
    PublicNetworkAccessEnabled = false,
    RedisConfiguration = new Azure.Redis.Inputs.CacheRedisConfigurationArgs
    {
        ActiveDirectoryAuthenticationEnabled = false,
        AofBackupEnabled = false,
        AofStorageConnectionString0 = "string",
        AofStorageConnectionString1 = "string",
        AuthenticationEnabled = false,
        DataPersistenceAuthenticationMethod = "string",
        Maxclients = 0,
        MaxfragmentationmemoryReserved = 0,
        MaxmemoryDelta = 0,
        MaxmemoryPolicy = "string",
        MaxmemoryReserved = 0,
        NotifyKeyspaceEvents = "string",
        RdbBackupEnabled = false,
        RdbBackupFrequency = 0,
        RdbBackupMaxSnapshotCount = 0,
        RdbStorageConnectionString = "string",
        StorageAccountSubscriptionId = "string",
    },
    RedisVersion = "string",
    AccessKeysAuthenticationEnabled = false,
    ReplicasPerPrimary = 0,
    Location = "string",
    ShardCount = 0,
    Identity = new Azure.Redis.Inputs.CacheIdentityArgs
    {
        Type = "string",
        IdentityIds = new[]
        {
            "string",
        },
        PrincipalId = "string",
        TenantId = "string",
    },
    SubnetId = "string",
    Tags = 
    {
        { "string", "string" },
    },
    TenantSettings = 
    {
        { "string", "string" },
    },
    Zones = new[]
    {
        "string",
    },
});

    example, err := redis.NewCache(ctx, "azureCacheResource", &redis.CacheArgs{
	ResourceGroupName: pulumi.String("string"),
	Capacity:          pulumi.Int(0),
	Family:            pulumi.String("string"),
	SkuName:           pulumi.String("string"),
	MinimumTlsVersion: pulumi.String("string"),
	ReplicasPerMaster: pulumi.Int(0),
	Name:              pulumi.String("string"),
	NonSslPortEnabled: pulumi.Bool(false),
	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{
		ActiveDirectoryAuthenticationEnabled: pulumi.Bool(false),
		AofBackupEnabled:                     pulumi.Bool(false),
		AofStorageConnectionString0:          pulumi.String("string"),
		AofStorageConnectionString1:          pulumi.String("string"),
		AuthenticationEnabled:                pulumi.Bool(false),
		DataPersistenceAuthenticationMethod:  pulumi.String("string"),
		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"),
		StorageAccountSubscriptionId:         pulumi.String("string"),
	},
	RedisVersion:                    pulumi.String("string"),
	AccessKeysAuthenticationEnabled: pulumi.Bool(false),
	ReplicasPerPrimary:              pulumi.Int(0),
	Location:                        pulumi.String("string"),
	ShardCount:                      pulumi.Int(0),
	Identity: &redis.CacheIdentityArgs{
		Type: pulumi.String("string"),
		IdentityIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		PrincipalId: pulumi.String("string"),
		TenantId:    pulumi.String("string"),
	},
	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 Cache("azureCacheResource", CacheArgs.builder()
    .resourceGroupName("string")
    .capacity(0)
    .family("string")
    .skuName("string")
    .minimumTlsVersion("string")
    .replicasPerMaster(0)
    .name("string")
    .nonSslPortEnabled(false)
    .patchSchedules(CachePatchScheduleArgs.builder()
        .dayOfWeek("string")
        .maintenanceWindow("string")
        .startHourUtc(0)
        .build())
    .privateStaticIpAddress("string")
    .publicNetworkAccessEnabled(false)
    .redisConfiguration(CacheRedisConfigurationArgs.builder()
        .activeDirectoryAuthenticationEnabled(false)
        .aofBackupEnabled(false)
        .aofStorageConnectionString0("string")
        .aofStorageConnectionString1("string")
        .authenticationEnabled(false)
        .dataPersistenceAuthenticationMethod("string")
        .maxclients(0)
        .maxfragmentationmemoryReserved(0)
        .maxmemoryDelta(0)
        .maxmemoryPolicy("string")
        .maxmemoryReserved(0)
        .notifyKeyspaceEvents("string")
        .rdbBackupEnabled(false)
        .rdbBackupFrequency(0)
        .rdbBackupMaxSnapshotCount(0)
        .rdbStorageConnectionString("string")
        .storageAccountSubscriptionId("string")
        .build())
    .redisVersion("string")
    .accessKeysAuthenticationEnabled(false)
    .replicasPerPrimary(0)
    .location("string")
    .shardCount(0)
    .identity(CacheIdentityArgs.builder()
        .type("string")
        .identityIds("string")
        .principalId("string")
        .tenantId("string")
        .build())
    .subnetId("string")
    .tags(Map.of("string", "string"))
    .tenantSettings(Map.of("string", "string"))
    .zones("string")
    .build());

    azure_cache_resource = azure.redis.Cache("azureCacheResource",
    resource_group_name="string",
    capacity=0,
    family="string",
    sku_name="string",
    minimum_tls_version="string",
    replicas_per_master=0,
    name="string",
    non_ssl_port_enabled=False,
    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={
        "active_directory_authentication_enabled": False,
        "aof_backup_enabled": False,
        "aof_storage_connection_string0": "string",
        "aof_storage_connection_string1": "string",
        "authentication_enabled": False,
        "data_persistence_authentication_method": "string",
        "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",
        "storage_account_subscription_id": "string",
    },
    redis_version="string",
    access_keys_authentication_enabled=False,
    replicas_per_primary=0,
    location="string",
    shard_count=0,
    identity={
        "type": "string",
        "identity_ids": ["string"],
        "principal_id": "string",
        "tenant_id": "string",
    },
    subnet_id="string",
    tags={
        "string": "string",
    },
    tenant_settings={
        "string": "string",
    },
    zones=["string"])

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

    type: azure:redis:Cache
properties:
    accessKeysAuthenticationEnabled: false
    capacity: 0
    family: string
    identity:
        identityIds:
            - string
        principalId: string
        tenantId: string
        type: string
    location: string
    minimumTlsVersion: string
    name: string
    nonSslPortEnabled: false
    patchSchedules:
        - dayOfWeek: string
          maintenanceWindow: string
          startHourUtc: 0
    privateStaticIpAddress: string
    publicNetworkAccessEnabled: false
    redisConfiguration:
        activeDirectoryAuthenticationEnabled: false
        aofBackupEnabled: false
        aofStorageConnectionString0: string
        aofStorageConnectionString1: string
        authenticationEnabled: false
        dataPersistenceAuthenticationMethod: string
        maxclients: 0
        maxfragmentationmemoryReserved: 0
        maxmemoryDelta: 0
        maxmemoryPolicy: string
        maxmemoryReserved: 0
        notifyKeyspaceEvents: string
        rdbBackupEnabled: false
        rdbBackupFrequency: 0
        rdbBackupMaxSnapshotCount: 0
        rdbStorageConnectionString: string
        storageAccountSubscriptionId: 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, 5.
    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. Changing this forces a new resource to be created.
    SkuName string

    The SKU of Redis to use. Possible values are Basic, Standard and Premium.

    Note Downgrading the SKU will force a new resource to be created.

    AccessKeysAuthenticationEnabled bool
    Whether access key authentication is enabled? Defaults to true. active_directory_authentication_enabled must be set to true to disable access key authentication.
    Identity CacheIdentity
    An identity block as defined below.
    Location string
    The location of the resource group. Changing this forces a new resource to be created.
    MinimumTlsVersion string
    The minimum TLS version. Possible values are 1.0, 1.1 and 1.2. Defaults to 1.0.
    Name string
    The name of the Redis instance. Changing this forces a new resource to be created.
    NonSslPortEnabled bool
    Enable the non-SSL port (6379) - disabled by default.
    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. This argument implies the use of subnet_id. 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 block as defined below - with some limitations by SKU - defaults/details are shown below.
    RedisVersion string
    Redis version. Only major version needed. Possible values are 4 and 6. Defaults to 6.
    ReplicasPerMaster int

    Amount of replicas to create per master for this Redis Cache.

    Note: Configuring the number of replicas per master is only available when using the Premium SKU and cannot be used in conjunction with shards.

    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>

    Specifies a list of Availability Zones in which this Redis Cache should be located. Changing this forces a new Redis Cache to be created.

    Please Note: Availability Zones are in Preview and only supported in several regions at this time - as such you must be opted into the Preview to use this functionality. You can opt into the Availability Zones Preview in the Azure Portal.

    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, 5.
    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. Changing this forces a new resource to be created.
    SkuName string

    The SKU of Redis to use. Possible values are Basic, Standard and Premium.

    Note Downgrading the SKU will force a new resource to be created.

    AccessKeysAuthenticationEnabled bool
    Whether access key authentication is enabled? Defaults to true. active_directory_authentication_enabled must be set to true to disable access key authentication.
    Identity CacheIdentityArgs
    An identity block as defined below.
    Location string
    The location of the resource group. Changing this forces a new resource to be created.
    MinimumTlsVersion string
    The minimum TLS version. Possible values are 1.0, 1.1 and 1.2. Defaults to 1.0.
    Name string
    The name of the Redis instance. Changing this forces a new resource to be created.
    NonSslPortEnabled bool
    Enable the non-SSL port (6379) - disabled by default.
    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. This argument implies the use of subnet_id. 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 block as defined below - with some limitations by SKU - defaults/details are shown below.
    RedisVersion string
    Redis version. Only major version needed. Possible values are 4 and 6. Defaults to 6.
    ReplicasPerMaster int

    Amount of replicas to create per master for this Redis Cache.

    Note: Configuring the number of replicas per master is only available when using the Premium SKU and cannot be used in conjunction with shards.

    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

    Specifies a list of Availability Zones in which this Redis Cache should be located. Changing this forces a new Redis Cache to be created.

    Please Note: Availability Zones are in Preview and only supported in several regions at this time - as such you must be opted into the Preview to use this functionality. You can opt into the Availability Zones Preview in the Azure Portal.

    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, 5.
    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. Changing this forces a new resource to be created.
    skuName String

    The SKU of Redis to use. Possible values are Basic, Standard and Premium.

    Note Downgrading the SKU will force a new resource to be created.

    accessKeysAuthenticationEnabled Boolean
    Whether access key authentication is enabled? Defaults to true. active_directory_authentication_enabled must be set to true to disable access key authentication.
    identity CacheIdentity
    An identity block as defined below.
    location String
    The location of the resource group. Changing this forces a new resource to be created.
    minimumTlsVersion String
    The minimum TLS version. Possible values are 1.0, 1.1 and 1.2. Defaults to 1.0.
    name String
    The name of the Redis instance. Changing this forces a new resource to be created.
    nonSslPortEnabled Boolean
    Enable the non-SSL port (6379) - disabled by default.
    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. This argument implies the use of subnet_id. 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 block as defined below - with some limitations by SKU - defaults/details are shown below.
    redisVersion String
    Redis version. Only major version needed. Possible values are 4 and 6. Defaults to 6.
    replicasPerMaster Integer

    Amount of replicas to create per master for this Redis Cache.

    Note: Configuring the number of replicas per master is only available when using the Premium SKU and cannot be used in conjunction with shards.

    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>

    Specifies a list of Availability Zones in which this Redis Cache should be located. Changing this forces a new Redis Cache to be created.

    Please Note: Availability Zones are in Preview and only supported in several regions at this time - as such you must be opted into the Preview to use this functionality. You can opt into the Availability Zones Preview in the Azure Portal.

    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, 5.
    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. Changing this forces a new resource to be created.
    skuName string

    The SKU of Redis to use. Possible values are Basic, Standard and Premium.

    Note Downgrading the SKU will force a new resource to be created.

    accessKeysAuthenticationEnabled boolean
    Whether access key authentication is enabled? Defaults to true. active_directory_authentication_enabled must be set to true to disable access key authentication.
    identity CacheIdentity
    An identity block as defined below.
    location string
    The location of the resource group. Changing this forces a new resource to be created.
    minimumTlsVersion string
    The minimum TLS version. Possible values are 1.0, 1.1 and 1.2. Defaults to 1.0.
    name string
    The name of the Redis instance. Changing this forces a new resource to be created.
    nonSslPortEnabled boolean
    Enable the non-SSL port (6379) - disabled by default.
    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. This argument implies the use of subnet_id. 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 block as defined below - with some limitations by SKU - defaults/details are shown below.
    redisVersion string
    Redis version. Only major version needed. Possible values are 4 and 6. Defaults to 6.
    replicasPerMaster number

    Amount of replicas to create per master for this Redis Cache.

    Note: Configuring the number of replicas per master is only available when using the Premium SKU and cannot be used in conjunction with shards.

    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[]

    Specifies a list of Availability Zones in which this Redis Cache should be located. Changing this forces a new Redis Cache to be created.

    Please Note: Availability Zones are in Preview and only supported in several regions at this time - as such you must be opted into the Preview to use this functionality. You can opt into the Availability Zones Preview in the Azure Portal.

    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, 5.
    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. Changing this forces a new resource to be created.
    sku_name str

    The SKU of Redis to use. Possible values are Basic, Standard and Premium.

    Note Downgrading the SKU will force a new resource to be created.

    access_keys_authentication_enabled bool
    Whether access key authentication is enabled? Defaults to true. active_directory_authentication_enabled must be set to true to disable access key authentication.
    identity CacheIdentityArgs
    An identity block as defined below.
    location str
    The location of the resource group. Changing this forces a new resource to be created.
    minimum_tls_version str
    The minimum TLS version. Possible values are 1.0, 1.1 and 1.2. Defaults to 1.0.
    name str
    The name of the Redis instance. Changing this forces a new resource to be created.
    non_ssl_port_enabled bool
    Enable the non-SSL port (6379) - disabled by default.
    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. This argument implies the use of subnet_id. 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 block as defined below - with some limitations by SKU - defaults/details are shown below.
    redis_version str
    Redis version. Only major version needed. Possible values are 4 and 6. Defaults to 6.
    replicas_per_master int

    Amount of replicas to create per master for this Redis Cache.

    Note: Configuring the number of replicas per master is only available when using the Premium SKU and cannot be used in conjunction with shards.

    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]

    Specifies a list of Availability Zones in which this Redis Cache should be located. Changing this forces a new Redis Cache to be created.

    Please Note: Availability Zones are in Preview and only supported in several regions at this time - as such you must be opted into the Preview to use this functionality. You can opt into the Availability Zones Preview in the Azure Portal.

    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, 5.
    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. Changing this forces a new resource to be created.
    skuName String

    The SKU of Redis to use. Possible values are Basic, Standard and Premium.

    Note Downgrading the SKU will force a new resource to be created.

    accessKeysAuthenticationEnabled Boolean
    Whether access key authentication is enabled? Defaults to true. active_directory_authentication_enabled must be set to true to disable access key authentication.
    identity Property Map
    An identity block as defined below.
    location String
    The location of the resource group. Changing this forces a new resource to be created.
    minimumTlsVersion String
    The minimum TLS version. Possible values are 1.0, 1.1 and 1.2. Defaults to 1.0.
    name String
    The name of the Redis instance. Changing this forces a new resource to be created.
    nonSslPortEnabled Boolean
    Enable the non-SSL port (6379) - disabled by default.
    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. This argument implies the use of subnet_id. 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 block as defined below - with some limitations by SKU - defaults/details are shown below.
    redisVersion String
    Redis version. Only major version needed. Possible values are 4 and 6. Defaults to 6.
    replicasPerMaster Number

    Amount of replicas to create per master for this Redis Cache.

    Note: Configuring the number of replicas per master is only available when using the Premium SKU and cannot be used in conjunction with shards.

    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>

    Specifies a list of Availability Zones in which this Redis Cache should be located. Changing this forces a new Redis Cache to be created.

    Please Note: Availability Zones are in Preview and only supported in several regions at this time - as such you must be opted into the Preview to use this functionality. You can opt into the Availability Zones Preview in the Azure Portal.

    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,
        access_keys_authentication_enabled: Optional[bool] = None,
        capacity: Optional[int] = None,
        family: Optional[str] = None,
        hostname: Optional[str] = None,
        identity: Optional[CacheIdentityArgs] = None,
        location: Optional[str] = None,
        minimum_tls_version: Optional[str] = None,
        name: Optional[str] = None,
        non_ssl_port_enabled: Optional[bool] = 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)
    Resource lookup is not supported in YAML
    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:
    AccessKeysAuthenticationEnabled bool
    Whether access key authentication is enabled? Defaults to true. active_directory_authentication_enabled must be set to true to disable access key authentication.
    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, 5.
    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
    Identity CacheIdentity
    An identity block as defined below.
    Location string
    The location of the resource group. Changing this forces a new resource to be created.
    MinimumTlsVersion string
    The minimum TLS version. Possible values are 1.0, 1.1 and 1.2. Defaults to 1.0.
    Name string
    The name of the Redis instance. Changing this forces a new resource to be created.
    NonSslPortEnabled bool
    Enable the non-SSL port (6379) - disabled by default.
    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. This argument implies the use of subnet_id. 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 block as defined below - with some limitations by SKU - defaults/details are shown below.
    RedisVersion string
    Redis version. Only major version needed. Possible values are 4 and 6. Defaults to 6.
    ReplicasPerMaster int

    Amount of replicas to create per master for this Redis Cache.

    Note: Configuring the number of replicas per master is only available when using the Premium SKU and cannot be used in conjunction with shards.

    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. Changing this forces a new resource to be created.
    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.

    Note Downgrading the SKU will force a new resource to be created.

    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>

    Specifies a list of Availability Zones in which this Redis Cache should be located. Changing this forces a new Redis Cache to be created.

    Please Note: Availability Zones are in Preview and only supported in several regions at this time - as such you must be opted into the Preview to use this functionality. You can opt into the Availability Zones Preview in the Azure Portal.

    AccessKeysAuthenticationEnabled bool
    Whether access key authentication is enabled? Defaults to true. active_directory_authentication_enabled must be set to true to disable access key authentication.
    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, 5.
    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
    Identity CacheIdentityArgs
    An identity block as defined below.
    Location string
    The location of the resource group. Changing this forces a new resource to be created.
    MinimumTlsVersion string
    The minimum TLS version. Possible values are 1.0, 1.1 and 1.2. Defaults to 1.0.
    Name string
    The name of the Redis instance. Changing this forces a new resource to be created.
    NonSslPortEnabled bool
    Enable the non-SSL port (6379) - disabled by default.
    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. This argument implies the use of subnet_id. 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 block as defined below - with some limitations by SKU - defaults/details are shown below.
    RedisVersion string
    Redis version. Only major version needed. Possible values are 4 and 6. Defaults to 6.
    ReplicasPerMaster int

    Amount of replicas to create per master for this Redis Cache.

    Note: Configuring the number of replicas per master is only available when using the Premium SKU and cannot be used in conjunction with shards.

    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. Changing this forces a new resource to be created.
    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.

    Note Downgrading the SKU will force a new resource to be created.

    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

    Specifies a list of Availability Zones in which this Redis Cache should be located. Changing this forces a new Redis Cache to be created.

    Please Note: Availability Zones are in Preview and only supported in several regions at this time - as such you must be opted into the Preview to use this functionality. You can opt into the Availability Zones Preview in the Azure Portal.

    accessKeysAuthenticationEnabled Boolean
    Whether access key authentication is enabled? Defaults to true. active_directory_authentication_enabled must be set to true to disable access key authentication.
    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, 5.
    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
    identity CacheIdentity
    An identity block as defined below.
    location String
    The location of the resource group. Changing this forces a new resource to be created.
    minimumTlsVersion String
    The minimum TLS version. Possible values are 1.0, 1.1 and 1.2. Defaults to 1.0.
    name String
    The name of the Redis instance. Changing this forces a new resource to be created.
    nonSslPortEnabled Boolean
    Enable the non-SSL port (6379) - disabled by default.
    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. This argument implies the use of subnet_id. 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 block as defined below - with some limitations by SKU - defaults/details are shown below.
    redisVersion String
    Redis version. Only major version needed. Possible values are 4 and 6. Defaults to 6.
    replicasPerMaster Integer

    Amount of replicas to create per master for this Redis Cache.

    Note: Configuring the number of replicas per master is only available when using the Premium SKU and cannot be used in conjunction with shards.

    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. Changing this forces a new resource to be created.
    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.

    Note Downgrading the SKU will force a new resource to be created.

    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>

    Specifies a list of Availability Zones in which this Redis Cache should be located. Changing this forces a new Redis Cache to be created.

    Please Note: Availability Zones are in Preview and only supported in several regions at this time - as such you must be opted into the Preview to use this functionality. You can opt into the Availability Zones Preview in the Azure Portal.

    accessKeysAuthenticationEnabled boolean
    Whether access key authentication is enabled? Defaults to true. active_directory_authentication_enabled must be set to true to disable access key authentication.
    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, 5.
    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
    identity CacheIdentity
    An identity block as defined below.
    location string
    The location of the resource group. Changing this forces a new resource to be created.
    minimumTlsVersion string
    The minimum TLS version. Possible values are 1.0, 1.1 and 1.2. Defaults to 1.0.
    name string
    The name of the Redis instance. Changing this forces a new resource to be created.
    nonSslPortEnabled boolean
    Enable the non-SSL port (6379) - disabled by default.
    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. This argument implies the use of subnet_id. 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 block as defined below - with some limitations by SKU - defaults/details are shown below.
    redisVersion string
    Redis version. Only major version needed. Possible values are 4 and 6. Defaults to 6.
    replicasPerMaster number

    Amount of replicas to create per master for this Redis Cache.

    Note: Configuring the number of replicas per master is only available when using the Premium SKU and cannot be used in conjunction with shards.

    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. Changing this forces a new resource to be created.
    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.

    Note Downgrading the SKU will force a new resource to be created.

    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[]

    Specifies a list of Availability Zones in which this Redis Cache should be located. Changing this forces a new Redis Cache to be created.

    Please Note: Availability Zones are in Preview and only supported in several regions at this time - as such you must be opted into the Preview to use this functionality. You can opt into the Availability Zones Preview in the Azure Portal.

    access_keys_authentication_enabled bool
    Whether access key authentication is enabled? Defaults to true. active_directory_authentication_enabled must be set to true to disable access key authentication.
    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, 5.
    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
    identity CacheIdentityArgs
    An identity block as defined below.
    location str
    The location of the resource group. Changing this forces a new resource to be created.
    minimum_tls_version str
    The minimum TLS version. Possible values are 1.0, 1.1 and 1.2. Defaults to 1.0.
    name str
    The name of the Redis instance. Changing this forces a new resource to be created.
    non_ssl_port_enabled bool
    Enable the non-SSL port (6379) - disabled by default.
    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. This argument implies the use of subnet_id. 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 block as defined below - with some limitations by SKU - defaults/details are shown below.
    redis_version str
    Redis version. Only major version needed. Possible values are 4 and 6. Defaults to 6.
    replicas_per_master int

    Amount of replicas to create per master for this Redis Cache.

    Note: Configuring the number of replicas per master is only available when using the Premium SKU and cannot be used in conjunction with shards.

    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. Changing this forces a new resource to be created.
    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.

    Note Downgrading the SKU will force a new resource to be created.

    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]

    Specifies a list of Availability Zones in which this Redis Cache should be located. Changing this forces a new Redis Cache to be created.

    Please Note: Availability Zones are in Preview and only supported in several regions at this time - as such you must be opted into the Preview to use this functionality. You can opt into the Availability Zones Preview in the Azure Portal.

    accessKeysAuthenticationEnabled Boolean
    Whether access key authentication is enabled? Defaults to true. active_directory_authentication_enabled must be set to true to disable access key authentication.
    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, 5.
    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
    identity Property Map
    An identity block as defined below.
    location String
    The location of the resource group. Changing this forces a new resource to be created.
    minimumTlsVersion String
    The minimum TLS version. Possible values are 1.0, 1.1 and 1.2. Defaults to 1.0.
    name String
    The name of the Redis instance. Changing this forces a new resource to be created.
    nonSslPortEnabled Boolean
    Enable the non-SSL port (6379) - disabled by default.
    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. This argument implies the use of subnet_id. 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 block as defined below - with some limitations by SKU - defaults/details are shown below.
    redisVersion String
    Redis version. Only major version needed. Possible values are 4 and 6. Defaults to 6.
    replicasPerMaster Number

    Amount of replicas to create per master for this Redis Cache.

    Note: Configuring the number of replicas per master is only available when using the Premium SKU and cannot be used in conjunction with shards.

    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. Changing this forces a new resource to be created.
    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.

    Note Downgrading the SKU will force a new resource to be created.

    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>

    Specifies a list of Availability Zones in which this Redis Cache should be located. Changing this forces a new Redis Cache to be created.

    Please Note: Availability Zones are in Preview and only supported in several regions at this time - as such you must be opted into the Preview to use this functionality. You can opt into the Availability Zones Preview in the Azure Portal.

    Supporting Types

    CacheIdentity, CacheIdentityArgs

    Type string
    Specifies the type of Managed Service Identity that should be configured on this Redis Cluster. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
    IdentityIds List<string>

    A list of User Assigned Managed Identity IDs to be assigned to this Redis Cluster.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    PrincipalId string
    TenantId string
    Type string
    Specifies the type of Managed Service Identity that should be configured on this Redis Cluster. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
    IdentityIds []string

    A list of User Assigned Managed Identity IDs to be assigned to this Redis Cluster.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    PrincipalId string
    TenantId string
    type String
    Specifies the type of Managed Service Identity that should be configured on this Redis Cluster. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
    identityIds List<String>

    A list of User Assigned Managed Identity IDs to be assigned to this Redis Cluster.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principalId String
    tenantId String
    type string
    Specifies the type of Managed Service Identity that should be configured on this Redis Cluster. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
    identityIds string[]

    A list of User Assigned Managed Identity IDs to be assigned to this Redis Cluster.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principalId string
    tenantId string
    type str
    Specifies the type of Managed Service Identity that should be configured on this Redis Cluster. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
    identity_ids Sequence[str]

    A list of User Assigned Managed Identity IDs to be assigned to this Redis Cluster.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principal_id str
    tenant_id str
    type String
    Specifies the type of Managed Service Identity that should be configured on this Redis Cluster. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
    identityIds List<String>

    A list of User Assigned Managed Identity IDs to be assigned to this Redis Cluster.

    NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

    principalId String
    tenantId String

    CachePatchSchedule, CachePatchScheduleArgs

    DayOfWeek string
    the Weekday name - possible values include Monday, Tuesday, Wednesday etc.
    MaintenanceWindow string
    The ISO 8601 timespan which specifies the amount of time the Redis Cache can be updated. Defaults to PT5H.
    StartHourUtc int

    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.

    DayOfWeek string
    the Weekday name - possible values include Monday, Tuesday, Wednesday etc.
    MaintenanceWindow string
    The ISO 8601 timespan which specifies the amount of time the Redis Cache can be updated. Defaults to PT5H.
    StartHourUtc int

    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.

    dayOfWeek String
    the Weekday name - possible values include Monday, Tuesday, Wednesday etc.
    maintenanceWindow String
    The ISO 8601 timespan which specifies the amount of time the Redis Cache can be updated. Defaults to PT5H.
    startHourUtc Integer

    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.

    dayOfWeek string
    the Weekday name - possible values include Monday, Tuesday, Wednesday etc.
    maintenanceWindow string
    The ISO 8601 timespan which specifies the amount of time the Redis Cache can be updated. Defaults to PT5H.
    startHourUtc number

    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.

    day_of_week str
    the Weekday name - possible values include Monday, Tuesday, Wednesday etc.
    maintenance_window str
    The ISO 8601 timespan which specifies the amount of time the Redis Cache can be updated. Defaults to PT5H.
    start_hour_utc int

    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.

    dayOfWeek String
    the Weekday name - possible values include Monday, Tuesday, Wednesday etc.
    maintenanceWindow String
    The ISO 8601 timespan which specifies the amount of time the Redis Cache can be updated. Defaults to PT5H.
    startHourUtc Number

    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.

    CacheRedisConfiguration, CacheRedisConfigurationArgs

    ActiveDirectoryAuthenticationEnabled bool
    Enable Microsoft Entra (AAD) authentication. Defaults to false.
    AofBackupEnabled bool

    Enable or disable AOF persistence for this Redis Cache. Defaults to false.

    NOTE: aof_backup_enabled can only be set when SKU is Premium.

    AofStorageConnectionString0 string
    First Storage Account connection string for AOF persistence.
    AofStorageConnectionString1 string

    Second Storage Account connection string for AOF persistence.

    Example usage:

    AuthenticationEnabled bool

    If set to false, the Redis instance will be accessible without authentication. Defaults to true.

    NOTE: authentication_enabled can only be set to false if a subnet_id is specified; and only works if there aren't existing instances within the subnet with authentication_enabled set to true.

    DataPersistenceAuthenticationMethod string
    Preferred auth method to communicate to storage account used for data persistence. Possible values are SAS and ManagedIdentity.
    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 to volatile-lru.
    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 SKUs. Defaults to false.

    NOTE: If rdb_backup_enabled set to true, rdb_storage_connection_string must also be set.

    RdbBackupFrequency int
    The Backup Frequency in Minutes. Only supported on Premium SKUs. 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 SKUs.
    RdbStorageConnectionString string

    The Connection String to the Storage Account. Only supported for Premium SKUs. 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}.

    NOTE: There's a bug in the Redis API where the original storage connection string isn't being returned, which is being tracked in this issue. In the interim you can use the ignoreChanges attribute to ignore changes to this field e.g.:

    StorageAccountSubscriptionId string
    The ID of the Subscription containing the Storage Account.

    resources:
  example:
    type: azure:redis:Cache
    properties:
      ignoreChanges:
        - ${redisConfiguration[0].rdbStorageConnectionString}
    ActiveDirectoryAuthenticationEnabled bool
    Enable Microsoft Entra (AAD) authentication. Defaults to false.
    AofBackupEnabled bool

    Enable or disable AOF persistence for this Redis Cache. Defaults to false.

    NOTE: aof_backup_enabled can only be set when SKU is Premium.

    AofStorageConnectionString0 string
    First Storage Account connection string for AOF persistence.
    AofStorageConnectionString1 string

    Second Storage Account connection string for AOF persistence.

    Example usage:

    AuthenticationEnabled bool

    If set to false, the Redis instance will be accessible without authentication. Defaults to true.

    NOTE: authentication_enabled can only be set to false if a subnet_id is specified; and only works if there aren't existing instances within the subnet with authentication_enabled set to true.

    DataPersistenceAuthenticationMethod string
    Preferred auth method to communicate to storage account used for data persistence. Possible values are SAS and ManagedIdentity.
    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 to volatile-lru.
    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 SKUs. Defaults to false.

    NOTE: If rdb_backup_enabled set to true, rdb_storage_connection_string must also be set.

    RdbBackupFrequency int
    The Backup Frequency in Minutes. Only supported on Premium SKUs. 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 SKUs.
    RdbStorageConnectionString string

    The Connection String to the Storage Account. Only supported for Premium SKUs. 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}.

    NOTE: There's a bug in the Redis API where the original storage connection string isn't being returned, which is being tracked in this issue. In the interim you can use the ignoreChanges attribute to ignore changes to this field e.g.:

    StorageAccountSubscriptionId string
    The ID of the Subscription containing the Storage Account.

    resources:
  example:
    type: azure:redis:Cache
    properties:
      ignoreChanges:
        - ${redisConfiguration[0].rdbStorageConnectionString}
    activeDirectoryAuthenticationEnabled Boolean
    Enable Microsoft Entra (AAD) authentication. Defaults to false.
    aofBackupEnabled Boolean

    Enable or disable AOF persistence for this Redis Cache. Defaults to false.

    NOTE: aof_backup_enabled can only be set when SKU is Premium.

    aofStorageConnectionString0 String
    First Storage Account connection string for AOF persistence.
    aofStorageConnectionString1 String

    Second Storage Account connection string for AOF persistence.

    Example usage:

    authenticationEnabled Boolean

    If set to false, the Redis instance will be accessible without authentication. Defaults to true.

    NOTE: authentication_enabled can only be set to false if a subnet_id is specified; and only works if there aren't existing instances within the subnet with authentication_enabled set to true.

    dataPersistenceAuthenticationMethod String
    Preferred auth method to communicate to storage account used for data persistence. Possible values are SAS and ManagedIdentity.
    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 to volatile-lru.
    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 SKUs. Defaults to false.

    NOTE: If rdb_backup_enabled set to true, rdb_storage_connection_string must also be set.

    rdbBackupFrequency Integer
    The Backup Frequency in Minutes. Only supported on Premium SKUs. 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 SKUs.
    rdbStorageConnectionString String

    The Connection String to the Storage Account. Only supported for Premium SKUs. 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}.

    NOTE: There's a bug in the Redis API where the original storage connection string isn't being returned, which is being tracked in this issue. In the interim you can use the ignoreChanges attribute to ignore changes to this field e.g.:

    storageAccountSubscriptionId String
    The ID of the Subscription containing the Storage Account.

    resources:
  example:
    type: azure:redis:Cache
    properties:
      ignoreChanges:
        - ${redisConfiguration[0].rdbStorageConnectionString}
    activeDirectoryAuthenticationEnabled boolean
    Enable Microsoft Entra (AAD) authentication. Defaults to false.
    aofBackupEnabled boolean

    Enable or disable AOF persistence for this Redis Cache. Defaults to false.

    NOTE: aof_backup_enabled can only be set when SKU is Premium.

    aofStorageConnectionString0 string
    First Storage Account connection string for AOF persistence.
    aofStorageConnectionString1 string

    Second Storage Account connection string for AOF persistence.

    Example usage:

    authenticationEnabled boolean

    If set to false, the Redis instance will be accessible without authentication. Defaults to true.

    NOTE: authentication_enabled can only be set to false if a subnet_id is specified; and only works if there aren't existing instances within the subnet with authentication_enabled set to true.

    dataPersistenceAuthenticationMethod string
    Preferred auth method to communicate to storage account used for data persistence. Possible values are SAS and ManagedIdentity.
    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 to volatile-lru.
    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 SKUs. Defaults to false.

    NOTE: If rdb_backup_enabled set to true, rdb_storage_connection_string must also be set.

    rdbBackupFrequency number
    The Backup Frequency in Minutes. Only supported on Premium SKUs. 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 SKUs.
    rdbStorageConnectionString string

    The Connection String to the Storage Account. Only supported for Premium SKUs. 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}.

    NOTE: There's a bug in the Redis API where the original storage connection string isn't being returned, which is being tracked in this issue. In the interim you can use the ignoreChanges attribute to ignore changes to this field e.g.:

    storageAccountSubscriptionId string
    The ID of the Subscription containing the Storage Account.

    resources:
  example:
    type: azure:redis:Cache
    properties:
      ignoreChanges:
        - ${redisConfiguration[0].rdbStorageConnectionString}
    active_directory_authentication_enabled bool
    Enable Microsoft Entra (AAD) authentication. Defaults to false.
    aof_backup_enabled bool

    Enable or disable AOF persistence for this Redis Cache. Defaults to false.

    NOTE: aof_backup_enabled can only be set when SKU is Premium.

    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.

    Example usage:

    authentication_enabled bool

    If set to false, the Redis instance will be accessible without authentication. Defaults to true.

    NOTE: authentication_enabled can only be set to false if a subnet_id is specified; and only works if there aren't existing instances within the subnet with authentication_enabled set to true.

    data_persistence_authentication_method str
    Preferred auth method to communicate to storage account used for data persistence. Possible values are SAS and ManagedIdentity.
    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 to volatile-lru.
    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 SKUs. Defaults to false.

    NOTE: If rdb_backup_enabled set to true, rdb_storage_connection_string must also be set.

    rdb_backup_frequency int
    The Backup Frequency in Minutes. Only supported on Premium SKUs. 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 SKUs.
    rdb_storage_connection_string str

    The Connection String to the Storage Account. Only supported for Premium SKUs. 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}.

    NOTE: There's a bug in the Redis API where the original storage connection string isn't being returned, which is being tracked in this issue. In the interim you can use the ignoreChanges attribute to ignore changes to this field e.g.:

    storage_account_subscription_id str
    The ID of the Subscription containing the Storage Account.

    resources:
  example:
    type: azure:redis:Cache
    properties:
      ignoreChanges:
        - ${redisConfiguration[0].rdbStorageConnectionString}
    activeDirectoryAuthenticationEnabled Boolean
    Enable Microsoft Entra (AAD) authentication. Defaults to false.
    aofBackupEnabled Boolean

    Enable or disable AOF persistence for this Redis Cache. Defaults to false.

    NOTE: aof_backup_enabled can only be set when SKU is Premium.

    aofStorageConnectionString0 String
    First Storage Account connection string for AOF persistence.
    aofStorageConnectionString1 String

    Second Storage Account connection string for AOF persistence.

    Example usage:

    authenticationEnabled Boolean

    If set to false, the Redis instance will be accessible without authentication. Defaults to true.

    NOTE: authentication_enabled can only be set to false if a subnet_id is specified; and only works if there aren't existing instances within the subnet with authentication_enabled set to true.

    dataPersistenceAuthenticationMethod String
    Preferred auth method to communicate to storage account used for data persistence. Possible values are SAS and ManagedIdentity.
    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 to volatile-lru.
    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 SKUs. Defaults to false.

    NOTE: If rdb_backup_enabled set to true, rdb_storage_connection_string must also be set.

    rdbBackupFrequency Number
    The Backup Frequency in Minutes. Only supported on Premium SKUs. 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 SKUs.
    rdbStorageConnectionString String

    The Connection String to the Storage Account. Only supported for Premium SKUs. 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}.

    NOTE: There's a bug in the Redis API where the original storage connection string isn't being returned, which is being tracked in this issue. In the interim you can use the ignoreChanges attribute to ignore changes to this field e.g.:

    storageAccountSubscriptionId String
    The ID of the Subscription containing the Storage Account.

    resources:
  example:
    type: azure:redis:Cache
    properties:
      ignoreChanges:
        - ${redisConfiguration[0].rdbStorageConnectionString}

    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.

    Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-azure