We recommend using Azure Native.
published on Monday, Mar 9, 2026 by Pulumi
We recommend using Azure Native.
published on Monday, Mar 9, 2026 by Pulumi
Manages an Azure Stack HCI Cluster.
Example Usage
using Pulumi;
using Azure = Pulumi.Azure;
using AzureAD = Pulumi.AzureAD;
class MyStack : Stack
{
public MyStack()
{
var exampleApplication = Output.Create(AzureAD.GetApplication.InvokeAsync(new AzureAD.GetApplicationArgs
{
Name = "example-app",
}));
var current = Output.Create(Azure.Core.GetClientConfig.InvokeAsync());
var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
{
Location = "West Europe",
});
var exampleHciCluster = new Azure.Stack.HciCluster("exampleHciCluster", new Azure.Stack.HciClusterArgs
{
ResourceGroupName = exampleResourceGroup.Name,
Location = exampleResourceGroup.Location,
ClientId = exampleApplication.Apply(exampleApplication => exampleApplication.ApplicationId),
TenantId = current.Apply(current => current.TenantId),
});
}
}
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/stack"
"github.com/pulumi/pulumi-azuread/sdk/v4/go/azuread"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleApplication, err := azuread.LookupApplication(ctx, &GetApplicationArgs{
Name: pulumi.StringRef("example-app"),
}, nil)
if err != nil {
return err
}
current, err := core.GetClientConfig(ctx, nil, nil)
if err != nil {
return err
}
exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
_, err = stack.NewHciCluster(ctx, "exampleHciCluster", &stack.HciClusterArgs{
ResourceGroupName: exampleResourceGroup.Name,
Location: exampleResourceGroup.Location,
ClientId: pulumi.String(exampleApplication.ApplicationId),
TenantId: pulumi.String(current.TenantId),
})
if err != nil {
return err
}
return nil
})
}
Example coming soon!
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
import * as azuread from "@pulumi/azuread";
const exampleApplication = azuread.getApplication({
name: "example-app",
});
const current = azure.core.getClientConfig({});
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleHciCluster = new azure.stack.HciCluster("exampleHciCluster", {
resourceGroupName: exampleResourceGroup.name,
location: exampleResourceGroup.location,
clientId: exampleApplication.then(exampleApplication => exampleApplication.applicationId),
tenantId: current.then(current => current.tenantId),
});
import pulumi
import pulumi_azure as azure
import pulumi_azuread as azuread
example_application = azuread.get_application(name="example-app")
current = azure.core.get_client_config()
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_hci_cluster = azure.stack.HciCluster("exampleHciCluster",
resource_group_name=example_resource_group.name,
location=example_resource_group.location,
client_id=example_application.application_id,
tenant_id=current.tenant_id)
Example coming soon!
Create HciCluster Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new HciCluster(name: string, args: HciClusterArgs, opts?: CustomResourceOptions);@overload
def HciCluster(resource_name: str,
args: HciClusterArgs,
opts: Optional[ResourceOptions] = None)
@overload
def HciCluster(resource_name: str,
opts: Optional[ResourceOptions] = None,
client_id: Optional[str] = None,
resource_group_name: Optional[str] = None,
location: Optional[str] = None,
name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tenant_id: Optional[str] = None)func NewHciCluster(ctx *Context, name string, args HciClusterArgs, opts ...ResourceOption) (*HciCluster, error)public HciCluster(string name, HciClusterArgs args, CustomResourceOptions? opts = null)
public HciCluster(String name, HciClusterArgs args)
public HciCluster(String name, HciClusterArgs args, CustomResourceOptions options)
type: azure:stack:HciCluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args HciClusterArgs
- 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 HciClusterArgs
- 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 HciClusterArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args HciClusterArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args HciClusterArgs
- 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 hciClusterResource = new Azure.Stack.HciCluster("hciClusterResource", new()
{
ClientId = "string",
ResourceGroupName = "string",
Location = "string",
Name = "string",
Tags =
{
{ "string", "string" },
},
TenantId = "string",
});
example, err := stack.NewHciCluster(ctx, "hciClusterResource", &stack.HciClusterArgs{
ClientId: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
Location: pulumi.String("string"),
Name: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
TenantId: pulumi.String("string"),
})
var hciClusterResource = new HciCluster("hciClusterResource", HciClusterArgs.builder()
.clientId("string")
.resourceGroupName("string")
.location("string")
.name("string")
.tags(Map.of("string", "string"))
.tenantId("string")
.build());
hci_cluster_resource = azure.stack.HciCluster("hciClusterResource",
client_id="string",
resource_group_name="string",
location="string",
name="string",
tags={
"string": "string",
},
tenant_id="string")
const hciClusterResource = new azure.stack.HciCluster("hciClusterResource", {
clientId: "string",
resourceGroupName: "string",
location: "string",
name: "string",
tags: {
string: "string",
},
tenantId: "string",
});
type: azure:stack:HciCluster
properties:
clientId: string
location: string
name: string
resourceGroupName: string
tags:
string: string
tenantId: string
HciCluster 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 HciCluster resource accepts the following input properties:
- Client
Id string - The Client ID of the Azure Active Directory which is used by the Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- Resource
Group stringName - The name of the Resource Group where the Azure Stack HCI Cluster should exist. Changing this forces a new resource to be created.
- Location string
- The Azure Region where the Azure Stack HCI Cluster should exist. Changing this forces a new resource to be created.
- Name string
- The name which should be used for this Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- Dictionary<string, string>
- A mapping of tags which should be assigned to the Azure Stack HCI Cluster.
- Tenant
Id string - The Tenant ID of the Azure Active Directory which is used by the Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- Client
Id string - The Client ID of the Azure Active Directory which is used by the Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- Resource
Group stringName - The name of the Resource Group where the Azure Stack HCI Cluster should exist. Changing this forces a new resource to be created.
- Location string
- The Azure Region where the Azure Stack HCI Cluster should exist. Changing this forces a new resource to be created.
- Name string
- The name which should be used for this Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- map[string]string
- A mapping of tags which should be assigned to the Azure Stack HCI Cluster.
- Tenant
Id string - The Tenant ID of the Azure Active Directory which is used by the Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- client
Id String - The Client ID of the Azure Active Directory which is used by the Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- resource
Group StringName - The name of the Resource Group where the Azure Stack HCI Cluster should exist. Changing this forces a new resource to be created.
- location String
- The Azure Region where the Azure Stack HCI Cluster should exist. Changing this forces a new resource to be created.
- name String
- The name which should be used for this Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- Map<String,String>
- A mapping of tags which should be assigned to the Azure Stack HCI Cluster.
- tenant
Id String - The Tenant ID of the Azure Active Directory which is used by the Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- client
Id string - The Client ID of the Azure Active Directory which is used by the Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- resource
Group stringName - The name of the Resource Group where the Azure Stack HCI Cluster should exist. Changing this forces a new resource to be created.
- location string
- The Azure Region where the Azure Stack HCI Cluster should exist. Changing this forces a new resource to be created.
- name string
- The name which should be used for this Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- {[key: string]: string}
- A mapping of tags which should be assigned to the Azure Stack HCI Cluster.
- tenant
Id string - The Tenant ID of the Azure Active Directory which is used by the Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- client_
id str - The Client ID of the Azure Active Directory which is used by the Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- resource_
group_ strname - The name of the Resource Group where the Azure Stack HCI Cluster should exist. Changing this forces a new resource to be created.
- location str
- The Azure Region where the Azure Stack HCI Cluster should exist. Changing this forces a new resource to be created.
- name str
- The name which should be used for this Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- Mapping[str, str]
- A mapping of tags which should be assigned to the Azure Stack HCI Cluster.
- tenant_
id str - The Tenant ID of the Azure Active Directory which is used by the Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- client
Id String - The Client ID of the Azure Active Directory which is used by the Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- resource
Group StringName - The name of the Resource Group where the Azure Stack HCI Cluster should exist. Changing this forces a new resource to be created.
- location String
- The Azure Region where the Azure Stack HCI Cluster should exist. Changing this forces a new resource to be created.
- name String
- The name which should be used for this Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- Map<String>
- A mapping of tags which should be assigned to the Azure Stack HCI Cluster.
- tenant
Id String - The Tenant ID of the Azure Active Directory which is used by the Azure Stack HCI Cluster. Changing this forces a new resource to be created.
Outputs
All input properties are implicitly available as output properties. Additionally, the HciCluster resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing HciCluster Resource
Get an existing HciCluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: HciClusterState, opts?: CustomResourceOptions): HciCluster@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
client_id: Optional[str] = None,
location: Optional[str] = None,
name: Optional[str] = None,
resource_group_name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tenant_id: Optional[str] = None) -> HciClusterfunc GetHciCluster(ctx *Context, name string, id IDInput, state *HciClusterState, opts ...ResourceOption) (*HciCluster, error)public static HciCluster Get(string name, Input<string> id, HciClusterState? state, CustomResourceOptions? opts = null)public static HciCluster get(String name, Output<String> id, HciClusterState state, CustomResourceOptions options)resources: _: type: azure:stack:HciCluster get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Client
Id string - The Client ID of the Azure Active Directory which is used by the Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- Location string
- The Azure Region where the Azure Stack HCI Cluster should exist. Changing this forces a new resource to be created.
- Name string
- The name which should be used for this Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- Resource
Group stringName - The name of the Resource Group where the Azure Stack HCI Cluster should exist. Changing this forces a new resource to be created.
- Dictionary<string, string>
- A mapping of tags which should be assigned to the Azure Stack HCI Cluster.
- Tenant
Id string - The Tenant ID of the Azure Active Directory which is used by the Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- Client
Id string - The Client ID of the Azure Active Directory which is used by the Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- Location string
- The Azure Region where the Azure Stack HCI Cluster should exist. Changing this forces a new resource to be created.
- Name string
- The name which should be used for this Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- Resource
Group stringName - The name of the Resource Group where the Azure Stack HCI Cluster should exist. Changing this forces a new resource to be created.
- map[string]string
- A mapping of tags which should be assigned to the Azure Stack HCI Cluster.
- Tenant
Id string - The Tenant ID of the Azure Active Directory which is used by the Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- client
Id String - The Client ID of the Azure Active Directory which is used by the Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- location String
- The Azure Region where the Azure Stack HCI Cluster should exist. Changing this forces a new resource to be created.
- name String
- The name which should be used for this Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- resource
Group StringName - The name of the Resource Group where the Azure Stack HCI Cluster should exist. Changing this forces a new resource to be created.
- Map<String,String>
- A mapping of tags which should be assigned to the Azure Stack HCI Cluster.
- tenant
Id String - The Tenant ID of the Azure Active Directory which is used by the Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- client
Id string - The Client ID of the Azure Active Directory which is used by the Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- location string
- The Azure Region where the Azure Stack HCI Cluster should exist. Changing this forces a new resource to be created.
- name string
- The name which should be used for this Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- resource
Group stringName - The name of the Resource Group where the Azure Stack HCI Cluster should exist. Changing this forces a new resource to be created.
- {[key: string]: string}
- A mapping of tags which should be assigned to the Azure Stack HCI Cluster.
- tenant
Id string - The Tenant ID of the Azure Active Directory which is used by the Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- client_
id str - The Client ID of the Azure Active Directory which is used by the Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- location str
- The Azure Region where the Azure Stack HCI Cluster should exist. Changing this forces a new resource to be created.
- name str
- The name which should be used for this Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- resource_
group_ strname - The name of the Resource Group where the Azure Stack HCI Cluster should exist. Changing this forces a new resource to be created.
- Mapping[str, str]
- A mapping of tags which should be assigned to the Azure Stack HCI Cluster.
- tenant_
id str - The Tenant ID of the Azure Active Directory which is used by the Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- client
Id String - The Client ID of the Azure Active Directory which is used by the Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- location String
- The Azure Region where the Azure Stack HCI Cluster should exist. Changing this forces a new resource to be created.
- name String
- The name which should be used for this Azure Stack HCI Cluster. Changing this forces a new resource to be created.
- resource
Group StringName - The name of the Resource Group where the Azure Stack HCI Cluster should exist. Changing this forces a new resource to be created.
- Map<String>
- A mapping of tags which should be assigned to the Azure Stack HCI Cluster.
- tenant
Id String - The Tenant ID of the Azure Active Directory which is used by the Azure Stack HCI Cluster. Changing this forces a new resource to be created.
Import
Azure Stack HCI Clusters can be imported using the resource id, e.g.
$ pulumi import azure:stack/hciCluster:HciCluster example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.AzureStackHCI/clusters/cluster1
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurermTerraform Provider.
We recommend using Azure Native.
published on Monday, Mar 9, 2026 by Pulumi
