@azure/service-bus package

클래스

MessagingError	메시징 오류의 기본 클래스에 대해 설명합니다.
ServiceBusAdministrationClient	모든 작업은 관련 출력이 있는 개체로 확인되는 약속을 반환합니다. 이러한 개체에는 서비스에서 직접 응답에 액세스하려는 경우 사용할 수 있는 라는 _response 속성도 있습니다.
ServiceBusClient	큐 및 토픽에 메시지를 보내기 위한 보낸 사람 인스턴스와 큐 및 구독에서 메시지를 수신할 받는 사람 인스턴스를 만들 수 있는 클라이언트입니다.
ServiceBusError	Service Bus 내에서 발생하는 오류입니다.

인터페이스

AuthorizationRule	ATOM 기반 관리 작업의 형식 AuthorizationRule 을 나타냅니다.
CorrelationRuleFilter	상관 관계 필터 식을 나타냅니다. CorrelationRuleFilter는 구독에서 들어오는 메시지의 사용자 및 시스템 속성과 일치하는 조건 집합을 보유합니다.
CreateMessageBatchOptions	에서 메서드를 createBatch 구성하는 옵션입니다 Sender. maxSizeInBytes: 일괄 처리 크기에 대한 상한입니다. 예제 사용법: { maxSizeInBytes: 1024 * 1024 // 1 MB }
CreateQueueOptions	큐의 설정 가능한 옵션을 나타냅니다.
CreateSubscriptionOptions	구독의 설정 가능한 옵션을 나타냅니다.
CreateTopicOptions	토픽의 설정 가능한 옵션을 나타냅니다.
DeadLetterOptions	Service Bus에서 받은 메시지의 메서드를 사용하여 deadLetter() 메시지를 배달 못한 편지에 대한 이유와 오류 설명을 설명합니다.
Delivery
GetMessageIteratorOptions	Service Bus에서 반복 가능한 반복기를 가져오는 경우의 옵션입니다.
HttpHeader	HttpHeaders 컬렉션 내의 개별 헤더입니다.
HttpHeadersLike	HTTP 헤더 키/값 쌍의 컬렉션입니다.
HttpResponse	항상 존재하는 HTTP 응답의 속성입니다.
MessageHandlers	일반 메시지 처리기 인터페이스(streamMessages에 사용됨).
NamespaceProperties	Service Bus 네임스페이스에 관련된 메타데이터를 나타냅니다.
OperationOptions	모든 작업에 대한 기본 옵션 유형입니다.
PeekMessagesOptions	수신기의 메서드에 peekMessages 전달된 옵션에 대해 설명합니다.
ProcessErrorArgs	콜백에 대한 processError 인수입니다.
QueueProperties	updateQueue에 대한 입력을 나타냅니다.
QueueRuntimeProperties	큐 엔터티의 런타임 정보 특성을 나타냅니다.
ReceiveMessagesOptions	Service Bus에서 메시지 일괄 처리를 수신할 때의 옵션입니다.
RetryOptions	모드, 재시도 횟수, 재시도 간격 등을 결정하는 정책 옵션을 다시 시도합니다.
RuleProperties	규칙의 모든 특성을 나타냅니다.
ServiceBusAdministrationClientOptions	의 클라이언트 옵션을 ServiceBusAdministrationClient나타냅니다.
ServiceBusClientOptions	ServiceBusClient를 만드는 동안 제공할 수 있는 옵션에 대해 설명합니다. webSocketOptions : 웹 소켓을 통해 AMQP 연결의 채널링을 구성하는 옵션입니다. websocket : WebSocket을 통해 연결을 선택하는 경우 AMQP 연결을 만드는 데 사용되는 WebSocket 생성자입니다. webSocketConstructorOptions : WebSocket을 통해 연결을 선택할 때 Websocket 생성자에 전달하는 옵션입니다. retryOptions : 클라이언트의 모든 작업에 대한 재시도 옵션입니다. maxRetries : 다시 시도할 수 있는 오류가 발생할 경우 작업을 다시 시도할 수 있는 횟수입니다. maxRetryDelayInMs: 재시도 사이의 최대 지연 시간입니다. 지수 재시도를 수행하는 경우에만 적용됩니다. mode: 열거형으로 지정된 적용할 재시도 모드입니다 RetryMode . 옵션은 Exponential 및 Fixed입니다. 기본값은 Fixed입니다. retryDelayInMs: 다음을 시도하기 전에 대기하는 시간(밀리초)입니다. 가 로 Exponential설정되면 mode 재시도 사이에 기하급수적으로 증가하는 지연을 계산하는 데 사용됩니다. 기본값: 30000밀리초. timeoutInMs: 작업 시간이 초과되기 전에 대기할 시간(밀리초)입니다. 다시 시도 시도가 남아 있는 경우 다시 시도가 트리거됩니다. 최소값: 60000밀리초
ServiceBusConnectionStringProperties	Service Bus 연결 문자열을 구성하는 속성 집합입니다.
ServiceBusMessage	Service Bus로 보낼 메시지를 설명합니다.
ServiceBusMessageBatch	메서드를 사용하여 만들 수 있는 메시지의 일괄 처리입니다 <xref:createBatch> .
ServiceBusReceivedMessage	피킹 작업 중에 Service Bus에서 받은 메시지를 설명하므로 해결할 수 없습니다.
ServiceBusReceiver	세션을 처리하지 않는 수신기입니다.
ServiceBusReceiverOptions	수신기를 만들 때 사용할 옵션입니다.
ServiceBusRuleManager	구독에 대한 규칙을 관리할 수 있습니다. 이 규칙 관리자에는 Listen 클레임만 필요한 반면 ServiceBusAdministrationClient 에는 클레임 관리가 필요합니다.
ServiceBusSender	발신자는 메시지를 보내고, 나중에 보낼 메시지를 예약하고, 예약된 메시지를 취소하는 데 사용할 수 있습니다. createSender ServiceBusClient의 함수를 사용하여 발신자를 인스턴스화합니다. Sender 클래스는 기본 AMQP 보낸 사람 링크를 통해 추상화됩니다.
ServiceBusSenderOptions	발신자를 만들 때 사용할 옵션입니다.
ServiceBusSessionReceiver	세션 잠금 갱신을 포함하여 세션을 처리하는 수신기입니다.
ServiceBusSessionReceiverOptions	세션이 사용하도록 설정된 큐/구독을 acceptSession 사용할 때 및 acceptNextSession 메서드에 전달되는 옵션에 대해 설명합니다.
SqlRuleFilter	SqlRuleFilter에서 가능한 모든 필드를 나타냅니다.
SubscribeOptions	Service Bus 큐 또는 구독을 구독할 때 사용되는 옵션입니다.
SubscriptionProperties	updateSubscription에 대한 입력을 나타냅니다.
SubscriptionRuntimeProperties	구독 엔터티의 런타임 정보 특성을 나타냅니다.
TokenCredential	인증 토큰을 제공할 수 있는 자격 증명을 나타냅니다.
TopicProperties	updateTopic에 대한 입력을 나타냅니다.
TopicRuntimeProperties	토픽 엔터티의 런타임 정보 특성을 나타냅니다.
TryAddOptions	분산 추적을 위해 컨텍스트를 수동으로 전파 Span 하는 옵션 집합입니다.
WebResourceLike	원격 서버에 대한 HTTP 요청에 대한 설명입니다.
WebSocketImpl	WebSocket 생성자의 필수 셰이프를 설명합니다.
WebSocketOptions	웹 소켓을 통해 AMQP 연결의 채널링을 구성하는 옵션입니다.

형식 별칭

EntitiesResponse	반복을 시작할 도 포함하는 continuationToken 엔터티에 대한 목록 작업의 결과를 나타냅니다.
EntityAvailabilityStatus	Service Bus 메시징 엔터티의 가능한 값 availabilityStatus 입니다.
EntityStatus	Service Bus 메시징 엔터티의 가능한 값 status 입니다.
OperationOptionsBase	참고: 이 형식은 OperationOptions에서 @azure/core-client 관련 필드와 구조를 미러링하기 위한 것입니다. 추적 및 abortSignal을 구성하는 옵션입니다.
RawHttpHeaders	단순 JSON 개체로 표현되는 HttpHeaders 컬렉션입니다.
ServiceBusErrorCode	Service Bus 오류 코드.
SqlRuleAction	SqlRuleAction에서 가능한 모든 필드를 나타냅니다.
TransferProgressEvent	업로드 또는 다운로드 진행률에 대한 응답으로 발생합니다.
WithResponse	원시 응답과 함께 작업의 반환된 응답을 나타냅니다.

열거형

RetryMode	재시도 모드 유형에 대해 설명합니다.
TokenType	지원되는 토큰의 형식을 설명합니다.

함수

delay<T>(number, AbortSignalLike, string, T)	t 밀리초 후 약속을 확인하는 setTimeout에 대한 래퍼입니다.
isServiceBusError(unknown)	오류가 형식인지 확인합니다. ServiceBusError
parseServiceBusConnectionString(string)	지정된 연결 문자열을 Azure Service Bus 적용 가능한 다른 속성으로 구문 분석합니다. 속성은 ServiceBusClient를 생성하는 데 유용합니다.

함수 세부 정보

delay<T>(number, AbortSignalLike, string, T)

t 밀리초 후 약속을 확인하는 setTimeout에 대한 래퍼입니다.

function delay<T>(delayInMs: number, abortSignal?: AbortSignalLike, abortErrorMsg?: string, value?: T): Promise<T | void>

매개 변수

delayInMs

number

지연될 시간(밀리초)입니다.

abortSignal

AbortSignalLike

포함하는 작업과 연결된 abortSignal입니다.

abortErrorMsg

string

포함 작업과 관련된 중단 오류 메시지입니다.

value

T

시간 초과 후 확인할 값(밀리초)입니다.

반환

Promise<T | void>

• 해결된 약속

isServiceBusError(unknown)

오류가 형식인지 확인합니다. ServiceBusError

function isServiceBusError(err: unknown): err

매개 변수

err

unknown

ServiceBusError 유형인지 확인하는 오류

반환

err

parseServiceBusConnectionString(string)

지정된 연결 문자열을 Azure Service Bus 적용 가능한 다른 속성으로 구문 분석합니다. 속성은 ServiceBusClient를 생성하는 데 유용합니다.

function parseServiceBusConnectionString(connectionString: string): ServiceBusConnectionStringProperties

매개 변수

connectionString

string

Service Bus 네임스페이스, 큐 또는 토픽에 대해 만든 공유 액세스 정책과 연결된 연결 문자열입니다.

반환

ServiceBusConnectionStringProperties