通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.HDInsight 群集 2023-08-15-preview

  • 项目

Bicep 资源定义

可以使用目标操作部署群集资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.HDInsight/clusters 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.HDInsight/clusters@2023-08-15-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        tenantId: 'string'
      }
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    clusterDefinition: {
      blueprint: 'string'
      componentVersion: {
        {customized property}: 'string'
      }
      configurations: any(Azure.Bicep.Types.Concrete.AnyType)
      kind: 'string'
    }
    clusterVersion: 'string'
    computeIsolationProperties: {
      enableComputeIsolation: bool
      hostSku: 'string'
    }
    computeProfile: {
      roles: [
        {
          autoscale: {
            capacity: {
              maxInstanceCount: int
              minInstanceCount: int
            }
            recurrence: {
              schedule: [
                {
                  days: [
                    'string'
                  ]
                  timeAndCapacity: {
                    maxInstanceCount: int
                    minInstanceCount: int
                    time: 'string'
                  }
                }
              ]
              timeZone: 'string'
            }
          }
          dataDisksGroups: [
            {
              disksPerNode: int
            }
          ]
          encryptDataDisks: bool
          hardwareProfile: {
            vmSize: 'string'
          }
          minInstanceCount: int
          name: 'string'
          osProfile: {
            linuxOperatingSystemProfile: {
              password: 'string'
              sshProfile: {
                publicKeys: [
                  {
                    certificateData: 'string'
                  }
                ]
              }
              username: 'string'
            }
          }
          scriptActions: [
            {
              name: 'string'
              parameters: 'string'
              uri: 'string'
            }
          ]
          targetInstanceCount: int
          virtualNetworkProfile: {
            id: 'string'
            subnet: 'string'
          }
          VMGroupName: 'string'
        }
      ]
    }
    diskEncryptionProperties: {
      encryptionAlgorithm: 'string'
      encryptionAtHost: bool
      keyName: 'string'
      keyVersion: 'string'
      msiResourceId: 'string'
      vaultUri: 'string'
    }
    encryptionInTransitProperties: {
      isEncryptionInTransitEnabled: bool
    }
    kafkaRestProperties: {
      clientGroupInfo: {
        groupId: 'string'
        groupName: 'string'
      }
      configurationOverride: {
        {customized property}: 'string'
      }
    }
    minSupportedTlsVersion: 'string'
    networkProperties: {
      outboundDependenciesManagedType: 'string'
      privateLink: 'string'
      resourceProviderConnection: 'string'
    }
    osType: 'string'
    privateLinkConfigurations: [
      {
        name: 'string'
        properties: {
          groupId: 'string'
          ipConfigurations: [
            {
              name: 'string'
              properties: {
                primary: bool
                privateIPAddress: 'string'
                privateIPAllocationMethod: 'string'
                subnet: {
                  id: 'string'
                }
              }
            }
          ]
        }
      }
    ]
    securityProfile: {
      aaddsResourceId: 'string'
      clusterUsersGroupDNs: [
        'string'
      ]
      directoryType: 'string'
      domain: 'string'
      domainUsername: 'string'
      domainUserPassword: 'string'
      ldapsUrls: [
        'string'
      ]
      msiResourceId: 'string'
      organizationalUnitDN: 'string'
    }
    storageProfile: {
      storageaccounts: [
        {
          container: 'string'
          enableSecureChannel: bool
          fileshare: 'string'
          fileSystem: 'string'
          isDefault: bool
          key: 'string'
          msiResourceId: 'string'
          name: 'string'
          resourceId: 'string'
          saskey: 'string'
        }
      ]
    }
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
  zones: [
    'string'
  ]
}

属性值

自动缩放

名字 描述 价值
能力 基于负载的自动缩放的参数 AutoscaleCapacity
复发 基于计划的自动缩放的参数 AutoscaleRecurrence

AutoscaleCapacity

名字 描述 价值
maxInstanceCount 群集的最大实例计数 int
minInstanceCount 群集的最小实例计数 int

AutoscaleRecurrence

名字 描述 价值
附表 基于计划的自动缩放规则的数组 AutoscaleSchedule[]
timeZone 自动缩放计划时间的时区 字符串

AutoscaleSchedule

名字 描述 价值
日 基于计划的自动缩放规则的一周中的天数 包含任一项的字符串数组：
“Friday”
“Monday”
“Saturday”
“星期日”
“星期四”
“Tuesday”
“Wednesday”
timeAndCapacity 基于计划的自动缩放规则的时间和容量 AutoscaleTimeAndCapacity

AutoscaleTimeAndCapacity

名字 描述 价值
maxInstanceCount 群集的最大实例计数 int
minInstanceCount 群集的最小实例计数 int
时间 格式为 xx：xx 的 24 小时时间 字符串

ClientGroupInfo

名字 描述 价值
groupId AAD 安全组 ID。 字符串
groupName AAD 安全组名称。 字符串

ClusterCreateParametersExtendedTags

名字 描述 价值

ClusterCreatePropertiesOrClusterGetProperties

名字 描述 价值
clusterDefinition 群集定义。 ClusterDefinition
clusterVersion 群集的版本。 字符串
computeIsolationProperties 计算隔离属性。 ComputeIsolationProperties
computeProfile 计算配置文件。 ComputeProfile
diskEncryptionProperties 磁盘加密属性。 DiskEncryptionProperties
encryptionInTransitProperties 传输中加密属性。 EncryptionInTransitProperties
kafkaRestProperties 群集 kafka rest 代理配置。 KafkaRestProperties
minSupportedTlsVersion 支持的最低 tls 版本。 字符串
networkProperties 网络属性。 NetworkProperties
osType 操作系统的类型。 “Linux”
“Windows”
privateLinkConfigurations 专用链接配置。 PrivateLinkConfiguration[]
securityProfile 安全配置文件。 SecurityProfile
storageProfile 存储配置文件。 StorageProfile
层 群集层。 “Premium”
“Standard”

ClusterDefinition

名字 描述 价值
蓝图 指向蓝图的链接。 字符串
componentVersion 群集中不同服务的版本。 ClusterDefinitionComponentVersion
配置 群集配置。 任何
类 群集的类型。 字符串

ClusterDefinitionComponentVersion

名字 描述 价值

ClusterIdentity

名字 描述 价值
类型 用于群集的标识类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 “None”
“SystemAssigned”
“SystemAssigned，UserAssigned”
“UserAssigned”
userAssignedIdentities 与群集关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 ClusterIdentityUserAssignedIdentities

ClusterIdentityUserAssignedIdentities

名字 描述 价值

ComputeIsolationProperties

名字 描述 价值
enableComputeIsolation 该标志指示是否启用计算隔离。 bool
hostSku 主机 SKU。 字符串

ComputeProfile

名字 描述 价值
角色 群集中的角色列表。 角色[]

DataDisksGroups

名字 描述 价值
disksPerNode 每个节点的磁盘数。 int

DiskEncryptionProperties

名字 描述 价值
encryptionAlgorithm 加密算法标识符，默认 RSA-OAEP。 “RSA-OAEP”
“RSA-OAEP-256”
“RSA1_5”
encryptionAtHost 指示是否启用资源磁盘加密。 bool
keyName 用于启用磁盘加密的密钥名称。 字符串
keyVersion 用于启用磁盘加密的特定密钥版本。 字符串
msiResourceId 用于访问密钥保管库的托管标识的资源 ID。 字符串
vaultUri 客户密钥所在的基密钥保管库 URI，例如。https://myvault.vault.azure.net 字符串

EncryptionInTransitProperties

名字 描述 价值
isEncryptionInTransitEnabled 指示群集节点间通信是否在传输中加密。 bool

HardwareProfile

名字 描述 价值
vmSize VM 的大小 字符串

IPConfiguration

名字 描述 价值
名字 专用链接 IP 配置的名称。 string （必需）
性能 专用链接 IP 配置属性。 IPConfigurationProperties

IPConfigurationProperties

名字 描述 价值
主要 指示此 IP 配置是否是相应 NIC 的主要配置。 bool
privateIPAddress IP 地址。 字符串
privateIPAllocationMethod 分配专用 IP 地址的方法。 “dynamic”
“static”
子 子网资源 ID。 ResourceId

KafkaRestProperties

名字 描述 价值
clientGroupInfo AAD 安全组的信息。 ClientGroupInfo
configurationOverride 需要重写的配置。 KafkaRestPropertiesConfigurationOverride

KafkaRestPropertiesConfigurationOverride

名字 描述 价值

LinuxOperatingSystemProfile

名字 描述 价值
密码 密码。 字符串
sshProfile SSH 配置文件。 SshProfile
username 用户名。 字符串

Microsoft.HDInsight/clusters

名字 描述 价值
身份 群集的标识（如果已配置）。 ClusterIdentity
位置 群集的位置。 字符串
名字 资源名称 string （必需）
性能 群集创建参数。 ClusterCreatePropertiesOrClusterGetProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
区 可用性区域。 string[]

NetworkProperties

名字 描述 价值
outboundDependenciesManagedType 一个值，用于描述如何管理 HDInsight 群集的出站依赖项。 “Managed”表示出站依赖项由 HDInsight 服务管理。 “外部”表示出站依赖项由客户特定的解决方案管理。 “External”
“Managed”
privateLink 指示是否启用专用链接。 “Disabled”
“Enabled”
resourceProviderConnection 资源提供程序连接的方向。 “Inbound”
“Outbound”

OsProfile

名字 描述 价值
linuxOperatingSystemProfile Linux OS 配置文件。 LinuxOperatingSystemProfile

PrivateLinkConfiguration

名字 描述 价值
名字 专用链接配置的名称。 string （必需）
性能 专用链接配置属性。 PrivateLinkConfigurationProperties（必需）

PrivateLinkConfigurationProperties

名字 描述 价值
groupId 要向其应用专用链接配置的 HDInsight 专用可链接子资源名称。 例如，“headnode”、“gateway”、“edgenode”。 string （必需）
ipConfigurations 专用链接服务的 IP 配置。 IPConfiguration[] （必需）

ResourceId

名字 描述 价值
id Azure 资源 ID。 字符串

角色

名字 描述 价值
自动缩放 自动缩放配置。 自动缩放
dataDisksGroups 角色的数据磁盘组。 DataDisksGroups[]
encryptDataDisks 指示是否加密数据磁盘。 bool
hardwareProfile 硬件配置文件。 HardwareProfile
minInstanceCount 群集的最小实例计数。 int
名字 角色的名称。 字符串
osProfile 操作系统配置文件。 OsProfile
scriptActions 角色上的脚本操作列表。 ScriptAction[]
targetInstanceCount 群集的实例计数。 int
virtualNetworkProfile 虚拟网络配置文件。 VirtualNetworkProfile
VMGroupName 虚拟机组的名称。 字符串

ScriptAction

名字 描述 价值
名字 脚本操作的名称。 string （必需）
参数 提供的脚本的参数。 string （必需）
uri 脚本的 URI。 string （必需）

SecurityProfile

名字 描述 价值
aaddsResourceId 用户的 Azure Active Directory 域服务的资源 ID。 字符串
clusterUsersGroupDN 自选。 群集用户组的可分辨名称 string[]
directoryType 目录类型。 “ActiveDirectory”
域 组织的 Active Directory 域。 字符串
domainUsername 将在群集上具有管理员权限的域用户帐户。 字符串
domainUserPassword 域管理员密码。 字符串
ldapsUrls 要与 Active Directory 通信的 LDAPS 协议 URL。 string[]
msiResourceId 用户分配的标识有权在用户的 AADDS 中读取和创建与群集相关的项目。 字符串
organizationUnitDN Active Directory 中的组织单位，用于放置群集和服务帐户。 字符串

SshProfile

名字 描述 价值
publicKeys SSH 公钥的列表。 SshPublicKey[]

SshPublicKey

