@azure/event-hubs package

類別

EventHubBufferedProducerClient	EventHubBufferedProducerClient用來將事件發佈至特定的事件中樞。 EventHubBufferedProducerClient不會立即發佈事件。 相反地，事件會經過緩衝處理，以便在批次已滿或 maxWaitTimeInMs 已經過且未加入佇列的新事件時，有效率地批處理和發佈事件。 視加入佇列事件時所指定的選項而定，它們可能會自動指派給分割區、根據指定的分割區索引鍵分組，或指派特別要求的數據分割。 此模型旨在將批次管理的負擔從呼叫端轉移，而代價是非決定性計時，以在何時發佈事件。 另外還有一些需要考慮的取捨： 如果應用程式當機，則緩衝區中的事件將不會發佈。 為了防止數據遺失，建議呼叫端使用 onSendEventsSuccessHandler 和 onSendEventsErrorHandler 處理程式來追蹤發佈進度。 指定分割區索引鍵的事件可能會指派與與其他產生者使用相同的索引鍵來指派不同的分割區。 在分割區暫時無法使用的不太可能情況下， EventHubBufferedProducerClient 可能需要較長的時間才能復原，而不是其他產生者。 在立即發佈具有決定性結果的事件時，請務必使用 建議使用 EventHubProducerClient ，將分割區索引鍵指派給與其他發行者一致的分割區，或將可用性最大化的需求。
EventHubConsumerClient	類別 EventHubConsumerClient 是用來取用事件中樞的事件。 有多種方式可以建立 EventHubConsumerClient 使用針對事件中樞實例建立的 SAS 原則中的 連接字串。 使用針對事件中樞命名空間建立之 SAS 原則的 連接字串，以及事件中樞實例的名稱 使用完整的命名空間，例如 <yournamespace>.servicebus.windows.net和 認證物件。 您也可以選擇性地傳遞： 設定重試原則或 Proxy 設定的選項包。 用戶端用來讀取檢查點的檢查點存放區，以判斷應用程式重新啟動時，應該繼續接收事件的位置。 用戶端也會使用檢查點存放區來負載平衡應用程式的多個實例。
EventHubProducerClient	類別 EventHubProducerClient 是用來將事件傳送至事件中樞。 有多種方式可以建立 EventHubProducerClient 使用針對事件中樞實例建立的 SAS 原則中的 連接字串。 使用針對事件中樞命名空間建立之 SAS 原則的 連接字串，以及事件中樞實例的名稱 使用完整的命名空間，例如 <yournamespace>.servicebus.windows.net和 認證物件。 您也可以選擇性地傳遞選項包來設定重試原則或 Proxy 設定。
MessagingError	描述傳訊錯誤的基類。

介面

