ServiceBusClient class

패키지:

@azure/service-bus

큐 및 토픽에 메시지를 보내기 위한 보낸 사람 인스턴스와 큐 및 구독에서 메시지를 수신할 받는 사람 인스턴스를 만들 수 있는 클라이언트입니다.

생성자

ServiceBusClient(string, ServiceBusClientOptions)	연결 문자열에 제공된 Azure Service Bus 네임스페이스에 보낸 사람 및 수신기를 만드는 데 사용할 수 있는 ServiceBusClient 클래스의 인스턴스를 만듭니다. 클라이언트로 만든 보낸 사람/수신자가 메시지를 보내고 받는 데 사용될 때까지 서비스에 연결되지 않습니다.
ServiceBusClient(string, TokenCredential | NamedKeyCredential | SASCredential, ServiceBusClientOptions)	제공된 Azure Service Bus 네임스페이스에 보낸 사람 및 수신기를 만드는 데 사용할 수 있는 ServiceBusClient 클래스의 인스턴스를 만듭니다. 클라이언트로 만든 보낸 사람/수신자가 메시지를 보내고 받는 데 사용될 때까지 서비스에 연결되지 않습니다.

속성

fullyQualifiedNamespace	이 클라이언트가 만들어지는 Service Bus 인스턴스의 정규화된 네임스페이스입니다. 이는 .servicebus.windows.net 유사할 수 있습니다.
identifier	이 ServiceBusClient를 식별하는 데 사용되는 이름입니다. 지정하지 않았거나 비어 있으면 임의의 고유 항목이 생성됩니다.

메서드