名字 描述 价值
certificateData SSH 的证书。 字符串

StorageAccount

名字 描述 价值
容器 存储帐户中的容器，仅用于为 WASB 存储帐户指定。 字符串
enableSecureChannel 启用安全通道，它是一个可选字段。 当群集版本 < 5.1 时，默认值为 false;当群集版本 >= 5.1 时为 true， bool
fileshare 文件共享名称。 字符串
fileSystem 文件系统，仅用于为 Azure Data Lake Storage Gen 2 指定。 字符串
isDefault 存储帐户是否为默认存储帐户。 bool
钥匙 存储帐户访问密钥。 字符串
msiResourceId 只能为 Azure Data Lake Storage Gen 2 指定允许访问存储帐户的托管标识（MSI）。 字符串
名字 存储帐户的名称。 字符串
resourceId 存储帐户的资源 ID，仅用于为 Azure Data Lake Storage Gen 2 指定。 字符串
saskey 共享访问签名密钥。 字符串

StorageProfile

名字 描述 价值
storageaccounts 群集中的存储帐户列表。 StorageAccount[]

UserAssignedIdentity

名字 描述 价值
tenantId 用户分配标识的租户 ID。 字符串

VirtualNetworkProfile

名字 描述 价值
id 虚拟网络的 ID。 字符串
子 子网的名称。 字符串

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件 描述
在 HDInsight 中部署基于 Linux 的 HBase 群集 此模板允许在 Azure HDInsight 中创建基于 Linux 的 HBase 群集。
在 Azure HDInsight 中部署 Spark 群集 使用此模板可以在 Azure HDInsight 中创建 Spark 群集。
在 HDInsight 中部署交互 Hive 群集 此模板允许在 HDInsight 和依赖的 Azure 存储帐户中创建 Interative Hive （LLAP） 群集。 群集的 SSH 身份验证方法是用户名和密码。 有关使用 SSH 公钥身份验证的模板，请参阅 /samples/azure/azure-quickstart-templates/hdinsight-linux-ssh-publickey
使用存储和 SSH 密码 部署 HDInsight 群集 此模板允许在 HDInsight 和依赖的 Azure 存储帐户中创建基于 Linux 的 Hadoop 群集。 群集的 SSH 身份验证方法是用户名和密码。 有关使用 SSH 公钥身份验证的模板，请参阅 /samples/azure/azure-quickstart-templates/hdinsight-linux-ssh-publickey/
在虚拟网络中部署 Kafka on HDInsight 此模板允许在虚拟网络中创建 Azure 虚拟网络和 Kafka on HDInsight 群集。 群集的 SSH 身份验证方法是用户名和密码。 有关使用 SSH 公钥身份验证的模板，请参阅 /samples/azure/azure-quickstart-templates/hdinsight-linux-ssh-publickey/

ARM 模板资源定义

可以使用目标操作部署群集资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.HDInsight/clusters 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.HDInsight/clusters",
  "apiVersion": "2023-08-15-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "tenantId": "string"
      }
    }
  },
  "location": "string",
  "properties": {
    "clusterDefinition": {
      "blueprint": "string",
      "componentVersion": {
        "{customized property}": "string"
      },
      "configurations": {},
      "kind": "string"
    },
    "clusterVersion": "string",
    "computeIsolationProperties": {
      "enableComputeIsolation": "bool",
      "hostSku": "string"
    },
    "computeProfile": {
      "roles": [
        {
          "autoscale": {
            "capacity": {
              "maxInstanceCount": "int",
              "minInstanceCount": "int"
            },
            "recurrence": {
              "schedule": [
                {
                  "days": [ "string" ],
                  "timeAndCapacity": {
                    "maxInstanceCount": "int",
                    "minInstanceCount": "int",
                    "time": "string"
                  }
                }
              ],
              "timeZone": "string"
            }
          },
          "dataDisksGroups": [
            {
              "disksPerNode": "int"
            }
          ],
          "encryptDataDisks": "bool",
          "hardwareProfile": {
            "vmSize": "string"
          },
          "minInstanceCount": "int",
          "name": "string",
          "osProfile": {
            "linuxOperatingSystemProfile": {
              "password": "string",
              "sshProfile": {
                "publicKeys": [
                  {
                    "certificateData": "string"
                  }
                ]
              },
              "username": "string"
            }
          },
          "scriptActions": [
            {
              "name": "string",
              "parameters": "string",
              "uri": "string"
            }
          ],
          "targetInstanceCount": "int",
          "virtualNetworkProfile": {
            "id": "string",
            "subnet": "string"
          },
          "VMGroupName": "string"
        }
      ]
    },
    "diskEncryptionProperties": {
      "encryptionAlgorithm": "string",
      "encryptionAtHost": "bool",
      "keyName": "string",
      "keyVersion": "string",
      "msiResourceId": "string",
      "vaultUri": "string"
    },
    "encryptionInTransitProperties": {
      "isEncryptionInTransitEnabled": "bool"
    },
    "kafkaRestProperties": {
      "clientGroupInfo": {
        "groupId": "string",
        "groupName": "string"
      },
      "configurationOverride": {
        "{customized property}": "string"
      }
    },
    "minSupportedTlsVersion": "string",
    "networkProperties": {
      "outboundDependenciesManagedType": "string",
      "privateLink": "string",
      "resourceProviderConnection": "string"
    },
    "osType": "string",
    "privateLinkConfigurations": [
      {
        "name": "string",
        "properties": {
          "groupId": "string",
          "ipConfigurations": [
            {
              "name": "string",
              "properties": {
                "primary": "bool",
                "privateIPAddress": "string",
                "privateIPAllocationMethod": "string",
                "subnet": {
                  "id": "string"
                }
              }
            }
          ]
        }
      }
    ],
    "securityProfile": {
      "aaddsResourceId": "string",
      "clusterUsersGroupDNs": [ "string" ],
      "directoryType": "string",
      "domain": "string",
      "domainUsername": "string",
      "domainUserPassword": "string",
      "ldapsUrls": [ "string" ],
      "msiResourceId": "string",
      "organizationalUnitDN": "string"
    },
    "storageProfile": {
      "storageaccounts": [
        {
          "container": "string",
          "enableSecureChannel": "bool",
          "fileshare": "string",
          "fileSystem": "string",
          "isDefault": "bool",
          "key": "string",
          "msiResourceId": "string",
          "name": "string",
          "resourceId": "string",
          "saskey": "string"
        }
      ]
    },
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  },
  "zones": [ "string" ]
}

