Share via

Microsoft.Cache redis/linkedServers

Bicep resource definition

The redis/linkedServers resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Cache/redis/linkedServers resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Cache/redis/linkedServers@2024-11-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    linkedRedisCacheId: 'string'
    linkedRedisCacheLocation: 'string'
    serverRole: 'string'
  }
}

Property Values

Microsoft.Cache/redis/linkedServers

Name Description Value
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: redis
properties Properties required to create a linked server. RedisLinkedServerCreatePropertiesOrRedisLinkedServerProperties (required)

RedisLinkedServerCreatePropertiesOrRedisLinkedServerProperties

Name Description Value
linkedRedisCacheId Fully qualified resourceId of the linked redis cache. string (required)
linkedRedisCacheLocation Location of the linked redis cache. string (required)
serverRole Role of the linked server. 'Primary'
'Secondary' (required)

ARM template resource definition

The redis/linkedServers resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Cache/redis/linkedServers resource, add the following JSON to your template.

{
  "type": "Microsoft.Cache/redis/linkedServers",
  "apiVersion": "2024-11-01",
  "name": "string",
  "properties": {
    "linkedRedisCacheId": "string",
    "linkedRedisCacheLocation": "string",
    "serverRole": "string"
  }
}

Property Values

Microsoft.Cache/redis/linkedServers

Name Description Value
apiVersion The api version '2024-11-01'
name The resource name string (required)
properties Properties required to create a linked server. RedisLinkedServerCreatePropertiesOrRedisLinkedServerProperties (required)
type The resource type 'Microsoft.Cache/redis/linkedServers'

RedisLinkedServerCreatePropertiesOrRedisLinkedServerProperties

Name Description Value
linkedRedisCacheId Fully qualified resourceId of the linked redis cache. string (required)
linkedRedisCacheLocation Location of the linked redis cache. string (required)
serverRole Role of the linked server. 'Primary'
'Secondary' (required)

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template Description
Create two geo-replicated caches in a Virtual Network

Deploy to Azure		 This template shows how to deploy two Premium tier Azure Cache for Redis instances into separate Virtual Networks and link them with geo-replication.

Terraform (AzAPI provider) resource definition

The redis/linkedServers resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Cache/redis/linkedServers resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Cache/redis/linkedServers@2024-11-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      linkedRedisCacheId = "string"
      linkedRedisCacheLocation = "string"
      serverRole = "string"
    }
  }
}

Property Values

Microsoft.Cache/redis/linkedServers

Name Description Value
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: redis
properties Properties required to create a linked server. RedisLinkedServerCreatePropertiesOrRedisLinkedServerProperties (required)
type The resource type "Microsoft.Cache/redis/linkedServers@2024-11-01"

RedisLinkedServerCreatePropertiesOrRedisLinkedServerProperties

Name Description Value
linkedRedisCacheId Fully qualified resourceId of the linked redis cache. string (required)
linkedRedisCacheLocation Location of the linked redis cache. string (required)
serverRole Role of the linked server. 'Primary'
'Secondary' (required)

Usage Examples

Terraform Samples

A basic example of deploying Redis Linked Server.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westus"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "resourceGroup_secondary" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = "${var.resource_name}-secondary"
  location = var.location
}

resource "azapi_resource" "redis_secondary" {
  type      = "Microsoft.Cache/redis@2024-11-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = "${var.resource_name}-secondary"
  location  = var.location
  body = {
    properties = {
      disableAccessKeyAuthentication = false
      enableNonSslPort               = false
      minimumTlsVersion              = "1.2"
      publicNetworkAccess            = "Enabled"
      redisConfiguration = {
        maxmemory-delta                        = "642"
        maxmemory-policy                       = "allkeys-lru"
        maxmemory-reserved                     = "642"
        preferred-data-persistence-auth-method = ""
      }
      redisVersion = "6"
      sku = {
        capacity = 1
        family   = "P"
        name     = "Premium"
      }
    }
  }
}

resource "azapi_resource" "redis_primary" {
  type      = "Microsoft.Cache/redis@2024-11-01"
  parent_id = azapi_resource.resourceGroup_secondary.id
  name      = "${var.resource_name}-primary"
  location  = var.location
  body = {
    properties = {
      disableAccessKeyAuthentication = false
      enableNonSslPort               = false
      minimumTlsVersion              = "1.2"
      publicNetworkAccess            = "Enabled"
      redisConfiguration = {
        maxmemory-delta                        = "642"
        maxmemory-policy                       = "allkeys-lru"
        maxmemory-reserved                     = "642"
        preferred-data-persistence-auth-method = ""
      }
      redisVersion = "6"
      sku = {
        capacity = 1
        family   = "P"
        name     = "Premium"
      }
    }
  }
}

resource "azapi_resource" "linkedServer" {
  type      = "Microsoft.Cache/redis/linkedServers@2024-11-01"
  parent_id = azapi_resource.redis_primary.id
  name      = "${var.resource_name}-secondary"
  body = {
    properties = {
      linkedRedisCacheId       = azapi_resource.redis_secondary.id
      linkedRedisCacheLocation = var.location
      serverRole               = "Secondary"
    }
  }
}
  • Last updated on