Share via

Microsoft.AzureStackHCI clusters 2021-09-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@2021-09-01-preview' = {
  scope: resourceSymbolicName or scope
  location: 'string'
  name: 'string'
  properties: {
    aadClientId: 'string'
    aadTenantId: 'string'
    cloudManagementEndpoint: 'string'
    desiredProperties: {
      diagnosticLevel: 'string'
      windowsServerSubscription: 'string'
    }
  }
  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
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
aadClientId App id of cluster AAD identity. string (required)
aadTenantId Tenant id of cluster AAD identity. string (required)
cloudManagementEndpoint Endpoint configured for management from the Azure portal. string
desiredProperties Desired properties of the cluster. ClusterDesiredProperties

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:

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": "2021-09-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "aadClientId": "string",
    "aadTenantId": "string",
    "cloudManagementEndpoint": "string",
    "desiredProperties": {
      "diagnosticLevel": "string",
      "windowsServerSubscription": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.AzureStackHCI/clusters

Name Description Value
apiVersion The api version '2021-09-01-preview'
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
aadClientId App id of cluster AAD identity. string (required)
aadTenantId Tenant id of cluster AAD identity. string (required)
cloudManagementEndpoint Endpoint configured for management from the Azure portal. string
desiredProperties Desired properties of the cluster. ClusterDesiredProperties

TrackedResourceTags

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@2021-09-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      aadClientId = "string"
      aadTenantId = "string"
      cloudManagementEndpoint = "string"
      desiredProperties = {
        diagnosticLevel = "string"
        windowsServerSubscription = "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)
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@2021-09-01-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
aadClientId App id of cluster AAD identity. string (required)
aadTenantId Tenant id of cluster AAD identity. string (required)
cloudManagementEndpoint Endpoint configured for management from the Azure portal. string
desiredProperties Desired properties of the cluster. ClusterDesiredProperties

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
  • Last updated on