Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
- Latest
- 2025-09-15-preview
- 2024-02-15-preview
- 2024-01-01
- 2023-11-01-preview
- 2023-08-01
- 2023-08-01-preview
- 2023-06-01
- 2023-03-01
- 2023-02-01
- 2022-12-15-preview
- 2022-12-01
- 2022-10-01
- 2022-09-01
- 2022-05-01
- 2022-03-01
- 2022-01-01
- 2021-09-01
- 2021-09-01-preview
- 2021-01-01-preview
- 2020-10-01
- 2020-03-01-preview
Bicep resource definition
The clusters resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.AzureStackHCI/clusters resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.AzureStackHCI/clusters@2025-09-15-preview' = {
scope: resourceSymbolicName or scope
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
kind: 'string'
location: 'string'
name: 'string'
properties: {
aadApplicationObjectId: 'string'
aadClientId: 'string'
aadServicePrincipalObjectId: 'string'
aadTenantId: 'string'
cloudManagementEndpoint: 'string'
desiredProperties: {
diagnosticLevel: 'string'
windowsServerSubscription: 'string'
}
localAvailabilityZones: [
{
localAvailabilityZoneName: 'string'
nodes: [
'string'
]
}
]
logCollectionProperties: {}
remoteSupportProperties: {}
secretsLocations: [
{
secretsLocation: 'string'
secretsType: 'string'
}
]
softwareAssuranceProperties: {
softwareAssuranceIntent: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.AzureStackHCI/clusters
| Name | Description | Value |
|---|---|---|
| identity | Identity of Cluster resource | ManagedServiceIdentity |
| kind | This property identifies the purpose of the Cluster deployment. For example, a valid value is AzureLocal | string Constraints: Pattern = ^[-\w\._,\(\\\)]+$ |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| properties | Cluster properties. | ClusterProperties |
| scope | Use when creating a resource at a scope that is different than the deployment scope. | Set this property to the symbolic name of a resource to apply the extension resource. |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
ClusterDesiredProperties
| Name | Description | Value |
|---|---|---|
| diagnosticLevel | Desired level of diagnostic data emitted by the cluster. | 'Basic' 'Enhanced' 'Off' |
| windowsServerSubscription | Desired state of Windows Server Subscription. | 'Disabled' 'Enabled' |
ClusterProperties
| Name | Description | Value |
|---|---|---|
| aadApplicationObjectId | Object id of cluster AAD identity. | string |
| aadClientId | App id of cluster AAD identity. | string |
| aadServicePrincipalObjectId | Id of cluster identity service principal. | string |
| aadTenantId | Tenant id of cluster AAD identity. | string |
| cloudManagementEndpoint | Endpoint configured for management from the Azure portal. | string |
| desiredProperties | Desired properties of the cluster. | ClusterDesiredProperties |
| localAvailabilityZones | Local Availability Zone information for HCI cluster | LocalAvailabilityZones[] |
| logCollectionProperties | Log Collection properties of the cluster. | LogCollectionProperties |
| remoteSupportProperties | RemoteSupport properties of the cluster. | RemoteSupportProperties |
| secretsLocations | List of secret locations. | SecretsLocationDetails[] |
| softwareAssuranceProperties | Software Assurance properties of the cluster. | SoftwareAssuranceProperties |
LocalAvailabilityZones
| Name | Description | Value |
|---|---|---|
| localAvailabilityZoneName | Local Availability Zone name for HCI cluster | string |
| nodes | Nodes belonging to a particular zone | string[] |
LogCollectionProperties
| Name | Description | Value |
|---|
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
RemoteSupportProperties
| Name | Description | Value |
|---|
SecretsLocationDetails
| Name | Description | Value |
|---|---|---|
| secretsLocation | secrets location | string (required) |
| secretsType | Type of secrets to store | 'BackupSecrets' (required) |
SoftwareAssuranceProperties
| Name | Description | Value |
|---|---|---|
| softwareAssuranceIntent | Customer Intent for Software Assurance Benefit. | 'Disable' 'Enable' |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
Usage Examples
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
| Module | Description |
|---|---|
| Azure Stack HCI Cluster | AVM Resource Module for Azure Stack HCI Cluster |
ARM template resource definition
The clusters resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.AzureStackHCI/clusters resource, add the following JSON to your template.
{
"type": "Microsoft.AzureStackHCI/clusters",
"apiVersion": "2025-09-15-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"kind": "string",
"location": "string",
"properties": {
"aadApplicationObjectId": "string",
"aadClientId": "string",
"aadServicePrincipalObjectId": "string",
"aadTenantId": "string",
"cloudManagementEndpoint": "string",
"desiredProperties": {
"diagnosticLevel": "string",
"windowsServerSubscription": "string"
},
"localAvailabilityZones": [
{
"localAvailabilityZoneName": "string",
"nodes": [ "string" ]
}
],
"logCollectionProperties": {
},
"remoteSupportProperties": {
},
"secretsLocations": [
{
"secretsLocation": "string",
"secretsType": "string"
}
],
"softwareAssuranceProperties": {
"softwareAssuranceIntent": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.AzureStackHCI/clusters
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2025-09-15-preview' |
| identity | Identity of Cluster resource | ManagedServiceIdentity |
| kind | This property identifies the purpose of the Cluster deployment. For example, a valid value is AzureLocal | string Constraints: Pattern = ^[-\w\._,\(\\\)]+$ |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| properties | Cluster properties. | ClusterProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.AzureStackHCI/clusters' |
ClusterDesiredProperties
| Name | Description | Value |
|---|---|---|
| diagnosticLevel | Desired level of diagnostic data emitted by the cluster. | 'Basic' 'Enhanced' 'Off' |
| windowsServerSubscription | Desired state of Windows Server Subscription. | 'Disabled' 'Enabled' |
ClusterProperties
| Name | Description | Value |
|---|---|---|
| aadApplicationObjectId | Object id of cluster AAD identity. | string |
| aadClientId | App id of cluster AAD identity. | string |
| aadServicePrincipalObjectId | Id of cluster identity service principal. | string |
| aadTenantId | Tenant id of cluster AAD identity. | string |
| cloudManagementEndpoint | Endpoint configured for management from the Azure portal. | string |
| desiredProperties | Desired properties of the cluster. | ClusterDesiredProperties |
| localAvailabilityZones | Local Availability Zone information for HCI cluster | LocalAvailabilityZones[] |
| logCollectionProperties | Log Collection properties of the cluster. | LogCollectionProperties |
| remoteSupportProperties | RemoteSupport properties of the cluster. | RemoteSupportProperties |
| secretsLocations | List of secret locations. | SecretsLocationDetails[] |
| softwareAssuranceProperties | Software Assurance properties of the cluster. | SoftwareAssuranceProperties |
LocalAvailabilityZones
| Name | Description | Value |
|---|---|---|
| localAvailabilityZoneName | Local Availability Zone name for HCI cluster | string |
| nodes | Nodes belonging to a particular zone | string[] |
LogCollectionProperties
| Name | Description | Value |
|---|
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
RemoteSupportProperties
| Name | Description | Value |
|---|
SecretsLocationDetails
| Name | Description | Value |
|---|---|---|
| secretsLocation | secrets location | string (required) |
| secretsType | Type of secrets to store | 'BackupSecrets' (required) |
SoftwareAssuranceProperties
| Name | Description | Value |
|---|---|---|
| softwareAssuranceIntent | Customer Intent for Software Assurance Benefit. | 'Disable' 'Enable' |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The clusters resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.AzureStackHCI/clusters resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AzureStackHCI/clusters@2025-09-15-preview"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
kind = "string"
properties = {
aadApplicationObjectId = "string"
aadClientId = "string"
aadServicePrincipalObjectId = "string"
aadTenantId = "string"
cloudManagementEndpoint = "string"
desiredProperties = {
diagnosticLevel = "string"
windowsServerSubscription = "string"
}
localAvailabilityZones = [
{
localAvailabilityZoneName = "string"
nodes = [
"string"
]
}
]
logCollectionProperties = {
}
remoteSupportProperties = {
}
secretsLocations = [
{
secretsLocation = "string"
secretsType = "string"
}
]
softwareAssuranceProperties = {
softwareAssuranceIntent = "string"
}
}
}
}
Property Values
Microsoft.AzureStackHCI/clusters
| Name | Description | Value |
|---|---|---|
| identity | Identity of Cluster resource | ManagedServiceIdentity |
| kind | This property identifies the purpose of the Cluster deployment. For example, a valid value is AzureLocal | string Constraints: Pattern = ^[-\w\._,\(\\\)]+$ |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| parent_id | The ID of the resource to apply this extension resource to. | string (required) |
| properties | Cluster properties. | ClusterProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.AzureStackHCI/clusters@2025-09-15-preview" |
ClusterDesiredProperties
| Name | Description | Value |
|---|---|---|
| diagnosticLevel | Desired level of diagnostic data emitted by the cluster. | 'Basic' 'Enhanced' 'Off' |
| windowsServerSubscription | Desired state of Windows Server Subscription. | 'Disabled' 'Enabled' |
ClusterProperties
| Name | Description | Value |
|---|---|---|
| aadApplicationObjectId | Object id of cluster AAD identity. | string |
| aadClientId | App id of cluster AAD identity. | string |
| aadServicePrincipalObjectId | Id of cluster identity service principal. | string |
| aadTenantId | Tenant id of cluster AAD identity. | string |
| cloudManagementEndpoint | Endpoint configured for management from the Azure portal. | string |
| desiredProperties | Desired properties of the cluster. | ClusterDesiredProperties |
| localAvailabilityZones | Local Availability Zone information for HCI cluster | LocalAvailabilityZones[] |
| logCollectionProperties | Log Collection properties of the cluster. | LogCollectionProperties |
| remoteSupportProperties | RemoteSupport properties of the cluster. | RemoteSupportProperties |
| secretsLocations | List of secret locations. | SecretsLocationDetails[] |
| softwareAssuranceProperties | Software Assurance properties of the cluster. | SoftwareAssuranceProperties |
LocalAvailabilityZones
| Name | Description | Value |
|---|---|---|
| localAvailabilityZoneName | Local Availability Zone name for HCI cluster | string |
| nodes | Nodes belonging to a particular zone | string[] |
LogCollectionProperties
| Name | Description | Value |
|---|
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
RemoteSupportProperties
| Name | Description | Value |
|---|
SecretsLocationDetails
| Name | Description | Value |
|---|---|---|
| secretsLocation | secrets location | string (required) |
| secretsType | Type of secrets to store | 'BackupSecrets' (required) |
SoftwareAssuranceProperties
| Name | Description | Value |
|---|---|---|
| softwareAssuranceIntent | Customer Intent for Software Assurance Benefit. | 'Disable' 'Enable' |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
Usage Examples
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
| Module | Description |
|---|---|
| Azure Stack HCI Cluster | AVM Resource Module for Azure Stack HCI Cluster |