属性值

自动缩放

名字 描述 价值
能力 基于负载的自动缩放的参数 AutoscaleCapacity
复发 基于计划的自动缩放的参数 AutoscaleRecurrence

AutoscaleCapacity

名字 描述 价值
maxInstanceCount 群集的最大实例计数 int
minInstanceCount 群集的最小实例计数 int

AutoscaleRecurrence

名字 描述 价值
附表 基于计划的自动缩放规则的数组 AutoscaleSchedule[]
timeZone 自动缩放计划时间的时区 字符串

AutoscaleSchedule

名字 描述 价值
日 基于计划的自动缩放规则的一周中的天数 包含任一项的字符串数组：
“Friday”
“Monday”
“Saturday”
“星期日”
“星期四”
“Tuesday”
“Wednesday”
timeAndCapacity 基于计划的自动缩放规则的时间和容量 AutoscaleTimeAndCapacity

AutoscaleTimeAndCapacity

名字 描述 价值
maxInstanceCount 群集的最大实例计数 int
minInstanceCount 群集的最小实例计数 int
时间 格式为 xx：xx 的 24 小时时间 字符串

ClientGroupInfo

名字 描述 价值
groupId AAD 安全组 ID。 字符串
groupName AAD 安全组名称。 字符串

ClusterCreateParametersExtendedTags

名字 描述 价值

ClusterCreatePropertiesOrClusterGetProperties

名字 描述 价值
clusterDefinition 群集定义。 ClusterDefinition
clusterVersion 群集的版本。 字符串
computeIsolationProperties 计算隔离属性。 ComputeIsolationProperties
computeProfile 计算配置文件。 ComputeProfile
diskEncryptionProperties 磁盘加密属性。 DiskEncryptionProperties
encryptionInTransitProperties 传输中加密属性。 EncryptionInTransitProperties
kafkaRestProperties 群集 kafka rest 代理配置。 KafkaRestProperties
minSupportedTlsVersion 支持的最低 tls 版本。 字符串
networkProperties 网络属性。 NetworkProperties
osType 操作系统的类型。 “Linux”
“Windows”
privateLinkConfigurations 专用链接配置。 PrivateLinkConfiguration[]
securityProfile 安全配置文件。 SecurityProfile
storageProfile 存储配置文件。 StorageProfile
层 群集层。 “Premium”
“Standard”

ClusterDefinition

名字 描述 价值
蓝图 指向蓝图的链接。 字符串
componentVersion 群集中不同服务的版本。 ClusterDefinitionComponentVersion
配置 群集配置。 任何
类 群集的类型。 字符串

ClusterDefinitionComponentVersion

名字 描述 价值

ClusterIdentity

名字 描述 价值
类型 用于群集的标识类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 “None”
“SystemAssigned”
“SystemAssigned，UserAssigned”
“UserAssigned”
userAssignedIdentities 与群集关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 ClusterIdentityUserAssignedIdentities

ClusterIdentityUserAssignedIdentities

名字 描述 价值

ComputeIsolationProperties

名字 描述 价值
enableComputeIsolation 该标志指示是否启用计算隔离。 bool
hostSku 主机 SKU。 字符串

ComputeProfile

名字 描述 价值
角色 群集中的角色列表。 角色[]

DataDisksGroups

名字 描述 价值
disksPerNode 每个节点的磁盘数。 int

DiskEncryptionProperties

名字 描述 价值
encryptionAlgorithm 加密算法标识符，默认 RSA-OAEP。 “RSA-OAEP”
“RSA-OAEP-256”
“RSA1_5”
encryptionAtHost 指示是否启用资源磁盘加密。 bool
keyName 用于启用磁盘加密的密钥名称。 字符串
keyVersion 用于启用磁盘加密的特定密钥版本。 字符串
msiResourceId 用于访问密钥保管库的托管标识的资源 ID。 字符串
vaultUri 客户密钥所在的基密钥保管库 URI，例如。https://myvault.vault.azure.net 字符串

EncryptionInTransitProperties

名字 描述 价值
isEncryptionInTransitEnabled 指示群集节点间通信是否在传输中加密。 bool

HardwareProfile

名字 描述 价值
vmSize VM 的大小 字符串

IPConfiguration

名字 描述 价值
名字 专用链接 IP 配置的名称。 string （必需）
性能 专用链接 IP 配置属性。 IPConfigurationProperties

IPConfigurationProperties

名字 描述 价值
主要 指示此 IP 配置是否是相应 NIC 的主要配置。 bool
privateIPAddress IP 地址。 字符串
privateIPAllocationMethod 分配专用 IP 地址的方法。 “dynamic”
“static”
子 子网资源 ID。 ResourceId

KafkaRestProperties

名字 描述 价值
clientGroupInfo AAD 安全组的信息。 ClientGroupInfo
configurationOverride 需要重写的配置。 KafkaRestPropertiesConfigurationOverride

KafkaRestPropertiesConfigurationOverride

名字 描述 价值

LinuxOperatingSystemProfile

名字 描述 价值
密码 密码。 字符串
sshProfile SSH 配置文件。 SshProfile
username 用户名。 字符串

Microsoft.HDInsight/clusters

名字 描述 价值
apiVersion API 版本 '2023-08-15-preview'
身份 群集的标识（如果已配置）。 ClusterIdentity
位置 群集的位置。 字符串
名字 资源名称 string （必需）
性能 群集创建参数。 ClusterCreatePropertiesOrClusterGetProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 “Microsoft.HDInsight/clusters”
区 可用性区域。 string[]

