Microsoft.Cache redis/linkedServers 2024-04-01-preview
Bicep resource definition
The redis/linkedServers resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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-04-01-preview' = {
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:
- Resource groups - See resource group deployment commands
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-04-01-preview",
"name": "string",
"properties": {
"linkedRedisCacheId": "string",
"linkedRedisCacheLocation": "string",
"serverRole": "string"
}
}
Property values
Microsoft.Cache/redis/linkedServers
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-04-01-preview' |
| 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) |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Create two geo-replicated caches in a Virtual Network |
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-04-01-preview"
name = "string"
body = jsonencode({
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-04-01-preview" |
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) |