BufferedCloseOptions	在上EventHubBufferedProducerClient設定 close 方法的選項。
BufferedFlushOptions	在上EventHubBufferedProducerClient設定 flush 方法的選項。
Checkpoint	檢查點的目的是代表使用者從事件中樞實例中取用者群組的特定分割區最後一次成功處理的事件。 updateCheckpoint()當使用者呼叫 類別上的 PartitionProcessor 方法時，Checkpoint會在內部建立 。 然後，它會儲存在建立 時， CheckpointManager 由使用者所選擇的 所實作的 EventProcessor記憶體解決方案中。 用戶永遠不會預期直接與互動 Checkpoint 。 這個介面存在以支援和CheckpointManager的內部工作EventProcessor。
CheckpointStore	檢查點存放區會儲存並擷取事件中樞實例之指定取用者群組中每個分割區的分割區擁有權資訊和檢查點詳細數據。 使用者不打算實作 CheckpointStore。 用戶預期會選擇此介面的現有實作、具現化它，並在具現化用戶端時將它 EventHubConsumerClient 傳遞給類別建構函式。 使用者不應該在檢查點存放區上使用任何方法，用戶端會在內部使用這些方法。 您可以在 npm 上找到 實作 CheckpointStore ，方法是搜尋前置詞為 @azure/eventhub-checkpointstore-的套件。
CreateBatchOptions	在上EventHubProducerClient設定 createBatch 方法的選項。 partitionKey ：哈希的值，用來產生數據分割指派。 maxSizeInBytes：批次大小的上限。 abortSignal ：發出要求以取消傳送作業的訊號。 使用方式範例： { partitionKey: 'foo', maxSizeInBytes: 1024 * 1024 // 1 MB }
EnqueueEventOptions	在上EventHubBufferedProducerClient設定 enqueueEvents 方法的選項。
EventData	介面，描述要傳送至事件中樞的數據。 使用 建立物件時要傳送的物件時 EventHubProducerClient，請使用這個做為參考。 例如，{ body: "your-data" } 或 { body: "your-data", properties: { propertyName: "property value" } }
EventDataAdapterParameters	createEventDataAdapter建立事件數據配接器之函式的參數。
EventDataBatch	介面，表示可用來將事件傳送至事件中樞的事件批次。 若要建立批次，請使用 createBatch() 上的 EventHubProducerClient方法。 若要傳送批次，請使用 sendBatch() 相同用戶端上的方法。 若要填滿批次，請在批次本身使用 tryAdd() 方法。
EventHubBufferedProducerClientOptions	描述可在建立 EventHubBufferedProducerClient時提供的選項。
EventHubClientOptions	描述可在建立 EventHubClient 時提供的選項。 userAgent ：要附加至內建使用者代理程式字串的字串，傳遞為服務的連接屬性。 webSocketOptions ：透過 Web 套接字設定 AMQP 連線通道的選項。 websocket ：如果您選擇透過 WebSocket 建立連線，則用來建立 AMQP 連線的 WebSocket 建構函式。 webSocketConstructorOptions ：當您選擇透過 WebSocket 建立連線時，要傳遞至 Websocket 建構函式的選項。 retryOptions ：客戶端/產生者/取用者上所有作業的重試選項。 maxRetries ：如果發生可重試的錯誤，可以重試作業的次數。 maxRetryDelayInMs：重試之間的延遲上限。 僅適用於執行指數重試時。 mode：要套用的重試模式，由列舉指定 RetryMode 。 選項為 Exponential 和 Fixed。 預設值為 Fixed。 retryDelayInMs：進行下一次嘗試之前，以毫秒為單位等候的時間量。 當 設定為 Exponential時mode，這會用來計算重試之間的指數增加延遲。 默認值：30000 毫秒。 timeoutInMs：作業逾時前等候的毫秒時間量。如果剩餘任何重試嘗試，這會觸發重試。 默認值：60000 毫秒。 簡單的用法可以是 { "maxRetries": 4 }。 使用方式範例： { retryOptions: { maxRetries: 4 } }
EventHubConnectionStringProperties	組成事件中樞 連接字串 的屬性集。
EventHubConsumerClientOptions	描述可在建立 EventHubConsumerClient 時提供的選項。 loadBalancingOptions：微調 EventHubConsumerClient 宣告分割區方式的選項。 userAgent ：要附加至內建使用者代理程式字串的字串，傳遞為服務的連接屬性。 webSocketOptions ：透過 Web 套接字設定 AMQP 連線通道的選項。 websocket ：如果您選擇透過 WebSocket 建立連線，則用來建立 AMQP 連線的 WebSocket 建構函式。 webSocketConstructorOptions ：當您選擇透過 WebSocket 建立連線時，要傳遞至 Websocket 建構函式的選項。 retryOptions ：客戶端/產生者/取用者上所有作業的重試選項。 maxRetries ：如果發生可重試的錯誤，可以重試作業的次數。 maxRetryDelayInMs：重試之間的延遲上限。 僅適用於執行指數重試時。 mode：要套用的重試模式，由列舉指定 RetryMode 。 選項為 Exponential 和 Fixed。 預設值為 Fixed。 retryDelayInMs：進行下一次嘗試之前，以毫秒為單位等候的時間量。 當 設定為 Exponential時mode，這會用來計算重試之間的指數增加延遲。 默認值：30000 毫秒。 timeoutInMs：作業逾時前等候的毫秒時間量。如果剩餘任何重試嘗試，這會觸發重試。 默認值：60000 毫秒。 簡單的用法可以是 { "maxRetries": 4 }。 使用方式範例： { retryOptions: { maxRetries: 4 } }
EventHubProperties	描述事件中樞的運行時間資訊。
EventPosition	表示事件在事件中樞分割區中的位置，通常用來在 上EventHubConsumerClient呼叫 subscribe() 方法，以指定分割區中要開始接收事件的位置。 若要取得代表數據流開頭或結尾的 EventPosition，請分別使用 常數 earliestEventPosition 和 latestEventPosition 。
GetEventHubPropertiesOptions	設定行為的 getEventHubProperties一組選項。 abortSignal ：介面的 AbortSignalLike 實作，可發出要求以取消作業的訊號。 parentSpan：當Span做parent呼叫此作業時所建立範圍之 的 或 SpanContext 。
GetPartitionIdsOptions	設定行為的 getPartitionIds一組選項。 abortSignal ：介面的 AbortSignalLike 實作，可發出要求以取消作業的訊號。 parentSpan：當Span做parent呼叫此作業時所建立範圍之 的 或 SpanContext 。
GetPartitionPropertiesOptions	設定行為的 getPartitionProperties一組選項。 abortSignal ：介面的 AbortSignalLike 實作，可發出要求以取消作業的訊號。 parentSpan：當Span做parent呼叫此作業時所建立範圍之 的 或 SpanContext 。
LastEnqueuedEventProperties	一組有關分割區最後加入佇列事件的資訊，如取用者觀察到的事件從事件中樞服務接收
LoadBalancingOptions	設定負載平衡設定的選項包。
OnSendEventsErrorContext	包含未成功傳送至事件中樞的事件、指派給它們的分割區，以及傳送時遇到的錯誤。
OnSendEventsSuccessContext	包含已成功傳送至事件中樞的事件，以及指派給的事件分割區。
OperationOptions	設定追蹤和中止的選項。
PartitionContext	介面，描述傳遞至屬於 之每個函式的內容 SubscriptionEventHandlers。 實作上述任何函式時，請使用內容物件來取得數據分割的相關信息，以及檢查點的能力。
PartitionOwnership	介面，表示事件中樞實例 EventProcessor 取用者群組中指定分割區處理的詳細數據。 注意：這是由 內部使用， EventProcessor 而且用戶永遠不需要直接建立它。
PartitionProperties	描述 EventHub Partition 的運行時間資訊。
ReceivedEventData	介面，描述從事件中樞接收的事件結構。 使用 建立 函式以 processEvents 處理使用 EventHubConsumerClient時從事件中樞接收的事件時，請使用此做為參考。
RetryOptions	決定模式、重試次數、重試間隔等重試原則選項。
SendBatchOptions	傳送事件陣列時，在上EventHubProducerClient設定 sendBatch 方法的選項。 如果 partitionId 已設定， partitionKey 則不得設定 ，反之亦然。 partitionId ：此批次將傳送至的分割區。 partitionKey ：哈希的值，用來產生數據分割指派。 abortSignal ：用來取消傳送作業的訊號。
SubscribeOptions	在上EventHubConsumerClient設定 subscribe 方法的選項。 例如，{ maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }
Subscription	介面，描述 方法在 上EventHubConsumerClient傳subscribe()回的物件。
SubscriptionEventHandlers	介面，描述呼叫 方法以從事件中樞接收事件時subscribe()，EventHubConsumerClient由用戶實作的函式。
TokenCredential	表示能夠提供驗證令牌的認證。
TryAddOptions	設定類別上EventDataBatch方法行為tryAdd的選項。
WebSocketImpl	描述 WebSocket 建構函式的必要圖形。
WebSocketOptions	透過 Web 套接字設定 AMQP 連線通道的選項。

類型別名

ProcessCloseHandler	使用者提供的函 EventHubConsumerClient 式簽章會在停止之後叫用，以從分割區接收事件。
ProcessErrorHandler	針對接收事件或執行任何傳遞至 subscribe() 方法的使用者提供函式時所發生的錯誤，所叫EventHubConsumerClient用之使用者提供的函式簽章。
ProcessEventsHandler	收到一組事件時，由 EventHubConsumerClient 所叫用之使用者提供的函式簽章。
ProcessInitializeHandler	使用者提供的函 EventHubConsumerClient 式簽章，剛好開始從分割區接收事件之前叫用。

列舉

CloseReason	列舉，表示 停止處理事件中樞取用者群組中分割區事件的不同原因 EventHubConsumerClient 。
RetryMode	描述重試模式類型

函式

createEventDataAdapter(EventDataAdapterParameters)	建構事件數據配接器的函式。 該配接器可以搭配 @azure/schema-registry-avro 使用，在事件數據中編碼和譯碼主體。
parseEventHubConnectionString(string)	將指定的 連接字串 剖析為適用於 Azure 事件中樞 的不同屬性。 屬性可用來建構 EventHubProducerClient 或 EventHubConsumerClient。

函式詳細資料

createEventDataAdapter(EventDataAdapterParameters)

建構事件數據配接器的函式。 該配接器可以搭配 @azure/schema-registry-avro 使用，在事件數據中編碼和譯碼主體。

function createEventDataAdapter(params?: EventDataAdapterParameters): MessageAdapter<EventData>

參數

params

EventDataAdapterParameters

用來建立事件數據的參數

傳回

MessageAdapter<EventData>

可產生及取用事件數據的事件數據配接器

parseEventHubConnectionString(string)

將指定的 連接字串 剖析為適用於 Azure 事件中樞 的不同屬性。 屬性可用來建構 EventHubProducerClient 或 EventHubConsumerClient。

function parseEventHubConnectionString(connectionString: string): Readonly<EventHubConnectionStringProperties>

參數

connectionString

string

與為事件中樞命名空間建立的共用存取原則相關聯的 連接字串。

傳回

Readonly<EventHubConnectionStringProperties>