acceptNextSession(string, ServiceBusSessionReceiverOptions)	세션 사용 Azure Service Bus 큐에서 사용 가능한 다음 세션에 대한 수신기를 만듭니다. "peekLock"(기본값) 및 "receiveAndDelete"의 두 가지 수신 모드 중에서 선택할 수 있습니다. peekLock 모드에서 수신자가 큐에 지정된 기간 동안 메시지를 잠급니다. receiveAndDelete 모드에서는 메시지가 수신될 때 Service Bus에서 삭제됩니다. 수신기에서 completeMessage(), abandonMessage(), deferMessage() 또는 deadletterMessage() 메서드를 호출하여 메시지를 해결할 수 있습니다. peekLock 및 메시지 결제가 작동하는 방법에 대한 자세한 내용은 여기를 참조하세요. https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptNextSession(string, string, ServiceBusSessionReceiverOptions)	세션 사용 Azure Service Bus 구독에서 사용 가능한 다음 세션에 대한 수신기를 만듭니다. "peekLock"(기본값) 및 "receiveAndDelete"의 두 가지 수신 모드 중에서 선택할 수 있습니다. peekLock 모드에서 수신자가 큐에 지정된 기간 동안 메시지를 잠급니다. receiveAndDelete 모드에서는 메시지가 수신될 때 Service Bus에서 삭제됩니다. 수신기에서 completeMessage(), abandonMessage(), deferMessage() 또는 deadletterMessage() 메서드를 호출하여 메시지를 해결할 수 있습니다. peekLock 및 메시지 결제가 작동하는 방법에 대한 자세한 내용은 여기를 참조하세요. https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptSession(string, string, ServiceBusSessionReceiverOptions)	세션 사용 Azure Service Bus 큐에 대한 수신기를 만듭니다. "peekLock"(기본값) 및 "receiveAndDelete"의 두 가지 수신 모드 중에서 선택할 수 있습니다. peekLock 모드에서 수신자가 큐에 지정된 기간 동안 메시지를 잠급니다. receiveAndDelete 모드에서는 메시지가 수신될 때 Service Bus에서 삭제됩니다. 수신기에서 completeMessage(), abandonMessage(), deferMessage() 또는 deadletterMessage() 메서드를 호출하여 메시지를 해결할 수 있습니다. peekLock 및 메시지 결제가 작동하는 방법에 대한 자세한 내용은 여기를 참조하세요. https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
acceptSession(string, string, string, ServiceBusSessionReceiverOptions)	세션 사용 Azure Service Bus 구독에 대한 수신기를 만듭니다. "peekLock"(기본값) 및 "receiveAndDelete"의 두 가지 수신 모드 중에서 선택할 수 있습니다. peekLock 모드에서 수신자가 큐에 지정된 기간 동안 메시지를 잠급니다. receiveAndDelete 모드에서는 메시지가 수신될 때 Service Bus에서 삭제됩니다. 수신기에서 completeMessage(), abandonMessage(), deferMessage() 또는 deadletterMessage() 메서드를 호출하여 메시지를 해결할 수 있습니다. peekLock 및 메시지 결제가 작동하는 방법에 대한 자세한 내용은 여기를 참조하세요. https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
close()	기본 AMQP 연결을 닫습니다. 참고: 이 인스턴스에서 만든 받는 사람 또는 보낸 사람 인스턴스의 연결이 끊어집니다.
createReceiver(string, ServiceBusReceiverOptions)	Azure Service Bus 큐에 대한 수신기를 만듭니다. 수신기의 메서드 중 하나가 호출될 때까지 서비스에 연결되지 않습니다. 배달 못한 편지 큐 또는 전송 배달 못한 편지 큐와 같은 하위 큐를 대상으로 하려면 옵션에 를 subQueue 제공합니다. 배달 못한 편지 큐에 대한 자세한 내용은 https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues "peekLock"(기본값) 및 "receiveAndDelete"의 두 가지 수신 모드 중에서 선택할 수 있습니다. peekLock 모드에서 수신자가 큐에 지정된 기간 동안 메시지를 잠급니다. receiveAndDelete 모드에서는 메시지가 수신될 때 Service Bus에서 삭제됩니다. 잠금 기간 내에 해결되지 않은 메시지는 큐에 설정된 최대 배달 횟수만큼 여러 번 다시 배달되며, 그 후에는 별도의 배달 못 한 편지 큐로 전송됩니다. 수신기에서 completeMessage(), abandonMessage(), deferMessage() 또는 deadletterMessage() 메서드를 호출하여 메시지를 해결할 수 있습니다. peekLock 및 메시지 결제가 작동하는 방법에 대한 자세한 내용은 여기를 참조하세요. https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
createReceiver(string, string, ServiceBusReceiverOptions)	Azure Service Bus 구독에 대한 수신기를 만듭니다. 수신기의 메서드 중 하나가 호출될 때까지 서비스에 연결되지 않습니다. 배달 못한 편지 큐 또는 전송 배달 못한 편지 큐와 같은 하위 큐를 대상으로 하려면 옵션에 를 subQueue 제공합니다. 배달 못한 편지 큐에 대한 자세한 내용은 https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues "peekLock"(기본값) 및 "receiveAndDelete"의 두 가지 수신 모드 중에서 선택할 수 있습니다. peekLock 모드에서 수신자가 큐에 지정된 기간 동안 메시지를 잠급니다. receiveAndDelete 모드에서는 메시지가 수신될 때 Service Bus에서 삭제됩니다. 잠금 기간 내에 정해지지 않은 메시지는 구독에 설정된 최대 배달 횟수만큼 여러 번 다시 배달되며, 그 후에는 별도의 배달 못 한 편지 큐로 전송됩니다. 수신기에서 completeMessage(), abandonMessage(), deferMessage() 또는 deadletterMessage() 메서드를 호출하여 메시지를 해결할 수 있습니다. peekLock 및 메시지 결제가 작동하는 방법에 대한 자세한 내용은 여기를 참조하세요. https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
createRuleManager(string, string)	구독에 대한 규칙을 관리하는 데 사용되는 ServiceBusRuleManager 인스턴스를 만듭니다.
createSender(string, ServiceBusSenderOptions)	메시지를 보내고, 나중에 보낼 메시지를 예약하고, 예약된 메시지를 취소하는 데 사용할 수 있는 발신자를 만듭니다. 보낸 사람의 메서드 중 하나가 호출될 때까지 서비스에 연결되지 않습니다.

생성자 세부 정보

ServiceBusClient(string, ServiceBusClientOptions)

연결 문자열에 제공된 Azure Service Bus 네임스페이스에 보낸 사람 및 수신기를 만드는 데 사용할 수 있는 ServiceBusClient 클래스의 인스턴스를 만듭니다. 클라이언트로 만든 보낸 사람/수신자가 메시지를 보내고 받는 데 사용될 때까지 서비스에 연결되지 않습니다.

new ServiceBusClient(connectionString: string, options?: ServiceBusClientOptions)

매개 변수

connectionString

string

Azure Service Bus 네임스페이스에 대한 연결 문자열입니다. 참고: 이 연결 문자열에는 무시되는 EntityPath가 포함될 수 있습니다.

options

ServiceBusClientOptions

Service Bus 클라이언트에 대한 옵션입니다.

ServiceBusClient(string, TokenCredential | NamedKeyCredential | SASCredential, ServiceBusClientOptions)

제공된 Azure Service Bus 네임스페이스에 보낸 사람 및 수신기를 만드는 데 사용할 수 있는 ServiceBusClient 클래스의 인스턴스를 만듭니다. 클라이언트로 만든 보낸 사람/수신자가 메시지를 보내고 받는 데 사용될 때까지 서비스에 연결되지 않습니다.

new ServiceBusClient(fullyQualifiedNamespace: string, credential: TokenCredential | NamedKeyCredential | SASCredential, options?: ServiceBusClientOptions)

매개 변수

fullyQualifiedNamespace

string

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

credential

TokenCredential | NamedKeyCredential | SASCredential

클라이언트가 토큰을 가져와 Azure Service Bus 연결을 인증하는 데 사용하는 자격 증명 개체입니다. 자격 증명을 만들려면 @azure/ID를 참조하세요. AAD에 대한 인터페이스의 고유한 구현을 사용하는 경우 service-bus에 TokenCredential 대한 "범위"를 로 설정하여 ["https://servicebus.azure.net//user_impersonation"] 적절한 토큰을 가져옵니다. 연결 문자열을 AzureNamedKeyCredential 사용하지 않고 및 을 전달 SharedAccessKeyNameSharedAccessKey 하려는 경우 @azure/core-auth의 를 사용합니다. 이러한 필드는 의 및 key 필드에 각각 매핑 name 됩니다AzureNamedKeyCredential. 연결 문자열을 사용하지 않고 을 AzureSASCredential 전달하려는 경우 @azure/core-auth에서 SharedAccessSignature 를 사용합니다. 이 필드는 에 매핑됩니다 signatureAzureSASCredential.

options

ServiceBusClientOptions

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

• retryOptions : 클라이언트의 모든 작업에 대한 재시도 정책을 구성합니다. 예를 들어 { "maxRetries": 4 } 또는 { "maxRetries": 4, "retryDelayInMs": 30000 }입니다.
• webSocketOptions: 웹 소켓을 통해 AMQP 연결의 채널링을 구성합니다.

속성 세부 정보

fullyQualifiedNamespace

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

fullyQualifiedNamespace: string

속성 값

string

identifier

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

identifier: string

속성 값

string

메서드 세부 정보

acceptNextSession(string, ServiceBusSessionReceiverOptions)

세션 사용 Azure Service Bus 큐에서 사용 가능한 다음 세션에 대한 수신기를 만듭니다.

"peekLock"(기본값) 및 "receiveAndDelete"의 두 가지 수신 모드 중에서 선택할 수 있습니다.

• peekLock 모드에서 수신자가 큐에 지정된 기간 동안 메시지를 잠급니다.
• receiveAndDelete 모드에서는 메시지가 수신될 때 Service Bus에서 삭제됩니다.

수신기에서 completeMessage(), abandonMessage(), deferMessage() 또는 deadletterMessage() 메서드를 호출하여 메시지를 해결할 수 있습니다.

