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

Microsoft.EventHub 群集 2024-01-01

• 最新
• 2024-01-01
• 2023-01-01-preview
• 2022-10-01-preview
• 2022-01-01-preview
• 2021-11-01
• 2021-06-01-preview
• 2018-01-01-preview

Bicep 资源定义

可以使用面向以下操作部署群集资源类型：

• 资源组 - 请参阅 资源组部署命令

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

资源格式

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

resource symbolicname 'Microsoft.EventHub/clusters@2024-01-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'Dedicated'
  }
  properties: {
    supportsScaling: bool
    upgradePreferences: {
      startDayOfWeek: 'string'
      startHourOfDay: int
    }
  }
}

属性值

clusters

名称	说明	值
name	资源名称	字符串 (必需) 字符限制：6-50 有效字符： 字母数字和连字符。 以字母开头。 以字母或数字结尾。
location	资源位置。	字符串
标记	资源标记。	标记名称和值的字典。 请参阅 模板中的标记
sku	群集 SKU 的属性。	ClusterSku
properties	在 List 或 Get 操作的响应中提供的事件中心群集属性。	ClusterProperties

ClusterProperties

名称	说明	值
supportsScaling	一个 值，该值指示是否支持缩放。	bool
upgradePreferences	群集升级首选项的属性。	UpgradePreferences

UpgradePreferences

名称	说明	值
startDayOfWeek	开始升级的首选一周中的某一天（UTC 时间）。 如果选择了“Any”，升级将在任意给定工作日继续进行	“Any” “Friday” “Monday” “Saturday” “星期日” “星期四” “Tuesday” “Wednesday”
startHourOfDay	开始升级的首选一天中的一小时（UTC 时间）	int 约束： 最小值 = 0 最大值 = 23

ClusterSku

名称	说明	值
容量	此群集中包含的事件中心群集容量单位的数量。	int 约束： 最小值 = 1
name	此 SKU 的名称。	需要“专用” ()

快速入门模板

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

模板	说明
在群集中创建事件中心群集 & 名称apce	使用此模板，可以在群集中创建 EventHubs 群集和命名空间
创建 Eventhub 群集、namesapce & eventhub	使用此模板可以在群集中创建 EventHubs 群集、命名空间和 eventhub

ARM 模板资源定义

可以使用面向以下操作部署群集资源类型：

• 资源组 - 请参阅 资源组部署命令

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

资源格式

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

{
  "type": "Microsoft.EventHub/clusters",
  "apiVersion": "2024-01-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "Dedicated"
  },
  "properties": {
    "supportsScaling": "bool",
    "upgradePreferences": {
      "startDayOfWeek": "string",
      "startHourOfDay": "int"
    }
  }
}

属性值

clusters

名称	说明	Value
type	资源类型	“Microsoft.EventHub/clusters”
apiVersion	资源 API 版本	'2024-01-01'
name	资源名称	字符串 (必需) 字符限制：6-50 有效字符： 字母数字和连字符。 以字母开头。 以字母或数字结尾。
location	资源位置。	字符串
标记	资源标记。	标记名称和值的字典。 请参阅 模板中的标记
sku	群集 SKU 的属性。	ClusterSku
properties	在列表或获取操作的响应中提供的事件中心群集属性。	ClusterProperties

ClusterProperties

名称	说明	值
supportsScaling	一个 值，该值指示是否支持缩放。	bool
upgradePreferences	群集升级首选项的属性。	升级首选项

升级首选项

名称	说明	值
startDayOfWeek	开始升级的首选一周中的某一天（UTC 时间）。 如果选择“Any”，则升级将在任意给定的工作日继续进行	“Any” “Friday” “Monday” “Saturday” “星期日” “星期四” “Tuesday” “星期三”
startHourOfDay	开始升级的一天中的首选时间（UTC 时间）	int 约束： 最小值 = 0 最大值 = 23

ClusterSku

名称	说明	值
容量	此群集中包含的事件中心群集容量单位的数量。	int 约束： 最小值 = 1
name	此 SKU 的名称。	“专用” (所需的)

快速入门模板

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

模板	说明
在群集中创建事件中心群集 & 名称apce	使用此模板可以在群集中创建 EventHubs 群集和命名空间
创建 Eventhub 群集、namesapce & eventhub	使用此模板可以在群集中创建 EventHubs 群集、命名空间和 eventhub

Terraform (AzAPI 提供程序) 资源定义

可以使用针对以下操作部署群集资源类型：

• 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventHub/clusters@2024-01-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      supportsScaling = bool
      upgradePreferences = {
        startDayOfWeek = "string"
        startHourOfDay = int
      }
    }
    sku = {
      capacity = int
      name = "Dedicated"
    }
  })
}

属性值

clusters

名称	说明	Value
type	资源类型	“Microsoft.EventHub/clusters@2024-01-01”
name	资源名称	字符串 (必需) 字符限制：6-50 有效字符： 字母数字和连字符。 以字母开头。 以字母或数字结尾。
location	资源位置。	字符串
parent_id	若要部署到资源组，请使用该资源组的 ID。	字符串 (必需)
标记	资源标记。	标记名称和值的字典。
sku	群集 SKU 的属性。	ClusterSku
properties	在列表或获取操作的响应中提供的事件中心群集属性。	ClusterProperties

ClusterProperties

名称	说明	值
supportsScaling	一个 值，该值指示是否支持缩放。	bool
upgradePreferences	群集升级首选项的属性。	升级首选项

升级首选项

名称	说明	值
startDayOfWeek	开始升级的首选一周中的某一天（UTC 时间）。 如果选择“Any”，则升级将在任意给定的工作日继续进行	“Any” "Friday" “星期一” “星期六” "Sunday" "Thursday" "Tuesday" "Wednesday"
startHourOfDay	开始升级的一天中的首选时间（UTC 时间）	int 约束： 最小值 = 0 最大值 = 23

ClusterSku

名称	说明	值
容量	此群集中包含的事件中心群集容量单位的数量。	int 约束： 最小值 = 1
name	此 SKU 的名称。	需要“专用” ()