1. Packages
  2. Azure Native
  3. API Docs
  4. redis
  5. getRedisLinkedServer
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.redis.getRedisLinkedServer

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

Gets the detailed information about a linked server of a redis cache (requires Premium SKU).

Uses Azure REST API version 2017-02-01.

Using getRedisLinkedServer

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getRedisLinkedServer(args: GetRedisLinkedServerArgs, opts?: InvokeOptions): Promise<GetRedisLinkedServerResult>
function getRedisLinkedServerOutput(args: GetRedisLinkedServerOutputArgs, opts?: InvokeOptions): Output<GetRedisLinkedServerResult>
Copy
def get_redis_linked_server(linked_server_name: Optional[str] = None,
                            name: Optional[str] = None,
                            resource_group_name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetRedisLinkedServerResult
def get_redis_linked_server_output(linked_server_name: Optional[pulumi.Input[str]] = None,
                            name: Optional[pulumi.Input[str]] = None,
                            resource_group_name: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetRedisLinkedServerResult]
Copy
func LookupRedisLinkedServer(ctx *Context, args *LookupRedisLinkedServerArgs, opts ...InvokeOption) (*LookupRedisLinkedServerResult, error)
func LookupRedisLinkedServerOutput(ctx *Context, args *LookupRedisLinkedServerOutputArgs, opts ...InvokeOption) LookupRedisLinkedServerResultOutput
Copy

> Note: This function is named LookupRedisLinkedServer in the Go SDK.

public static class GetRedisLinkedServer 
{
    public static Task<GetRedisLinkedServerResult> InvokeAsync(GetRedisLinkedServerArgs args, InvokeOptions? opts = null)
    public static Output<GetRedisLinkedServerResult> Invoke(GetRedisLinkedServerInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRedisLinkedServerResult> getRedisLinkedServer(GetRedisLinkedServerArgs args, InvokeOptions options)
public static Output<GetRedisLinkedServerResult> getRedisLinkedServer(GetRedisLinkedServerArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:redis:getRedisLinkedServer
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

LinkedServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the linked server.
Name
This property is required.
Changes to this property will trigger replacement.
string
The name of the redis cache.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
LinkedServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the linked server.
Name
This property is required.
Changes to this property will trigger replacement.
string
The name of the redis cache.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
linkedServerName
This property is required.
Changes to this property will trigger replacement.
String
The name of the linked server.
name
This property is required.
Changes to this property will trigger replacement.
String
The name of the redis cache.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
linkedServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the linked server.
name
This property is required.
Changes to this property will trigger replacement.
string
The name of the redis cache.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
linked_server_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the linked server.
name
This property is required.
Changes to this property will trigger replacement.
str
The name of the redis cache.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
linkedServerName
This property is required.
Changes to this property will trigger replacement.
String
The name of the linked server.
name
This property is required.
Changes to this property will trigger replacement.
String
The name of the redis cache.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.

getRedisLinkedServer Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Resource ID.
LinkedRedisCacheId string
Fully qualified resourceId of the linked redis cache.
LinkedRedisCacheLocation string
Location of the linked redis cache.
Name string
Resource name.
ProvisioningState string
Terminal state of the link between primary and secondary redis cache.
ServerRole string
Role of the linked server.
Type string
Resource type.
AzureApiVersion string
The Azure API version of the resource.
Id string
Resource ID.
LinkedRedisCacheId string
Fully qualified resourceId of the linked redis cache.
LinkedRedisCacheLocation string
Location of the linked redis cache.
Name string
Resource name.
ProvisioningState string
Terminal state of the link between primary and secondary redis cache.
ServerRole string
Role of the linked server.
Type string
Resource type.
azureApiVersion String
The Azure API version of the resource.
id String
Resource ID.
linkedRedisCacheId String
Fully qualified resourceId of the linked redis cache.
linkedRedisCacheLocation String
Location of the linked redis cache.
name String
Resource name.
provisioningState String
Terminal state of the link between primary and secondary redis cache.
serverRole String
Role of the linked server.
type String
Resource type.
azureApiVersion string
The Azure API version of the resource.
id string
Resource ID.
linkedRedisCacheId string
Fully qualified resourceId of the linked redis cache.
linkedRedisCacheLocation string
Location of the linked redis cache.
name string
Resource name.
provisioningState string
Terminal state of the link between primary and secondary redis cache.
serverRole string
Role of the linked server.
type string
Resource type.
azure_api_version str
The Azure API version of the resource.
id str
Resource ID.
linked_redis_cache_id str
Fully qualified resourceId of the linked redis cache.
linked_redis_cache_location str
Location of the linked redis cache.
name str
Resource name.
provisioning_state str
Terminal state of the link between primary and secondary redis cache.
server_role str
Role of the linked server.
type str
Resource type.
azureApiVersion String
The Azure API version of the resource.
id String
Resource ID.
linkedRedisCacheId String
Fully qualified resourceId of the linked redis cache.
linkedRedisCacheLocation String
Location of the linked redis cache.
name String
Resource name.
provisioningState String
Terminal state of the link between primary and secondary redis cache.
serverRole String
Role of the linked server.
type String
Resource type.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi