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@2023-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    linkedRedisCacheId: 'string'
    linkedRedisCacheLocation: 'string'
    serverRole: 'string'
  }
}

Property values

redis/linkedServers

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.
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. RedisLinkedServerCreatePropertiesOrRedisLinkedServer... (required)

RedisLinkedServerCreatePropertiesOrRedisLinkedServer...

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)

Quickstart templates

The following 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.

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": "2023-08-01",
  "name": "string",
  "properties": {
    "linkedRedisCacheId": "string",
    "linkedRedisCacheLocation": "string",
    "serverRole": "string"
  }
}

Property values

redis/linkedServers

Name Description Value
type The resource type 'Microsoft.Cache/redis/linkedServers'
apiVersion The resource api version '2023-08-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)
properties Properties required to create a linked server. RedisLinkedServerCreatePropertiesOrRedisLinkedServer... (required)

RedisLinkedServerCreatePropertiesOrRedisLinkedServer...

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)

Quickstart templates

The following 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@2023-08-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      linkedRedisCacheId = "string"
      linkedRedisCacheLocation = "string"
      serverRole = "string"
    }
  })
}

Property values

redis/linkedServers

Name Description Value
type The resource type "Microsoft.Cache/redis/linkedServers@2023-08-01"
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. RedisLinkedServerCreatePropertiesOrRedisLinkedServer... (required)

RedisLinkedServerCreatePropertiesOrRedisLinkedServer...

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)