NetworkProperties

名字 描述 价值
outboundDependenciesManagedType 一个值，用于描述如何管理 HDInsight 群集的出站依赖项。 “Managed”表示出站依赖项由 HDInsight 服务管理。 “外部”表示出站依赖项由客户特定的解决方案管理。 “External”
“Managed”
privateLink 指示是否启用专用链接。 “Disabled”
“Enabled”
resourceProviderConnection 资源提供程序连接的方向。 “Inbound”
“Outbound”

OsProfile

名字 描述 价值
linuxOperatingSystemProfile Linux OS 配置文件。 LinuxOperatingSystemProfile

PrivateLinkConfiguration

名字 描述 价值
名字 专用链接配置的名称。 string （必需）
性能 专用链接配置属性。 PrivateLinkConfigurationProperties（必需）

PrivateLinkConfigurationProperties

名字 描述 价值
groupId 要向其应用专用链接配置的 HDInsight 专用可链接子资源名称。 例如，“headnode”、“gateway”、“edgenode”。 string （必需）
ipConfigurations 专用链接服务的 IP 配置。 IPConfiguration[] （必需）

ResourceId

名字 描述 价值
id Azure 资源 ID。 字符串

角色

名字 描述 价值
自动缩放 自动缩放配置。 自动缩放
dataDisksGroups 角色的数据磁盘组。 DataDisksGroups[]
encryptDataDisks 指示是否加密数据磁盘。 bool
hardwareProfile 硬件配置文件。 HardwareProfile
minInstanceCount 群集的最小实例计数。 int
名字 角色的名称。 字符串
osProfile 操作系统配置文件。 OsProfile
scriptActions 角色上的脚本操作列表。 ScriptAction[]
targetInstanceCount 群集的实例计数。 int
virtualNetworkProfile 虚拟网络配置文件。 VirtualNetworkProfile
VMGroupName 虚拟机组的名称。 字符串

ScriptAction

名字 描述 价值
名字 脚本操作的名称。 string （必需）
参数 提供的脚本的参数。 string （必需）
uri 脚本的 URI。 string （必需）

SecurityProfile

名字 描述 价值
aaddsResourceId 用户的 Azure Active Directory 域服务的资源 ID。 字符串
clusterUsersGroupDN 自选。 群集用户组的可分辨名称 string[]
directoryType 目录类型。 “ActiveDirectory”
域 组织的 Active Directory 域。 字符串
domainUsername 将在群集上具有管理员权限的域用户帐户。 字符串
domainUserPassword 域管理员密码。 字符串
ldapsUrls 要与 Active Directory 通信的 LDAPS 协议 URL。 string[]
msiResourceId 用户分配的标识有权在用户的 AADDS 中读取和创建与群集相关的项目。 字符串
organizationUnitDN Active Directory 中的组织单位，用于放置群集和服务帐户。 字符串

SshProfile

名字 描述 价值
publicKeys SSH 公钥的列表。 SshPublicKey[]

SshPublicKey

名字 描述 价值
certificateData SSH 的证书。 字符串

StorageAccount

名字 描述 价值
容器 存储帐户中的容器，仅用于为 WASB 存储帐户指定。 字符串
enableSecureChannel 启用安全通道，它是一个可选字段。 当群集版本 < 5.1 时，默认值为 false;当群集版本 >= 5.1 时为 true， bool
fileshare 文件共享名称。 字符串
fileSystem 文件系统，仅用于为 Azure Data Lake Storage Gen 2 指定。 字符串
isDefault 存储帐户是否为默认存储帐户。 bool
钥匙 存储帐户访问密钥。 字符串
msiResourceId 只能为 Azure Data Lake Storage Gen 2 指定允许访问存储帐户的托管标识（MSI）。 字符串
名字 存储帐户的名称。 字符串
resourceId 存储帐户的资源 ID，仅用于为 Azure Data Lake Storage Gen 2 指定。 字符串
saskey 共享访问签名密钥。 字符串

StorageProfile

名字 描述 价值
storageaccounts 群集中的存储帐户列表。 StorageAccount[]

UserAssignedIdentity

名字 描述 价值
tenantId 用户分配标识的租户 ID。 字符串

VirtualNetworkProfile

名字 描述 价值
id 虚拟网络的 ID。 字符串
子 子网的名称。 字符串

快速入门模板

以下快速入门模板部署此资源类型。

模板 描述
创建 HDInsight Linux 群集并运行脚本操作

部署到 Azure 		模板在虚拟网络中创建 HDInsight Linux 群集，然后在每个节点上运行自定义脚本操作并设置环境 var。
创建运行 ADAM 的 HDInsight 群集

部署到 Azure 		创建运行基因组学分析平台 ADAM 的 HDInsight linux 群集
创建运行 Apache Spark 1.4.1 的 HDInsight 群集

部署到 Azure 		创建运行 Apache Spark 1.4.1 的 HDInsight linux 群集。
部署 HDInsight 群集和 SQL 数据库

部署到 Azure 		使用此模板可以创建 HDInsight 群集和用于测试 Sqoop 的 SQL 数据库。
使用边缘节点 部署 HDInsight 群集

部署到 Azure 		使用此模板可以创建运行 Linux 的 HDInsight 群集，其中包含空边缘节点。 有关详细信息，请参阅 /azure/hdinsight/hdinsight-apps-use-edge-node
在 HDInsight 中部署基于 Linux 的 HBase 群集

部署到 Azure 		此模板允许在 Azure HDInsight 中创建基于 Linux 的 HBase 群集。
在 VNet 中部署安全的 VNet 和 HDInsight 群集

部署到 Azure 		通过此模板，可以创建在 VNet 中运行 Linux 的 Azure VNet 和 HDInsight Hadoop 群集。
在 VNet 中部署 Spark 群集

部署到 Azure 		此模板允许在 VNet 中创建 Azure VNet 和 HDInsight Spark 群集。
在 Azure HDInsight 中部署 Spark 群集

