Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Azure Native
  4. API Docs
  5. horizondb
  6. getHorizonDbCluster
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.getHorizonDbCluster

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

    Gets information about a HorizonDB cluster.

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

    Using getHorizonDbCluster

    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 getHorizonDbCluster(args: GetHorizonDbClusterArgs, opts?: InvokeOptions): Promise<GetHorizonDbClusterResult>
function getHorizonDbClusterOutput(args: GetHorizonDbClusterOutputArgs, opts?: InvokeOptions): Output<GetHorizonDbClusterResult>
    def get_horizon_db_cluster(cluster_name: Optional[str] = None,
                           resource_group_name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetHorizonDbClusterResult
def get_horizon_db_cluster_output(cluster_name: pulumi.Input[Optional[str]] = None,
                           resource_group_name: pulumi.Input[Optional[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetHorizonDbClusterResult]
    func LookupHorizonDbCluster(ctx *Context, args *LookupHorizonDbClusterArgs, opts ...InvokeOption) (*LookupHorizonDbClusterResult, error)
func LookupHorizonDbClusterOutput(ctx *Context, args *LookupHorizonDbClusterOutputArgs, opts ...InvokeOption) LookupHorizonDbClusterResultOutput

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

    public static class GetHorizonDbCluster 
{
    public static Task<GetHorizonDbClusterResult> InvokeAsync(GetHorizonDbClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetHorizonDbClusterResult> Invoke(GetHorizonDbClusterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetHorizonDbClusterResult> getHorizonDbCluster(GetHorizonDbClusterArgs args, InvokeOptions options)
public static Output<GetHorizonDbClusterResult> getHorizonDbCluster(GetHorizonDbClusterArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:horizondb:getHorizonDbCluster
  arguments:
    # arguments dictionary
    data "azure-native_horizondb_get_horizon_db_cluster" "name" {
    # arguments
}

    The following arguments are supported:

    ClusterName string
    The name of the HorizonDB cluster.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ClusterName string
    The name of the HorizonDB cluster.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    cluster_name string
    The name of the HorizonDB cluster.
    resource_group_name string
    The name of the resource group. The name is case insensitive.
    clusterName String
    The name of the HorizonDB cluster.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    clusterName string
    The name of the HorizonDB cluster.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    cluster_name str
    The name of the HorizonDB cluster.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    clusterName String
    The name of the HorizonDB cluster.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getHorizonDbCluster 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}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.HorizonDb.Outputs.HorizonDbClusterPropertiesResponse
    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"
    Tags Dictionary<string, string>
    Resource tags.
    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}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties HorizonDbClusterPropertiesResponse
    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"
    Tags map[string]string
    Resource tags.
    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}"
    location string
    The geo-location where the resource lives
    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"
    tags map(string)
    Resource tags.
    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}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties HorizonDbClusterPropertiesResponse
    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"
    tags Map<String,String>
    Resource tags.
    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}"
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    properties HorizonDbClusterPropertiesResponse
    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"
    tags {[key: string]: string}
    Resource tags.
    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}"
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    properties HorizonDbClusterPropertiesResponse
    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"
    tags Mapping[str, str]
    Resource tags.
    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}"
    location String
    The geo-location where the resource lives
    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"
    tags Map<String>
    Resource tags.

    Supporting Types

    HorizonDbClusterParameterGroupConnectionPropertiesResponse

    SyncStatus string
    Indication of if parameter group is applied on HorizonDB resource.
    ApplyImmediately bool
    Indicates whether the parameters should be applied immediately.
    Id string
    The resource ID of the connected parameter group.
    SyncStatus string
    Indication of if parameter group is applied on HorizonDB resource.
    ApplyImmediately bool
    Indicates whether the parameters should be applied immediately.
    Id string
    The resource ID of the connected parameter group.
    sync_status string
    Indication of if parameter group is applied on HorizonDB resource.
    apply_immediately bool
    Indicates whether the parameters should be applied immediately.
    id string
    The resource ID of the connected parameter group.
    syncStatus String
    Indication of if parameter group is applied on HorizonDB resource.
    applyImmediately Boolean
    Indicates whether the parameters should be applied immediately.
    id String
    The resource ID of the connected parameter group.
    syncStatus string
    Indication of if parameter group is applied on HorizonDB resource.
    applyImmediately boolean
    Indicates whether the parameters should be applied immediately.
    id string
    The resource ID of the connected parameter group.
    sync_status str
    Indication of if parameter group is applied on HorizonDB resource.
    apply_immediately bool
    Indicates whether the parameters should be applied immediately.
    id str
    The resource ID of the connected parameter group.
    syncStatus String
    Indication of if parameter group is applied on HorizonDB resource.
    applyImmediately Boolean
    Indicates whether the parameters should be applied immediately.
    id String
    The resource ID of the connected parameter group.

    HorizonDbClusterPropertiesResponse

    AdministratorLogin string
    The administrator login name.
    FullyQualifiedDomainName string
    The fully qualified domain name of the cluster.
    ProvisioningState string
    The provisioning state of the cluster.
    ReadonlyEndpoint string
    The fully qualified domain name used for readonly endpoint for the cluster.
    State string
    Current state of the cluster.
    CreateMode string
    The mode to create a new HorizonDB cluster.
    Network Pulumi.AzureNative.HorizonDb.Inputs.NetworkResponse
    The network related info.
    ParameterGroup Pulumi.AzureNative.HorizonDb.Inputs.HorizonDbClusterParameterGroupConnectionPropertiesResponse
    Defines connection to a parameter group.
    PointInTimeUTC string
    Restore point creation time specifying the time to restore from.
    PoolName string
    The pool name for restore or replica operations.
    ProcessorType string
    The processor type for the HorizonDB cluster.
    ReplicaCount int
    Number of replicas.
    SourceClusterResourceId string
    The source cluster resource ID for restore or replica creation.
    VCores int
    Number of vCores.
    Version string
    The version of the HorizonDB cluster.
    ZonePlacementPolicy string
    Defines how replicas are placed across availability zones.
    AdministratorLogin string
    The administrator login name.
    FullyQualifiedDomainName string
    The fully qualified domain name of the cluster.
    ProvisioningState string
    The provisioning state of the cluster.
    ReadonlyEndpoint string
    The fully qualified domain name used for readonly endpoint for the cluster.
    State string
    Current state of the cluster.
    CreateMode string
    The mode to create a new HorizonDB cluster.
    Network NetworkResponse
    The network related info.
    ParameterGroup HorizonDbClusterParameterGroupConnectionPropertiesResponse
    Defines connection to a parameter group.
    PointInTimeUTC string
    Restore point creation time specifying the time to restore from.
    PoolName string
    The pool name for restore or replica operations.
    ProcessorType string
    The processor type for the HorizonDB cluster.
    ReplicaCount int
    Number of replicas.
    SourceClusterResourceId string
    The source cluster resource ID for restore or replica creation.
    VCores int
    Number of vCores.
    Version string
    The version of the HorizonDB cluster.
    ZonePlacementPolicy string
    Defines how replicas are placed across availability zones.
    administrator_login string
    The administrator login name.
    fully_qualified_domain_name string
    The fully qualified domain name of the cluster.
    provisioning_state string
    The provisioning state of the cluster.
    readonly_endpoint string
    The fully qualified domain name used for readonly endpoint for the cluster.
    state string
    Current state of the cluster.
    create_mode string
    The mode to create a new HorizonDB cluster.
    network object
    The network related info.
    parameter_group object
    Defines connection to a parameter group.
    point_in_time_utc string
    Restore point creation time specifying the time to restore from.
    pool_name string
    The pool name for restore or replica operations.
    processor_type string
    The processor type for the HorizonDB cluster.
    replica_count number
    Number of replicas.
    source_cluster_resource_id string
    The source cluster resource ID for restore or replica creation.
    v_cores number
    Number of vCores.
    version string
    The version of the HorizonDB cluster.
    zone_placement_policy string
    Defines how replicas are placed across availability zones.
    administratorLogin String
    The administrator login name.
    fullyQualifiedDomainName String
    The fully qualified domain name of the cluster.
    provisioningState String
    The provisioning state of the cluster.
    readonlyEndpoint String
    The fully qualified domain name used for readonly endpoint for the cluster.
    state String
    Current state of the cluster.
    createMode String
    The mode to create a new HorizonDB cluster.
    network NetworkResponse
    The network related info.
    parameterGroup HorizonDbClusterParameterGroupConnectionPropertiesResponse
    Defines connection to a parameter group.
    pointInTimeUTC String
    Restore point creation time specifying the time to restore from.
    poolName String
    The pool name for restore or replica operations.
    processorType String
    The processor type for the HorizonDB cluster.
    replicaCount Integer
    Number of replicas.
    sourceClusterResourceId String
    The source cluster resource ID for restore or replica creation.
    vCores Integer
    Number of vCores.
    version String
    The version of the HorizonDB cluster.
    zonePlacementPolicy String
    Defines how replicas are placed across availability zones.
    administratorLogin string
    The administrator login name.
    fullyQualifiedDomainName string
    The fully qualified domain name of the cluster.
    provisioningState string
    The provisioning state of the cluster.
    readonlyEndpoint string
    The fully qualified domain name used for readonly endpoint for the cluster.
    state string
    Current state of the cluster.
    createMode string
    The mode to create a new HorizonDB cluster.
    network NetworkResponse
    The network related info.
    parameterGroup HorizonDbClusterParameterGroupConnectionPropertiesResponse
    Defines connection to a parameter group.
    pointInTimeUTC string
    Restore point creation time specifying the time to restore from.
    poolName string
    The pool name for restore or replica operations.
    processorType string
    The processor type for the HorizonDB cluster.
    replicaCount number
    Number of replicas.
    sourceClusterResourceId string
    The source cluster resource ID for restore or replica creation.
    vCores number
    Number of vCores.
    version string
    The version of the HorizonDB cluster.
    zonePlacementPolicy string
    Defines how replicas are placed across availability zones.
    administrator_login str
    The administrator login name.
    fully_qualified_domain_name str
    The fully qualified domain name of the cluster.
    provisioning_state str
    The provisioning state of the cluster.
    readonly_endpoint str
    The fully qualified domain name used for readonly endpoint for the cluster.
    state str
    Current state of the cluster.
    create_mode str
    The mode to create a new HorizonDB cluster.
    network NetworkResponse
    The network related info.
    parameter_group HorizonDbClusterParameterGroupConnectionPropertiesResponse
    Defines connection to a parameter group.
    point_in_time_utc str
    Restore point creation time specifying the time to restore from.
    pool_name str
    The pool name for restore or replica operations.
    processor_type str
    The processor type for the HorizonDB cluster.
    replica_count int
    Number of replicas.
    source_cluster_resource_id str
    The source cluster resource ID for restore or replica creation.
    v_cores int
    Number of vCores.
    version str
    The version of the HorizonDB cluster.
    zone_placement_policy str
    Defines how replicas are placed across availability zones.
    administratorLogin String
    The administrator login name.
    fullyQualifiedDomainName String
    The fully qualified domain name of the cluster.
    provisioningState String
    The provisioning state of the cluster.
    readonlyEndpoint String
    The fully qualified domain name used for readonly endpoint for the cluster.
    state String
    Current state of the cluster.
    createMode String
    The mode to create a new HorizonDB cluster.
    network Property Map
    The network related info.
    parameterGroup Property Map
    Defines connection to a parameter group.
    pointInTimeUTC String
    Restore point creation time specifying the time to restore from.
    poolName String
    The pool name for restore or replica operations.
    processorType String
    The processor type for the HorizonDB cluster.
    replicaCount Number
    Number of replicas.
    sourceClusterResourceId String
    The source cluster resource ID for restore or replica creation.
    vCores Number
    Number of vCores.
    version String
    The version of the HorizonDB cluster.
    zonePlacementPolicy String
    Defines how replicas are placed across availability zones.

    NetworkResponse

    PublicNetworkAccess string
    The flag indicating whether public ip is requested.
    PublicNetworkAccess string
    The flag indicating whether public ip is requested.
    public_network_access string
    The flag indicating whether public ip is requested.
    publicNetworkAccess String
    The flag indicating whether public ip is requested.
    publicNetworkAccess string
    The flag indicating whether public ip is requested.
    public_network_access str
    The flag indicating whether public ip is requested.
    publicNetworkAccess String
    The flag indicating whether public ip is requested.

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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial