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

Microsoft.EventHub 命名空间/eventhubs

Bicep 资源定义

可以使用目标操作部署命名空间/eventhubs 资源类型:

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

资源格式

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

resource symbolicname 'Microsoft.EventHub/namespaces/eventhubs@2024-05-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    captureDescription: {
      destination: {
        identity: {
          type: 'string'
          userAssignedIdentity: 'string'
        }
        name: 'string'
        properties: {
          archiveNameFormat: 'string'
          blobContainer: 'string'
          dataLakeAccountName: 'string'
          dataLakeFolderPath: 'string'
          dataLakeSubscriptionId: 'string'
          storageAccountResourceId: 'string'
        }
      }
      enabled: bool
      encoding: 'string'
      intervalInSeconds: int
      sizeLimitInBytes: int
      skipEmptyArchives: bool
    }
    messageRetentionInDays: int
    messageTimestampDescription: {
      timestampType: 'string'
    }
    partitionCount: int
    retentionDescription: {
      cleanupPolicy: 'string'
      minCompactionLagInMins: int
      retentionTimeInHours: int
      tombstoneRetentionTimeInHours: int
    }
    status: 'string'
    userMetadata: 'string'
  }
}

属性值

CaptureDescription

名字 描述 价值
目的地 将存储捕获的目标的属性。 (存储帐户、Blob 名称) 目标
启用 一个值,该值指示是否启用捕获说明。 bool
编码 枚举捕获说明的编码格式的可能值。 注意:新 API 版本中将弃用“AvroDeflate” “Avro”
“AvroDeflate”
intervalInSeconds 使用时间范围可以设置捕获到 Azure Blob 的频率,值应介于 60 到 900 秒之间 int
sizeLimitInBytes 大小窗口定义在捕获操作之前在事件中心生成的数据量,值应在10485760到524288000字节之间 int
skipEmptyArchives 一个值,该值指示是否跳过空存档 bool

CaptureIdentity

名字 描述 价值
类型 Azure Active Directory 托管标识的类型。 “SystemAssigned”
“UserAssigned”
userAssignedIdentity 托管用户标识的 ARM ID。 此属性是必需的,类型为 UserAssignedIdentity。 如果类型为 SystemAssigned,则将使用与命名空间关联的系统分配标识。 字符串

目的地

名字 描述 价值
身份 一个值,该值指示是否启用捕获说明。 CaptureIdentity
名字 捕获目标的名称 字符串
性能 描述捕获目标的存储帐户、Blob 容器和存档名称格式的属性 DestinationProperties

DestinationProperties

名字 描述 价值
archiveNameFormat 存档的 Blob 命名约定,例如 {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}。 此处的所有参数(Namespace,EventHub .. 等)都是强制性的,无论顺序如何 字符串
blobContainer Blob 容器名称 字符串
dataLakeAccountName 捕获事件的 Azure Data Lake Store 名称 字符串
dataLakeFolderPath 捕获事件的目标文件夹路径 字符串
dataLakeSubscriptionId Azure Data Lake Store 的订阅 ID 字符串

约束:
最小长度 = 36
最大长度 = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
storageAccountResourceId 用于创建 Blob 的存储帐户的资源 ID 字符串

EventhubProperties

名字 描述 价值
captureDescription 捕获说明的属性 CaptureDescription
messageRetentionInDays 保留此事件中心的事件的天数,值应为 1 到 7 天 int

约束:
最小值 = 1
messageTimestampDescription MessageTimestamp 说明的属性 MessageTimestampDescription
partitionCount 为事件中心创建的分区数,允许的值从 1 到 32 个分区。 int

约束:
最小值 = 1
retentionDescription 事件中心保留设置 RetentionDescription
地位 枚举事件中心状态的可能值。 “Active”
“创建”
“删除”
“Disabled”
“ReceiveDisabled”
“重命名”
“正在还原”
“SendDisabled”
“未知”
userMetadata 获取和设置用户的元数据。 字符串