部署到 Azure 		使用此模板可以在 Azure HDInsight 中创建 Spark 群集。
在 VNet 中部署 VNet 和 HBase 群集

部署到 Azure 		通过此模板，可以创建在 VNet 中运行 Linux 的 Azure VNet 和 HDInsight HBase 群集。
在 VNet 中部署 Azure VNet 和两个 HBase 群集

部署到 Azure 		使用此模板，可以在 VNet 中配置具有两个 HBase 群集的 HBase 环境，以便配置 HBase 复制。
在 HDInsight 中部署交互 Hive 群集

部署到 Azure 		此模板允许在 HDInsight 和依赖的 Azure 存储帐户中创建 Interative Hive （LLAP） 群集。 群集的 SSH 身份验证方法是用户名和密码。 有关使用 SSH 公钥身份验证的模板，请参阅 /samples/azure/azure-quickstart-templates/hdinsight-linux-ssh-publickey
部署 R-server HDInsight 群集

部署到 Azure 		使用此模板，可以使用 R Server for HDInsight 创建运行 Linux 的 HDInsight 群集。 此模板还会创建 Azure 存储帐户。 群集的 SSH 身份验证方法是用户名/密码。
在一个区域中部署具有两个 VNet 的 HBase 复制

部署到 Azure 		使用此模板，可以在同一区域中的两个 VNet 中配置具有两个 HBase 群集的一个 HBase 环境，以便配置 HBase 复制。
部署 HDInsight 群集 + Confluent 架构注册表节点

部署到 Azure 		使用此模板，可以使用架构注册表边缘节点创建运行 Linux 的 HDInsight 群集。 有关详细信息，请参阅 /azure/hdinsight/hdinsight-apps-use-edge-node
部署具有现有默认存储 的 HDInsight 群集

部署到 Azure 		使用此模板可以在 HDInsight 中创建 Hadoop 群集。 群集使用现有的存储帐户作为默认存储加入。
使用现有链接存储部署 HDInsight 群集

部署到 Azure 		此模板允许在 HDInsight 中创建 Hadoop 群集和依赖的默认存储帐户。 该模板还会链接现有存储帐户。 链接的存储帐户通常包含业务数据。
使用存储和 SSH 密码 部署 HDInsight 群集

部署到 Azure 		此模板允许在 HDInsight 和依赖的 Azure 存储帐户中创建基于 Linux 的 Hadoop 群集。 群集的 SSH 身份验证方法是用户名和密码。 有关使用 SSH 公钥身份验证的模板，请参阅 /samples/azure/azure-quickstart-templates/hdinsight-linux-ssh-publickey/
在 Linux 上部署 HDInsight （w/ Azure 存储， SSH 密钥）

部署到 Azure 		使用此模板可以创建运行 Linux 的 HDInsight 群集。 此模板还会创建 Azure 存储帐户。 群集的 SSH 身份验证方法是用户名/公钥。
在新的 Data Lake Store 和存储 上部署 HDInsight

部署到 Azure 		使用此模板，可以使用新的 Data Lake Store 和存储帐户部署新的 Linux HDInsight 群集。
在虚拟网络中部署 Kafka on HDInsight

部署到 Azure 		此模板允许在虚拟网络中创建 Azure 虚拟网络和 Kafka on HDInsight 群集。 群集的 SSH 身份验证方法是用户名和密码。 有关使用 SSH 公钥身份验证的模板，请参阅 /samples/azure/azure-quickstart-templates/hdinsight-linux-ssh-publickey/
在 HDInsight 中部署具有增强写入的 Linux HBase 群集

部署到 Azure 		通过此模板，可以在 Azure HDInsight 中创建基于 Linux 的 HBase 群集并增强写入。
HDInsight （现有 Hive 元存储上的 Linux、SSH、vnet）

部署到 Azure 		此模板允许在现有的 Hive 元存储和虚拟网络上创建运行 Linux 的 HDInsight 群集。 群集的 SSH 身份验证方法是用户名/密码。
TLS 版本 1.2 或更高版本的 HDInsight 群集

部署到 Azure 		使用此模板可以创建一个 HDInsight 群集，该群集的 TLS 协议强制为 1.2 或更高版本。
在 VNET 中使用自定义 Ambari + Hive 元存储 DB HDInsight

部署到 Azure 		此模板允许在现有虚拟网络中创建 HDInsight 群集，该群集具有新的 SQL DB，该数据库既充当自定义 Ambari DB，又充当 Hive 元存储。 必须具有现有的 SQL Sever、存储帐户和 VNET。
使用基于负载的自动缩放启用 HDInsight

部署到 Azure 		使用此模板可以创建启用了基于负载的自动缩放的 HDInsight Spark 群集。
使用基于计划的自动缩放启用 HDInsight

