다음을 통해 공유

CbsClient class

  • 참조
패키지:
@azure/core-amqp

AMQP 연결을 통해 $cbs 엔드포인트와 대화하는 EventHub/ServiceBus Cbs 클라이언트에 대해 설명합니다.

생성자

CbsClient(Connection, string)

속성

cbsLock

amqp 연결에 대한 잠금이 없는 경우 cbs 세션을 설정하기 위한 잠금을 획득하는 데 사용되는 연결당 $cbs 세션당 고유한 잠금 이름입니다.
connection

AMQP 연결입니다.
connectionLock

amqp 연결이 없는 경우 잠금을 획득하는 데 사용되는 연결당 고유한 잠금 이름입니다.
endpoint

CBS 엔드포인트 - "$cbs"
replyTo

CBS replyTo - 서비스가 회신해야 하는 수신자 링크 이름입니다.

메서드

close()

이 클라이언트에 대한 EventHub/ServiceBus에 대한 AMQP cbs 세션을 닫고 연결 끊김이 완료될 때 해결될 약속을 반환합니다.
init({ abortSignal?: AbortSignalLike, timeoutInMs?: number })

지정된 연결에서 이전에 초기화되지 않은 경우 CBS 세션의 싱글톤 인스턴스를 만듭니다.
isOpen()

cbs 발신자 수신자 링크가 열려 있는지 닫혔는지 여부를 나타냅니다.
negotiateClaim(string, string, TokenType, { abortSignal?: AbortSignalLike, timeoutInMs?: number })

EventHub/ServiceBus 서비스와 CBS 클레임을 협상합니다.
remove()

이 클라이언트에 대한 EventHub/ServiceBus에 대한 AMQP cbs 세션을 제거합니다.

생성자 세부 정보

CbsClient(Connection, string) 

new CbsClient(connection: Connection, connectionLock: string)

매개 변수

connection

Connection

AMQP 연결입니다.

connectionLock

string

연결당 고유한 문자열(일반적으로 guid)입니다.

속성 세부 정보

cbsLock

amqp 연결에 대한 잠금이 없는 경우 cbs 세션을 설정하기 위한 잠금을 획득하는 데 사용되는 연결당 $cbs 세션당 고유한 잠금 이름입니다.

cbsLock: string

속성 값

string

connection

AMQP 연결입니다.

connection: Connection

속성 값

Connection

connectionLock

amqp 연결이 없는 경우 잠금을 획득하는 데 사용되는 연결당 고유한 잠금 이름입니다.

connectionLock: string

속성 값

string

endpoint

CBS 엔드포인트 - "$cbs"

endpoint: string

속성 값

string

replyTo

CBS replyTo - 서비스가 회신해야 하는 수신자 링크 이름입니다.

replyTo: string

속성 값

string

메서드 세부 정보

close()

이 클라이언트에 대한 EventHub/ServiceBus에 대한 AMQP cbs 세션을 닫고 연결 끊김이 완료될 때 해결될 약속을 반환합니다.

function close(): Promise<void>

반환

Promise<void>

init({ abortSignal?: AbortSignalLike, timeoutInMs?: number })

지정된 연결에서 이전에 초기화되지 않은 경우 CBS 세션의 싱글톤 인스턴스를 만듭니다.

function init(options?: { abortSignal?: AbortSignalLike, timeoutInMs?: number }): Promise<void>

매개 변수

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

이 메서드의 동작에 영향을 주는 데 사용할 수 있는 선택적 매개 변수입니다. 예를 들어 abortSignal 진행 중인 init 호출을 취소할 수 있도록 을 전달할 수 있습니다.

반환

Promise<void>

약속.

isOpen()

cbs 발신자 수신자 링크가 열려 있는지 닫혔는지 여부를 나타냅니다.

function isOpen(): boolean

반환

boolean

true 열기, false 닫힘.

negotiateClaim(string, string, TokenType, { abortSignal?: AbortSignalLike, timeoutInMs?: number })

EventHub/ServiceBus 서비스와 CBS 클레임을 협상합니다.

function negotiateClaim(audience: string, token: string, tokenType: TokenType, options?: { abortSignal?: AbortSignalLike, timeoutInMs?: number }): Promise<CbsResponse>

매개 변수

audience

string

다음 양식 중 하나로 토큰이 요청되는 엔터티 토큰 대상 그룹입니다.

  • Service Bus

    • 보낸 사람

      • "sb://<yournamespace>.servicebus.windows.net/<queue-name>"
      • "sb://<yournamespace>.servicebus.windows.net/<topic-name>"

    • 수신기 - "sb://<yournamespace>.servicebus.windows.net/<queue-name>" - "sb://<yournamespace>.servicebus.windows.net/<topic-name>"

    • ManagementClient - "sb://<your-namespace>.servicebus.windows.net/<queue-name>/$management". - "sb://<your-namespace>.servicebus.windows.net/<topic-name>/$management".

  • EventHubs

    • 보낸 사람

      • "sb://<yournamespace>.servicebus.windows.net/<hubName>"
      • "sb://<yournamespace>.servicebus.windows.net/<hubName>/Partitions/<partitionId>".

    • 받는 사람

      • "sb://<your-namespace>.servicebus.windows.net/<event-hub-name>/ConsumerGroups/<consumer-group-name>/Partitions/<partition-id>".

    • ManagementClient

      • "sb://<your-namespace>.servicebus.windows.net/<event-hub-name>/$management".
token

string

put-token 요청에서 보내야 하는 토큰입니다.

tokenType
TokenType

사용 중인 토큰의 형식입니다. 예를 들어 'jwt' 또는 'servicebus.windows.net:sastoken'입니다.

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

이 메서드의 동작에 영향을 주는 데 사용할 수 있는 선택적 매개 변수입니다. 예를 들어 abortSignal 진행 중인 negotiateClaim 호출을 취소할 수 있도록 을 전달할 수 있습니다.

반환

Promise<CbsResponse>

$cbs 인증이 성공하면 해결되고 $cbs 인증 중에 오류가 발생하면 거부하는 Promise입니다.

remove()

이 클라이언트에 대한 EventHub/ServiceBus에 대한 AMQP cbs 세션을 제거합니다.

function remove()