MessageTimestampDescription

名字 描述 价值
timestampType 表示消息将保留的时间戳类型。两种类型的时间戳类型 -“AppendTime”和“CreateTime”。 AppendTime 是指在中转站日志中追加消息的时间。 CreateTime 是指在源端生成消息的时间,生成者可以在发送消息时设置此时间戳。 默认值为 AppendTime。 如果使用 AMQP 协议,CreateTime 等于 AppendTime 及其行为保持不变。 “Create”
“LogAppend”

Microsoft.EventHub/namespaces/eventhubs

名字 描述 价值
名字 资源名称 字符串

约束:
最小长度 = 1
最大长度 = 1 (必需)
父母 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源外部的子资源
类型资源的符号名称:命名空间
性能 提供给“创建或更新事件中心”操作的属性。 EventhubProperties

RetentionDescription

名字 描述 价值
cleanupPolicy 枚举清理策略的可能值 “Compact”
“Delete”
“DeleteOrCompact”
minCompactionLagInMins 消息在日志中无法压缩的最短时间。 当 cleanupPolicy 为 Compact 或 DeleteOrCompact 时,将使用此值。 int
retentionTimeInHours 保留此事件中心的事件的小时数。 这应该是命名空间 SKU 最大值的正值。-1 是一种特殊情况,即保留时间是无限的,但实体的大小受到限制,其大小取决于命名空间 SKU 类型。 int
tombstoneRetentionTimeInHours 保留压缩事件中心的逻辑删除标记的小时数。 当 cleanupPolicy 为 Compact 或 DeleteOrCompact 时,将使用此值。 使用者必须在此指定的时间范围内完成读取墓碑标记(如果使用者从起始偏移开始)以确保它们获取压缩事件中心内逻辑删除标记所描述的特定键的有效快照 int

快速入门示例

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

Bicep 文件 描述
使用时间数据历史记录连接 Azure 数字孪生 此模板创建配置了时序数据历史记录连接的 Azure 数字孪生实例。 若要创建连接,必须创建其他资源,例如事件中心命名空间、事件中心、Azure 数据资源管理器群集和数据库。 数据将发送到事件中心,该事件中心最终将数据转发到 Azure 数据资源管理器群集。 数据存储在群集中的数据库表中
使用事件中心和托管标识 Azure Function App 他的模板在 Linux 消耗计划上预配 Azure 函数应用,以及事件中心、Azure 存储和 Application Insights。 函数应用能够使用托管标识连接到事件中心和存储帐户
创建事件中心 使用此模板,可以使用事件中心部署 EventHubs 命名空间。
创建 EventHubs 命名空间、事件中心 & 使用者组 使用此模板可以部署事件中心标准命名空间、事件中心和使用者组。
创建 Eventhub 群集、namesapce & eventhub 使用此模板可以在群集中创建 EventHubs 群集、命名空间和 eventhub
使用事件网格连接部署 Azure 数据资源管理器数据库 使用事件网格连接部署 Azure 数据资源管理器数据库。
使用事件中心连接部署 Azure 数据资源管理器数据库 使用事件中心连接部署 Azure 数据资源管理器数据库。
部署 MedTech 服务 MedTech 服务是一项 Azure Health Data Services,旨在从多个设备引入设备数据,将设备数据转换为 FHIR 观察,然后保存在 Azure Health Data Services FHIR 服务中。
部署 MedTech 服务,包括 Azure IoT 中心 MedTech 服务是一项 Azure Health Data Services,旨在从多个设备引入设备数据,将设备数据转换为 FHIR 观察,然后保存在 Azure Health Data Services FHIR 服务中。
在 Azure 体系结构 上部署体育分析 创建启用了 ADLS Gen 2 的 Azure 存储帐户、存储帐户的链接服务的 Azure 数据工厂实例(如果已部署的 Azure SQL 数据库)和 Azure Databricks 实例。 将为部署模板的用户的 AAD 标识以及 ADF 实例的托管标识授予存储帐户上的存储 Blob 数据参与者角色。 还有一些选项可用于部署 Azure Key Vault 实例、Azure SQL 数据库和 Azure 事件中心(用于流式处理用例)。 部署 Azure Key Vault 后,将为部署模板的用户提供数据工厂托管标识和 AAD 标识,并被授予 Key Vault 机密用户角色。
使用 WAF、域和日志将 FrontDoor CDN EventHub 此模板创建新的 Azure FrontDoor cdn 配置文件。 使用自定义和托管规则、cdn 路由、源和组与 WAF 和路由关联创建 WAF,配置自定义域,创建事件中心和诊断设置,以便使用事件中心发送 CDN 访问日志。
Moesif API 分析和货币化 该模板会将来自 Azure API 管理的 API 调用记录到 Moesif API 分析和盈利平台

ARM 模板资源定义

可以使用目标操作部署命名空间/eventhubs 资源类型:

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

资源格式

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

{
  "type": "Microsoft.EventHub/namespaces/eventhubs",
  "apiVersion": "2024-05-01-preview",
  "name": "string",
  "properties": {
    "captureDescription": {
      "destination": {
        "identity": {
          "type": "string",
          "userAssignedIdentity": "string"
        },
        "name": "string",
        "properties": {
          "archiveNameFormat": "string",
          "blobContainer": "string",
          "dataLakeAccountName": "string",
          "dataLakeFolderPath": "string",
          "dataLakeSubscriptionId": "string",
          "storageAccountResourceId": "string"
        }
      },
      "enabled": "bool",
      "encoding": "string",
      "intervalInSeconds": "int",
      "sizeLimitInBytes": "int",
      "skipEmptyArchives": "bool"
    },
    "messageRetentionInDays": "int",
    "messageTimestampDescription": {
      "timestampType": "string"
    },
    "partitionCount": "int",
    "retentionDescription": {
      "cleanupPolicy": "string",
      "minCompactionLagInMins": "int",
      "retentionTimeInHours": "int",
      "tombstoneRetentionTimeInHours": "int"
    },
    "status": "string",
    "userMetadata": "string"
  }
}

属性值

CaptureDescription

名字 描述 价值
目的地 将存储捕获的目标的属性。 (存储帐户、Blob 名称) 目标
启用 一个值,该值指示是否启用捕获说明。 bool
编码 枚举捕获说明的编码格式的可能值。 注意:新 API 版本中将弃用“AvroDeflate” “Avro”
“AvroDeflate”
intervalInSeconds 使用时间范围可以设置捕获到 Azure Blob 的频率,值应介于 60 到 900 秒之间 int
sizeLimitInBytes 大小窗口定义在捕获操作之前在事件中心生成的数据量,值应在10485760到524288000字节之间 int
skipEmptyArchives 一个值,该值指示是否跳过空存档 bool

CaptureIdentity

名字 描述 价值
类型 Azure Active Directory 托管标识的类型。 “SystemAssigned”
“UserAssigned”
userAssignedIdentity 托管用户标识的 ARM ID。 此属性是必需的,类型为 UserAssignedIdentity。 如果类型为 SystemAssigned,则将使用与命名空间关联的系统分配标识。 字符串

目的地

名字 描述 价值
身份 一个值,该值指示是否启用捕获说明。 CaptureIdentity
名字 捕获目标的名称 字符串
性能 描述捕获目标的存储帐户、Blob 容器和存档名称格式的属性 DestinationProperties

DestinationProperties

名字 描述 价值
archiveNameFormat 存档的 Blob 命名约定,例如 {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}。 此处的所有参数(Namespace,EventHub .. 等)都是强制性的,无论顺序如何 字符串
blobContainer Blob 容器名称 字符串
dataLakeAccountName 捕获事件的 Azure Data Lake Store 名称 字符串
dataLakeFolderPath 捕获事件的目标文件夹路径 字符串
dataLakeSubscriptionId Azure Data Lake Store 的订阅 ID 字符串

约束:
最小长度 = 36
最大长度 = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
storageAccountResourceId 用于创建 Blob 的存储帐户的资源 ID 字符串

EventhubProperties

名字 描述 价值
captureDescription 捕获说明的属性 CaptureDescription
messageRetentionInDays 保留此事件中心的事件的天数,值应为 1 到 7 天 int

约束:
最小值 = 1
messageTimestampDescription MessageTimestamp 说明的属性 MessageTimestampDescription
partitionCount 为事件中心创建的分区数,允许的值从 1 到 32 个分区。 int

约束:
最小值 = 1
retentionDescription 事件中心保留设置 RetentionDescription
地位 枚举事件中心状态的可能值。 “Active”
“创建”
“删除”
“Disabled”
“ReceiveDisabled”
“重命名”
“正在还原”
“SendDisabled”
“未知”
userMetadata 获取和设置用户的元数据。 字符串

MessageTimestampDescription

名字 描述 价值
timestampType 表示消息将保留的时间戳类型。两种类型的时间戳类型 -“AppendTime”和“CreateTime”。 AppendTime 是指在中转站日志中追加消息的时间。 CreateTime 是指在源端生成消息的时间,生成者可以在发送消息时设置此时间戳。 默认值为 AppendTime。 如果使用 AMQP 协议,CreateTime 等于 AppendTime 及其行为保持不变。 “Create”
“LogAppend”

Microsoft.EventHub/namespaces/eventhubs

名字 描述 价值
apiVersion API 版本 '2024-05-01-preview'
名字 资源名称 字符串

约束:
最小长度 = 1
最大长度 = 1 (必需)
性能 提供给“创建或更新事件中心”操作的属性。 EventhubProperties
类型 资源类型 “Microsoft.EventHub/namespaces/eventhubs”

RetentionDescription

名字 描述 价值
cleanupPolicy 枚举清理策略的可能值 “Compact”
“Delete”
“DeleteOrCompact”
minCompactionLagInMins 消息在日志中无法压缩的最短时间。 当 cleanupPolicy 为 Compact 或 DeleteOrCompact 时,将使用此值。 int
retentionTimeInHours 保留此事件中心的事件的小时数。 这应该是命名空间 SKU 最大值的正值。-1 是一种特殊情况,即保留时间是无限的,但实体的大小受到限制,其大小取决于命名空间 SKU 类型。 int
tombstoneRetentionTimeInHours 保留压缩事件中心的逻辑删除标记的小时数。 当 cleanupPolicy 为 Compact 或 DeleteOrCompact 时,将使用此值。 使用者必须在此指定的时间范围内完成读取墓碑标记(如果使用者从起始偏移开始)以确保它们获取压缩事件中心内逻辑删除标记所描述的特定键的有效快照 int

快速入门模板

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

模板 描述
使用时间数据历史记录连接 Azure 数字孪生

部署到 Azure
此模板创建配置了时序数据历史记录连接的 Azure 数字孪生实例。 若要创建连接,必须创建其他资源,例如事件中心命名空间、事件中心、Azure 数据资源管理器群集和数据库。 数据将发送到事件中心,该事件中心最终将数据转发到 Azure 数据资源管理器群集。 数据存储在群集中的数据库表中
使用事件中心和托管标识 Azure Function App

部署到 Azure
他的模板在 Linux 消耗计划上预配 Azure 函数应用,以及事件中心、Azure 存储和 Application Insights。 函数应用能够使用托管标识连接到事件中心和存储帐户
创建事件中心

部署到 Azure
使用此模板,可以使用事件中心部署 EventHubs 命名空间。
创建 EventHubs 命名空间、事件中心 & 使用者组

部署到 Azure
使用此模板可以部署事件中心标准命名空间、事件中心和使用者组。
创建 Eventhub 群集、namesapce & eventhub

部署到 Azure
使用此模板可以在群集中创建 EventHubs 群集、命名空间和 eventhub
使用事件网格连接部署 Azure 数据资源管理器数据库

部署到 Azure
使用事件网格连接部署 Azure 数据资源管理器数据库。
使用事件中心连接部署 Azure 数据资源管理器数据库

部署到 Azure
使用事件中心连接部署 Azure 数据资源管理器数据库。
部署 MedTech 服务

部署到 Azure
MedTech 服务是一项 Azure Health Data Services,旨在从多个设备引入设备数据,将设备数据转换为 FHIR 观察,然后保存在 Azure Health Data Services FHIR 服务中。
部署 MedTech 服务,包括 Azure IoT 中心

部署到 Azure
MedTech 服务是一项 Azure Health Data Services,旨在从多个设备引入设备数据,将设备数据转换为 FHIR 观察,然后保存在 Azure Health Data Services FHIR 服务中。
在 Azure 体系结构 上部署体育分析

部署到 Azure
创建启用了 ADLS Gen 2 的 Azure 存储帐户、存储帐户的链接服务的 Azure 数据工厂实例(如果已部署的 Azure SQL 数据库)和 Azure Databricks 实例。 将为部署模板的用户的 AAD 标识以及 ADF 实例的托管标识授予存储帐户上的存储 Blob 数据参与者角色。 还有一些选项可用于部署 Azure Key Vault 实例、Azure SQL 数据库和 Azure 事件中心(用于流式处理用例)。 部署 Azure Key Vault 后,将为部署模板的用户提供数据工厂托管标识和 AAD 标识,并被授予 Key Vault 机密用户角色。
使用 WAF、域和日志将 FrontDoor CDN EventHub

部署到 Azure
此模板创建新的 Azure FrontDoor cdn 配置文件。 使用自定义和托管规则、cdn 路由、源和组与 WAF 和路由关联创建 WAF,配置自定义域,创建事件中心和诊断设置,以便使用事件中心发送 CDN 访问日志。
Moesif API 分析和货币化

部署到 Azure
该模板会将来自 Azure API 管理的 API 调用记录到 Moesif API 分析和盈利平台

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

可以使用目标操作部署命名空间/eventhubs 资源类型:

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventHub/namespaces/eventhubs@2024-05-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      captureDescription = {
        destination = {
          identity = {
            type = "string"
            userAssignedIdentity = "string"
          }
          name = "string"
          properties = {
            archiveNameFormat = "string"
            blobContainer = "string"
            dataLakeAccountName = "string"
            dataLakeFolderPath = "string"
            dataLakeSubscriptionId = "string"
            storageAccountResourceId = "string"
          }
        }
        enabled = bool
        encoding = "string"
        intervalInSeconds = int
        sizeLimitInBytes = int
        skipEmptyArchives = bool
      }
      messageRetentionInDays = int
      messageTimestampDescription = {
        timestampType = "string"
      }
      partitionCount = int
      retentionDescription = {
        cleanupPolicy = "string"
        minCompactionLagInMins = int
        retentionTimeInHours = int
        tombstoneRetentionTimeInHours = int
      }
      status = "string"
      userMetadata = "string"
    }
  })
}

属性值

CaptureDescription

名字 描述 价值
目的地 将存储捕获的目标的属性。 (存储帐户、Blob 名称) 目标
启用 一个值,该值指示是否启用捕获说明。 bool
编码 枚举捕获说明的编码格式的可能值。 注意:新 API 版本中将弃用“AvroDeflate” “Avro”
“AvroDeflate”
intervalInSeconds 使用时间范围可以设置捕获到 Azure Blob 的频率,值应介于 60 到 900 秒之间 int
sizeLimitInBytes 大小窗口定义在捕获操作之前在事件中心生成的数据量,值应在10485760到524288000字节之间 int
skipEmptyArchives 一个值,该值指示是否跳过空存档 bool

CaptureIdentity

