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.
Bicep resource definition
The clusters resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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@2020-10-01' = {
location: 'string'
name: 'string'
properties: {
aadClientId: 'string'
aadTenantId: 'string'
reportedProperties: {}
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.AzureStackHCI/clusters
| Name | Description | Value |
|---|---|---|
| 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 |
ClusterProperties
| Name | Description | Value |
|---|---|---|
| aadClientId | App id of cluster AAD identity. | string (required) |
| aadTenantId | Tenant id of cluster AAD identity. | string (required) |
| reportedProperties | Properties reported by cluster agent. | ClusterReportedProperties |
ClusterReportedProperties
| Name | Description | Value |
|---|
TrackedResourceTags
| 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:
- Resource groups - See resource group deployment commands
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": "2020-10-01",
"name": "string",
"location": "string",
"properties": {
"aadClientId": "string",
"aadTenantId": "string",
"reportedProperties": {
}
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.AzureStackHCI/clusters
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2020-10-01' |
| 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' |
ClusterProperties
| Name | Description | Value |
|---|---|---|
| aadClientId | App id of cluster AAD identity. | string (required) |
| aadTenantId | Tenant id of cluster AAD identity. | string (required) |
| reportedProperties | Properties reported by cluster agent. | ClusterReportedProperties |
ClusterReportedProperties
| Name | Description | Value |
|---|
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Azure Quickstart Templates
The following Azure Quickstart templates deploy this resource type.
| Template | Description |
|---|---|
creates an Azure Stack HCI 23H2 cluster |
This template creates an Azure Stack HCI 23H2 cluster using an ARM template, using custom storage IP |
| creates an Azure Stack HCI 23H2 cluster |
This template creates an Azure Stack HCI 23H2 cluster using an ARM template, using custom storage IP |
| creates an Azure Stack HCI 23H2 cluster |
This template creates an Azure Stack HCI 23H2 cluster using an ARM template. |
Terraform (AzAPI provider) resource definition
The clusters resource type can be deployed with operations that target:
- Resource groups
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@2020-10-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
aadClientId = "string"
aadTenantId = "string"
reportedProperties = {
}
}
}
}
Property Values
Microsoft.AzureStackHCI/clusters
| Name | Description | Value |
|---|---|---|
| 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. |
| type | The resource type | "Microsoft.AzureStackHCI/clusters@2020-10-01" |
ClusterProperties
| Name | Description | Value |
|---|---|---|
| aadClientId | App id of cluster AAD identity. | string (required) |
| aadTenantId | Tenant id of cluster AAD identity. | string (required) |
| reportedProperties | Properties reported by cluster agent. | ClusterReportedProperties |
ClusterReportedProperties
| Name | Description | Value |
|---|
TrackedResourceTags
| 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 |