azure-native.redis.getLinkedServer

Azure Native v3.10.1, Nov 7 25

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.10.1 published on Friday, Nov 7, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-azure-native

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.10.1 published on Friday, Nov 7, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-azure-native

Other available API versions: 2017-10-01, 2018-03-01, 2019-07-01, 2020-06-01, 2020-12-01, 2021-06-01, 2022-05-01, 2022-06-01, 2023-04-01, 2023-05-01-preview, 2023-08-01, 2024-03-01, 2024-04-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native redis [ApiVersion]. See the version guide for details.

Using getLinkedServer

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 getLinkedServer(args: GetLinkedServerArgs, opts?: InvokeOptions): Promise<GetLinkedServerResult>
function getLinkedServerOutput(args: GetLinkedServerOutputArgs, opts?: InvokeOptions): Output<GetLinkedServerResult>

def get_linked_server(linked_server_name: Optional[str] = None,
                      name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetLinkedServerResult
def get_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[GetLinkedServerResult]

func LookupLinkedServer(ctx *Context, args *LookupLinkedServerArgs, opts ...InvokeOption) (*LookupLinkedServerResult, error)
func LookupLinkedServerOutput(ctx *Context, args *LookupLinkedServerOutputArgs, opts ...InvokeOption) LookupLinkedServerResultOutput

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

public static class GetLinkedServer 
{
    public static Task<GetLinkedServerResult> InvokeAsync(GetLinkedServerArgs args, InvokeOptions? opts = null)
    public static Output<GetLinkedServerResult> Invoke(GetLinkedServerInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetLinkedServerResult> getLinkedServer(GetLinkedServerArgs args, InvokeOptions options)
public static Output<GetLinkedServerResult> getLinkedServer(GetLinkedServerArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:redis:getLinkedServer
  arguments:
    # arguments dictionary

The following arguments are supported:

LinkedServerName string: The name of the RedisLinkedServerWithProperties
Name string: The name of the redis cache.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

LinkedServerName string: The name of the RedisLinkedServerWithProperties
Name string: The name of the redis cache.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

linkedServerName String: The name of the RedisLinkedServerWithProperties
name String: The name of the redis cache.
resourceGroupName String: The name of the resource group. The name is case insensitive.

linkedServerName string: The name of the RedisLinkedServerWithProperties
name string: The name of the redis cache.
resourceGroupName string: The name of the resource group. The name is case insensitive.

linked_server_name str: The name of the RedisLinkedServerWithProperties
name str: The name of the redis cache.
resource_group_name str: The name of the resource group. The name is case insensitive.

linkedServerName String: The name of the RedisLinkedServerWithProperties
name String: The name of the redis cache.
resourceGroupName String: The name of the resource group. The name is case insensitive.

getLinkedServer Result

The following output properties are available:

AzureApiVersion string: The Azure API version of the resource.
GeoReplicatedPrimaryHostName string: The unchanging DNS name which will always point to current geo-primary cache among the linked redis caches for seamless Geo Failover experience.
Id string: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
LinkedRedisCacheId string: Fully qualified resourceId of the linked redis cache.
LinkedRedisCacheLocation string: Location of the linked redis cache.
Name string: The name of the resource
PrimaryHostName string: The changing DNS name that resolves to the current geo-primary cache among the linked redis caches before or after the Geo Failover.
ProvisioningState string: Terminal state of the link between primary and secondary redis cache.
ServerRole string: Role of the linked server.
SystemData Pulumi.AzureNative.Redis.Outputs.SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

AzureApiVersion string: The Azure API version of the resource.
GeoReplicatedPrimaryHostName string: The unchanging DNS name which will always point to current geo-primary cache among the linked redis caches for seamless Geo Failover experience.
Id string: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
LinkedRedisCacheId string: Fully qualified resourceId of the linked redis cache.
LinkedRedisCacheLocation string: Location of the linked redis cache.
Name string: The name of the resource
PrimaryHostName string: The changing DNS name that resolves to the current geo-primary cache among the linked redis caches before or after the Geo Failover.
ProvisioningState string: Terminal state of the link between primary and secondary redis cache.
ServerRole string: Role of the linked server.
SystemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

azureApiVersion String: The Azure API version of the resource.
geoReplicatedPrimaryHostName String: The unchanging DNS name which will always point to current geo-primary cache among the linked redis caches for seamless Geo Failover experience.
id String: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
linkedRedisCacheId String: Fully qualified resourceId of the linked redis cache.
linkedRedisCacheLocation String: Location of the linked redis cache.
name String: The name of the resource
primaryHostName String: The changing DNS name that resolves to the current geo-primary cache among the linked redis caches before or after the Geo Failover.
provisioningState String: Terminal state of the link between primary and secondary redis cache.
serverRole String: Role of the linked server.
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

azureApiVersion string: The Azure API version of the resource.
geoReplicatedPrimaryHostName string: The unchanging DNS name which will always point to current geo-primary cache among the linked redis caches for seamless Geo Failover experience.
id string: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
linkedRedisCacheId string: Fully qualified resourceId of the linked redis cache.
linkedRedisCacheLocation string: Location of the linked redis cache.
name string: The name of the resource
primaryHostName string: The changing DNS name that resolves to the current geo-primary cache among the linked redis caches before or after the Geo Failover.
provisioningState string: Terminal state of the link between primary and secondary redis cache.
serverRole string: Role of the linked server.
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

azure_api_version str: The Azure API version of the resource.
geo_replicated_primary_host_name str: The unchanging DNS name which will always point to current geo-primary cache among the linked redis caches for seamless Geo Failover experience.
id str: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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: The name of the resource
primary_host_name str: The changing DNS name that resolves to the current geo-primary cache among the linked redis caches before or after the Geo Failover.
provisioning_state str: Terminal state of the link between primary and secondary redis cache.
server_role str: Role of the linked server.
system_data SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

azureApiVersion String: The Azure API version of the resource.
geoReplicatedPrimaryHostName String: The unchanging DNS name which will always point to current geo-primary cache among the linked redis caches for seamless Geo Failover experience.
id String: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
linkedRedisCacheId String: Fully qualified resourceId of the linked redis cache.
linkedRedisCacheLocation String: Location of the linked redis cache.
name String: The name of the resource
primaryHostName String: The changing DNS name that resolves to the current geo-primary cache among the linked redis caches before or after the Geo Failover.
provisioningState String: Terminal state of the link between primary and secondary redis cache.
serverRole String: Role of the linked server.
systemData Property Map: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

SystemDataResponse

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

createdAt string: The timestamp of resource creation (UTC).
createdBy string: The identity that created the resource.
createdByType string: The type of identity that created the resource.
lastModifiedAt string: The timestamp of resource last modification (UTC)
lastModifiedBy string: The identity that last modified the resource.
lastModifiedByType string: The type of identity that last modified the resource.

created_at str: The timestamp of resource creation (UTC).
created_by str: The identity that created the resource.
created_by_type str: The type of identity that created the resource.
last_modified_at str: The timestamp of resource last modification (UTC)
last_modified_by str: The identity that last modified the resource.
last_modified_by_type str: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.