EventHubConsumerClientOptions interface

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

EventHubConsumerClient를 만드는 동안 제공할 수 있는 옵션에 대해 설명합니다.

  • loadBalancingOptions: EventHubConsumerClient 클레임이 파티션되는 방식을 조정하는 옵션입니다.
  • userAgent : 서비스에 대한 연결 속성으로 전달되는 기본 제공 사용자 에이전트 문자열에 추가할 문자열입니다.
  • webSocketOptions : 웹 소켓을 통해 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
    }
}
Extends
EventHubClientOptions

속성

loadBalancingOptions

EventHubConsumerClient 클레임 파티션을 조정하는 옵션입니다.

상속된 속성

customEndpointAddress

Event Hubs 서비스에 연결할 때 사용할 사용자 지정 엔드포인트입니다. 이 기능은 네트워크에서 표준 Azure Event Hubs 엔드포인트 주소에 대한 연결을 허용하지 않지만 중간자를 통한 연결을 허용하는 경우에 유용할 수 있습니다.

예: "https://my.custom.endpoint:100/"
identifier

클라이언트를 식별하는 데 사용되는 고유한 이름입니다. 제공되지 않으면 GUID가 식별자로 사용됩니다.
retryOptions

클라이언트의 모든 작업에 대한 재시도 정책을 구성하는 옵션입니다. 예를 들어 { "maxRetries": 4 } 또는 { "maxRetries": 4, "retryDelayInMs": 30000 }입니다.
userAgent

Event Hubs 서비스에 전달되는 기본 제공 사용자 에이전트 문자열에 추가되는 값입니다.
webSocketOptions

웹 소켓을 통해 AMQP 연결의 채널링을 구성하는 옵션입니다.

속성 세부 정보

loadBalancingOptions

EventHubConsumerClient 클레임 파티션을 조정하는 옵션입니다.

loadBalancingOptions?: LoadBalancingOptions

속성 값

LoadBalancingOptions

상속된 속성 세부 정보

customEndpointAddress

Event Hubs 서비스에 연결할 때 사용할 사용자 지정 엔드포인트입니다. 이 기능은 네트워크에서 표준 Azure Event Hubs 엔드포인트 주소에 대한 연결을 허용하지 않지만 중간자를 통한 연결을 허용하는 경우에 유용할 수 있습니다.

예: "https://my.custom.endpoint:100/"

customEndpointAddress?: string

속성 값

string

EventHubClientOptions.customEndpointAddress에서 상속됨

identifier

클라이언트를 식별하는 데 사용되는 고유한 이름입니다. 제공되지 않으면 GUID가 식별자로 사용됩니다.

identifier?: string

속성 값

string

EventHubClientOptions.identifier에서 상속됨

retryOptions

클라이언트의 모든 작업에 대한 재시도 정책을 구성하는 옵션입니다. 예를 들어 { "maxRetries": 4 } 또는 { "maxRetries": 4, "retryDelayInMs": 30000 }입니다.

retryOptions?: RetryOptions

속성 값

RetryOptions

EventHubClientOptions.retryOptions에서 상속됨

userAgent

Event Hubs 서비스에 전달되는 기본 제공 사용자 에이전트 문자열에 추가되는 값입니다.

userAgent?: string

속성 값

string

EventHubClientOptions.userAgent에서 상속됨

webSocketOptions

웹 소켓을 통해 AMQP 연결의 채널링을 구성하는 옵션입니다.

webSocketOptions?: WebSocketOptions

속성 값

WebSocketOptions

EventHubClientOptions.webSocketOptions에서 상속됨