peekLock 및 메시지 결제가 작동하는 방법에 대한 자세한 내용은 여기를 참조하세요. https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function acceptNextSession(queueName: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>

매개 변수

queueName

string

받을 큐의 이름입니다.

options

ServiceBusSessionReceiverOptions

옵션에는 receiveMode(peekLock으로 기본값), 세션 수신기를 만드는 옵션이 포함됩니다.

반환

Promise<ServiceBusSessionReceiver>

메시지를 수신, 피킹 및 정정하는 데 사용할 수 있는 수신기입니다.

acceptNextSession(string, string, ServiceBusSessionReceiverOptions)

세션 사용 Azure Service Bus 구독에서 사용 가능한 다음 세션에 대한 수신기를 만듭니다.

"peekLock"(기본값) 및 "receiveAndDelete"의 두 가지 수신 모드 중에서 선택할 수 있습니다.

• peekLock 모드에서 수신자가 큐에 지정된 기간 동안 메시지를 잠급니다.
• receiveAndDelete 모드에서는 메시지가 수신될 때 Service Bus에서 삭제됩니다.

수신기에서 completeMessage(), abandonMessage(), deferMessage() 또는 deadletterMessage() 메서드를 호출하여 메시지를 해결할 수 있습니다.

peekLock 및 메시지 결제가 작동하는 방법에 대한 자세한 내용은 여기를 참조하세요. https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function acceptNextSession(topicName: string, subscriptionName: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>

매개 변수

topicName

string

수신하려는 구독에 대한 토픽의 이름입니다.

subscriptionName

string

수신하려는 구독의 이름(아래 topic)입니다.

options

ServiceBusSessionReceiverOptions

옵션에는 receiveMode(peekLock으로 기본값), 세션 수신기를 만드는 옵션이 포함됩니다.

반환

Promise<ServiceBusSessionReceiver>

메시지를 수신, 피킹 및 정정하는 데 사용할 수 있는 수신기입니다.

acceptSession(string, string, ServiceBusSessionReceiverOptions)

세션 사용 Azure Service Bus 큐에 대한 수신기를 만듭니다.

"peekLock"(기본값) 및 "receiveAndDelete"의 두 가지 수신 모드 중에서 선택할 수 있습니다.

• peekLock 모드에서 수신자가 큐에 지정된 기간 동안 메시지를 잠급니다.
• receiveAndDelete 모드에서는 메시지가 수신될 때 Service Bus에서 삭제됩니다.

수신기에서 completeMessage(), abandonMessage(), deferMessage() 또는 deadletterMessage() 메서드를 호출하여 메시지를 해결할 수 있습니다.

peekLock 및 메시지 결제가 작동하는 방법에 대한 자세한 내용은 여기를 참조하세요. https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function acceptSession(queueName: string, sessionId: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>

매개 변수

queueName

string

받을 큐의 이름입니다.

sessionId

string

메시지를 수신해야 하는 세션의 ID입니다.

options

ServiceBusSessionReceiverOptions

옵션에는 receiveMode(peekLock으로 기본값), 세션 수신기를 만드는 옵션이 포함됩니다.

반환

Promise<ServiceBusSessionReceiver>

메시지를 수신, 피킹 및 정정하는 데 사용할 수 있는 수신기입니다.

acceptSession(string, string, string, ServiceBusSessionReceiverOptions)

세션 사용 Azure Service Bus 구독에 대한 수신기를 만듭니다.

"peekLock"(기본값) 및 "receiveAndDelete"의 두 가지 수신 모드 중에서 선택할 수 있습니다.

• peekLock 모드에서 수신자가 큐에 지정된 기간 동안 메시지를 잠급니다.
• receiveAndDelete 모드에서는 메시지가 수신될 때 Service Bus에서 삭제됩니다.

수신기에서 completeMessage(), abandonMessage(), deferMessage() 또는 deadletterMessage() 메서드를 호출하여 메시지를 해결할 수 있습니다.

peekLock 및 메시지 결제가 작동하는 방법에 대한 자세한 내용은 여기를 참조하세요. https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function acceptSession(topicName: string, subscriptionName: string, sessionId: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>

매개 변수

topicName

string

수신하려는 구독에 대한 토픽의 이름입니다.

subscriptionName

string

수신하려는 구독의 이름(아래 topic)입니다.

sessionId

string

메시지를 수신해야 하는 세션의 ID입니다.

options

ServiceBusSessionReceiverOptions

옵션에는 receiveMode(peekLock으로 기본값), 세션 수신기를 만드는 옵션이 포함됩니다.

반환

Promise<ServiceBusSessionReceiver>

메시지를 수신, 피킹 및 정정하는 데 사용할 수 있는 수신기입니다.

close()

기본 AMQP 연결을 닫습니다. 참고: 이 인스턴스에서 만든 받는 사람 또는 보낸 사람 인스턴스의 연결이 끊어집니다.

function close(): Promise<void>

반환

Promise<void>

createReceiver(string, ServiceBusReceiverOptions)

Azure Service Bus 큐에 대한 수신기를 만듭니다. 수신기의 메서드 중 하나가 호출될 때까지 서비스에 연결되지 않습니다.

배달 못한 편지 큐 또는 전송 배달 못한 편지 큐와 같은 하위 큐를 대상으로 하려면 옵션에 를 subQueue 제공합니다. 배달 못한 편지 큐에 대한 자세한 내용은 https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

"peekLock"(기본값) 및 "receiveAndDelete"의 두 가지 수신 모드 중에서 선택할 수 있습니다.

• peekLock 모드에서 수신자가 큐에 지정된 기간 동안 메시지를 잠급니다.
• receiveAndDelete 모드에서는 메시지가 수신될 때 Service Bus에서 삭제됩니다.

잠금 기간 내에 해결되지 않은 메시지는 큐에 설정된 최대 배달 횟수만큼 여러 번 다시 배달되며, 그 후에는 별도의 배달 못 한 편지 큐로 전송됩니다.

수신기에서 completeMessage(), abandonMessage(), deferMessage() 또는 deadletterMessage() 메서드를 호출하여 메시지를 해결할 수 있습니다.

peekLock 및 메시지 결제가 작동하는 방법에 대한 자세한 내용은 여기를 참조하세요. https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function createReceiver(queueName: string, options?: ServiceBusReceiverOptions): ServiceBusReceiver

매개 변수

queueName

string

받을 큐의 이름입니다.

options

ServiceBusReceiverOptions

receiveMode를 전달하는 옵션이며, 기본값은 peekLock입니다.

반환

ServiceBusReceiver

메시지를 수신, 피킹 및 정정하는 데 사용할 수 있는 수신기입니다.

createReceiver(string, string, ServiceBusReceiverOptions)

Azure Service Bus 구독에 대한 수신기를 만듭니다. 수신기의 메서드 중 하나가 호출될 때까지 서비스에 연결되지 않습니다.

배달 못한 편지 큐 또는 전송 배달 못한 편지 큐와 같은 하위 큐를 대상으로 하려면 옵션에 를 subQueue 제공합니다. 배달 못한 편지 큐에 대한 자세한 내용은 https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

"peekLock"(기본값) 및 "receiveAndDelete"의 두 가지 수신 모드 중에서 선택할 수 있습니다.

• peekLock 모드에서 수신자가 큐에 지정된 기간 동안 메시지를 잠급니다.
• receiveAndDelete 모드에서는 메시지가 수신될 때 Service Bus에서 삭제됩니다.

잠금 기간 내에 정해지지 않은 메시지는 구독에 설정된 최대 배달 횟수만큼 여러 번 다시 배달되며, 그 후에는 별도의 배달 못 한 편지 큐로 전송됩니다.

수신기에서 completeMessage(), abandonMessage(), deferMessage() 또는 deadletterMessage() 메서드를 호출하여 메시지를 해결할 수 있습니다.

peekLock 및 메시지 결제가 작동하는 방법에 대한 자세한 내용은 여기를 참조하세요. https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

function createReceiver(topicName: string, subscriptionName: string, options?: ServiceBusReceiverOptions): ServiceBusReceiver

매개 변수

topicName

string

수신하려는 구독에 대한 토픽의 이름입니다.

subscriptionName

string

수신하려는 구독의 이름(아래 topic)입니다.

options

ServiceBusReceiverOptions

receiveMode를 전달하는 옵션이며, 기본값은 peekLock입니다.

반환

ServiceBusReceiver

메시지를 수신, 피킹 및 정정하는 데 사용할 수 있는 수신기입니다.

createRuleManager(string, string)

구독에 대한 규칙을 관리하는 데 사용되는 ServiceBusRuleManager 인스턴스를 만듭니다.

function createRuleManager(topicName: string, subscriptionName: string): ServiceBusRuleManager

매개 변수

topicName

string

ServiceBusRuleManager를 만드는 항목

subscriptionName

string

ServiceBusRuleManager를 만들기 위해 지정된 항목과 관련된 구독입니다.

반환

ServiceBusRuleManager

지정된 구독 및 토픽으로 범위가 지정된 ServiceBusRuleManager 입니다.

createSender(string, ServiceBusSenderOptions)

메시지를 보내고, 나중에 보낼 메시지를 예약하고, 예약된 메시지를 취소하는 데 사용할 수 있는 발신자를 만듭니다. 보낸 사람의 메서드 중 하나가 호출될 때까지 서비스에 연결되지 않습니다.

function createSender(queueOrTopicName: string, options?: ServiceBusSenderOptions): ServiceBusSender

매개 변수

queueOrTopicName

string

메시지를 보낼 큐 또는 토픽의 이름입니다.

options

ServiceBusSenderOptions

반환

ServiceBusSender