Поделиться через

CbsClient class

  • Ссылка
Пакет:
@azure/core-amqp

Описывает клиент EventHub/ServiceBus Cbs, который взаимодействует с конечной точкой $cbs через подключение AMQP.

Конструкторы

CbsClient(Connection, string)

Свойства

cbsLock

Уникальное имя блокировки для $cbs сеанса на подключение, которое используется для получения блокировки для установления сеанса cbs, если он не существует для подключения amqp.
connection

Подключение AMQP.
connectionLock

Уникальное имя блокировки для каждого подключения, которое используется для получения блокировки для установления подключения amqp, если оно не существует.
endpoint

Конечная точка CBS — "$cbs"
replyTo

CBS replyTo — имя ссылки получателя, на которую должна отвечать служба.

Методы

close()

Закрывает сеанс CBS AMQP в EventHub/ServiceBus для этого клиента, возвращая обещание, которое будет разрешено после завершения отключения.
init({ abortSignal?: AbortSignalLike, timeoutInMs?: number })

Создает одноэлементный экземпляр сеанса CBS, если он не был инициализирован ранее для данного подключения.
isOpen()

Указывает, открыта или закрыта ссылка получателя cbs sender.
negotiateClaim(string, string, TokenType, { abortSignal?: AbortSignalLike, timeoutInMs?: number })

Согласовывает утверждение CBS со службой EventHub/ServiceBus.
remove()

Удаляет сеанс CBS AMQP в EventHub/ServiceBus для этого клиента.

Сведения о конструкторе

CbsClient(Connection, string) 

new CbsClient(connection: Connection, connectionLock: string)

Параметры

connection

Connection

Подключение AMQP.

connectionLock

string

Уникальная строка (обычно guid) для каждого подключения.

Сведения о свойстве

cbsLock

Уникальное имя блокировки для $cbs сеанса на подключение, которое используется для получения блокировки для установления сеанса cbs, если он не существует для подключения amqp.

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()

Закрывает сеанс CBS AMQP в EventHub/ServiceBus для этого клиента, возвращая обещание, которое будет разрешено после завершения отключения.

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 sender.

function isOpen(): boolean

Возвращаемое значение

boolean

true открытый, false закрытый.

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

Согласовывает утверждение CBS со службой EventHub/ServiceBus.

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

Параметры

audience

string

Аудитория маркера сущности, для которой запрашивается маркер в одной из следующих форм:

  • Служебная шина

    • Отправитель

      • "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>

Объект Promise, который разрешается при успешном выполнении проверки подлинности $cbs и отклоняется при возникновении ошибки во время проверки подлинности $cbs.

remove()

Удаляет сеанс CBS AMQP в EventHub/ServiceBus для этого клиента.

function remove()