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

We recommend using Azure Native.

Azure Classic v5.43.0 published on Saturday, May 6, 2023 by Pulumi
pulumi/pulumi-azure

azure.redis.Cache

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.43.0 published on Saturday, May 6, 2023 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.

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

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

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

});

    package main

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

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

    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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var exampleCache = new Cache("exampleCache", CacheArgs.builder()        
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .capacity(2)
            .family("C")
            .skuName("Standard")
            .enableNonSslPort(false)
            .minimumTlsVersion("1.2")
            .redisConfiguration()
            .build());

    }
}

    import pulumi
import pulumi_azure as azure

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

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

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

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

    Create Cache Resource

    new Cache(name: string, args: CacheArgs, opts?: CustomResourceOptions);
    @overload
def Cache(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          capacity: Optional[int] = None,
          enable_non_ssl_port: Optional[bool] = None,
          family: Optional[str] = None,
          identity: Optional[CacheIdentityArgs] = None,
          location: Optional[str] = None,
          minimum_tls_version: Optional[str] = None,
          name: Optional[str] = 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,
          replicas_per_master: Optional[int] = None,
          replicas_per_primary: Optional[int] = None,
          resource_group_name: Optional[str] = None,
          shard_count: Optional[int] = None,
          sku_name: Optional[str] = None,
          subnet_id: Optional[str] = None,
          tags: Optional[Mapping[str, str]] = None,
          tenant_settings: Optional[Mapping[str, str]] = None,
          zones: Optional[Sequence[str]] = None)
