EventHubConsumerClient class

  • 참조
패키지:
@azure/event-hubs

클래스는 EventHubConsumerClient 이벤트 허브의 이벤트를 사용하는 데 사용됩니다.

를 만드는 방법에는 여러 가지가 있습니다. EventHubConsumerClient

  • Event Hub instance 대해 만든 SAS 정책의 연결 문자열을 사용합니다.
  • Event Hub 네임스페이스에 대해 만든 SAS 정책의 연결 문자열과 Event Hub instance
  • 와 같은 <yournamespace>.servicebus.windows.net전체 네임스페이스 및 자격 증명 개체를 사용합니다.

필요에 따라 다음을 전달할 수도 있습니다.

  • 다시 시도 정책 또는 프록시 설정을 구성하는 옵션 모음입니다.
  • 클라이언트가 검사점을 읽고 애플리케이션이 다시 시작될 때 이벤트 수신을 다시 시작해야 하는 위치를 결정하는 데 사용되는 검사점 저장소입니다. 검사점 저장소는 클라이언트에서 애플리케이션의 여러 인스턴스 부하를 분산하는 데도 사용됩니다.

생성자

EventHubConsumerClient(string, string, CheckpointStore, EventHubConsumerClientOptions)

클래스는 EventHubConsumerClient 이벤트 허브에서 이벤트를 사용하는 데 사용됩니다. parmeter를 options 사용하여 재시도 정책 또는 프록시 설정을 구성합니다.
EventHubConsumerClient(string, string, EventHubConsumerClientOptions)

클래스는 EventHubConsumerClient 이벤트 허브에서 이벤트를 사용하는 데 사용됩니다. parmeter를 options 사용하여 재시도 정책 또는 프록시 설정을 구성합니다.
EventHubConsumerClient(string, string, string, CheckpointStore, EventHubConsumerClientOptions)

클래스는 EventHubConsumerClient 이벤트 허브의 이벤트를 사용하는 데 사용됩니다. parmeter를 options 사용하여 재시도 정책 또는 프록시 설정을 구성합니다.
EventHubConsumerClient(string, string, string, EventHubConsumerClientOptions)

클래스는 EventHubConsumerClient 이벤트 허브의 이벤트를 사용하는 데 사용됩니다. parmeter를 options 사용하여 재시도 정책 또는 프록시 설정을 구성합니다.
EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, CheckpointStore, EventHubConsumerClientOptions)

클래스는 EventHubConsumerClient 이벤트 허브의 이벤트를 사용하는 데 사용됩니다. parmeter를 options 사용하여 재시도 정책 또는 프록시 설정을 구성합니다.
EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, EventHubConsumerClientOptions)

클래스는 EventHubConsumerClient 이벤트 허브의 이벤트를 사용하는 데 사용됩니다. parmeter를 options 사용하여 재시도 정책 또는 프록시 설정을 구성합니다.

속성

defaultConsumerGroupName

Event Hubs 서비스의 기본 소비자 그룹의 이름입니다.
eventHubName

이 클라이언트가 만들어지는 이벤트 허브 instance 이름입니다.
fullyQualifiedNamespace

이 클라이언트가 만들어지는 Event Hub instance 정규화된 네임스페이스입니다. 이는 .servicebus.windows.net 유사할 수 있습니다.
identifier

이 EventHubConsumerClient를 식별하는 데 사용되는 이름입니다. 지정하지 않았거나 비어 있으면 임의의 고유 항목이 생성됩니다.

메서드

close()

이벤트 허브 instance 대한 AMQP 연결을 닫고 연결 끊김이 완료되면 해결될 프라미스를 반환합니다.
getEventHubProperties(GetEventHubPropertiesOptions)

이벤트 허브 런타임 정보를 제공합니다.
getPartitionIds(GetPartitionIdsOptions)

이벤트 허브와 연결된 각 파티션에 대한 ID를 제공합니다.
getPartitionProperties(string, GetPartitionPropertiesOptions)

지정된 파티션의 상태에 대한 정보를 제공합니다.
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 }
);
subscribe(SubscriptionEventHandlers, SubscribeOptions)

모든 파티션의 이벤트를 구독합니다.

검사점 저장소가 에 EventHubConsumerClient 제공되고 애플리케이션의 여러 인스턴스가 있는 경우 각 instance 파티션의 하위 집합을 구독하여 부하가 분산되도록 합니다.

반환된 개체에서 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 }
);

생성자 세부 정보

EventHubConsumerClient(string, string, CheckpointStore, EventHubConsumerClientOptions)

클래스는 EventHubConsumerClient 이벤트 허브에서 이벤트를 사용하는 데 사용됩니다. parmeter를 options 사용하여 재시도 정책 또는 프록시 설정을 구성합니다.

new EventHubConsumerClient(consumerGroup: string, connectionString: string, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)

매개 변수

consumerGroup

string

이벤트를 처리할 소비자 그룹의 이름입니다.

connectionString

string

Event Hub instance 연결하는 데 사용할 연결 문자열입니다. 공유 키 속성과 이벤트 허브 경로가 이 연결 문자열에 포함되어야 합니다. 예: '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: 웹 소켓을 통해 AMQP 연결의 채널링을 구성합니다.
  • userAgent : 서비스에 전달되는 기본 제공 사용자 에이전트 문자열에 추가할 문자열입니다.

EventHubConsumerClient(string, string, EventHubConsumerClientOptions)

클래스는 EventHubConsumerClient 이벤트 허브에서 이벤트를 사용하는 데 사용됩니다. parmeter를 options 사용하여 재시도 정책 또는 프록시 설정을 구성합니다.

new EventHubConsumerClient(consumerGroup: string, connectionString: string, options?: EventHubConsumerClientOptions)

매개 변수

consumerGroup

string

이벤트를 처리할 소비자 그룹의 이름입니다.

connectionString

string

Event Hub instance 연결하는 데 사용할 연결 문자열입니다. 공유 키 속성과 이벤트 허브 경로가 이 연결 문자열에 포함되어야 합니다. 예: '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: 웹 소켓을 통해 AMQP 연결의 채널링을 구성합니다.
  • userAgent : 서비스에 전달되는 기본 제공 사용자 에이전트 문자열에 추가할 문자열입니다.

EventHubConsumerClient(string, string, string, CheckpointStore, EventHubConsumerClientOptions)

클래스는 EventHubConsumerClient 이벤트 허브의 이벤트를 사용하는 데 사용됩니다. parmeter를 options 사용하여 재시도 정책 또는 프록시 설정을 구성합니다.

new EventHubConsumerClient(consumerGroup: string, connectionString: string, eventHubName: string, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)

매개 변수

consumerGroup

string

이벤트를 처리할 소비자 그룹의 이름입니다.

connectionString

string

Event Hubs 네임스페이스에 연결하는 데 사용할 연결 문자열입니다. 공유 키 속성은 이 연결 문자열에 포함되지만 이벤트 허브 경로에는 포함되지 않을 것으로 예상됩니다(예: '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: 웹 소켓을 통해 AMQP 연결의 채널링을 구성합니다.
  • userAgent : 서비스에 전달되는 기본 제공 사용자 에이전트 문자열에 추가할 문자열입니다.

EventHubConsumerClient(string, string, string, EventHubConsumerClientOptions)

클래스는 EventHubConsumerClient 이벤트 허브의 이벤트를 사용하는 데 사용됩니다. parmeter를 options 사용하여 재시도 정책 또는 프록시 설정을 구성합니다.

new EventHubConsumerClient(consumerGroup: string, connectionString: string, eventHubName: string, options?: EventHubConsumerClientOptions)

매개 변수

consumerGroup

string

이벤트를 처리할 소비자 그룹의 이름입니다.

connectionString

string

Event Hubs 네임스페이스에 연결하는 데 사용할 연결 문자열입니다. 공유 키 속성은 이 연결 문자열에 포함되지만 이벤트 허브 경로에는 포함되지 않을 것으로 예상됩니다(예: '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: 웹 소켓을 통해 AMQP 연결의 채널링을 구성합니다.
  • userAgent : 서비스에 전달되는 기본 제공 사용자 에이전트 문자열에 추가할 문자열입니다.

EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, CheckpointStore, EventHubConsumerClientOptions)

클래스는 EventHubConsumerClient 이벤트 허브의 이벤트를 사용하는 데 사용됩니다. parmeter를 options 사용하여 재시도 정책 또는 프록시 설정을 구성합니다.

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

TokenCredential | NamedKeyCredential | SASCredential

클라이언트가 토큰을 가져와 Azure Event Hubs 서비스와의 연결을 인증하는 데 사용하는 자격 증명 개체입니다. AAD 인증을 지원하는 자격 증명을 만들려면 @azure/ID를 참조하세요. 연결 문자열을 AzureNamedKeyCredential 사용하지 않고 를 전달 SharedAccessKeyNameSharedAccessKey 하려는 경우 @azure/core-auth에서 를 사용합니다. 이러한 필드는 의 및 key 필드에 각각 매핑 name 됩니다AzureNamedKeyCredential. 연결 문자열을 AzureSASCredential 사용하지 않고 를 전달 SharedAccessSignature 하려는 경우 @azure/core-auth에서 를 사용합니다. 이 필드는 의 에 signature 매핑됩니다 AzureSASCredential.

checkpointStore
CheckpointStore

클라이언트가 검사점을 읽고 애플리케이션이 다시 시작될 때 이벤트 수신을 다시 시작해야 하는 위치를 결정하는 데 사용되는 검사점 저장소입니다. 클라이언트에서 애플리케이션의 여러 인스턴스 부하를 분산하는 데도 사용됩니다.

options
EventHubConsumerClientOptions

클라이언트를 구성할 때 적용할 옵션 집합입니다.

  • retryOptions : 클라이언트의 모든 작업에 대한 재시도 정책을 구성합니다. 예를 들어 { "maxRetries": 4 } 또는 { "maxRetries": 4, "retryDelayInMs": 30000 }입니다.
  • webSocketOptions: 웹 소켓을 통해 AMQP 연결의 채널링을 구성합니다.
  • userAgent : 서비스에 전달되는 기본 제공 사용자 에이전트 문자열에 추가할 문자열입니다.

EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, EventHubConsumerClientOptions)

클래스는 EventHubConsumerClient 이벤트 허브의 이벤트를 사용하는 데 사용됩니다. parmeter를 options 사용하여 재시도 정책 또는 프록시 설정을 구성합니다.

new EventHubConsumerClient(consumerGroup: string, fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential | NamedKeyCredential | SASCredential, options?: EventHubConsumerClientOptions)

매개 변수

consumerGroup

string

이벤트를 처리할 소비자 그룹의 이름입니다.

fullyQualifiedNamespace

string

.servicebus.windows.net 유사할 수 있는 전체 네임스페이스입니다.

eventHubName

string

클라이언트를 연결할 특정 이벤트 허브의 이름입니다.

credential

TokenCredential | NamedKeyCredential | SASCredential

클라이언트가 토큰을 가져와 Azure Event Hubs 서비스와의 연결을 인증하는 데 사용하는 자격 증명 개체입니다. AAD 인증을 지원하는 자격 증명을 만들려면 @azure/ID를 참조하세요. 연결 문자열을 AzureNamedKeyCredential 사용하지 않고 를 전달 SharedAccessKeyNameSharedAccessKey 하려는 경우 @azure/core-auth에서 를 사용합니다. 이러한 필드는 의 및 key 필드에 각각 매핑 name 됩니다AzureNamedKeyCredential. 연결 문자열을 AzureSASCredential 사용하지 않고 를 전달 SharedAccessSignature 하려는 경우 @azure/core-auth에서 를 사용합니다. 이 필드는 의 에 signature 매핑됩니다 AzureSASCredential.

options
EventHubConsumerClientOptions

클라이언트를 구성할 때 적용할 옵션 집합입니다.

  • retryOptions : 클라이언트의 모든 작업에 대한 재시도 정책을 구성합니다. 예를 들어 { "maxRetries": 4 } 또는 { "maxRetries": 4, "retryDelayInMs": 30000 }입니다.
  • webSocketOptions: 웹 소켓을 통해 AMQP 연결의 채널링을 구성합니다.
  • userAgent : 서비스에 전달되는 기본 제공 사용자 에이전트 문자열에 추가할 문자열입니다.

속성 세부 정보

defaultConsumerGroupName

Event Hubs 서비스의 기본 소비자 그룹의 이름입니다.

static defaultConsumerGroupName: string

속성 값

string

eventHubName

이 클라이언트가 만들어지는 이벤트 허브 instance 이름입니다.

string eventHubName

속성 값

string

fullyQualifiedNamespace

이 클라이언트가 만들어지는 Event Hub instance 정규화된 네임스페이스입니다. 이는 .servicebus.windows.net 유사할 수 있습니다.

string fullyQualifiedNamespace

속성 값

string

identifier

이 EventHubConsumerClient를 식별하는 데 사용되는 이름입니다. 지정하지 않았거나 비어 있으면 임의의 고유 항목이 생성됩니다.

identifier: string

속성 값

string

메서드 세부 정보

close()

이벤트 허브 instance 대한 AMQP 연결을 닫고 연결 끊김이 완료되면 해결될 프라미스를 반환합니다.

function close(): Promise<void>

반환

Promise<void>

Promise

getEventHubProperties(GetEventHubPropertiesOptions)

이벤트 허브 런타임 정보를 제공합니다.

function getEventHubProperties(options?: GetEventHubPropertiesOptions): Promise<EventHubProperties>

매개 변수

options
GetEventHubPropertiesOptions

작업 호출에 적용할 옵션 집합입니다.

반환

Promise<EventHubProperties>

Event Hub instance 대한 정보로 해결되는 약속입니다.

getPartitionIds(GetPartitionIdsOptions)

이벤트 허브와 연결된 각 파티션에 대한 ID를 제공합니다.

function getPartitionIds(options?: GetPartitionIdsOptions): Promise<string[]>

매개 변수

options
GetPartitionIdsOptions

작업 호출에 적용할 옵션 집합입니다.

반환

Promise<string[]>

이벤트 허브와 연결된 각 파티션의 ID를 나타내는 문자열 배열로 확인되는 프라미스입니다.

getPartitionProperties(string, GetPartitionPropertiesOptions)

지정된 파티션의 상태에 대한 정보를 제공합니다.

function getPartitionProperties(partitionId: string, options?: GetPartitionPropertiesOptions): Promise<PartitionProperties>

매개 변수

partitionId

string

정보가 필요한 파티션의 ID입니다.

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

구독할 파티션의 ID입니다.

handlers
SubscriptionEventHandlers

구독 수명 주기에 대한 처리기 - 파티션의 구독 초기화, 이벤트 수신, 오류 처리 및 파티션에 대한 구독 닫기.

options
SubscribeOptions

이벤트를 수신하는 방법을 구성합니다. 가장 일반적인 것은 maxBatchSize 및 maxWaitTimeInSeconds 는 이벤트 수신에 제공된 처리기에 대한 이벤트 흐름과 시작 위치를 제어하는 것입니다. 예를 들어 { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }

반환

Subscription

subscribe(SubscriptionEventHandlers, SubscribeOptions)

모든 파티션의 이벤트를 구독합니다.

검사점 저장소가 에 EventHubConsumerClient 제공되고 애플리케이션의 여러 인스턴스가 있는 경우 각 instance 파티션의 하위 집합을 구독하여 부하가 분산되도록 합니다.

반환된 개체에서 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 } }

반환

Subscription