部署到 Azure 		使用此模板，可以创建启用了基于计划的自动缩放的 HDInsight Spark 群集。

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署群集资源类型：

  • 资源组

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.HDInsight/clusters 资源，请将以下 Terraform 添加到模板中。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.HDInsight/clusters@2023-08-15-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
        tenantId = "string"
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  zones = [
    "string"
  ]
  body = jsonencode({
    properties = {
      clusterDefinition = {
        blueprint = "string"
        componentVersion = {
          {customized property} = "string"
        }
        configurations = ?
        kind = "string"
      }
      clusterVersion = "string"
      computeIsolationProperties = {
        enableComputeIsolation = bool
        hostSku = "string"
      }
      computeProfile = {
        roles = [
          {
            autoscale = {
              capacity = {
                maxInstanceCount = int
                minInstanceCount = int
              }
              recurrence = {
                schedule = [
                  {
                    days = [
                      "string"
                    ]
                    timeAndCapacity = {
                      maxInstanceCount = int
                      minInstanceCount = int
                      time = "string"
                    }
                  }
                ]
                timeZone = "string"
              }
            }
            dataDisksGroups = [
              {
                disksPerNode = int
              }
            ]
            encryptDataDisks = bool
            hardwareProfile = {
              vmSize = "string"
            }
            minInstanceCount = int
            name = "string"
            osProfile = {
              linuxOperatingSystemProfile = {
                password = "string"
                sshProfile = {
                  publicKeys = [
                    {
                      certificateData = "string"
                    }
                  ]
                }
                username = "string"
              }
            }
            scriptActions = [
              {
                name = "string"
                parameters = "string"
                uri = "string"
              }
            ]
            targetInstanceCount = int
            virtualNetworkProfile = {
              id = "string"
              subnet = "string"
            }
            VMGroupName = "string"
          }
        ]
      }
      diskEncryptionProperties = {
        encryptionAlgorithm = "string"
        encryptionAtHost = bool
        keyName = "string"
        keyVersion = "string"
        msiResourceId = "string"
        vaultUri = "string"
      }
      encryptionInTransitProperties = {
        isEncryptionInTransitEnabled = bool
      }
      kafkaRestProperties = {
        clientGroupInfo = {
          groupId = "string"
          groupName = "string"
        }
        configurationOverride = {
          {customized property} = "string"
        }
      }
      minSupportedTlsVersion = "string"
      networkProperties = {
        outboundDependenciesManagedType = "string"
        privateLink = "string"
        resourceProviderConnection = "string"
      }
      osType = "string"
      privateLinkConfigurations = [
        {
          name = "string"
          properties = {
            groupId = "string"
            ipConfigurations = [
              {
                name = "string"
                properties = {
                  primary = bool
                  privateIPAddress = "string"
                  privateIPAllocationMethod = "string"
                  subnet = {
                    id = "string"
                  }
                }
              }
            ]
          }
        }
      ]
      securityProfile = {
        aaddsResourceId = "string"
        clusterUsersGroupDNs = [
          "string"
        ]
        directoryType = "string"
        domain = "string"
        domainUsername = "string"
        domainUserPassword = "string"
        ldapsUrls = [
          "string"
        ]
        msiResourceId = "string"
        organizationalUnitDN = "string"
      }
      storageProfile = {
        storageaccounts = [
          {
            container = "string"
            enableSecureChannel = bool
            fileshare = "string"
            fileSystem = "string"
            isDefault = bool
            key = "string"
            msiResourceId = "string"
            name = "string"
            resourceId = "string"
            saskey = "string"
          }
        ]
      }
      tier = "string"
    }
  })
}

属性值

自动缩放

名字 描述 价值
能力 基于负载的自动缩放的参数 AutoscaleCapacity
复发 基于计划的自动缩放的参数 AutoscaleRecurrence

AutoscaleCapacity

名字 描述 价值
maxInstanceCount 群集的最大实例计数 int
minInstanceCount 群集的最小实例计数 int

AutoscaleRecurrence

名字 描述 价值
附表 基于计划的自动缩放规则的数组 AutoscaleSchedule[]
timeZone 自动缩放计划时间的时区 字符串

AutoscaleSchedule

名字 描述 价值
日 基于计划的自动缩放规则的一周中的天数 包含任一项的字符串数组：
“Friday”
“Monday”
“Saturday”
“星期日”
“星期四”
“Tuesday”
“Wednesday”
timeAndCapacity 基于计划的自动缩放规则的时间和容量 AutoscaleTimeAndCapacity

AutoscaleTimeAndCapacity

名字 描述 价值
maxInstanceCount 群集的最大实例计数 int
minInstanceCount 群集的最小实例计数 int
时间 格式为 xx：xx 的 24 小时时间 字符串

ClientGroupInfo

名字 描述 价值
groupId AAD 安全组 ID。 字符串
groupName AAD 安全组名称。 字符串

ClusterCreateParametersExtendedTags

名字 描述 价值

ClusterCreatePropertiesOrClusterGetProperties

名字 描述 价值
clusterDefinition 群集定义。 ClusterDefinition
clusterVersion 群集的版本。 字符串
computeIsolationProperties 计算隔离属性。 ComputeIsolationProperties
computeProfile 计算配置文件。 ComputeProfile
diskEncryptionProperties 磁盘加密属性。 DiskEncryptionProperties
encryptionInTransitProperties 传输中加密属性。 EncryptionInTransitProperties
kafkaRestProperties 群集 kafka rest 代理配置。 KafkaRestProperties
minSupportedTlsVersion 支持的最低 tls 版本。 字符串
networkProperties 网络属性。 NetworkProperties
osType 操作系统的类型。 “Linux”
“Windows”
privateLinkConfigurations 专用链接配置。 PrivateLinkConfiguration[]
securityProfile 安全配置文件。 SecurityProfile
storageProfile 存储配置文件。 StorageProfile
层 群集层。 “Premium”
“Standard”

ClusterDefinition

名字 描述 价值
蓝图 指向蓝图的链接。 字符串
componentVersion 群集中不同服务的版本。 ClusterDefinitionComponentVersion
配置 群集配置。 任何
类 群集的类型。 字符串

ClusterDefinitionComponentVersion

名字 描述 价值

ClusterIdentity

名字 描述 价值
类型 用于群集的标识类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 “None”
“SystemAssigned”
“SystemAssigned，UserAssigned”
“UserAssigned”
userAssignedIdentities 与群集关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 ClusterIdentityUserAssignedIdentities

ClusterIdentityUserAssignedIdentities

名字 描述 价值

ComputeIsolationProperties

名字 描述 价值
enableComputeIsolation 该标志指示是否启用计算隔离。 bool
hostSku 主机 SKU。 字符串

ComputeProfile

名字 描述 价值
角色 群集中的角色列表。 角色[]

DataDisksGroups

名字 描述 价值
disksPerNode 每个节点的磁盘数。 int

DiskEncryptionProperties

名字 描述 价值
encryptionAlgorithm 加密算法标识符，默认 RSA-OAEP。 “RSA-OAEP”
“RSA-OAEP-256”
“RSA1_5”
encryptionAtHost 指示是否启用资源磁盘加密。 bool
keyName 用于启用磁盘加密的密钥名称。 字符串
keyVersion 用于启用磁盘加密的特定密钥版本。 字符串
msiResourceId 用于访问密钥保管库的托管标识的资源 ID。 字符串
vaultUri 客户密钥所在的基密钥保管库 URI，例如。https://myvault.vault.azure.net 字符串

