你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.EventHub namespaces/eventhubs 2021-01-01-preview
Bicep 资源定义
命名空间/eventhubs 资源类型可以使用面向以下对象的操作进行部署：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中更改的属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.EventHub/namespaces/eventhubs 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.EventHub/namespaces/eventhubs@2021-01-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
captureDescription: {
destination: {
name: 'string'
properties: {
archiveNameFormat: 'string'
blobContainer: 'string'
storageAccountResourceId: 'string'
}
}
enabled: bool
encoding: 'string'
intervalInSeconds: int
sizeLimitInBytes: int
skipEmptyArchives: bool
}
messageRetentionInDays: int
partitionCount: int
status: 'string'
}
}
属性值
namespaces/eventhubs
| 名称 | 说明 | 值 |
|---|---|---|
| name | 资源名称 了解如何在 Bicep 中为子资源设置名称和类型。 |
字符串 (必需) 字符限制：1-256 有效字符： 字母数字、句点、连字符和下划线。 以字母或数字开头和结尾。 |
| 父级 (parent) | 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源之外的子资源。 |
类型为资源的符号名称： 命名空间 |
| properties | 提供给“创建或更新事件中心”操作的属性。 | EventhubProperties |
EventhubProperties
| 名称 | 说明 | 值 |
|---|---|---|
| captureDescription | 捕获说明的属性 | CaptureDescription |
| messageRetentionInDays | 为此事件中心保留事件的天数，值应为 1 到 7 天 | int 约束： 最小值 = 1 |
| partitionCount | 为事件中心创建的分区数，允许的值为 1 到 32 个分区。 | int 约束： 最小值 = 1 |
| status | 枚举事件中心状态的可能值。 | “Active” “正在创建” “正在删除” “Disabled” “ReceiveDisabled” “重命名” “正在还原” “SendDisabled” “未知” |
CaptureDescription
| 名称 | 说明 | 值 |
|---|---|---|
| destination | 要存储捕获的目标的属性。 (存储帐户、Blob 名称) | 目标 |
| enabled | 一个 值，该值指示是否启用捕获说明。 | bool |
| encoding | 枚举捕获说明编码格式的可能值。 注意：新 API 版本中将弃用“AvroDeflate” | “Avro” “AvroDeflate” |
| intervalInSeconds | 使用时间范围可以设置捕获到 Azure Blob 的频率，值应介于 60 到 900 秒之间 | int 约束： 最小值 = 60 最大值 = 900 |
| sizeLimitInBytes | 大小窗口定义捕获操作之前事件中心内生成的数据量，值应介于 10485760 到 524288000 个字节之间 | int 约束： 最小值 = 10485760 最大值 = 524288000 |
| skipEmptyArchives | 一个 值，该值指示是否跳过空存档 | bool |
目标
| 名称 | 说明 | 值 |
|---|---|---|
| name | 捕获目标的名称 | string |
| properties | 描述捕获目标的存储帐户、Blob 容器和存档名称格式的属性 | DestinationProperties |
DestinationProperties
| 名称 | 说明 | 值 |
|---|---|---|
| archiveNameFormat | 存档的 Blob 命名约定，例如 {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}。 此处的所有参数 (Namespace，EventHub 。等) 是强制性的，无论顺序如何 | 字符串 |
| blobContainer | Blob 容器名称 | 字符串 |
| storageAccountResourceId | 要用于创建 Blob 的存储帐户的资源 ID | 字符串 |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 说明 |
|---|---|
适用于 Azure 事件中心 的 PubNub 实时网关 |
适用于 Azure 的 PubNub 实时网关在 PubNub 数据Stream网络与 Azure 事件中心 之间提供实时数据流桥。 - 将其视为 PubNub 和 Azure 之间的双向桥梁！ |
| 在 Azure 上部署体育分析体系结构 |
创建启用了 ADLS Gen 2 的 Azure 存储帐户，创建一个Azure 数据工厂实例，其中包含存储帐户的链接服务 (Azure SQL数据库（如果已部署) ），以及一个 Azure Databricks 实例。 将为部署模板的用户的 AAD 标识和 ADF 实例的托管标识授予存储帐户上的存储 Blob 数据参与者角色。 还有一些选项可用于部署 Azure 密钥保管库 实例、Azure SQL数据库和 Azure 事件中心 (，用于流式处理用例) 。 部署 Azure 密钥保管库时，将为部署模板的用户授予数据工厂托管标识和 AAD 标识密钥保管库机密用户角色。 |
| Moesif API 分析和盈利 |
该模板会将 Azure API 管理 的 API 调用记录到 Moesif API 分析和盈利平台 |
| 具有时间数据历史记录连接的 Azure 数字孪生 |
此模板创建配置了时序数据历史记录连接的 Azure 数字孪生实例。 若要创建连接，必须创建其他资源，例如事件中心命名空间、事件中心、Azure 数据资源管理器群集和数据库。 数据将发送到事件中心，该事件中心最终将数据转发到 Azure 数据资源管理器 群集。 数据存储在群集的数据库表中 |
| 创建事件网格自定义主题和事件中心处理程序 |
创建Azure 事件网格自定义主题和事件中心来处理事件。 |
| 创建 EventHubs 命名空间、事件中心 & 使用者组 |
使用此模板可以部署事件中心标准命名空间、事件中心和使用者组。 |
| 创建 EventHubs authorizationRules |
使用此模板可以部署 EventHubs 标准命名空间、事件中心、使用者组和 authorizationRules |
| 创建 Eventhub 群集、namesapce & eventhub |
使用此模板可以在群集中创建 EventHubs 群集、命名空间和 eventhub |
| 创建启用了捕获的 EventHub |
此模板使你能够部署包含事件中心的 EventHubs 命名空间并启用捕获 |
| 创建启用了捕获的 EventHubs (ADLS) |
此模板使你能够部署包含事件中心的 EventHubs 命名空间并启用捕获 |
| 创建 EventHubs 命名空间并启用自动膨胀 |
使用此模板可以部署事件中心标准命名空间、事件中心和使用者组。此模板还会在命名空间上启用自动膨胀功能。 |
| 创建事件中心 |
通过此模板，可以使用事件中心部署 EventHubs 命名空间。 |
| 通过专用终结点连接到事件中心命名空间 |
此示例演示如何使用配置虚拟网络和专用 DNS 区域通过专用终结点访问事件中心命名空间。 |
| 部署 MedTech 服务 |
MedTech 服务是 Azure 运行状况数据服务之一，旨在从多个设备引入设备数据，将设备数据转换为 FHIR 观察，然后将其持久保存在 Azure Health Data Services FHIR 服务中。 |
| 部署 MedTech 服务，包括Azure IoT 中心 |
MedTech 服务是 Azure 运行状况数据服务之一，旨在从多个设备引入设备数据，将设备数据转换为 FHIR 观察，然后将其持久保存在 Azure Health Data Services FHIR 服务中。 |
| 使用事件中心连接部署 Azure 数据资源管理器 db |
使用事件中心连接部署 Azure 数据资源管理器 db。 |
| 将审核写入事件中心的Azure SQL服务器 |
此模板允许部署启用了审核的 Azure SQL 服务器，以便将审核日志写入事件中心 |
| 创建配置了日志和指标发送的 SQL MI |
此模板允许部署 SQL MI 和其他资源，用于存储诊断工作区、存储帐户、事件中心) (日志和指标。 |
| 使用事件中心事件源创建环境 |
使用此模板，可以部署配置为使用事件中心的事件的时序见解环境。 |
| 具有事件中心和托管标识的 Azure 函数应用 |
他的模板在 Linux 消耗计划上预配 Azure 函数应用，以及事件中心、Azure 存储和 Application Insights。 函数应用能够使用托管标识连接到事件中心和存储帐户 |
ARM 模板资源定义
命名空间/eventhubs 资源类型可以使用面向以下对象的操作进行部署：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.EventHub/namespaces/eventhubs 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.EventHub/namespaces/eventhubs",
"apiVersion": "2021-01-01-preview",
"name": "string",
"properties": {
"captureDescription": {
"destination": {
"name": "string",
"properties": {
"archiveNameFormat": "string",
"blobContainer": "string",
"storageAccountResourceId": "string"
}
},
"enabled": "bool",
"encoding": "string",
"intervalInSeconds": "int",
"sizeLimitInBytes": "int",
"skipEmptyArchives": "bool"
},
"messageRetentionInDays": "int",
"partitionCount": "int",
"status": "string"
}
}
属性值
namespaces/eventhubs
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | 'Microsoft.EventHub/namespaces/eventhubs' |
| apiVersion | 资源 API 版本 | '2021-01-01-preview' |
| name | 资源名称 了解如何在 JSON ARM 模板中设置子资源的名称和类型。 |
字符串 (必需) 字符限制：1-256 有效字符： 字母数字、句点、连字符和下划线。 以字母或数字开头和结尾。 |
| properties | 提供给创建或更新事件中心操作的属性。 | EventhubProperties |
EventhubProperties
| 名称 | 说明 | 值 |
|---|---|---|
| captureDescription | 捕获说明的属性 | CaptureDescription |
| messageRetentionInDays | 为此事件中心保留事件的天数，值应为 1 到 7 天 | int 约束： 最小值 = 1 |
| partitionCount | 为事件中心创建的分区数，允许的值为 1 到 32 个分区。 | int 约束： 最小值 = 1 |
| status | 枚举事件中心状态的可能值。 | 'Active' 'Creating' '正在删除' 'Disabled' 'ReceiveDisabled' “重命名” “正在还原” “SendDisabled” “未知” |
CaptureDescription
| 名称 | 说明 | 值 |
|---|---|---|
| destination | 要存储捕获的目标的属性。 (存储帐户、Blob 名称) | 目标 |
| enabled | 一个 值，该值指示是否启用捕获说明。 | bool |
| encoding | 枚举捕获说明编码格式的可能值。 注意：新 API 版本中将弃用“AvroDeflate” | 'Avro' 'AvroDeflate' |
| intervalInSeconds | 使用时间窗口可以设置捕获到 Azure Blob 的频率，值应介于 60 到 900 秒之间 | int 约束： 最小值 = 60 最大值 = 900 |
| sizeLimitInBytes | 大小窗口定义捕获操作之前在事件中心生成的数据量，值应介于 10485760 到 524288000 个字节之间 | int 约束： 最小值 = 10485760 最大值 = 524288000 |
| skipEmptyArchives | 一个 值，该值指示是否跳过空存档 | bool |
目标
| 名称 | 说明 | 值 |
|---|---|---|
| name | 捕获目标的名称 | string |
| properties | 描述捕获目标的存储帐户、Blob 容器和存档名称格式的属性 | DestinationProperties |
DestinationProperties
| 名称 | 说明 | 值 |
|---|---|---|
| archiveNameFormat | 存档的 Blob 命名约定，例如 {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}。 此处的所有参数 (Namespace，EventHub 。等) 是强制性的，无论顺序如何 | 字符串 |
| blobContainer | Blob 容器名称 | 字符串 |
| storageAccountResourceId | 要用于创建 Blob 的存储帐户的资源 ID | 字符串 |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 说明 |
|---|---|
| 适用于 Azure 事件中心 的 PubNub 实时网关 |
适用于 Azure 的 PubNub 实时网关在 PubNub 数据Stream网络与 Azure 事件中心 之间提供实时数据流桥。 - 将其视为 PubNub 和 Azure 之间的双向桥梁！ |
| 在 Azure 上部署体育分析体系结构 |
创建启用了 ADLS Gen 2 的 Azure 存储帐户，创建一个Azure 数据工厂实例，其中包含存储帐户的链接服务 (Azure SQL数据库（如果已部署) ），以及一个 Azure Databricks 实例。 将为部署模板的用户的 AAD 标识和 ADF 实例的托管标识授予存储帐户上的存储 Blob 数据参与者角色。 还有一些选项可用于部署 Azure 密钥保管库 实例、Azure SQL数据库和 Azure 事件中心 (，用于流式处理用例) 。 部署 Azure 密钥保管库时，将为部署模板的用户授予数据工厂托管标识和 AAD 标识密钥保管库机密用户角色。 |
| Moesif API 分析和盈利 |
该模板会将 Azure API 管理 的 API 调用记录到 Moesif API 分析和盈利平台 |
| 具有时间数据历史记录连接的 Azure 数字孪生 |
此模板创建配置了时序数据历史记录连接的 Azure 数字孪生实例。 若要创建连接，必须创建其他资源，例如事件中心命名空间、事件中心、Azure 数据资源管理器群集和数据库。 数据将发送到事件中心，该事件中心最终将数据转发到 Azure 数据资源管理器 群集。 数据存储在群集的数据库表中 |
| 创建事件网格自定义主题和事件中心处理程序 |
创建Azure 事件网格自定义主题和事件中心来处理事件。 |
| 创建 EventHubs 命名空间、事件中心 & 使用者组 |
使用此模板可以部署事件中心标准命名空间、事件中心和使用者组。 |
| 创建 EventHubs authorizationRules |
使用此模板可以部署 EventHubs 标准命名空间、事件中心、使用者组和 authorizationRules |
| 创建 Eventhub 群集、namesapce & eventhub |
使用此模板可以在群集中创建 EventHubs 群集、命名空间和 eventhub |
| 创建启用了捕获的 EventHub |
此模板使你能够部署包含事件中心的 EventHubs 命名空间并启用捕获 |
| 创建启用了捕获的 EventHubs (ADLS) |
此模板使你能够部署包含事件中心的 EventHubs 命名空间并启用捕获 |
| 创建 EventHubs 命名空间并启用自动膨胀 |
使用此模板可以部署事件中心标准命名空间、事件中心和使用者组。此模板还会在命名空间上启用自动膨胀功能。 |
| 创建事件中心 |
通过此模板，可以使用事件中心部署 EventHubs 命名空间。 |
| 通过专用终结点连接到事件中心命名空间 |
此示例演示如何使用配置虚拟网络和专用 DNS 区域通过专用终结点访问事件中心命名空间。 |
| 部署 MedTech 服务 |
MedTech 服务是 Azure 运行状况数据服务之一，旨在从多个设备引入设备数据，将设备数据转换为 FHIR 观察，然后将其持久保存在 Azure Health Data Services FHIR 服务中。 |
| 部署 MedTech 服务，包括Azure IoT 中心 |
MedTech 服务是 Azure 运行状况数据服务之一，旨在从多个设备引入设备数据，将设备数据转换为 FHIR 观察，然后将其持久保存在 Azure Health Data Services FHIR 服务中。 |
| 使用事件中心连接部署 Azure 数据资源管理器 db |
使用事件中心连接部署 Azure 数据资源管理器 db。 |
| 将审核写入事件中心的Azure SQL服务器 |
此模板允许部署启用了审核的 Azure SQL 服务器，以便将审核日志写入事件中心 |
| 创建配置了日志和指标发送的 SQL MI |
此模板允许部署 SQL MI 和其他资源，用于存储诊断工作区、存储帐户、事件中心) (日志和指标。 |
| 使用事件中心事件源创建环境 |
使用此模板，可以部署配置为使用事件中心的事件的时序见解环境。 |
| 具有事件中心和托管标识的 Azure 函数应用 |
他的模板在 Linux 消耗计划上预配 Azure 函数应用，以及事件中心、Azure 存储和 Application Insights。 函数应用能够使用托管标识连接到事件中心和存储帐户 |
Terraform (AzAPI 提供程序) 资源定义
命名空间/eventhubs 资源类型可以使用面向以下对象的操作进行部署：
- 资源组
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.EventHub/namespaces/eventhubs 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventHub/namespaces/eventhubs@2021-01-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
captureDescription = {
destination = {
name = "string"
properties = {
archiveNameFormat = "string"
blobContainer = "string"
storageAccountResourceId = "string"
}
}
enabled = bool
encoding = "string"
intervalInSeconds = int
sizeLimitInBytes = int
skipEmptyArchives = bool
}
messageRetentionInDays = int
partitionCount = int
status = "string"
}
})
}
属性值
namespaces/eventhubs
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | “Microsoft.EventHub/namespaces/eventhubs@2021-01-01-preview” |
| name | 资源名称 | 字符串 (必需) 字符限制：1-256 有效字符： 字母数字、句点、连字符和下划线。 以字母或数字开头和结尾。 |
| parent_id | 此资源的父资源的 ID。 | 类型为：命名空间的资源的 ID |
| properties | 提供给创建或更新事件中心操作的属性。 | EventhubProperties |
EventhubProperties
| 名称 | 说明 | 值 |
|---|---|---|
| captureDescription | 捕获说明的属性 | CaptureDescription |
| messageRetentionInDays | 为此事件中心保留事件的天数，值应为 1 到 7 天 | int 约束： 最小值 = 1 |
| partitionCount | 为事件中心创建的分区数，允许的值为 1 到 32 个分区。 | int 约束： 最小值 = 1 |
| status | 枚举事件中心状态的可能值。 | “Active” “正在创建” “正在删除” “Disabled” “ReceiveDisabled” “重命名” “正在还原” “SendDisabled” "Unknown" |
CaptureDescription
| 名称 | 说明 | 值 |
|---|---|---|
| destination | 要存储捕获的目标的属性。 (存储帐户、Blob 名称) | 目标 |
| enabled | 一个 值，该值指示是否启用捕获说明。 | bool |
| encoding | 枚举捕获说明编码格式的可能值。 注意：新 API 版本中将弃用“AvroDeflate” | “Avro” “AvroDeflate” |
| intervalInSeconds | 使用时间窗口可以设置捕获到 Azure Blob 的频率，值应介于 60 到 900 秒之间 | int 约束： 最小值 = 60 最大值 = 900 |
| sizeLimitInBytes | 大小窗口定义捕获操作之前在事件中心生成的数据量，值应介于 10485760 到 524288000 个字节之间 | int 约束： 最小值 = 10485760 最大值 = 524288000 |
| skipEmptyArchives | 一个 值，该值指示是否跳过空存档 | bool |
目标
| 名称 | 说明 | 值 |
|---|---|---|
| name | 捕获目标的名称 | string |
| properties | 描述捕获目标的存储帐户、Blob 容器和存档名称格式的属性 | DestinationProperties |
DestinationProperties
| 名称 | 说明 | 值 |
|---|---|---|
| archiveNameFormat | 存档的 Blob 命名约定，例如 {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}。 此处的所有参数 (Namespace，EventHub 。等) 是强制性的，无论顺序如何 | 字符串 |
| blobContainer | Blob 容器名称 | 字符串 |
| storageAccountResourceId | 要用于创建 Blob 的存储帐户的资源 ID | 字符串 |
反馈
即将发布：在整个 2024 年，我们将逐步淘汰作为内容反馈机制的“GitHub 问题”，并将其取代为新的反馈系统。 有关详细信息，请参阅：https://aka.ms/ContentUserFeedback。
提交和查看相关反馈