Share via


Microsoft.HDInsight clusterpools 2023-06-01-preview

Bicep resource definition

The clusterpools 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.HDInsight/clusterpools resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.HDInsight/clusterpools@2023-06-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    clusterPoolProfile: {
      clusterPoolVersion: 'string'
    }
    computeProfile: {
      vmSize: 'string'
    }
    logAnalyticsProfile: {
      enabled: bool
      workspaceId: 'string'
    }
    managedResourceGroupName: 'string'
    networkProfile: {
      subnetId: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.HDInsight/clusterpools

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string (required)
properties Gets or sets the properties. Define cluster pool specific properties. ClusterPoolResourceProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

ClusterPoolResourceProperties

Name Description Value
clusterPoolProfile CLuster pool profile. ClusterPoolResourcePropertiesClusterPoolProfile
computeProfile CLuster pool compute profile. ClusterPoolResourcePropertiesComputeProfile (required)
logAnalyticsProfile Cluster pool log analytics profile to enable OMS agent for AKS cluster. ClusterPoolResourcePropertiesLogAnalyticsProfile
managedResourceGroupName A resource group created by RP, to hold the resources created by RP on-behalf of customers. It will also be used to generate aksManagedResourceGroupName by pattern: MC_{managedResourceGroupName}{clusterPoolName}{region}. Please make sure it meets resource group name restriction. string

Constraints:
Min length = 1
Max length = 40
networkProfile Cluster pool network profile. ClusterPoolResourcePropertiesNetworkProfile

ClusterPoolResourcePropertiesClusterPoolProfile

Name Description Value
clusterPoolVersion Cluster pool version is a 2-part version. string

Constraints:
Pattern = ^(0|[1-9][0-9]{0,18})\.(0|[1-9][0-9]{0,18})$ (required)

ClusterPoolResourcePropertiesComputeProfile

Name Description Value
vmSize The virtual machine SKU. string

Constraints:
Pattern = ^[a-zA-Z0-9_\-]{0,256}$ (required)

ClusterPoolResourcePropertiesLogAnalyticsProfile

Name Description Value
enabled True if log analytics is enabled for cluster pool, otherwise false. bool (required)
workspaceId Log analytics workspace to associate with the OMS agent. string

ClusterPoolResourcePropertiesNetworkProfile

Name Description Value
subnetId Cluster pool subnet resource id. string (required)

TrackedResourceTags

Name Description Value

ARM template resource definition

The clusterpools 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.HDInsight/clusterpools resource, add the following JSON to your template.

{
  "type": "Microsoft.HDInsight/clusterpools",
  "apiVersion": "2023-06-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "clusterPoolProfile": {
      "clusterPoolVersion": "string"
    },
    "computeProfile": {
      "vmSize": "string"
    },
    "logAnalyticsProfile": {
      "enabled": "bool",
      "workspaceId": "string"
    },
    "managedResourceGroupName": "string",
    "networkProfile": {
      "subnetId": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.HDInsight/clusterpools

Name Description Value
apiVersion The api version '2023-06-01-preview'
location The geo-location where the resource lives string (required)
name The resource name string (required)
properties Gets or sets the properties. Define cluster pool specific properties. ClusterPoolResourceProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.HDInsight/clusterpools'

ClusterPoolResourceProperties

Name Description Value
clusterPoolProfile CLuster pool profile. ClusterPoolResourcePropertiesClusterPoolProfile
computeProfile CLuster pool compute profile. ClusterPoolResourcePropertiesComputeProfile (required)
logAnalyticsProfile Cluster pool log analytics profile to enable OMS agent for AKS cluster. ClusterPoolResourcePropertiesLogAnalyticsProfile
managedResourceGroupName A resource group created by RP, to hold the resources created by RP on-behalf of customers. It will also be used to generate aksManagedResourceGroupName by pattern: MC_{managedResourceGroupName}{clusterPoolName}{region}. Please make sure it meets resource group name restriction. string

Constraints:
Min length = 1
Max length = 40
networkProfile Cluster pool network profile. ClusterPoolResourcePropertiesNetworkProfile

ClusterPoolResourcePropertiesClusterPoolProfile

Name Description Value
clusterPoolVersion Cluster pool version is a 2-part version. string

Constraints:
Pattern = ^(0|[1-9][0-9]{0,18})\.(0|[1-9][0-9]{0,18})$ (required)

ClusterPoolResourcePropertiesComputeProfile

Name Description Value
vmSize The virtual machine SKU. string

Constraints:
Pattern = ^[a-zA-Z0-9_\-]{0,256}$ (required)

ClusterPoolResourcePropertiesLogAnalyticsProfile

Name Description Value
enabled True if log analytics is enabled for cluster pool, otherwise false. bool (required)
workspaceId Log analytics workspace to associate with the OMS agent. string

ClusterPoolResourcePropertiesNetworkProfile

Name Description Value
subnetId Cluster pool subnet resource id. string (required)

TrackedResourceTags

Name Description Value

Usage Examples

Terraform (AzAPI provider) resource definition

The clusterpools 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.HDInsight/clusterpools resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.HDInsight/clusterpools@2023-06-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      clusterPoolProfile = {
        clusterPoolVersion = "string"
      }
      computeProfile = {
        vmSize = "string"
      }
      logAnalyticsProfile = {
        enabled = bool
        workspaceId = "string"
      }
      managedResourceGroupName = "string"
      networkProfile = {
        subnetId = "string"
      }
    }
  }
}

Property Values

Microsoft.HDInsight/clusterpools

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string (required)
properties Gets or sets the properties. Define cluster pool specific properties. ClusterPoolResourceProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.HDInsight/clusterpools@2023-06-01-preview"

ClusterPoolResourceProperties

Name Description Value
clusterPoolProfile CLuster pool profile. ClusterPoolResourcePropertiesClusterPoolProfile
computeProfile CLuster pool compute profile. ClusterPoolResourcePropertiesComputeProfile (required)
logAnalyticsProfile Cluster pool log analytics profile to enable OMS agent for AKS cluster. ClusterPoolResourcePropertiesLogAnalyticsProfile
managedResourceGroupName A resource group created by RP, to hold the resources created by RP on-behalf of customers. It will also be used to generate aksManagedResourceGroupName by pattern: MC_{managedResourceGroupName}{clusterPoolName}{region}. Please make sure it meets resource group name restriction. string

Constraints:
Min length = 1
Max length = 40
networkProfile Cluster pool network profile. ClusterPoolResourcePropertiesNetworkProfile

ClusterPoolResourcePropertiesClusterPoolProfile

Name Description Value
clusterPoolVersion Cluster pool version is a 2-part version. string

Constraints:
Pattern = ^(0|[1-9][0-9]{0,18})\.(0|[1-9][0-9]{0,18})$ (required)

ClusterPoolResourcePropertiesComputeProfile

Name Description Value
vmSize The virtual machine SKU. string

Constraints:
Pattern = ^[a-zA-Z0-9_\-]{0,256}$ (required)

ClusterPoolResourcePropertiesLogAnalyticsProfile

Name Description Value
enabled True if log analytics is enabled for cluster pool, otherwise false. bool (required)
workspaceId Log analytics workspace to associate with the OMS agent. string

ClusterPoolResourcePropertiesNetworkProfile

Name Description Value
subnetId Cluster pool subnet resource id. string (required)

TrackedResourceTags

Name Description Value