1. Packages
  2. Packages
  3. Azure Native
  4. API Docs
  5. horizondb
  6. getHorizonDbReplica
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.23.0
published on Saturday, Jul 18, 2026 by Pulumi
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.
Viewing docs for Azure Native v3.23.0
published on Saturday, Jul 18, 2026 by Pulumi

    Gets information about a HorizonDB replica.

    Uses Azure REST API version 2026-01-20-preview.

    Using getHorizonDbReplica

    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 getHorizonDbReplica(args: GetHorizonDbReplicaArgs, opts?: InvokeOptions): Promise<GetHorizonDbReplicaResult>
    function getHorizonDbReplicaOutput(args: GetHorizonDbReplicaOutputArgs, opts?: InvokeOptions): Output<GetHorizonDbReplicaResult>
    def get_horizon_db_replica(cluster_name: Optional[str] = None,
                               pool_name: Optional[str] = None,
                               replica_name: Optional[str] = None,
                               resource_group_name: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetHorizonDbReplicaResult
    def get_horizon_db_replica_output(cluster_name: pulumi.Input[Optional[str]] = None,
                               pool_name: pulumi.Input[Optional[str]] = None,
                               replica_name: pulumi.Input[Optional[str]] = None,
                               resource_group_name: pulumi.Input[Optional[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetHorizonDbReplicaResult]
    func LookupHorizonDbReplica(ctx *Context, args *LookupHorizonDbReplicaArgs, opts ...InvokeOption) (*LookupHorizonDbReplicaResult, error)
    func LookupHorizonDbReplicaOutput(ctx *Context, args *LookupHorizonDbReplicaOutputArgs, opts ...InvokeOption) LookupHorizonDbReplicaResultOutput

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

    public static class GetHorizonDbReplica 
    {
        public static Task<GetHorizonDbReplicaResult> InvokeAsync(GetHorizonDbReplicaArgs args, InvokeOptions? opts = null)
        public static Output<GetHorizonDbReplicaResult> Invoke(GetHorizonDbReplicaInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetHorizonDbReplicaResult> getHorizonDbReplica(GetHorizonDbReplicaArgs args, InvokeOptions options)
    public static Output<GetHorizonDbReplicaResult> getHorizonDbReplica(GetHorizonDbReplicaArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:horizondb:getHorizonDbReplica
      arguments:
        # arguments dictionary
    data "azure-native_horizondb_get_horizon_db_replica" "name" {
        # arguments
    }

    The following arguments are supported:

    ClusterName string
    The name of the HorizonDB cluster.
    PoolName string
    The name of the HorizonDB pool.
    ReplicaName string
    The name of the HorizonDB replica.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ClusterName string
    The name of the HorizonDB cluster.
    PoolName string
    The name of the HorizonDB pool.
    ReplicaName string
    The name of the HorizonDB replica.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    cluster_name string
    The name of the HorizonDB cluster.
    pool_name string
    The name of the HorizonDB pool.
    replica_name string
    The name of the HorizonDB replica.
    resource_group_name string
    The name of the resource group. The name is case insensitive.
    clusterName String
    The name of the HorizonDB cluster.
    poolName String
    The name of the HorizonDB pool.
    replicaName String
    The name of the HorizonDB replica.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    clusterName string
    The name of the HorizonDB cluster.
    poolName string
    The name of the HorizonDB pool.
    replicaName string
    The name of the HorizonDB replica.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    cluster_name str
    The name of the HorizonDB cluster.
    pool_name str
    The name of the HorizonDB pool.
    replica_name str
    The name of the HorizonDB replica.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    clusterName String
    The name of the HorizonDB cluster.
    poolName String
    The name of the HorizonDB pool.
    replicaName String
    The name of the HorizonDB replica.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getHorizonDbReplica Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.HorizonDb.Outputs.HorizonDbReplicaPropertiesResponse
    The resource-specific properties for this resource.
    SystemData Pulumi.AzureNative.HorizonDb.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.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    Properties HorizonDbReplicaPropertiesResponse
    The resource-specific properties for this resource.
    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 string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    properties object
    The resource-specific properties for this resource.
    system_data object
    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.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    properties HorizonDbReplicaPropertiesResponse
    The resource-specific properties for this resource.
    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.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    properties HorizonDbReplicaPropertiesResponse
    The resource-specific properties for this resource.
    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.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name str
    The name of the resource
    properties HorizonDbReplicaPropertiesResponse
    The resource-specific properties for this resource.
    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.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    properties Property Map
    The resource-specific properties for this resource.
    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

    HorizonDbReplicaPropertiesResponse

    FullyQualifiedDomainName string
    The fully qualified domain name of the replica.
    ProvisioningState string
    The provisioning state of the replica.
    Status string
    Current status of the replica.
    AvailabilityZone string
    The availability zone of the replica.
    Role string
    Role of the replica.
    FullyQualifiedDomainName string
    The fully qualified domain name of the replica.
    ProvisioningState string
    The provisioning state of the replica.
    Status string
    Current status of the replica.
    AvailabilityZone string
    The availability zone of the replica.
    Role string
    Role of the replica.
    fully_qualified_domain_name string
    The fully qualified domain name of the replica.
    provisioning_state string
    The provisioning state of the replica.
    status string
    Current status of the replica.
    availability_zone string
    The availability zone of the replica.
    role string
    Role of the replica.
    fullyQualifiedDomainName String
    The fully qualified domain name of the replica.
    provisioningState String
    The provisioning state of the replica.
    status String
    Current status of the replica.
    availabilityZone String
    The availability zone of the replica.
    role String
    Role of the replica.
    fullyQualifiedDomainName string
    The fully qualified domain name of the replica.
    provisioningState string
    The provisioning state of the replica.
    status string
    Current status of the replica.
    availabilityZone string
    The availability zone of the replica.
    role string
    Role of the replica.
    fully_qualified_domain_name str
    The fully qualified domain name of the replica.
    provisioning_state str
    The provisioning state of the replica.
    status str
    Current status of the replica.
    availability_zone str
    The availability zone of the replica.
    role str
    Role of the replica.
    fullyQualifiedDomainName String
    The fully qualified domain name of the replica.
    provisioningState String
    The provisioning state of the replica.
    status String
    Current status of the replica.
    availabilityZone String
    The availability zone of the replica.
    role String
    Role of the replica.

    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.
    created_at string
    The timestamp of resource creation (UTC).
    created_by string
    The identity that created the resource.
    created_by_type string
    The type of identity that created the resource.
    last_modified_at string
    The timestamp of resource last modification (UTC)
    last_modified_by string
    The identity that last modified the resource.
    last_modified_by_type 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.

    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.
    Viewing docs for Azure Native v3.23.0
    published on Saturday, Jul 18, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial