EventHubConsumerClient class
EventHubConsumerClient 類別可用來取用事件中樞的事件。
有多種方式可以建立 EventHubConsumerClient
- 使用針對事件中樞實例建立的 SAS 原則中的連接字串。
- 使用針對事件中樞命名空間所建立 SAS 原則的連接字串，以及事件中樞實例的名稱
- 使用完整的命名空間，例如
<yournamespace>.servicebus.windows.net和認證物件。
或者，您也可以傳遞：
- 設定重試原則或 Proxy 設定的選項包。
- 用戶端用來讀取檢查點的檢查點存放區，以判斷應用程式重新啟動時應該繼續接收事件的位置。 用戶端也會使用檢查點存放區來平衡應用程式的多個實例。
建構函式
屬性
| default |
事件中樞服務中預設取用者群組的名稱。 |
| event |
建立此用戶端的事件中樞實例名稱。 |
| fully |
建立此用戶端之事件中樞實例的完整命名空間。 這可能類似於 .servicebus.windows.net。 |
| identifier | 用來識別此 EventHubConsumerClient 的名稱。 如果未指定或空白，則會產生隨機唯一的 。 |
方法
| close() | 關閉事件中樞實例的AMQP連線，並傳回在中斷連線完成時將解決的承諾。 |
| get |
提供事件中樞運行時間資訊。 |
| get |
提供與事件中樞相關聯的每個分割區標識碼。 |
| get |
提供指定數據分割狀態的相關信息。 |
| subscribe(string, Subscription |
訂閱單一分割區的事件。 在傳回的物件上呼叫 close（） 以停止接收事件。 範例用法： |
| subscribe(Subscription |
訂閱來自所有分割區的事件。 如果檢查點存放區提供給 在傳回的物件上呼叫 close（） 以停止接收事件。 範例用法： |
建構函式詳細資料
EventHubConsumerClient(string, string, CheckpointStore, EventHubConsumerClientOptions)
EventHubConsumerClient 類別可用來取用事件中樞的事件。
使用 options 參數來設定重試原則或 Proxy 設定。
new EventHubConsumerClient(consumerGroup: string, connectionString: string, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)參數
- consumerGroup
-
string
要處理事件的取用者群組名稱。
- connectionString
-
string
用於連線到事件中樞實例的連接字串。 預期共用金鑰屬性和事件中樞路徑會包含在此連接字串中。 例如 'Endpoint=sb：//my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name;SharedAccessKey=my-SA-key;EntityPath=my-event-hub-name'。
- checkpointStore
- CheckpointStore
用戶端用來讀取檢查點的檢查點存放區，以判斷應用程式重新啟動時應該繼續接收事件的位置。 用戶端也會使用它來平衡應用程式的多個實例負載。
- options
- EventHubConsumerClientOptions
設定用戶端時要套用的一組選項。
-
retryOptions：設定用戶端上所有作業的重試原則。 例如，{ "maxRetries": 4 }或{ "maxRetries": 4, "retryDelayInMs": 30000 }。 -
webSocketOptions：設定透過 Web 套接字的 AMQP 連線通道。 -
userAgent：要附加至傳遞至服務之內建使用者代理程式字串的字串。
EventHubConsumerClient(string, string, EventHubConsumerClientOptions)
EventHubConsumerClient 類別可用來取用事件中樞的事件。
使用 options 參數來設定重試原則或 Proxy 設定。
new EventHubConsumerClient(consumerGroup: string, connectionString: string, options?: EventHubConsumerClientOptions)參數
- consumerGroup
-
string
要處理事件的取用者群組名稱。
- connectionString
-
string
用於連線到事件中樞實例的連接字串。 預期共用金鑰屬性和事件中樞路徑會包含在此連接字串中。 例如 'Endpoint=sb：//my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name;SharedAccessKey=my-SA-key;EntityPath=my-event-hub-name'。
- options
- EventHubConsumerClientOptions
設定用戶端時要套用的一組選項。
-
retryOptions：設定用戶端上所有作業的重試原則。 例如，{ "maxRetries": 4 }或{ "maxRetries": 4, "retryDelayInMs": 30000 }。 -
webSocketOptions：設定透過 Web 套接字的 AMQP 連線通道。 -
userAgent：要附加至傳遞至服務之內建使用者代理程式字串的字串。
EventHubConsumerClient(string, string, string, CheckpointStore, EventHubConsumerClientOptions)
EventHubConsumerClient 類別可用來取用事件中樞的事件。
使用 options 參數來設定重試原則或 Proxy 設定。
new EventHubConsumerClient(consumerGroup: string, connectionString: string, eventHubName: string, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)參數
- consumerGroup
-
string
要處理事件的取用者群組名稱。
- connectionString
-
string
用於連線到事件中樞命名空間的連接字串。 預期共用密鑰屬性會包含在此連接字串中，但不包含事件中樞路徑，例如 'Endpoint=sb：//my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name;SharedAccessKey=my-SA-key;'。
- eventHubName
-
string
要連接用戶端的特定事件中樞名稱。
- checkpointStore
- CheckpointStore
用戶端用來讀取檢查點的檢查點存放區，以判斷應用程式重新啟動時應該繼續接收事件的位置。 用戶端也會使用它來平衡應用程式的多個實例負載。
- options
- EventHubConsumerClientOptions
設定用戶端時要套用的一組選項。
-
retryOptions：設定用戶端上所有作業的重試原則。 例如，{ "maxRetries": 4 }或{ "maxRetries": 4, "retryDelayInMs": 30000 }。 -
webSocketOptions：設定透過 Web 套接字的 AMQP 連線通道。 -
userAgent：要附加至傳遞至服務之內建使用者代理程式字串的字串。
EventHubConsumerClient(string, string, string, EventHubConsumerClientOptions)
EventHubConsumerClient 類別可用來取用事件中樞的事件。
使用 options 參數來設定重試原則或 Proxy 設定。
new EventHubConsumerClient(consumerGroup: string, connectionString: string, eventHubName: string, options?: EventHubConsumerClientOptions)參數
- consumerGroup
-
string
要處理事件的取用者群組名稱。
- connectionString
-
string
用於連線到事件中樞命名空間的連接字串。 預期共用密鑰屬性會包含在此連接字串中，但不包含事件中樞路徑，例如 'Endpoint=sb：//my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name;SharedAccessKey=my-SA-key;'。
- eventHubName
-
string
要連接用戶端的特定事件中樞名稱。
- options
- EventHubConsumerClientOptions
設定用戶端時要套用的一組選項。
-
retryOptions：設定用戶端上所有作業的重試原則。 例如，{ "maxRetries": 4 }或{ "maxRetries": 4, "retryDelayInMs": 30000 }。 -
webSocketOptions：設定透過 Web 套接字的 AMQP 連線通道。 -
userAgent：要附加至傳遞至服務之內建使用者代理程式字串的字串。
EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, CheckpointStore, EventHubConsumerClientOptions)
EventHubConsumerClient 類別可用來取用事件中樞的事件。
使用 options 參數來設定重試原則或 Proxy 設定。
new EventHubConsumerClient(consumerGroup: string, fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential | NamedKeyCredential | SASCredential, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)參數
- consumerGroup
-
string
要處理事件的取用者群組名稱。
- fullyQualifiedNamespace
-
string
可能類似於 .servicebus.windows.net 的完整命名空間
- eventHubName
-
string
要連接用戶端的特定事件中樞名稱。
- credential
用戶端用來取得令牌的認證物件，用來驗證與 Azure 事件中樞服務的連線。
請參閱@azure/身分識別，以建立支援 AAD 驗證的認證。如果您想要傳入 SharedAccessKeyName 和 SharedAccessKey 而不使用連接字串，請使用 @azure/core-auth 中的 AzureNamedKeyCredential。 這些欄位分別對應至 AzureNamedKeyCredential中的 [name] 和 [key] 字段。
如果您想要傳入 SharedAccessSignature 而不使用連接字串，請使用 @azure/core-auth 中的 AzureSASCredential。 此欄位會對應至 AzureSASCredential中的 signature。
- checkpointStore
- CheckpointStore
用戶端用來讀取檢查點的檢查點存放區，以判斷應用程式重新啟動時應該繼續接收事件的位置。 用戶端也會使用它來平衡應用程式的多個實例負載。
- options
- EventHubConsumerClientOptions
設定用戶端時要套用的一組選項。
-
retryOptions：設定用戶端上所有作業的重試原則。 例如，{ "maxRetries": 4 }或{ "maxRetries": 4, "retryDelayInMs": 30000 }。 -
webSocketOptions：設定透過 Web 套接字的 AMQP 連線通道。 -
userAgent：要附加至傳遞至服務之內建使用者代理程式字串的字串。
EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, EventHubConsumerClientOptions)
EventHubConsumerClient 類別可用來取用事件中樞的事件。
使用 options 參數來設定重試原則或 Proxy 設定。
new EventHubConsumerClient(consumerGroup: string, fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential | NamedKeyCredential | SASCredential, options?: EventHubConsumerClientOptions)參數
- consumerGroup
-
string
要處理事件的取用者群組名稱。
- fullyQualifiedNamespace
-
string
可能類似於 .servicebus.windows.net 的完整命名空間
- eventHubName
-
string
要連接用戶端的特定事件中樞名稱。
- credential
用戶端用來取得令牌的認證物件，用來驗證與 Azure 事件中樞服務的連線。
請參閱@azure/身分識別，以建立支援 AAD 驗證的認證。如果您想要傳入 SharedAccessKeyName 和 SharedAccessKey 而不使用連接字串，請使用 @azure/core-auth 中的 AzureNamedKeyCredential。 這些欄位分別對應至 AzureNamedKeyCredential中的 [name] 和 [key] 字段。
如果您想要傳入 SharedAccessSignature 而不使用連接字串，請使用 @azure/core-auth 中的 AzureSASCredential。 此欄位會對應至 AzureSASCredential中的 signature。
- options
- EventHubConsumerClientOptions
設定用戶端時要套用的一組選項。
-
retryOptions：設定用戶端上所有作業的重試原則。 例如，{ "maxRetries": 4 }或{ "maxRetries": 4, "retryDelayInMs": 30000 }。 -
webSocketOptions：設定透過 Web 套接字的 AMQP 連線通道。 -
userAgent：要附加至傳遞至服務之內建使用者代理程式字串的字串。
屬性詳細資料
defaultConsumerGroupName
事件中樞服務中預設取用者群組的名稱。
static defaultConsumerGroupName: string屬性值
string
eventHubName
建立此用戶端的事件中樞實例名稱。
string eventHubName屬性值
string
fullyQualifiedNamespace
建立此用戶端之事件中樞實例的完整命名空間。 這可能類似於 .servicebus.windows.net。
string fullyQualifiedNamespace屬性值
string
identifier
用來識別此 EventHubConsumerClient 的名稱。 如果未指定或空白，則會產生隨機唯一的 。
identifier: string屬性值
string
方法詳細資料
close()
關閉事件中樞實例的AMQP連線，並傳回在中斷連線完成時將解決的承諾。
function close(): Promise<void>傳回
Promise<void>
承諾
getEventHubProperties(GetEventHubPropertiesOptions)
提供事件中樞運行時間資訊。
function getEventHubProperties(options?: GetEventHubPropertiesOptions): Promise<EventHubProperties>參數
- options
- GetEventHubPropertiesOptions
要套用至作業呼叫的選項集。
傳回
Promise<EventHubProperties>
可透過事件中樞實例相關信息解析的承諾。
getPartitionIds(GetPartitionIdsOptions)
提供與事件中樞相關聯的每個分割區標識碼。
function getPartitionIds(options?: GetPartitionIdsOptions): Promise<string[]>參數
- options
- GetPartitionIdsOptions
要套用至作業呼叫的選項集。
傳回
Promise<string[]>
承諾，會使用字串數位分析，代表與事件中樞相關聯之每個分割區的識別碼。
getPartitionProperties(string, GetPartitionPropertiesOptions)
提供指定數據分割狀態的相關信息。
function getPartitionProperties(partitionId: string, options?: GetPartitionPropertiesOptions): Promise<PartitionProperties>參數
- partitionId
-
string
需要資訊的分割區標識碼。
- options
- GetPartitionPropertiesOptions
要套用至作業呼叫的選項集。
傳回
Promise<PartitionProperties>
承諾，可解決數據分割狀態的相關信息。
subscribe(string, SubscriptionEventHandlers, SubscribeOptions)
訂閱單一分割區的事件。 在傳回的物件上呼叫 close（） 以停止接收事件。
範例用法：
const client = new EventHubConsumerClient(consumerGroup, connectionString, eventHubName);
const subscription = client.subscribe(
partitionId,
{
processEvents: (events, context) => { console.log("Received event count: ", events.length) },
processError: (err, context) => { console.log("Error: ", err) }
},
{ startPosition: earliestEventPosition }
);
function subscribe(partitionId: string, handlers: SubscriptionEventHandlers, options?: SubscribeOptions): Subscription參數
- partitionId
-
string
要訂閱之數據分割的標識碼。
- handlers
- SubscriptionEventHandlers
訂閱生命週期的處理程式 - 分割區的訂閱初始化、接收事件、處理錯誤，以及分割區訂閱的關閉。
- options
- SubscribeOptions
設定接收事件的方式。
最常見的是 maxBatchSize 和 maxWaitTimeInSeconds，控制提供給接收事件以及開始位置之處理程式的事件流程。 例如，{ maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }
傳回
subscribe(SubscriptionEventHandlers, SubscribeOptions)
訂閱來自所有分割區的事件。
如果檢查點存放區提供給 EventHubConsumerClient，而且您的應用程式有多個實例，則每個實例都會訂閱分割區的子集，讓負載在它們之間平衡。
在傳回的物件上呼叫 close（） 以停止接收事件。
範例用法：
const client = new EventHubConsumerClient(consumerGroup, connectionString, eventHubName);
const subscription = client.subscribe(
{
processEvents: (events, context) => { console.log("Received event count: ", events.length) },
processError: (err, context) => { console.log("Error: ", err) }
},
{ startPosition: earliestEventPosition }
);
function subscribe(handlers: SubscriptionEventHandlers, options?: SubscribeOptions): Subscription參數
- handlers
- SubscriptionEventHandlers
訂閱生命週期的處理程式 - 每個分割區的訂用帳戶初始化、接收事件、處理錯誤，以及每個分割區的訂閱關閉。
- options
- SubscribeOptions
設定接收事件的方式。
最常見的是 maxBatchSize 和 maxWaitTimeInSeconds，控制提供給接收事件以及開始位置之處理程式的事件流程。 例如，{ maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }