你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Microsoft.HDInsight 群集/应用程序 2023-08-15-preview
Bicep 资源定义
可以使用目标操作部署群集/应用程序资源类型:
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
若要创建 Microsoft.HDInsight/clusters/applications 资源,请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.HDInsight/clusters/applications@2023-08-15-preview' = {
parent: resourceSymbolicName
etag: 'string'
name: 'string'
properties: {
applicationType: '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'
}
]
}
errors: [
{
code: 'string'
message: 'string'
}
]
httpsEndpoints: [
{
accessModes: [
'string'
]
destinationPort: int
disableGatewayAuth: bool
privateIPAddress: 'string'
subDomainSuffix: 'string'
}
]
installScriptActions: [
{
name: 'string'
parameters: 'string'
roles: [
'string'
]
uri: 'string'
}
]
privateLinkConfigurations: [
{
name: 'string'
properties: {
groupId: 'string'
ipConfigurations: [
{
name: 'string'
properties: {
primary: bool
privateIPAddress: 'string'
privateIPAllocationMethod: 'string'
subnet: {
id: 'string'
}
}
}
]
}
}
]
sshEndpoints: [
{
destinationPort: int
location: 'string'
privateIPAddress: 'string'
publicPort: int
}
]
uninstallScriptActions: [
{
name: 'string'
parameters: 'string'
roles: [
'string'
]
uri: 'string'
}
]
}
tags: {
{customized property}: 'string'
}
}
属性值
ApplicationGetEndpoint
名字 |
描述 |
价值 |
destinationPort |
要连接到的目标端口。 |
int |
位置 |
终结点的位置。 |
字符串 |
privateIPAddress |
终结点的专用 IP 地址。 |
字符串 |
publicPort |
要连接到的公共端口。 |
int |
ApplicationGetHttpsEndpoint
名字 |
描述 |
价值 |
accessModes |
应用程序的访问模式列表。 |
string[] |
destinationPort |
要连接到的目标端口。 |
int |
disableGatewayAuth |
该值指示是否禁用 GatewayAuth。 |
bool |
privateIPAddress |
终结点的专用 IP 地址。 |
字符串 |
subDomainSuffix |
应用程序的子域后缀。 |
字符串 |
ApplicationProperties
自动缩放
AutoscaleCapacity
名字 |
描述 |
价值 |
maxInstanceCount |
群集的最大实例计数 |
int |
minInstanceCount |
群集的最小实例计数 |
int |
AutoscaleRecurrence
AutoscaleSchedule
名字 |
描述 |
价值 |
日 |
基于计划的自动缩放规则的一周中的天数 |
包含任一项的字符串数组: “Friday” “Monday” “Saturday” “星期日” “星期四” “Tuesday” “Wednesday” |
timeAndCapacity |
基于计划的自动缩放规则的时间和容量 |
AutoscaleTimeAndCapacity |
AutoscaleTimeAndCapacity
名字 |
描述 |
价值 |
maxInstanceCount |
群集的最大实例计数 |
int |
minInstanceCount |
群集的最小实例计数 |
int |
时间 |
格式为 xx:xx 的 24 小时时间 |
字符串 |
ComputeProfile
名字 |
描述 |
价值 |
角色 |
群集中的角色列表。 |
角色[] |
DataDisksGroups
名字 |
描述 |
价值 |
disksPerNode |
每个节点的磁盘数。 |
int |
错误
名字 |
描述 |
价值 |
法典 |
错误代码。 |
字符串 |
消息 |
错误消息。 |
字符串 |
HardwareProfile
名字 |
描述 |
价值 |
vmSize |
VM 的大小 |
字符串 |
IPConfiguration
IPConfigurationProperties
名字 |
描述 |
价值 |
主要 |
指示此 IP 配置是否是相应 NIC 的主要配置。 |
bool |
privateIPAddress |
IP 地址。 |
字符串 |
privateIPAllocationMethod |
分配专用 IP 地址的方法。 |
“dynamic” “static” |
子 |
子网资源 ID。 |
ResourceId |
LinuxOperatingSystemProfile
名字 |
描述 |
价值 |
密码 |
密码。 |
字符串 |
sshProfile |
SSH 配置文件。 |
SshProfile |
username |
用户名。 |
字符串 |
Microsoft.HDInsight/clusters/applications
名字 |
描述 |
价值 |
etag |
应用程序的 ETag |
字符串 |
名字 |
资源名称 |
string (必需) |
父母 |
在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。
有关详细信息,请参阅 父资源外部的子资源。 |
类型资源的符号名称:群集 |
性能 |
应用程序的属性。 |
ApplicationProperties |
标签 |
资源标记 |
标记名称和值的字典。 请参阅模板 中的 标记 |
OsProfile
PrivateLinkConfiguration
PrivateLinkConfigurationProperties
名字 |
描述 |
价值 |
groupId |
要向其应用专用链接配置的 HDInsight 专用可链接子资源名称。 例如,“headnode”、“gateway”、“edgenode”。 |
string (必需) |
ipConfigurations |
专用链接服务的 IP 配置。 |
IPConfiguration[] (必需) |
ResourceId
名字 |
描述 |
价值 |
id |
Azure 资源 ID。 |
字符串 |
角色
RuntimeScriptAction
名字 |
描述 |
价值 |
名字 |
脚本操作的名称。 |
string (必需) |
参数 |
脚本的参数 |
字符串 |
角色 |
将执行脚本的角色列表。 |
string[] (必需) |
uri |
脚本的 URI。 |
string (必需) |
ScriptAction
名字 |
描述 |
价值 |
名字 |
脚本操作的名称。 |
string (必需) |
参数 |
提供的脚本的参数。 |
string (必需) |
uri |
脚本的 URI。 |
string (必需) |
SshProfile
SshPublicKey
名字 |
描述 |
价值 |
certificateData |
SSH 的证书。 |
字符串 |
VirtualNetworkProfile
名字 |
描述 |
价值 |
id |
虚拟网络的 ID。 |
字符串 |
子 |
子网的名称。 |
字符串 |
ARM 模板资源定义
可以使用目标操作部署群集/应用程序资源类型:
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
若要创建 Microsoft.HDInsight/clusters/applications 资源,请将以下 JSON 添加到模板。
{
"type": "Microsoft.HDInsight/clusters/applications",
"apiVersion": "2023-08-15-preview",
"name": "string",
"etag": "string",
"properties": {
"applicationType": "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"
}
]
},
"errors": [
{
"code": "string",
"message": "string"
}
],
"httpsEndpoints": [
{
"accessModes": [ "string" ],
"destinationPort": "int",
"disableGatewayAuth": "bool",
"privateIPAddress": "string",
"subDomainSuffix": "string"
}
],
"installScriptActions": [
{
"name": "string",
"parameters": "string",
"roles": [ "string" ],
"uri": "string"
}
],
"privateLinkConfigurations": [
{
"name": "string",
"properties": {
"groupId": "string",
"ipConfigurations": [
{
"name": "string",
"properties": {
"primary": "bool",
"privateIPAddress": "string",
"privateIPAllocationMethod": "string",
"subnet": {
"id": "string"
}
}
}
]
}
}
],
"sshEndpoints": [
{
"destinationPort": "int",
"location": "string",
"privateIPAddress": "string",
"publicPort": "int"
}
],
"uninstallScriptActions": [
{
"name": "string",
"parameters": "string",
"roles": [ "string" ],
"uri": "string"
}
]
},
"tags": {
"{customized property}": "string"
}
}
属性值
ApplicationGetEndpoint
名字 |
描述 |
价值 |
destinationPort |
要连接到的目标端口。 |
int |
位置 |
终结点的位置。 |
字符串 |
privateIPAddress |
终结点的专用 IP 地址。 |
字符串 |
publicPort |
要连接到的公共端口。 |
int |
ApplicationGetHttpsEndpoint
名字 |
描述 |
价值 |
accessModes |
应用程序的访问模式列表。 |
string[] |
destinationPort |
要连接到的目标端口。 |
int |
disableGatewayAuth |
该值指示是否禁用 GatewayAuth。 |
bool |
privateIPAddress |
终结点的专用 IP 地址。 |
字符串 |
subDomainSuffix |
应用程序的子域后缀。 |
字符串 |
ApplicationProperties
自动缩放
AutoscaleCapacity
名字 |
描述 |
价值 |
maxInstanceCount |
群集的最大实例计数 |
int |
minInstanceCount |
群集的最小实例计数 |
int |
AutoscaleRecurrence
AutoscaleSchedule
名字 |
描述 |
价值 |
日 |
基于计划的自动缩放规则的一周中的天数 |
包含任一项的字符串数组: “Friday” “Monday” “Saturday” “星期日” “星期四” “Tuesday” “Wednesday” |
timeAndCapacity |
基于计划的自动缩放规则的时间和容量 |
AutoscaleTimeAndCapacity |
AutoscaleTimeAndCapacity
名字 |
描述 |
价值 |
maxInstanceCount |
群集的最大实例计数 |
int |
minInstanceCount |
群集的最小实例计数 |
int |
时间 |
格式为 xx:xx 的 24 小时时间 |
字符串 |
ComputeProfile
名字 |
描述 |
价值 |
角色 |
群集中的角色列表。 |
角色[] |
DataDisksGroups
名字 |
描述 |
价值 |
disksPerNode |
每个节点的磁盘数。 |
int |
错误
名字 |
描述 |
价值 |
法典 |
错误代码。 |
字符串 |
消息 |
错误消息。 |
字符串 |
HardwareProfile
名字 |
描述 |
价值 |
vmSize |
VM 的大小 |
字符串 |
IPConfiguration
IPConfigurationProperties
名字 |
描述 |
价值 |
主要 |
指示此 IP 配置是否是相应 NIC 的主要配置。 |
bool |
privateIPAddress |
IP 地址。 |
字符串 |
privateIPAllocationMethod |
分配专用 IP 地址的方法。 |
“dynamic” “static” |
子 |
子网资源 ID。 |
ResourceId |
LinuxOperatingSystemProfile
名字 |
描述 |
价值 |
密码 |
密码。 |
字符串 |
sshProfile |
SSH 配置文件。 |
SshProfile |
username |
用户名。 |
字符串 |
Microsoft.HDInsight/clusters/applications
名字 |
描述 |
价值 |
apiVersion |
API 版本 |
'2023-08-15-preview' |
etag |
应用程序的 ETag |
字符串 |
名字 |
资源名称 |
string (必需) |
性能 |
应用程序的属性。 |
ApplicationProperties |
标签 |
资源标记 |
标记名称和值的字典。 请参阅模板 中的 标记 |
类型 |
资源类型 |
“Microsoft.HDInsight/clusters/applications” |
OsProfile
PrivateLinkConfiguration
PrivateLinkConfigurationProperties
名字 |
描述 |
价值 |
groupId |
要向其应用专用链接配置的 HDInsight 专用可链接子资源名称。 例如,“headnode”、“gateway”、“edgenode”。 |
string (必需) |
ipConfigurations |
专用链接服务的 IP 配置。 |
IPConfiguration[] (必需) |
ResourceId
名字 |
描述 |
价值 |
id |
Azure 资源 ID。 |
字符串 |
角色
RuntimeScriptAction
名字 |
描述 |
价值 |
名字 |
脚本操作的名称。 |
string (必需) |
参数 |
脚本的参数 |
字符串 |
角色 |
将执行脚本的角色列表。 |
string[] (必需) |
uri |
脚本的 URI。 |
string (必需) |
ScriptAction
名字 |
描述 |
价值 |
名字 |
脚本操作的名称。 |
string (必需) |
参数 |
提供的脚本的参数。 |
string (必需) |
uri |
脚本的 URI。 |
string (必需) |
SshProfile
SshPublicKey
名字 |
描述 |
价值 |
certificateData |
SSH 的证书。 |
字符串 |
VirtualNetworkProfile
名字 |
描述 |
价值 |
id |
虚拟网络的 ID。 |
字符串 |
子 |
子网的名称。 |
字符串 |
快速入门模板
以下快速入门模板部署此资源类型。
模板 |
描述 |
使用边缘节点 部署 HDInsight 群集
|
使用此模板可以创建运行 Linux 的 HDInsight 群集,其中包含空边缘节点。 有关详细信息,请参阅 /azure/hdinsight/hdinsight-apps-use-edge-node |
将边缘节点部署到现有 HDInsight 群集
|
使用此模板可以创建一个空边缘节点并将其添加到现有的 HDInsight 群集。 有关详细信息,请参阅 /azure/hdinsight/hdinsight-apps-use-edge-node |
部署 HDInsight 群集 + Confluent 架构注册表节点
|
使用此模板,可以使用架构注册表边缘节点创建运行 Linux 的 HDInsight 群集。 有关详细信息,请参阅 /azure/hdinsight/hdinsight-apps-use-edge-node |
可以使用目标操作部署群集/应用程序资源类型:
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
若要创建 Microsoft.HDInsight/clusters/applications 资源,请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.HDInsight/clusters/applications@2023-08-15-preview"
name = "string"
etag = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
applicationType = "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"
}
]
}
errors = [
{
code = "string"
message = "string"
}
]
httpsEndpoints = [
{
accessModes = [
"string"
]
destinationPort = int
disableGatewayAuth = bool
privateIPAddress = "string"
subDomainSuffix = "string"
}
]
installScriptActions = [
{
name = "string"
parameters = "string"
roles = [
"string"
]
uri = "string"
}
]
privateLinkConfigurations = [
{
name = "string"
properties = {
groupId = "string"
ipConfigurations = [
{
name = "string"
properties = {
primary = bool
privateIPAddress = "string"
privateIPAllocationMethod = "string"
subnet = {
id = "string"
}
}
}
]
}
}
]
sshEndpoints = [
{
destinationPort = int
location = "string"
privateIPAddress = "string"
publicPort = int
}
]
uninstallScriptActions = [
{
name = "string"
parameters = "string"
roles = [
"string"
]
uri = "string"
}
]
}
})
}
属性值
ApplicationGetEndpoint
名字 |
描述 |
价值 |
destinationPort |
要连接到的目标端口。 |
int |
位置 |
终结点的位置。 |
字符串 |
privateIPAddress |
终结点的专用 IP 地址。 |
字符串 |
publicPort |
要连接到的公共端口。 |
int |
ApplicationGetHttpsEndpoint
名字 |
描述 |
价值 |
accessModes |
应用程序的访问模式列表。 |
string[] |
destinationPort |
要连接到的目标端口。 |
int |
disableGatewayAuth |
该值指示是否禁用 GatewayAuth。 |
bool |
privateIPAddress |
终结点的专用 IP 地址。 |
字符串 |
subDomainSuffix |
应用程序的子域后缀。 |
字符串 |
ApplicationProperties
自动缩放
AutoscaleCapacity
名字 |
描述 |
价值 |
maxInstanceCount |
群集的最大实例计数 |
int |
minInstanceCount |
群集的最小实例计数 |
int |
AutoscaleRecurrence
AutoscaleSchedule
名字 |
描述 |
价值 |
日 |
基于计划的自动缩放规则的一周中的天数 |
包含任一项的字符串数组: “Friday” “Monday” “Saturday” “星期日” “星期四” “Tuesday” “Wednesday” |
timeAndCapacity |
基于计划的自动缩放规则的时间和容量 |
AutoscaleTimeAndCapacity |
AutoscaleTimeAndCapacity
名字 |
描述 |
价值 |
maxInstanceCount |
群集的最大实例计数 |
int |
minInstanceCount |
群集的最小实例计数 |
int |
时间 |
格式为 xx:xx 的 24 小时时间 |
字符串 |
ComputeProfile
名字 |
描述 |
价值 |
角色 |
群集中的角色列表。 |
角色[] |
DataDisksGroups
名字 |
描述 |
价值 |
disksPerNode |
每个节点的磁盘数。 |
int |
错误
名字 |
描述 |
价值 |
法典 |
错误代码。 |
字符串 |
消息 |
错误消息。 |
字符串 |
HardwareProfile
名字 |
描述 |
价值 |
vmSize |
VM 的大小 |
字符串 |
IPConfiguration
IPConfigurationProperties
名字 |
描述 |
价值 |
主要 |
指示此 IP 配置是否是相应 NIC 的主要配置。 |
bool |
privateIPAddress |
IP 地址。 |
字符串 |
privateIPAllocationMethod |
分配专用 IP 地址的方法。 |
“dynamic” “static” |
子 |
子网资源 ID。 |
ResourceId |
LinuxOperatingSystemProfile
名字 |
描述 |
价值 |
密码 |
密码。 |
字符串 |
sshProfile |
SSH 配置文件。 |
SshProfile |
username |
用户名。 |
字符串 |
Microsoft.HDInsight/clusters/applications
名字 |
描述 |
价值 |
etag |
应用程序的 ETag |
字符串 |
名字 |
资源名称 |
string (必需) |
parent_id |
此资源的父资源的 ID。 |
类型资源的 ID:群集 |
性能 |
应用程序的属性。 |
ApplicationProperties |
标签 |
资源标记 |
标记名称和值的字典。 |
类型 |
资源类型 |
“Microsoft.HDInsight/clusters/applications@2023-08-15-preview” |
OsProfile
PrivateLinkConfiguration
PrivateLinkConfigurationProperties
名字 |
描述 |
价值 |
groupId |
要向其应用专用链接配置的 HDInsight 专用可链接子资源名称。 例如,“headnode”、“gateway”、“edgenode”。 |
string (必需) |
ipConfigurations |
专用链接服务的 IP 配置。 |
IPConfiguration[] (必需) |
ResourceId
名字 |
描述 |
价值 |
id |
Azure 资源 ID。 |
字符串 |
角色
RuntimeScriptAction
名字 |
描述 |
价值 |
名字 |
脚本操作的名称。 |
string (必需) |
参数 |
脚本的参数 |
字符串 |
角色 |
将执行脚本的角色列表。 |
string[] (必需) |
uri |
脚本的 URI。 |
string (必需) |
ScriptAction
名字 |
描述 |
价值 |
名字 |
脚本操作的名称。 |
string (必需) |
参数 |
提供的脚本的参数。 |
string (必需) |
uri |
脚本的 URI。 |
string (必需) |
SshProfile
SshPublicKey
名字 |
描述 |
价值 |
certificateData |
SSH 的证书。 |
字符串 |
VirtualNetworkProfile
名字 |
描述 |
价值 |
id |
虚拟网络的 ID。 |
字符串 |
子 |
子网的名称。 |
字符串 |