Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Azure Native
  4. API Docs
  5. horizondb
  6. HorizonDbReplica
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
Schema (JSON)
pulumi/pulumi-azure-native

azure-native.horizondb.HorizonDbReplica

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
Schema (JSON)
pulumi/pulumi-azure-native

    Represents the HorizonDB replica.

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

    Example Usage

    Create or update a HorizonDB replica

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var horizonDbReplica = new AzureNative.HorizonDb.HorizonDbReplica("horizonDbReplica", new()
    {
        ClusterName = "examplecluster",
        PoolName = "examplepool",
        Properties = new AzureNative.HorizonDb.Inputs.HorizonDbReplicaPropertiesArgs
        {
            AvailabilityZone = "1",
            Role = AzureNative.HorizonDb.ReplicaRole.Read,
        },
        ReplicaName = "examplereplica",
        ResourceGroupName = "exampleresourcegroup",
    });

});

    package main

import (
	horizondb "github.com/pulumi/pulumi-azure-native-sdk/horizondb/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := horizondb.NewHorizonDbReplica(ctx, "horizonDbReplica", &horizondb.HorizonDbReplicaArgs{
			ClusterName: pulumi.String("examplecluster"),
			PoolName:    pulumi.String("examplepool"),
			Properties: &horizondb.HorizonDbReplicaPropertiesArgs{
				AvailabilityZone: pulumi.String("1"),
				Role:             pulumi.String(horizondb.ReplicaRoleRead),
			},
			ReplicaName:       pulumi.String("examplereplica"),
			ResourceGroupName: pulumi.String("exampleresourcegroup"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    pulumi {
  required_providers {
    azure-native = {
      source = "pulumi/azure-native"
    }
  }
}

resource "azure-native_horizondb_horizondbreplica" "horizonDbReplica" {
  cluster_name = "examplecluster"
  pool_name    = "examplepool"
  properties = {
    availability_zone = "1"
    role              = "Read"
  }
  replica_name        = "examplereplica"
  resource_group_name = "exampleresourcegroup"
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.horizondb.HorizonDbReplica;
import com.pulumi.azurenative.horizondb.HorizonDbReplicaArgs;
import com.pulumi.azurenative.horizondb.inputs.HorizonDbReplicaPropertiesArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var horizonDbReplica = new HorizonDbReplica("horizonDbReplica", HorizonDbReplicaArgs.builder()
            .clusterName("examplecluster")
            .poolName("examplepool")
            .properties(HorizonDbReplicaPropertiesArgs.builder()
                .availabilityZone("1")
                .role("Read")
                .build())
            .replicaName("examplereplica")
            .resourceGroupName("exampleresourcegroup")
            .build());

    }
}

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const horizonDbReplica = new azure_native.horizondb.HorizonDbReplica("horizonDbReplica", {
    clusterName: "examplecluster",
    poolName: "examplepool",
    properties: {
        availabilityZone: "1",
        role: azure_native.horizondb.ReplicaRole.Read,
    },
    replicaName: "examplereplica",
    resourceGroupName: "exampleresourcegroup",
});

    import pulumi
import pulumi_azure_native as azure_native

horizon_db_replica = azure_native.horizondb.HorizonDbReplica("horizonDbReplica",
    cluster_name="examplecluster",
    pool_name="examplepool",
    properties={
        "availability_zone": "1",
        "role": azure_native.horizondb.ReplicaRole.READ,
    },
    replica_name="examplereplica",
    resource_group_name="exampleresourcegroup")

    resources:
  horizonDbReplica:
    type: azure-native:horizondb:HorizonDbReplica
    properties:
      clusterName: examplecluster
      poolName: examplepool
      properties:
        availabilityZone: '1'
        role: Read
      replicaName: examplereplica
      resourceGroupName: exampleresourcegroup

    Create HorizonDbReplica Resource

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

    Constructor syntax

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

@overload
def HorizonDbReplica(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     cluster_name: Optional[str] = None,
                     pool_name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     properties: Optional[HorizonDbReplicaPropertiesArgs] = None,
                     replica_name: Optional[str] = None)
    func NewHorizonDbReplica(ctx *Context, name string, args HorizonDbReplicaArgs, opts ...ResourceOption) (*HorizonDbReplica, error)
    public HorizonDbReplica(string name, HorizonDbReplicaArgs args, CustomResourceOptions? opts = null)
    public HorizonDbReplica(String name, HorizonDbReplicaArgs args)
public HorizonDbReplica(String name, HorizonDbReplicaArgs args, CustomResourceOptions options)

    type: azure-native:horizondb:HorizonDbReplica
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "azure-native_horizondb_horizon_db_replica" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args HorizonDbReplicaArgs
    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 HorizonDbReplicaArgs
    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 HorizonDbReplicaArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HorizonDbReplicaArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HorizonDbReplicaArgs
    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 horizonDbReplicaResource = new AzureNative.HorizonDb.HorizonDbReplica("horizonDbReplicaResource", new()
{
    ClusterName = "string",
    PoolName = "string",
    ResourceGroupName = "string",
    Properties = new AzureNative.HorizonDb.Inputs.HorizonDbReplicaPropertiesArgs
    {
        AvailabilityZone = "string",
        Role = "string",
    },
    ReplicaName = "string",
});

    example, err := horizondb.NewHorizonDbReplica(ctx, "horizonDbReplicaResource", &horizondb.HorizonDbReplicaArgs{
	ClusterName:       pulumi.String("string"),
	PoolName:          pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	Properties: &horizondb.HorizonDbReplicaPropertiesArgs{
		AvailabilityZone: pulumi.String("string"),
		Role:             pulumi.String("string"),
	},
	ReplicaName: pulumi.String("string"),
})

    resource "azure-native_horizondb_horizon_db_replica" "horizonDbReplicaResource" {
  lifecycle {
    create_before_destroy = true
  }
  cluster_name        = "string"
  pool_name           = "string"
  resource_group_name = "string"
  properties = {
    availability_zone = "string"
    role              = "string"
  }
  replica_name = "string"
}

    var horizonDbReplicaResource = new HorizonDbReplica("horizonDbReplicaResource", HorizonDbReplicaArgs.builder()
    .clusterName("string")
    .poolName("string")
    .resourceGroupName("string")
    .properties(HorizonDbReplicaPropertiesArgs.builder()
        .availabilityZone("string")
        .role("string")
        .build())
    .replicaName("string")
    .build());

    horizon_db_replica_resource = azure_native.horizondb.HorizonDbReplica("horizonDbReplicaResource",
    cluster_name="string",
    pool_name="string",
    resource_group_name="string",
    properties={
        "availability_zone": "string",
        "role": "string",
    },
    replica_name="string")

    const horizonDbReplicaResource = new azure_native.horizondb.HorizonDbReplica("horizonDbReplicaResource", {
    clusterName: "string",
    poolName: "string",
    resourceGroupName: "string",
    properties: {
        availabilityZone: "string",
        role: "string",
    },
    replicaName: "string",
});

    type: azure-native:horizondb:HorizonDbReplica
properties:
    clusterName: string
    poolName: string
    properties:
        availabilityZone: string
        role: string
    replicaName: string
    resourceGroupName: string

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

    ClusterName string
    The name of the HorizonDB cluster.
    PoolName string
    The name of the HorizonDB pool.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    Properties Pulumi.AzureNative.HorizonDb.Inputs.HorizonDbReplicaProperties
    The resource-specific properties for this resource.
    ReplicaName string
    The name of the HorizonDB replica.
    ClusterName string
    The name of the HorizonDB cluster.
    PoolName string
    The name of the HorizonDB pool.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    Properties HorizonDbReplicaPropertiesArgs
    The resource-specific properties for this resource.
    ReplicaName string
    The name of the HorizonDB replica.
    cluster_name string
    The name of the HorizonDB cluster.
    pool_name string
    The name of the HorizonDB pool.
    resource_group_name string
    The name of the resource group. The name is case insensitive.
    properties object
    The resource-specific properties for this resource.
    replica_name string
    The name of the HorizonDB replica.
    clusterName String
    The name of the HorizonDB cluster.
    poolName String
    The name of the HorizonDB pool.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    properties HorizonDbReplicaProperties
    The resource-specific properties for this resource.
    replicaName String
    The name of the HorizonDB replica.
    clusterName string
    The name of the HorizonDB cluster.
    poolName string
    The name of the HorizonDB pool.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    properties HorizonDbReplicaProperties
    The resource-specific properties for this resource.
    replicaName string
    The name of the HorizonDB replica.
    cluster_name str
    The name of the HorizonDB cluster.
    pool_name str
    The name of the HorizonDB pool.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    properties HorizonDbReplicaPropertiesArgs
    The resource-specific properties for this resource.
    replica_name str
    The name of the HorizonDB replica.
    clusterName String
    The name of the HorizonDB cluster.
    poolName String
    The name of the HorizonDB pool.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    properties Property Map
    The resource-specific properties for this resource.
    replicaName String
    The name of the HorizonDB replica.

    Outputs

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

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the 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
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the 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
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the 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
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the 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
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the 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
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the 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
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the 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

    HorizonDbReplicaProperties, HorizonDbReplicaPropertiesArgs

    Properties of a HorizonDB replica.
    AvailabilityZone string
    The availability zone of the replica.
    Role string | Pulumi.AzureNative.HorizonDb.ReplicaRole
    Role of the replica.
    AvailabilityZone string
    The availability zone of the replica.
    Role string | ReplicaRole
    Role of the replica.
    availability_zone string
    The availability zone of the replica.
    role string | "Read" | "ReadWrite"
    Role of the replica.
    availabilityZone String
    The availability zone of the replica.
    role String | ReplicaRole
    Role of the replica.
    availabilityZone string
    The availability zone of the replica.
    role string | ReplicaRole
    Role of the replica.
    availability_zone str
    The availability zone of the replica.
    role str | ReplicaRole
    Role of the replica.
    availabilityZone String
    The availability zone of the replica.
    role String | "Read" | "ReadWrite"
    Role of the replica.

    HorizonDbReplicaPropertiesResponse, HorizonDbReplicaPropertiesResponseArgs

    Properties of a HorizonDB 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 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.

    ReplicaRole, ReplicaRoleArgs

    Read
    Read Read-only replica
    ReadWrite
    ReadWrite ReadWrite replica
    ReplicaRoleRead
    Read Read-only replica
    ReplicaRoleReadWrite
    ReadWrite ReadWrite replica
    "Read"
    Read Read-only replica
    "ReadWrite"
    ReadWrite ReadWrite replica
    Read
    Read Read-only replica
    ReadWrite
    ReadWrite ReadWrite replica
    Read
    Read Read-only replica
    ReadWrite
    ReadWrite ReadWrite replica
    READ
    Read Read-only replica
    READ_WRITE
    ReadWrite ReadWrite replica
    "Read"
    Read Read-only replica
    "ReadWrite"
    ReadWrite ReadWrite replica

    SystemDataResponse, SystemDataResponseArgs

    Metadata pertaining to creation and last modification of 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 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.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:horizondb:HorizonDbReplica examplereplica /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HorizonDb/clusters/{clusterName}/pools/{poolName}/replicas/{replicaName}

    To learn more about importing existing cloud resources, see Importing resources.

    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
    Schema (JSON)
    pulumi/pulumi-azure-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial