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

We recommend using Azure Native.

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

azure.redis.LinkedServer

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 Linked Server (ie Geo Location)

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    resources:
  example-primary:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources-primary
      location: East US
  example-primaryCache:
    type: azure:redis:Cache
    name: example-primary
    properties:
      name: example-cache1
      location: ${["example-primary"].location}
      resourceGroupName: ${["example-primary"].name}
      capacity: 1
      family: P
      skuName: Premium
      enableNonSslPort: false
      redisConfiguration:
        maxmemoryReserved: 2
        maxmemoryDelta: 2
        maxmemoryPolicy: allkeys-lru
  example-secondary:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources-secondary
      location: West US
  example-secondaryCache:
    type: azure:redis:Cache
    name: example-secondary
    properties:
      name: example-cache2
      location: ${["example-secondary"].location}
      resourceGroupName: ${["example-secondary"].name}
      capacity: 1
      family: P
      skuName: Premium
      enableNonSslPort: false
      redisConfiguration:
        maxmemoryReserved: 2
        maxmemoryDelta: 2
        maxmemoryPolicy: allkeys-lru
  example-link:
    type: azure:redis:LinkedServer
    properties:
      targetRedisCacheName: ${["example-primaryCache"].name}
      resourceGroupName: ${["example-primaryCache"].resourceGroupName}
      linkedRedisCacheId: ${["example-secondaryCache"].id}
      linkedRedisCacheLocation: ${["example-secondaryCache"].location}
      serverRole: Secondary

    Create LinkedServer Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new LinkedServer(name: string, args: LinkedServerArgs, opts?: CustomResourceOptions);
    @overload