名字 描述 价值
类型 Azure Active Directory 托管标识的类型。 “SystemAssigned”
“UserAssigned”
userAssignedIdentity 托管用户标识的 ARM ID。 此属性是必需的,类型为 UserAssignedIdentity。 如果类型为 SystemAssigned,则将使用与命名空间关联的系统分配标识。 字符串

目的地

名字 描述 价值
身份 一个值,该值指示是否启用捕获说明。 CaptureIdentity
名字 捕获目标的名称 字符串
性能 描述捕获目标的存储帐户、Blob 容器和存档名称格式的属性 DestinationProperties

DestinationProperties

名字 描述 价值
archiveNameFormat 存档的 Blob 命名约定,例如 {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}。 此处的所有参数(Namespace,EventHub .. 等)都是强制性的,无论顺序如何 字符串
blobContainer Blob 容器名称 字符串
dataLakeAccountName 捕获事件的 Azure Data Lake Store 名称 字符串
dataLakeFolderPath 捕获事件的目标文件夹路径 字符串
dataLakeSubscriptionId Azure Data Lake Store 的订阅 ID 字符串

约束:
最小长度 = 36
最大长度 = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
storageAccountResourceId 用于创建 Blob 的存储帐户的资源 ID 字符串

EventhubProperties

名字 描述 价值
captureDescription 捕获说明的属性 CaptureDescription
messageRetentionInDays 保留此事件中心的事件的天数,值应为 1 到 7 天 int

约束:
最小值 = 1
messageTimestampDescription MessageTimestamp 说明的属性 MessageTimestampDescription
partitionCount 为事件中心创建的分区数,允许的值从 1 到 32 个分区。 int

约束:
最小值 = 1
retentionDescription 事件中心保留设置 RetentionDescription
地位 枚举事件中心状态的可能值。 “Active”
“创建”
“删除”
“Disabled”
“ReceiveDisabled”
“重命名”
“正在还原”
“SendDisabled”
“未知”
userMetadata 获取和设置用户的元数据。 字符串

MessageTimestampDescription

名字 描述 价值
timestampType 表示消息将保留的时间戳类型。两种类型的时间戳类型 -“AppendTime”和“CreateTime”。 AppendTime 是指在中转站日志中追加消息的时间。 CreateTime 是指在源端生成消息的时间,生成者可以在发送消息时设置此时间戳。 默认值为 AppendTime。 如果使用 AMQP 协议,CreateTime 等于 AppendTime 及其行为保持不变。 “Create”
“LogAppend”

Microsoft.EventHub/namespaces/eventhubs

名字 描述 价值
名字 资源名称 字符串

约束:
最小长度 = 1
最大长度 = 1 (必需)
parent_id 此资源的父资源的 ID。 类型资源的 ID:命名空间
性能 提供给“创建或更新事件中心”操作的属性。 EventhubProperties
类型 资源类型 “Microsoft.EventHub/namespaces/eventhubs@2024-05-01-preview”

RetentionDescription

名字 描述 价值
cleanupPolicy 枚举清理策略的可能值 “Compact”
“Delete”
“DeleteOrCompact”
minCompactionLagInMins 消息在日志中无法压缩的最短时间。 当 cleanupPolicy 为 Compact 或 DeleteOrCompact 时,将使用此值。 int
retentionTimeInHours 保留此事件中心的事件的小时数。 这应该是命名空间 SKU 最大值的正值。-1 是一种特殊情况,即保留时间是无限的,但实体的大小受到限制,其大小取决于命名空间 SKU 类型。 int
tombstoneRetentionTimeInHours 保留压缩事件中心的逻辑删除标记的小时数。 当 cleanupPolicy 为 Compact 或 DeleteOrCompact 时,将使用此值。 使用者必须在此指定的时间范围内完成读取墓碑标记(如果使用者从起始偏移开始)以确保它们获取压缩事件中心内逻辑删除标记所描述的特定键的有效快照 int