We recommend using Azure Native.
Azure v6.28.0 published on Friday, Oct 3, 2025 by Pulumi
azure.stack.getHciCluster
Use this data source to access information about an existing Azure Stack HCI Cluster instance.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = azure.stack.getHciCluster({
    name: "existing",
    resourceGroupName: "existing",
});
export const id = example.then(example => example.id);
export const location = example.then(example => example.location);
export const clientId = example.then(example => example.clientId);
import pulumi
import pulumi_azure as azure
example = azure.stack.get_hci_cluster(name="existing",
    resource_group_name="existing")
pulumi.export("id", example.id)
pulumi.export("location", example.location)
pulumi.export("clientId", example.client_id)
package main
import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/stack"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := stack.LookupHciCluster(ctx, &stack.LookupHciClusterArgs{
			Name:              "existing",
			ResourceGroupName: "existing",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("id", example.Id)
		ctx.Export("location", example.Location)
		ctx.Export("clientId", example.ClientId)
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() => 
{
    var example = Azure.Stack.GetHciCluster.Invoke(new()
    {
        Name = "existing",
        ResourceGroupName = "existing",
    });
    return new Dictionary<string, object?>
    {
        ["id"] = example.Apply(getHciClusterResult => getHciClusterResult.Id),
        ["location"] = example.Apply(getHciClusterResult => getHciClusterResult.Location),
        ["clientId"] = example.Apply(getHciClusterResult => getHciClusterResult.ClientId),
    };
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.stack.StackFunctions;
import com.pulumi.azure.stack.inputs.GetHciClusterArgs;
import java.util.List;
import java.util.ArrayList;
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) {
        final var example = StackFunctions.getHciCluster(GetHciClusterArgs.builder()
            .name("existing")
            .resourceGroupName("existing")
            .build());
        ctx.export("id", example.id());
        ctx.export("location", example.location());
        ctx.export("clientId", example.clientId());
    }
}
variables:
  example:
    fn::invoke:
      function: azure:stack:getHciCluster
      arguments:
        name: existing
        resourceGroupName: existing
outputs:
  id: ${example.id}
  location: ${example.location}
  clientId: ${example.clientId}