EncryptionInTransitProperties

名字 描述 价值
isEncryptionInTransitEnabled 指示群集节点间通信是否在传输中加密。 bool

HardwareProfile

名字 描述 价值
vmSize VM 的大小 字符串

IPConfiguration

名字 描述 价值
名字 专用链接 IP 配置的名称。 string （必需）
性能 专用链接 IP 配置属性。 IPConfigurationProperties

IPConfigurationProperties

名字 描述 价值
主要 指示此 IP 配置是否是相应 NIC 的主要配置。 bool
privateIPAddress IP 地址。 字符串
privateIPAllocationMethod 分配专用 IP 地址的方法。 “dynamic”
“static”
子 子网资源 ID。 ResourceId

KafkaRestProperties

名字 描述 价值
clientGroupInfo AAD 安全组的信息。 ClientGroupInfo
configurationOverride 需要重写的配置。 KafkaRestPropertiesConfigurationOverride

KafkaRestPropertiesConfigurationOverride

名字 描述 价值

LinuxOperatingSystemProfile

名字 描述 价值
密码 密码。 字符串
sshProfile SSH 配置文件。 SshProfile
username 用户名。 字符串

Microsoft.HDInsight/clusters

名字 描述 价值
身份 群集的标识（如果已配置）。 ClusterIdentity
位置 群集的位置。 字符串
名字 资源名称 string （必需）
性能 群集创建参数。 ClusterCreatePropertiesOrClusterGetProperties
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.HDInsight/clusters@2023-08-15-preview”
区 可用性区域。 string[]

NetworkProperties

名字 描述 价值
outboundDependenciesManagedType 一个值，用于描述如何管理 HDInsight 群集的出站依赖项。 “Managed”表示出站依赖项由 HDInsight 服务管理。 “外部”表示出站依赖项由客户特定的解决方案管理。 “External”
“Managed”
privateLink 指示是否启用专用链接。 “Disabled”
“Enabled”
resourceProviderConnection 资源提供程序连接的方向。 “Inbound”
“Outbound”

OsProfile

名字 描述 价值
linuxOperatingSystemProfile Linux OS 配置文件。 LinuxOperatingSystemProfile

PrivateLinkConfiguration

名字 描述 价值
名字 专用链接配置的名称。 string （必需）
性能 专用链接配置属性。 PrivateLinkConfigurationProperties（必需）

PrivateLinkConfigurationProperties

名字 描述 价值
groupId 要向其应用专用链接配置的 HDInsight 专用可链接子资源名称。 例如，“headnode”、“gateway”、“edgenode”。 string （必需）
ipConfigurations 专用链接服务的 IP 配置。 IPConfiguration[] （必需）

ResourceId

名字 描述 价值
id Azure 资源 ID。 字符串

角色

名字 描述 价值
自动缩放 自动缩放配置。 自动缩放
dataDisksGroups 角色的数据磁盘组。 DataDisksGroups[]
encryptDataDisks 指示是否加密数据磁盘。 bool
hardwareProfile 硬件配置文件。 HardwareProfile
minInstanceCount 群集的最小实例计数。 int
名字 角色的名称。 字符串
osProfile 操作系统配置文件。 OsProfile
scriptActions 角色上的脚本操作列表。 ScriptAction[]
targetInstanceCount 群集的实例计数。 int
virtualNetworkProfile 虚拟网络配置文件。 VirtualNetworkProfile
VMGroupName 虚拟机组的名称。 字符串

ScriptAction

名字 描述 价值
名字 脚本操作的名称。 string （必需）
参数 提供的脚本的参数。 string （必需）
uri 脚本的 URI。 string （必需）

SecurityProfile

名字 描述 价值
aaddsResourceId 用户的 Azure Active Directory 域服务的资源 ID。 字符串
clusterUsersGroupDN 自选。 群集用户组的可分辨名称 string[]
directoryType 目录类型。 “ActiveDirectory”
域 组织的 Active Directory 域。 字符串
domainUsername 将在群集上具有管理员权限的域用户帐户。 字符串
domainUserPassword 域管理员密码。 字符串
ldapsUrls 要与 Active Directory 通信的 LDAPS 协议 URL。 string[]
msiResourceId 用户分配的标识有权在用户的 AADDS 中读取和创建与群集相关的项目。 字符串
organizationUnitDN Active Directory 中的组织单位，用于放置群集和服务帐户。 字符串

SshProfile

名字 描述 价值
publicKeys SSH 公钥的列表。 SshPublicKey[]

SshPublicKey

名字 描述 价值
certificateData SSH 的证书。 字符串

StorageAccount

名字 描述 价值
容器 存储帐户中的容器，仅用于为 WASB 存储帐户指定。 字符串
enableSecureChannel 启用安全通道，它是一个可选字段。 当群集版本 < 5.1 时，默认值为 false;当群集版本 >= 5.1 时为 true， bool
fileshare 文件共享名称。 字符串
fileSystem 文件系统，仅用于为 Azure Data Lake Storage Gen 2 指定。 字符串
isDefault 存储帐户是否为默认存储帐户。 bool
钥匙 存储帐户访问密钥。 字符串
msiResourceId 只能为 Azure Data Lake Storage Gen 2 指定允许访问存储帐户的托管标识（MSI）。 字符串
名字 存储帐户的名称。 字符串
resourceId 存储帐户的资源 ID，仅用于为 Azure Data Lake Storage Gen 2 指定。 字符串
saskey 共享访问签名密钥。 字符串

StorageProfile

名字 描述 价值
storageaccounts 群集中的存储帐户列表。 StorageAccount[]

UserAssignedIdentity

名字 描述 价值
tenantId 用户分配标识的租户 ID。 字符串

VirtualNetworkProfile

名字 描述 价值
id 虚拟网络的 ID。 字符串
子 子网的名称。 字符串