def LinkedServer(resource_name: str,
                 args: LinkedServerArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def LinkedServer(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 linked_redis_cache_id: Optional[str] = None,
                 linked_redis_cache_location: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 server_role: Optional[str] = None,
                 target_redis_cache_name: Optional[str] = None)
    func NewLinkedServer(ctx *Context, name string, args LinkedServerArgs, opts ...ResourceOption) (*LinkedServer, error)
    public LinkedServer(string name, LinkedServerArgs args, CustomResourceOptions? opts = null)
    public LinkedServer(String name, LinkedServerArgs args)
public LinkedServer(String name, LinkedServerArgs args, CustomResourceOptions options)

    type: azure:redis:LinkedServer
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 LinkedServerArgs
    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 LinkedServerArgs
    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 LinkedServerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LinkedServerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LinkedServerArgs
    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 linkedServerResource = new Azure.Redis.LinkedServer("linkedServerResource", new()
{
    LinkedRedisCacheId = "string",
    LinkedRedisCacheLocation = "string",
    ResourceGroupName = "string",
    ServerRole = "string",
    TargetRedisCacheName = "string",
});

    example, err := redis.NewLinkedServer(ctx, "linkedServerResource", &redis.LinkedServerArgs{
	LinkedRedisCacheId:       pulumi.String("string"),
	LinkedRedisCacheLocation: pulumi.String("string"),
	ResourceGroupName:        pulumi.String("string"),
	ServerRole:               pulumi.String("string"),
	TargetRedisCacheName:     pulumi.String("string"),
})

    var linkedServerResource = new LinkedServer("linkedServerResource", LinkedServerArgs.builder()
    .linkedRedisCacheId("string")
    .linkedRedisCacheLocation("string")
    .resourceGroupName("string")
    .serverRole("string")
    .targetRedisCacheName("string")
    .build());

    linked_server_resource = azure.redis.LinkedServer("linkedServerResource",
    linked_redis_cache_id="string",
    linked_redis_cache_location="string",
    resource_group_name="string",
    server_role="string",
    target_redis_cache_name="string")

    const linkedServerResource = new azure.redis.LinkedServer("linkedServerResource", {
    linkedRedisCacheId: "string",
    linkedRedisCacheLocation: "string",
    resourceGroupName: "string",
    serverRole: "string",
    targetRedisCacheName: "string",
});

    type: azure:redis:LinkedServer
properties:
    linkedRedisCacheId: string
    linkedRedisCacheLocation: string
    resourceGroupName: string
    serverRole: string
    targetRedisCacheName: string

    LinkedServer 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 LinkedServer resource accepts the following input properties:

    LinkedRedisCacheId string
    The ID of the linked Redis cache. Changing this forces a new Redis to be created.
    LinkedRedisCacheLocation string
    The location of the linked Redis cache. Changing this forces a new Redis to be created.
    ResourceGroupName string
    The name of the Resource Group where the Redis caches exists. Changing this forces a new Redis to be created.
    ServerRole string
    The role of the linked Redis cache (eg "Secondary"). Changing this forces a new Redis to be created. Possible values are Primary and Secondary.
    TargetRedisCacheName string
    The name of Redis cache to link with. Changing this forces a new Redis to be created. (eg The primary role)
    LinkedRedisCacheId string
    The ID of the linked Redis cache. Changing this forces a new Redis to be created.
    LinkedRedisCacheLocation string
    The location of the linked Redis cache. Changing this forces a new Redis to be created.
    ResourceGroupName string
    The name of the Resource Group where the Redis caches exists. Changing this forces a new Redis to be created.
    ServerRole string
    The role of the linked Redis cache (eg "Secondary"). Changing this forces a new Redis to be created. Possible values are Primary and Secondary.
    TargetRedisCacheName string
    The name of Redis cache to link with. Changing this forces a new Redis to be created. (eg The primary role)
    linkedRedisCacheId String
    The ID of the linked Redis cache. Changing this forces a new Redis to be created.
    linkedRedisCacheLocation String
    The location of the linked Redis cache. Changing this forces a new Redis to be created.
    resourceGroupName String
    The name of the Resource Group where the Redis caches exists. Changing this forces a new Redis to be created.
    serverRole String
    The role of the linked Redis cache (eg "Secondary"). Changing this forces a new Redis to be created. Possible values are Primary and Secondary.
    targetRedisCacheName String
    The name of Redis cache to link with. Changing this forces a new Redis to be created. (eg The primary role)
    linkedRedisCacheId string
    The ID of the linked Redis cache. Changing this forces a new Redis to be created.
    linkedRedisCacheLocation string
    The location of the linked Redis cache. Changing this forces a new Redis to be created.
    resourceGroupName string
    The name of the Resource Group where the Redis caches exists. Changing this forces a new Redis to be created.
    serverRole string
    The role of the linked Redis cache (eg "Secondary"). Changing this forces a new Redis to be created. Possible values are Primary and Secondary.
    targetRedisCacheName string
    The name of Redis cache to link with. Changing this forces a new Redis to be created. (eg The primary role)
    linked_redis_cache_id str
    The ID of the linked Redis cache. Changing this forces a new Redis to be created.
    linked_redis_cache_location str
    The location of the linked Redis cache. Changing this forces a new Redis to be created.
    resource_group_name str
    The name of the Resource Group where the Redis caches exists. Changing this forces a new Redis to be created.
    server_role str
    The role of the linked Redis cache (eg "Secondary"). Changing this forces a new Redis to be created. Possible values are Primary and Secondary.
    target_redis_cache_name str
    The name of Redis cache to link with. Changing this forces a new Redis to be created. (eg The primary role)
    linkedRedisCacheId String
    The ID of the linked Redis cache. Changing this forces a new Redis to be created.
    linkedRedisCacheLocation String
    The location of the linked Redis cache. Changing this forces a new Redis to be created.
    resourceGroupName String
    The name of the Resource Group where the Redis caches exists. Changing this forces a new Redis to be created.
    serverRole String
    The role of the linked Redis cache (eg "Secondary"). Changing this forces a new Redis to be created. Possible values are Primary and Secondary.
    targetRedisCacheName String
    The name of Redis cache to link with. Changing this forces a new Redis to be created. (eg The primary role)

    Outputs

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

    GeoReplicatedPrimaryHostName string
    The geo-replicated primary hostname for this linked server.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the linked server.
    GeoReplicatedPrimaryHostName string
    The geo-replicated primary hostname for this linked server.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the linked server.
    geoReplicatedPrimaryHostName String
    The geo-replicated primary hostname for this linked server.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the linked server.
    geoReplicatedPrimaryHostName string
    The geo-replicated primary hostname for this linked server.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the linked server.
    geo_replicated_primary_host_name str
    The geo-replicated primary hostname for this linked server.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the linked server.
    geoReplicatedPrimaryHostName String
    The geo-replicated primary hostname for this linked server.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the linked server.

    Look up Existing LinkedServer Resource

    Get an existing LinkedServer 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?: LinkedServerState, opts?: CustomResourceOptions): LinkedServer
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        geo_replicated_primary_host_name: Optional[str] = None,
        linked_redis_cache_id: Optional[str] = None,
        linked_redis_cache_location: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        server_role: Optional[str] = None,
        target_redis_cache_name: Optional[str] = None) -> LinkedServer
    func GetLinkedServer(ctx *Context, name string, id IDInput, state *LinkedServerState, opts ...ResourceOption) (*LinkedServer, error)
    public static LinkedServer Get(string name, Input<string> id, LinkedServerState? state, CustomResourceOptions? opts = null)
    public static LinkedServer get(String name, Output<String> id, LinkedServerState 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:
    GeoReplicatedPrimaryHostName string
    The geo-replicated primary hostname for this linked server.
    LinkedRedisCacheId string
    The ID of the linked Redis cache. Changing this forces a new Redis to be created.
    LinkedRedisCacheLocation string
    The location of the linked Redis cache. Changing this forces a new Redis to be created.
    Name string
    The name of the linked server.
    ResourceGroupName string
    The name of the Resource Group where the Redis caches exists. Changing this forces a new Redis to be created.
    ServerRole string
    The role of the linked Redis cache (eg "Secondary"). Changing this forces a new Redis to be created. Possible values are Primary and Secondary.
    TargetRedisCacheName string
    The name of Redis cache to link with. Changing this forces a new Redis to be created. (eg The primary role)
    GeoReplicatedPrimaryHostName string
    The geo-replicated primary hostname for this linked server.
    LinkedRedisCacheId string
    The ID of the linked Redis cache. Changing this forces a new Redis to be created.
    LinkedRedisCacheLocation string
    The location of the linked Redis cache. Changing this forces a new Redis to be created.
    Name string
    The name of the linked server.
    ResourceGroupName string
    The name of the Resource Group where the Redis caches exists. Changing this forces a new Redis to be created.
    ServerRole string
    The role of the linked Redis cache (eg "Secondary"). Changing this forces a new Redis to be created. Possible values are Primary and Secondary.
    TargetRedisCacheName string
    The name of Redis cache to link with. Changing this forces a new Redis to be created. (eg The primary role)
    geoReplicatedPrimaryHostName String
    The geo-replicated primary hostname for this linked server.
    linkedRedisCacheId String
    The ID of the linked Redis cache. Changing this forces a new Redis to be created.
    linkedRedisCacheLocation String
    The location of the linked Redis cache. Changing this forces a new Redis to be created.
    name String
    The name of the linked server.
    resourceGroupName String
    The name of the Resource Group where the Redis caches exists. Changing this forces a new Redis to be created.
    serverRole String
    The role of the linked Redis cache (eg "Secondary"). Changing this forces a new Redis to be created. Possible values are Primary and Secondary.
    targetRedisCacheName String
    The name of Redis cache to link with. Changing this forces a new Redis to be created. (eg The primary role)
    geoReplicatedPrimaryHostName string
    The geo-replicated primary hostname for this linked server.
    linkedRedisCacheId string
    The ID of the linked Redis cache. Changing this forces a new Redis to be created.
    linkedRedisCacheLocation string
    The location of the linked Redis cache. Changing this forces a new Redis to be created.
    name string
    The name of the linked server.
    resourceGroupName string
    The name of the Resource Group where the Redis caches exists. Changing this forces a new Redis to be created.
    serverRole string
    The role of the linked Redis cache (eg "Secondary"). Changing this forces a new Redis to be created. Possible values are Primary and Secondary.
    targetRedisCacheName string
    The name of Redis cache to link with. Changing this forces a new Redis to be created. (eg The primary role)
    geo_replicated_primary_host_name str
    The geo-replicated primary hostname for this linked server.
    linked_redis_cache_id str
    The ID of the linked Redis cache. Changing this forces a new Redis to be created.
    linked_redis_cache_location str
    The location of the linked Redis cache. Changing this forces a new Redis to be created.
    name str
    The name of the linked server.
    resource_group_name str
    The name of the Resource Group where the Redis caches exists. Changing this forces a new Redis to be created.
    server_role str
    The role of the linked Redis cache (eg "Secondary"). Changing this forces a new Redis to be created. Possible values are Primary and Secondary.
    target_redis_cache_name str
    The name of Redis cache to link with. Changing this forces a new Redis to be created. (eg The primary role)
    geoReplicatedPrimaryHostName String
    The geo-replicated primary hostname for this linked server.
    linkedRedisCacheId String
    The ID of the linked Redis cache. Changing this forces a new Redis to be created.
    linkedRedisCacheLocation String
    The location of the linked Redis cache. Changing this forces a new Redis to be created.
    name String
    The name of the linked server.
    resourceGroupName String
    The name of the Resource Group where the Redis caches exists. Changing this forces a new Redis to be created.
    serverRole String
    The role of the linked Redis cache (eg "Secondary"). Changing this forces a new Redis to be created. Possible values are Primary and Secondary.
    targetRedisCacheName String
    The name of Redis cache to link with. Changing this forces a new Redis to be created. (eg The primary role)

    Import

    Redis can be imported using the resource id, e.g.

    $ pulumi import azure:redis/linkedServer:LinkedServer example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Cache/redis/cache1/linkedServers/cache2

    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