API Providers
This data source uses the following Azure API Providers:
- Microsoft.AzureStackHCI- 2024-01-01, 2022-05-04
Using getHciCluster
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 getHciCluster(args: GetHciClusterArgs, opts?: InvokeOptions): Promise<GetHciClusterResult>
function getHciClusterOutput(args: GetHciClusterOutputArgs, opts?: InvokeOptions): Output<GetHciClusterResult>def get_hci_cluster(name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetHciClusterResult
def get_hci_cluster_output(name: Optional[pulumi.Input[str]] = None,
                    resource_group_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetHciClusterResult]func LookupHciCluster(ctx *Context, args *LookupHciClusterArgs, opts ...InvokeOption) (*LookupHciClusterResult, error)
func LookupHciClusterOutput(ctx *Context, args *LookupHciClusterOutputArgs, opts ...InvokeOption) LookupHciClusterResultOutput> Note: This function is named LookupHciCluster in the Go SDK.
public static class GetHciCluster 
{
    public static Task<GetHciClusterResult> InvokeAsync(GetHciClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetHciClusterResult> Invoke(GetHciClusterInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetHciClusterResult> getHciCluster(GetHciClusterArgs args, InvokeOptions options)
public static Output<GetHciClusterResult> getHciCluster(GetHciClusterArgs args, InvokeOptions options)
fn::invoke:
  function: azure:stack/getHciCluster:getHciCluster
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Name string
- The name of the Azure Stack HCI Cluster.
- ResourceGroup stringName 
- The name of the Resource Group where the Azure Stack HCI Cluster exists.
- Name string
- The name of the Azure Stack HCI Cluster.
- ResourceGroup stringName 
- The name of the Resource Group where the Azure Stack HCI Cluster exists.
- name String
- The name of the Azure Stack HCI Cluster.
- resourceGroup StringName 
- The name of the Resource Group where the Azure Stack HCI Cluster exists.
- name string
- The name of the Azure Stack HCI Cluster.
- resourceGroup stringName 
- The name of the Resource Group where the Azure Stack HCI Cluster exists.
- name str
- The name of the Azure Stack HCI Cluster.
- resource_group_ strname 
- The name of the Resource Group where the Azure Stack HCI Cluster exists.
- name String
- The name of the Azure Stack HCI Cluster.
- resourceGroup StringName 
- The name of the Resource Group where the Azure Stack HCI Cluster exists.
getHciCluster Result
The following output properties are available:
- AutomanageConfiguration stringId 
- The ID of the Automanage Configuration assigned to the Azure Stack HCI Cluster.
- ClientId string
- The Client ID of the Azure Active Directory used by the Azure Stack HCI Cluster.
- CloudId string
- An immutable UUID for the Azure Stack HCI Cluster.
- Id string
- The provider-assigned unique ID for this managed resource.
- Identities
List<GetHci Cluster Identity> 
- An identityblock as defined below.
- Location string
- The Azure Region where the Azure Stack HCI Cluster exists.
- Name string
- ResourceGroup stringName 
- ResourceProvider stringObject Id 
- The object ID of the Resource Provider Service Principal.
- ServiceEndpoint string
- The region specific Data Path Endpoint of the Azure Stack HCI Cluster.
- Dictionary<string, string>
- A mapping of tags assigned to the Azure Stack HCI Cluster.
- TenantId string
- The Tenant ID associated with this Managed Service Identity.
- AutomanageConfiguration stringId 
- The ID of the Automanage Configuration assigned to the Azure Stack HCI Cluster.
- ClientId string
- The Client ID of the Azure Active Directory used by the Azure Stack HCI Cluster.
- CloudId string
- An immutable UUID for the Azure Stack HCI Cluster.
- Id string
- The provider-assigned unique ID for this managed resource.
- Identities
[]GetHci Cluster Identity 
- An identityblock as defined below.
- Location string
- The Azure Region where the Azure Stack HCI Cluster exists.
- Name string
- ResourceGroup stringName 
- ResourceProvider stringObject Id 
- The object ID of the Resource Provider Service Principal.
- ServiceEndpoint string
- The region specific Data Path Endpoint of the Azure Stack HCI Cluster.
- map[string]string
- A mapping of tags assigned to the Azure Stack HCI Cluster.
- TenantId string
- The Tenant ID associated with this Managed Service Identity.
- automanageConfiguration StringId 
- The ID of the Automanage Configuration assigned to the Azure Stack HCI Cluster.
- clientId String
- The Client ID of the Azure Active Directory used by the Azure Stack HCI Cluster.
- cloudId String
- An immutable UUID for the Azure Stack HCI Cluster.
- id String
- The provider-assigned unique ID for this managed resource.
- identities
List<GetHci Cluster Identity> 
- An identityblock as defined below.
- location String
- The Azure Region where the Azure Stack HCI Cluster exists.
- name String
- resourceGroup StringName 
- resourceProvider StringObject Id 
- The object ID of the Resource Provider Service Principal.
- serviceEndpoint String
- The region specific Data Path Endpoint of the Azure Stack HCI Cluster.
- Map<String,String>
- A mapping of tags assigned to the Azure Stack HCI Cluster.
- tenantId String
- The Tenant ID associated with this Managed Service Identity.
- automanageConfiguration stringId 
- The ID of the Automanage Configuration assigned to the Azure Stack HCI Cluster.
- clientId string
- The Client ID of the Azure Active Directory used by the Azure Stack HCI Cluster.
- cloudId string
- An immutable UUID for the Azure Stack HCI Cluster.
- id string
- The provider-assigned unique ID for this managed resource.
- identities
GetHci Cluster Identity[] 
- An identityblock as defined below.
- location string
- The Azure Region where the Azure Stack HCI Cluster exists.
- name string
- resourceGroup stringName 
- resourceProvider stringObject Id 
- The object ID of the Resource Provider Service Principal.
- serviceEndpoint string
- The region specific Data Path Endpoint of the Azure Stack HCI Cluster.
- {[key: string]: string}
- A mapping of tags assigned to the Azure Stack HCI Cluster.
- tenantId string
- The Tenant ID associated with this Managed Service Identity.
- automanage_configuration_ strid 
- The ID of the Automanage Configuration assigned to the Azure Stack HCI Cluster.
- client_id str
- The Client ID of the Azure Active Directory used by the Azure Stack HCI Cluster.
- cloud_id str
- An immutable UUID for the Azure Stack HCI Cluster.
- id str
- The provider-assigned unique ID for this managed resource.
- identities
Sequence[GetHci Cluster Identity] 
- An identityblock as defined below.
- location str
- The Azure Region where the Azure Stack HCI Cluster exists.
- name str
- resource_group_ strname 
- resource_provider_ strobject_ id 
- The object ID of the Resource Provider Service Principal.
- service_endpoint str
- The region specific Data Path Endpoint of the Azure Stack HCI Cluster.
- Mapping[str, str]
- A mapping of tags assigned to the Azure Stack HCI Cluster.
- tenant_id str
- The Tenant ID associated with this Managed Service Identity.
- automanageConfiguration StringId 
- The ID of the Automanage Configuration assigned to the Azure Stack HCI Cluster.
- clientId String
- The Client ID of the Azure Active Directory used by the Azure Stack HCI Cluster.
- cloudId String
- An immutable UUID for the Azure Stack HCI Cluster.
- id String
- The provider-assigned unique ID for this managed resource.
- identities List<Property Map>
- An identityblock as defined below.
- location String
- The Azure Region where the Azure Stack HCI Cluster exists.
- name String
- resourceGroup StringName 
- resourceProvider StringObject Id 
- The object ID of the Resource Provider Service Principal.
- serviceEndpoint String
- The region specific Data Path Endpoint of the Azure Stack HCI Cluster.
- Map<String>
- A mapping of tags assigned to the Azure Stack HCI Cluster.
- tenantId String
- The Tenant ID associated with this Managed Service Identity.
Supporting Types
GetHciClusterIdentity   
- PrincipalId string
- The Principal ID associated with this Managed Service Identity.
- TenantId string
- The Tenant ID associated with this Managed Service Identity.
- Type string
- (Required) The type of Managed Service Identity configured on the Azure Stack HCI Cluster.
- PrincipalId string
- The Principal ID associated with this Managed Service Identity.
- TenantId string
- The Tenant ID associated with this Managed Service Identity.
- Type string
- (Required) The type of Managed Service Identity configured on the Azure Stack HCI Cluster.
- principalId String
- The Principal ID associated with this Managed Service Identity.
- tenantId String
- The Tenant ID associated with this Managed Service Identity.
- type String
- (Required) The type of Managed Service Identity configured on the Azure Stack HCI Cluster.
- principalId string
- The Principal ID associated with this Managed Service Identity.
- tenantId string
- The Tenant ID associated with this Managed Service Identity.
- type string
- (Required) The type of Managed Service Identity configured on the Azure Stack HCI Cluster.
- principal_id str
- The Principal ID associated with this Managed Service Identity.
- tenant_id str
- The Tenant ID associated with this Managed Service Identity.
- type str
- (Required) The type of Managed Service Identity configured on the Azure Stack HCI Cluster.
- principalId String
- The Principal ID associated with this Managed Service Identity.
- tenantId String
- The Tenant ID associated with this Managed Service Identity.
- type String
- (Required) The type of Managed Service Identity configured on the Azure Stack HCI Cluster.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the azurermTerraform Provider.
