Microsoft.EventHub 命名空間/eventhubs 2018-01-01-preview

  • 發行項

Bicep 資源定義

命名空間/eventhubs 資源類型可以使用目標作業進行部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.EventHub/namespaces/eventhubs 資源，請將下列 Bicep 新增至您的範本。

resource symbolicname 'Microsoft.EventHub/namespaces/eventhubs@2018-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'
'Creating'
'刪除'
'Disabled'
'ReceiveDisabled'
'Renaming'
'還原'
'SendDisabled'
'Unknown'

CaptureDescription

名稱 描述 值
目的地 將儲存擷取之目的地的屬性。 (記憶體帳戶、Blob 名稱) 目的地
已啟用 值，指出是否啟用擷取描述。 bool
編碼 列舉擷取描述編碼格式的可能值。 注意：新的 API 版本中將會淘汰 'AvroDflate' 'Avro'
'AvroDflate'
intervalInSeconds 時間範圍可讓您設定擷取至 Azure Blob 的頻率，值應該介於 60 到 900 秒之間 int

約束：
最小值 = 60
最大值 = 900
sizeLimitInBytes 大小視窗會在擷取作業之前定義事件中樞內建的數據量，值應該介於10485760到524288000個字節之間 int

約束：
最小值 = 10485760
最大值 = 524288000
skipEmptyArchives 值，指出是否要略過空白封存 bool

目的地

名稱 描述 值
NAME 擷取目的地的名稱 字串
properties 描述擷取目的地記憶體帳戶、Blob 容器和封存名稱格式的屬性 DestinationProperties

DestinationProperties

名稱 描述 值
archiveNameFormat 封存的 Blob 命名慣例，例如 {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}。 在這裡，所有參數 (Namespace，EventHub ..etc) 不論順序為何，都是強制的 字串
blobContainer Blob 容器名稱 字串
storageAccountResourceId 要用來建立 Blob 之記憶體帳戶的資源識別碼 字串

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
適用於 Azure 事件中樞的 PubNub 即時閘道

部署至 Azure		 適用於 Azure 的 PubNub 即時閘道提供 PubNub 資料 Stream 網路與 Azure 事件中樞 之間的即時數據流網橋。 -- 將其視為 PubNub 與 Azure 之間的雙向網橋！
在 Azure 架構上部署運動分析

部署至 Azure		 建立已啟用 ADLS Gen 2 的 Azure 記憶體帳戶、具有記憶體帳戶連結服務的 Azure Data Factory 實例， (部署) Azure SQL 資料庫，以及 Azure Databricks 實例。 部署範本的使用者 AAD 身分識別和 ADF 實例的受控識別將會獲得記憶體帳戶上的記憶體 Blob 數據參與者角色。 此外，還有選項可用來部署 Azure 金鑰保存庫 實例、Azure SQL 資料庫，以及用於串流處理使用案例的 Azure 事件中樞 () 。 部署 Azure 金鑰保存庫 時，部署範本之用戶的數據處理站受控識別和 AAD 身分識別將會獲得 金鑰保存庫 秘密使用者角色。
Moesif API 分析和獲利

部署至 Azure		 此範本會將來自 Azure API 管理 的 API 呼叫記錄至 Moesif API 分析和獲利平臺
具有時間數據歷程記錄連線的 Azure Digital Twins

部署至 Azure		 此範本會建立以時間序列數據歷程記錄連線設定的 Azure Digital Twins 實例。 若要建立連線，必須建立其他資源，例如事件中樞命名空間、事件中樞、Azure Data Explorer 叢集和資料庫。 數據會傳送至事件中樞，最後會將數據轉送至 Azure Data Explorer 叢集。 數據會儲存在叢集中的資料庫數據表中
建立事件方格自定義主題和事件中樞處理程式

部署至 Azure		 建立 Azure 事件方格 自定義主題和事件中樞來處理事件。
建立 EventHubs 命名空間、事件中樞、& 取用者群組

部署至 Azure		 此範本可讓您部署事件中樞標準命名空間、事件中樞和取用者群組。
建立 EventHubs authorizationRules

部署至 Azure		 此範本可讓您部署 EventHubs Standard 命名空間、事件中樞、取用者群組和 authorizationRules
建立 Eventhub 叢集、nameapce & eventhub

部署至 Azure		 此範本可讓您在叢集中建立 EventHubs 叢集、命名空間和 eventhub
建立已啟用擷取的 EventHubs

部署至 Azure		 此範本可讓您使用事件中樞部署 EventHubs 命名空間，並在其中啟用擷取
建立已啟用擷取的 EventHubs (ADLS)

部署至 Azure		 此範本可讓您使用事件中樞部署 EventHubs 命名空間，並在其中啟用擷取
建立 EventHubs 命名空間並啟用自動擴充

部署至 Azure		 此範本可讓您部署事件中樞標準命名空間、事件中樞和取用者群組。此範本也會開啟命名空間上的自動擴充功能。
建立事件中樞

部署至 Azure		 此範本可讓您使用事件中樞來部署 EventHubs 命名空間。
透過私人端點連線到事件中樞命名空間

部署至 Azure		 此範例示範如何使用設定虛擬網路和私人 DNS 區域，透過私人端點存取事件中樞命名空間。
部署 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 Data Explorer db

部署至 Azure		 使用事件中樞連線部署 Azure Data Explorer db。
Azure SQL 寫入事件中樞稽核的伺服器

部署至 Azure		 此範本可讓您部署已啟用稽核的 Azure SQL 伺服器，以將稽核記錄寫入事件中樞
使用已設定的記錄和計量傳送來建立 SQL MI

部署至 Azure		 此範本可讓您部署用來儲存記錄和計量的 SQL MI 和其他資源， (診斷工作區、記憶體帳戶、事件中樞) 。
使用事件中樞事件來源建立環境

部署至 Azure		 此範本可讓您部署時間序列深入解析環境，其設定為從事件中樞取用事件。
具有事件中樞和受控識別的 Azure 函式應用程式

部署至 Azure		 他的範本會在Linux取用方案上布建 Azure 函式應用程式，以及事件中樞、Azure 記憶體和 Application Insights。 函式應用程式可以使用受控識別連線到事件中樞和記憶體帳戶

ARM 範本資源定義

命名空間/eventhubs 資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。

資源格式

若要建立 Microsoft.EventHub/namespaces/eventhubs 資源，請將下列 JSON 新增至您的範本。

{
  "type": "Microsoft.EventHub/namespaces/eventhubs",
  "apiVersion": "2018-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

名稱 描述 值
類型 資源類型 'Microsoft.EventHub/namespaces/eventhubs'
apiVersion 資源 API 版本 '2018-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'
'Renaming'
'還原'
'SendDisabled'
'Unknown'

CaptureDescription

名稱 描述 值
目的地 將儲存擷取之目的地的屬性。 (記憶體帳戶、Blob 名稱) 目的地
已啟用 值，指出是否啟用擷取描述。 bool
編碼 列舉擷取描述編碼格式的可能值。 注意：新 API 版本中將會取代 'AvroDeflate' 'Avro'
'AvroDeflate'
intervalInSeconds 時間範圍可讓您設定擷取至 Azure Blob 的頻率，值應該介於 60 到 900 秒之間 int

約束：
最小值 = 60
最大值 = 900
sizeLimitInBytes 大小視窗會在擷取作業之前定義事件中樞內建的數據量，值應該介於10485760到524288000位元組之間 int

約束：
最小值 = 10485760
最大值 = 524288000
skipEmptyArchives 值，指出是否要略過空白封存 bool

目的地

名稱 描述 值
NAME 擷取目的地的名稱 字串
properties 描述擷取目的地記憶體帳戶、Blob 容器和封存名稱格式的屬性 DestinationProperties

DestinationProperties

名稱 描述 值
archiveNameFormat 封存的 Blob 命名慣例，例如 {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}。 在這裡，所有參數 (Namespace，EventHub ..etc) 不論順序為何，都是強制的 字串
blobContainer Blob 容器名稱 字串
storageAccountResourceId 要用來建立 Blob 的記憶體帳戶資源識別碼 字串

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
適用於 Azure 事件中樞的 PubNub 即時閘道

部署至 Azure		 適用於 Azure 的 PubNub 即時閘道提供 PubNub 資料 Stream 網路與 Azure 事件中樞 之間的即時數據流網橋。 -- 將其視為 PubNub 與 Azure 之間的雙向網橋！
在 Azure 架構上部署運動分析

部署至 Azure		 建立已啟用 ADLS Gen 2 的 Azure 記憶體帳戶、具有記憶體帳戶連結服務的 Azure Data Factory 實例， (部署) Azure SQL 資料庫，以及 Azure Databricks 實例。 部署範本的使用者 AAD 身分識別和 ADF 實例的受控識別，將會獲得記憶體帳戶上的記憶體 Blob 數據參與者角色。 另外還有一個選項可用來部署 Azure 金鑰保存庫 實例、Azure SQL 資料庫，以及用於串流使用案例的 Azure 事件中樞 () 。 部署 Azure 金鑰保存庫 時，數據處理站受控識別和部署範本之使用者的 AAD 身分識別將會獲得 金鑰保存庫 秘密使用者角色。
Moesif API 分析和獲利

部署至 Azure		 此範本會將來自 Azure API 管理 的 API 呼叫記錄到 Moesif API 分析和獲利平臺
具有時間數據歷程記錄連線的 Azure Digital Twins

部署至 Azure		 此範本會建立設定時間序列數據歷程記錄連線的 Azure Digital Twins 實例。 若要建立連線，必須建立其他資源，例如事件中樞命名空間、事件中樞、Azure Data Explorer 叢集和資料庫。 數據會傳送至事件中樞，最後會將數據轉送至 Azure Data Explorer 叢集。 數據會儲存在叢集中的資料庫數據表中
建立事件方格自定義主題和事件中樞處理程式

部署至 Azure		 建立 Azure 事件方格 自定義主題和事件中樞來處理事件。
建立 EventHubs 命名空間、事件中樞、& 取用者群組

部署至 Azure		 此範本可讓您部署事件中樞標準命名空間、事件中樞和取用者群組。
建立 EventHubs authorizationRules

部署至 Azure		 此範本可讓您部署 EventHubs Standard 命名空間、事件中樞、取用者群組和 authorizationRules
建立 Eventhub 叢集、nameapce & eventhub

部署至 Azure		 此範本可讓您在叢集中建立 EventHubs 叢集、命名空間和 eventhub
建立已啟用擷取的 EventHubs

部署至 Azure		 此範本可讓您部署具有事件中樞的 EventHubs 命名空間，並在其上啟用擷取
建立已啟用擷取的 EventHubs (ADLS)

部署至 Azure		 此範本可讓您部署具有事件中樞的 EventHubs 命名空間，並在其上啟用擷取
建立 EventHubs 命名空間並啟用自動擴充

部署至 Azure		 此範本可讓您部署事件中樞標準命名空間、事件中樞和取用者群組。此範本也會開啟命名空間上的自動擴充功能。
建立事件中樞

部署至 Azure		 此範本可讓您使用事件中樞部署 EventHubs 命名空間。
透過私人端點連線到事件中樞命名空間

部署至 Azure		 此範例示範如何使用設定虛擬網路和私人 DNS 區域，透過私人端點存取事件中樞命名空間。
部署 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 Data Explorer db

部署至 Azure		 使用事件中樞連線部署 Azure Data Explorer db。
Azure SQL 寫入事件中樞稽核的伺服器

部署至 Azure		 此範本可讓您部署已啟用稽核的 Azure SQL 伺服器，以將稽核記錄寫入事件中樞
建立已設定傳送記錄和計量的 SQL MI

部署至 Azure		 此範本可讓您部署用於儲存記錄和計量的 SQL MI 和其他資源， (診斷工作區、記憶體帳戶、事件中樞) 。
使用事件中樞事件來源建立環境

部署至 Azure		 此範本可讓您部署設定為取用事件中樞事件的時間序列深入解析環境。
具有事件中樞和受控識別的 Azure 函式應用程式

部署至 Azure		 他的範本會在Linux取用方案上布建 Azure 函式應用程式，以及事件中樞、Azure 記憶體和 Application Insights。 函式應用程式能夠使用受控識別來連線到事件中樞和記憶體帳戶

Terraform (AzAPI 提供者) 資源定義

命名空間/eventhubs 資源類型可以使用目標作業進行部署：

  • 資源群組

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.EventHub/namespaces/eventhubs 資源，請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventHub/namespaces/eventhubs@2018-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

名稱 描述 值
類型 資源類型 “Microsoft.EventHub/namespaces/eventhubs@2018-01-01-preview”
NAME 資源名稱 需要字串 ()

字元限制：1-256

合法字元：
英數字元、句號、連字號和底線。

以字母或數字開頭及結尾。
parent_id 此資源父系之資源的標識碼。 類型資源的識別碼： 命名空間
properties 提供給建立或更新事件中樞作業的屬性。 EventhubProperties

EventhubProperties

名稱 描述 值
captureDescription 擷取描述的屬性 CaptureDescription
messageRetentionInDays 保留此事件中樞事件的天數，值應為 1 到 7 天 int

約束：
最小值 = 1
partitionCount 為事件中樞建立的數據分割數目，允許的值是從 1 到 32 個數據分割。 int

約束：
最小值 = 1
status 列舉事件中樞狀態的可能值。 作用中”
“建立”
“刪除”
“Disabled”
“ReceiveDisabled”
“重新命名”
「正在還原」
“SendDisabled”
“未知”

CaptureDescription

名稱 描述 值
目的地 將儲存擷取之目的地的屬性。 (記憶體帳戶、Blob 名稱) 目的地
已啟用 值，指出是否啟用擷取描述。 bool
編碼 列舉擷取描述編碼格式的可能值。 注意：新的 API 版本中將會淘汰 'AvroDflate' “Avro”
“AvroDflate”
intervalInSeconds 時間範圍可讓您設定擷取至 Azure Blob 的頻率，值應該介於 60 到 900 秒之間 int

約束：
最小值 = 60
最大值 = 900
sizeLimitInBytes 大小視窗會在擷取作業之前定義事件中樞內建的數據量，值應該介於10485760到524288000個字節之間 int

約束：
最小值 = 10485760
最大值 = 524288000
skipEmptyArchives 值，指出是否略過空白封存 bool

目的地

名稱 描述 值
NAME 擷取目的地的名稱 字串
properties 描述擷取目的地的記憶體帳戶、Blob 容器和封存名稱格式的屬性 DestinationProperties

DestinationProperties

名稱 描述 值
archiveNameFormat 封存的 Blob 命名慣例，例如 {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}。 在這裡，所有參數 (Namespace，EventHub ..etc) 不論順序為何，都是強制的 字串
blobContainer Blob 容器名稱 字串
storageAccountResourceId 要用來建立 Blob 的記憶體帳戶資源識別碼 字串