@overload
def Cache(resource_name: str,
          args: CacheArgs,
          opts: Optional[ResourceOptions] = 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.
    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.

    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

    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.

    EnableNonSslPort bool

    Enable the non-SSL port (6379) - disabled by default.

    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.

    PatchSchedules List<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 as defined below - with some limitations by SKU - defaults/details are shown below.

    RedisVersion string

    Redis version. Only major version needed. Valid values: 4, 6.

    ReplicasPerMaster int

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

    ReplicasPerPrimary int

    Amount of replicas to create per primary for this Redis Cache. If both replicas_per_primary and replicas_per_master are set, they need to be equal.

    ShardCount int

    Only available when using the Premium SKU The number of Shards to create on the Redis Cluster.

    SubnetId string

    Only available when using the Premium SKU The ID of the Subnet within which the Redis Cache should be deployed. This Subnet must only contain Azure Cache for Redis instances without any other type of resources. Changing this forces a new resource to be created.

    Tags Dictionary<string, string>

    A mapping of tags to assign to the resource.

    TenantSettings Dictionary<string, string>

    A mapping of tenant settings to assign to the resource.

    Zones List<string>

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

    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.

    EnableNonSslPort bool

    Enable the non-SSL port (6379) - disabled by default.

    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.

    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 as defined below - with some limitations by SKU - defaults/details are shown below.

    RedisVersion string

    Redis version. Only major version needed. Valid values: 4, 6.

    ReplicasPerMaster int

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

    ReplicasPerPrimary int

    Amount of replicas to create per primary for this Redis Cache. If both replicas_per_primary and replicas_per_master are set, they need to be equal.

    ShardCount int

    Only available when using the Premium SKU The number of Shards to create on the Redis Cluster.

    SubnetId string

    Only available when using the Premium SKU The ID of the Subnet within which the Redis Cache should be deployed. This Subnet must only contain Azure Cache for Redis instances without any other type of resources. Changing this forces a new resource to be created.

    Tags map[string]string

    A mapping of tags to assign to the resource.

    TenantSettings map[string]string

    A mapping of tenant settings to assign to the resource.

    Zones []string

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

    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.

    enableNonSslPort Boolean

    Enable the non-SSL port (6379) - disabled by default.

    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.

    patchSchedules List<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 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 CacheRedisConfigurationArgs

    A redis_configuration as defined below - with some limitations by SKU - defaults/details are shown below.

    redisVersion String

    Redis version. Only major version needed. Valid values: 4, 6.

    replicasPerMaster Integer

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

    replicasPerPrimary Integer

    Amount of replicas to create per primary for this Redis Cache. If both replicas_per_primary and replicas_per_master are set, they need to be equal.

    shardCount Integer

    Only available when using the Premium SKU The number of Shards to create on the Redis Cluster.

    subnetId String

    Only available when using the Premium SKU The ID of the Subnet within which the Redis Cache should be deployed. This Subnet must only contain Azure Cache for Redis instances without any other type of resources. Changing this forces a new resource to be created.

    tags Map<String,String>

    A mapping of tags to assign to the resource.

    tenantSettings Map<String,String>

    A mapping of tenant settings to assign to the resource.

    zones List<String>

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

    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.

    enableNonSslPort boolean

    Enable the non-SSL port (6379) - disabled by default.

    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.

    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 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 CacheRedisConfigurationArgs

    A redis_configuration as defined below - with some limitations by SKU - defaults/details are shown below.

    redisVersion string

    Redis version. Only major version needed. Valid values: 4, 6.

    replicasPerMaster number

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

    replicasPerPrimary number

    Amount of replicas to create per primary for this Redis Cache. If both replicas_per_primary and replicas_per_master are set, they need to be equal.

    shardCount number

    Only available when using the Premium SKU The number of Shards to create on the Redis Cluster.

    subnetId string

    Only available when using the Premium SKU The ID of the Subnet within which the Redis Cache should be deployed. This Subnet must only contain Azure Cache for Redis instances without any other type of resources. Changing this forces a new resource to be created.

    tags {[key: string]: string}

    A mapping of tags to assign to the resource.

    tenantSettings {[key: string]: string}

    A mapping of tenant settings to assign to the resource.

    zones string[]

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

    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.

    enable_non_ssl_port bool

    Enable the non-SSL port (6379) - disabled by default.

    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.

    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 as defined below - with some limitations by SKU - defaults/details are shown below.

    redis_version str

    Redis version. Only major version needed. Valid values: 4, 6.

    replicas_per_master int

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

    replicas_per_primary int

    Amount of replicas to create per primary for this Redis Cache. If both replicas_per_primary and replicas_per_master are set, they need to be equal.

    shard_count int

    Only available when using the Premium SKU The number of Shards to create on the Redis Cluster.

    subnet_id str

    Only available when using the Premium SKU The ID of the Subnet within which the Redis Cache should be deployed. This Subnet must only contain Azure Cache for Redis instances without any other type of resources. Changing this forces a new resource to be created.

    tags Mapping[str, str]

    A mapping of tags to assign to the resource.

    tenant_settings Mapping[str, str]

    A mapping of tenant settings to assign to the resource.

    zones Sequence[str]

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

    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.

    enableNonSslPort Boolean

    Enable the non-SSL port (6379) - disabled by default.

    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.

    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 as defined below - with some limitations by SKU - defaults/details are shown below.

    redisVersion String

    Redis version. Only major version needed. Valid values: 4, 6.

    replicasPerMaster Number

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

    replicasPerPrimary Number

    Amount of replicas to create per primary for this Redis Cache. If both replicas_per_primary and replicas_per_master are set, they need to be equal.

    shardCount Number

    Only available when using the Premium SKU The number of Shards to create on the Redis Cluster.

    subnetId String

    Only available when using the Premium SKU The ID of the Subnet within which the Redis Cache should be deployed. This Subnet must only contain Azure Cache for Redis instances without any other type of resources. Changing this forces a new resource to be created.

    tags Map<String>

    A mapping of tags to assign to the resource.

    tenantSettings Map<String>

    A mapping of tenant settings to assign to the resource.

    zones List<String>

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

    Outputs

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

    Hostname string

    The Hostname of the Redis Instance

    Id string

    The provider-assigned unique ID for this managed resource.

    Port int

    The non-SSL Port of the Redis Instance

    PrimaryAccessKey string

    The Primary Access Key for the Redis Instance

    PrimaryConnectionString string

    The primary connection string of the Redis Instance.

    SecondaryAccessKey string

    The Secondary Access Key for the Redis Instance

    SecondaryConnectionString string

    The secondary connection string of the Redis Instance.

    SslPort int

    The SSL Port of the Redis Instance

    Hostname string

    The Hostname of the Redis Instance

    Id string

    The provider-assigned unique ID for this managed resource.

    Port int

    The non-SSL Port of the Redis Instance

    PrimaryAccessKey string

    The Primary Access Key for the Redis Instance

    PrimaryConnectionString string

    The primary connection string of the Redis Instance.

    SecondaryAccessKey string

    The Secondary Access Key for the Redis Instance

    SecondaryConnectionString string

    The secondary connection string of the Redis Instance.

    SslPort int

    The SSL Port of the Redis Instance

    hostname String

    The Hostname of the Redis Instance

    id String

    The provider-assigned unique ID for this managed resource.

    port Integer

    The non-SSL Port of the Redis Instance

    primaryAccessKey String

    The Primary Access Key for the Redis Instance

    primaryConnectionString String

    The primary connection string of the Redis Instance.

    secondaryAccessKey String

    The Secondary Access Key for the Redis Instance

    secondaryConnectionString String

    The secondary connection string of the Redis Instance.

    sslPort Integer

    The SSL Port of the Redis Instance

    hostname string

    The Hostname of the Redis Instance

    id string

    The provider-assigned unique ID for this managed resource.

    port number

    The non-SSL Port of the Redis Instance

    primaryAccessKey string

    The Primary Access Key for the Redis Instance

    primaryConnectionString string

    The primary connection string of the Redis Instance.

    secondaryAccessKey string

    The Secondary Access Key for the Redis Instance

    secondaryConnectionString string

    The secondary connection string of the Redis Instance.

    sslPort number

    The SSL Port of the Redis Instance

    hostname str

    The Hostname of the Redis Instance

    id str

    The provider-assigned unique ID for this managed resource.

    port int

    The non-SSL Port of the Redis Instance

    primary_access_key str

    The Primary Access Key for the Redis Instance

    primary_connection_string str

    The primary connection string of the Redis Instance.

    secondary_access_key str

    The Secondary Access Key for the Redis Instance

    secondary_connection_string str

    The secondary connection string of the Redis Instance.

    ssl_port int

    The SSL Port of the Redis Instance

    hostname String

    The Hostname of the Redis Instance

    id String

    The provider-assigned unique ID for this managed resource.

    port Number

    The non-SSL Port of the Redis Instance

    primaryAccessKey String

    The Primary Access Key for the Redis Instance

    primaryConnectionString String

    The primary connection string of the Redis Instance.

    secondaryAccessKey String

    The Secondary Access Key for the Redis Instance

    secondaryConnectionString String

    The secondary connection string of the Redis Instance.

    sslPort Number

    The SSL Port of the Redis Instance

    Look up Existing Cache Resource

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

    public static get(name: string, id: Input<ID>, state?: CacheState, opts?: CustomResourceOptions): Cache
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        capacity: Optional[int] = None,
        enable_non_ssl_port: Optional[bool] = None,
        family: Optional[str] = None,
        hostname: Optional[str] = None,
        identity: Optional[CacheIdentityArgs] = None,
        location: Optional[str] = None,
        minimum_tls_version: Optional[str] = None,
        name: Optional[str] = None,
        patch_schedules: Optional[Sequence[CachePatchScheduleArgs]] = None,
        port: Optional[int] = None,
        primary_access_key: Optional[str] = None,
        primary_connection_string: Optional[str] = None,
        private_static_ip_address: Optional[str] = None,
        public_network_access_enabled: Optional[bool] = None,
        redis_configuration: Optional[CacheRedisConfigurationArgs] = None,
        redis_version: Optional[str] = None,
        replicas_per_master: Optional[int] = None,
        replicas_per_primary: Optional[int] = None,
        resource_group_name: Optional[str] = None,
        secondary_access_key: Optional[str] = None,
        secondary_connection_string: Optional[str] = None,
        shard_count: Optional[int] = None,
        sku_name: Optional[str] = None,
        ssl_port: Optional[int] = None,
        subnet_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tenant_settings: Optional[Mapping[str, str]] = None,
        zones: Optional[Sequence[str]] = None) -> Cache
    func GetCache(ctx *Context, name string, id IDInput, state *CacheState, opts ...ResourceOption) (*Cache, error)
    public static Cache Get(string name, Input<string> id, CacheState? state, CustomResourceOptions? opts = null)
    public static Cache get(String name, Output<String> id, CacheState state, CustomResourceOptions options)
    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:
    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.

    EnableNonSslPort bool

    Enable the non-SSL port (6379) - disabled by default.

    Family string

    The SKU family/pricing group to use. Valid values are C (for Basic/Standard SKU family) and P (for Premium)

    Hostname string

    The Hostname of the Redis Instance

    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.

    PatchSchedules List<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 as defined below - with some limitations by SKU - defaults/details are shown below.

    RedisVersion string

    Redis version. Only major version needed. Valid values: 4, 6.

    ReplicasPerMaster int

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

    ReplicasPerPrimary int

    Amount of replicas to create per primary for this Redis Cache. If both replicas_per_primary and replicas_per_master are set, they need to be equal.

    ResourceGroupName string

    The name of the resource group in which to create the Redis instance. 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.

    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.

    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.

    EnableNonSslPort bool

    Enable the non-SSL port (6379) - disabled by default.

    Family string

    The SKU family/pricing group to use. Valid values are C (for Basic/Standard SKU family) and P (for Premium)

    Hostname string

    The Hostname of the Redis Instance

    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.

    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 as defined below - with some limitations by SKU - defaults/details are shown below.

    RedisVersion string

    Redis version. Only major version needed. Valid values: 4, 6.

    ReplicasPerMaster int

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

    ReplicasPerPrimary int

    Amount of replicas to create per primary for this Redis Cache. If both replicas_per_primary and replicas_per_master are set, they need to be equal.

    ResourceGroupName string

    The name of the resource group in which to create the Redis instance. 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.

    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.

    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.

    enableNonSslPort Boolean

    Enable the non-SSL port (6379) - disabled by default.

    family String

    The SKU family/pricing group to use. Valid values are C (for Basic/Standard SKU family) and P (for Premium)

    hostname String

    The Hostname of the Redis Instance

    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.

    patchSchedules List<CachePatchScheduleArgs>

    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 CacheRedisConfigurationArgs

    A redis_configuration as defined below - with some limitations by SKU - defaults/details are shown below.

    redisVersion String

    Redis version. Only major version needed. Valid values: 4, 6.

    replicasPerMaster Integer

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

    replicasPerPrimary Integer

    Amount of replicas to create per primary for this Redis Cache. If both replicas_per_primary and replicas_per_master are set, they need to be equal.

    resourceGroupName String

    The name of the resource group in which to create the Redis instance. 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.

    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.

    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.

    enableNonSslPort boolean

    Enable the non-SSL port (6379) - disabled by default.

    family string

    The SKU family/pricing group to use. Valid values are C (for Basic/Standard SKU family) and P (for Premium)

    hostname string

    The Hostname of the Redis Instance

    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.

    patchSchedules CachePatchScheduleArgs[]

    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 CacheRedisConfigurationArgs

    A redis_configuration as defined below - with some limitations by SKU - defaults/details are shown below.

    redisVersion string

    Redis version. Only major version needed. Valid values: 4, 6.

    replicasPerMaster number

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

    replicasPerPrimary number

    Amount of replicas to create per primary for this Redis Cache. If both replicas_per_primary and replicas_per_master are set, they need to be equal.

    resourceGroupName string

    The name of the resource group in which to create the Redis instance. 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.

    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.

    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.

    enable_non_ssl_port bool

    Enable the non-SSL port (6379) - disabled by default.

    family str

    The SKU family/pricing group to use. Valid values are C (for Basic/Standard SKU family) and P (for Premium)

    hostname str

    The Hostname of the Redis Instance

    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.

    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 as defined below - with some limitations by SKU - defaults/details are shown below.

    redis_version str

    Redis version. Only major version needed. Valid values: 4, 6.

    replicas_per_master int

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

    replicas_per_primary int

    Amount of replicas to create per primary for this Redis Cache. If both replicas_per_primary and replicas_per_master are set, they need to be equal.

    resource_group_name str

    The name of the resource group in which to create the Redis instance. 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.

    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.

    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.

    enableNonSslPort Boolean

    Enable the non-SSL port (6379) - disabled by default.

    family String

    The SKU family/pricing group to use. Valid values are C (for Basic/Standard SKU family) and P (for Premium)

    hostname String

    The Hostname of the Redis Instance

    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.

    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 as defined below - with some limitations by SKU - defaults/details are shown below.

    redisVersion String

    Redis version. Only major version needed. Valid values: 4, 6.

    replicasPerMaster Number

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

    replicasPerPrimary Number

    Amount of replicas to create per primary for this Redis Cache. If both replicas_per_primary and replicas_per_master are set, they need to be equal.

    resourceGroupName String

    The name of the resource group in which to create the Redis instance. 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.

    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.

    Supporting Types

    CacheIdentity

    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.

    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.

    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.

    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.

    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.

    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.

    principalId String
    tenantId String

    CachePatchSchedule

    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.

    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.

    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.

    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.

    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.

    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.

    CacheRedisConfiguration

    AofBackupEnabled bool

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

    AofStorageConnectionString0 string

    First Storage Account connection string for AOF persistence.

    AofStorageConnectionString1 string

    Second Storage Account connection string for AOF persistence.

    EnableAuthentication bool

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

    Maxclients int

    Returns the max number of connected clients at the same time.

    MaxfragmentationmemoryReserved int

    Value in megabytes reserved to accommodate for memory fragmentation. Defaults are shown below.

    MaxmemoryDelta int

    The max-memory delta for this Redis instance. Defaults are shown below.

    MaxmemoryPolicy string

    How Redis will select what to remove when maxmemory is reached. Defaults are shown below. 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.

    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}.

    AofBackupEnabled bool

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

    AofStorageConnectionString0 string

    First Storage Account connection string for AOF persistence.

    AofStorageConnectionString1 string

    Second Storage Account connection string for AOF persistence.

    EnableAuthentication bool

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

    Maxclients int

    Returns the max number of connected clients at the same time.

    MaxfragmentationmemoryReserved int

    Value in megabytes reserved to accommodate for memory fragmentation. Defaults are shown below.

    MaxmemoryDelta int

    The max-memory delta for this Redis instance. Defaults are shown below.

    MaxmemoryPolicy string

    How Redis will select what to remove when maxmemory is reached. Defaults are shown below. 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.

    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}.

    aofBackupEnabled Boolean

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

    aofStorageConnectionString0 String

    First Storage Account connection string for AOF persistence.

    aofStorageConnectionString1 String

    Second Storage Account connection string for AOF persistence.

    enableAuthentication Boolean

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

    maxclients Integer

    Returns the max number of connected clients at the same time.

    maxfragmentationmemoryReserved Integer

    Value in megabytes reserved to accommodate for memory fragmentation. Defaults are shown below.

    maxmemoryDelta Integer

    The max-memory delta for this Redis instance. Defaults are shown below.

    maxmemoryPolicy String

    How Redis will select what to remove when maxmemory is reached. Defaults are shown below. 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.

    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}.

    aofBackupEnabled boolean

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

    aofStorageConnectionString0 string

    First Storage Account connection string for AOF persistence.

    aofStorageConnectionString1 string

    Second Storage Account connection string for AOF persistence.

    enableAuthentication boolean

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

    maxclients number

    Returns the max number of connected clients at the same time.

    maxfragmentationmemoryReserved number

    Value in megabytes reserved to accommodate for memory fragmentation. Defaults are shown below.

    maxmemoryDelta number

    The max-memory delta for this Redis instance. Defaults are shown below.

    maxmemoryPolicy string

    How Redis will select what to remove when maxmemory is reached. Defaults are shown below. 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.

    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}.

    aof_backup_enabled bool

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

    aof_storage_connection_string0 str

    First Storage Account connection string for AOF persistence.

    aof_storage_connection_string1 str

    Second Storage Account connection string for AOF persistence.

    enable_authentication bool

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

    maxclients int

    Returns the max number of connected clients at the same time.

    maxfragmentationmemory_reserved int

    Value in megabytes reserved to accommodate for memory fragmentation. Defaults are shown below.

    maxmemory_delta int

    The max-memory delta for this Redis instance. Defaults are shown below.

    maxmemory_policy str

    How Redis will select what to remove when maxmemory is reached. Defaults are shown below. 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.

    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}.

    aofBackupEnabled Boolean

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

    aofStorageConnectionString0 String

    First Storage Account connection string for AOF persistence.

    aofStorageConnectionString1 String

    Second Storage Account connection string for AOF persistence.

    enableAuthentication Boolean

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

    maxclients Number

    Returns the max number of connected clients at the same time.

    maxfragmentationmemoryReserved Number

    Value in megabytes reserved to accommodate for memory fragmentation. Defaults are shown below.

    maxmemoryDelta Number

    The max-memory delta for this Redis instance. Defaults are shown below.

    maxmemoryPolicy String

    How Redis will select what to remove when maxmemory is reached. Defaults are shown below. 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.

    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}.

    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

    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 Classic v5.43.0 published on Saturday, May 6, 2023 by Pulumi
    pulumi/pulumi-azure