Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. redis
  5. getLinkedServer
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.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.redis.getLinkedServer

Explore with Pulumi AI

azure-native logo
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.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

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

    Uses Azure REST API version 2024-11-01.

    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 linked server.
    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 linked server.
    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 linked server.
    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 linked server.
    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 linked server.
    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 linked server.
    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. Ex - /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.
    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. Ex - /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.
    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. Ex - /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.
    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. Ex - /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.
    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. Ex - /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.
    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. Ex - /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.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    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.3.0 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-azure-native