CbsClient class

Paket:

@azure/core-amqp

Menjelaskan klien EventHub/ServiceBus Cbs yang berbicara dengan titik akhir $cbs melalui koneksi AMQP.

Konstruktor

CbsClient(Connection, string)

Properti

cbsLock	Nama kunci unik per sesi $cbs per koneksi yang digunakan untuk memperoleh kunci untuk membuat sesi cbs jika tidak ada untuk koneksi amqp.
connection	Koneksi AMQP.
connectionLock	Nama kunci unik per koneksi yang digunakan untuk memperoleh kunci untuk membuat koneksi amqp jika tidak ada.
endpoint	Titik akhir CBS - "$cbs"
replyTo	Balasan CBS - Nama tautan penerima yang harus dibalas layanan.

Metode

close()	Menutup sesi AMQP cbs ke EventHub/ServiceBus untuk klien ini, mengembalikan janji yang akan diselesaikan ketika pemutusan sambungan selesai.
init({ abortSignal?: AbortSignalLike, timeoutInMs?: number })	Membuat instans singleton sesi CBS jika belum diinisialisasi sebelumnya pada koneksi yang diberikan.
isOpen()	Menunjukkan apakah tautan penerima pengirim cbs terbuka atau tertutup.
negotiateClaim(string, string, TokenType, { abortSignal?: AbortSignalLike, timeoutInMs?: number })	Menegosiasikan klaim CBS dengan Layanan EventHub/ServiceBus.
remove()	Menghapus sesi AMQP cbs ke EventHub/ServiceBus untuk klien ini,

Detail Konstruktor

CbsClient(Connection, string)

new CbsClient(connection: Connection, connectionLock: string)

Parameter

connection

Connection

Koneksi AMQP.

connectionLock

string

String unik (biasanya guid) per koneksi.

Detail Properti

cbsLock

Nama kunci unik per sesi $cbs per koneksi yang digunakan untuk memperoleh kunci untuk membuat sesi cbs jika tidak ada untuk koneksi amqp.

cbsLock: string

Nilai Properti

string

connection

Koneksi AMQP.

connection: Connection

Nilai Properti

Connection

connectionLock

Nama kunci unik per koneksi yang digunakan untuk memperoleh kunci untuk membuat koneksi amqp jika tidak ada.

connectionLock: string

Nilai Properti

string

endpoint

Titik akhir CBS - "$cbs"

endpoint: string

Nilai Properti

string

replyTo

Balasan CBS - Nama tautan penerima yang harus dibalas layanan.

replyTo: string

Nilai Properti

string

Detail Metode

close()

Menutup sesi AMQP cbs ke EventHub/ServiceBus untuk klien ini, mengembalikan janji yang akan diselesaikan ketika pemutusan sambungan selesai.

function close(): Promise<void>

Mengembalikan

Promise<void>

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

Membuat instans singleton sesi CBS jika belum diinisialisasi sebelumnya pada koneksi yang diberikan.

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

Parameter

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

Parameter opsional yang dapat digunakan untuk memengaruhi perilaku metode ini. Misalnya, abortSignal dapat diteruskan untuk memungkinkan pembatalan pemanggilan init yang sedang berlangsung.

Mengembalikan

Promise<void>

Janji<batal>.

isOpen()

Menunjukkan apakah tautan penerima pengirim cbs terbuka atau tertutup.

function isOpen(): boolean

Mengembalikan

boolean

true terbuka, false ditutup.

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

Menegosiasikan klaim CBS dengan Layanan EventHub/ServiceBus.

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

Parameter

audience

string

Audiens token entitas yang tokennya diminta dalam salah satu formulir berikut:

• ServiceBus

  • Pengirim

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

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

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

• EventHubs

  • Pengirim

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

  • Penerima

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

Token yang perlu dikirim dalam permintaan put-token.

tokenType

TokenType

Jenis token yang digunakan. Misalnya, 'jwt' atau 'servicebus.windows.net:sastoken'.

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

Parameter opsional yang dapat digunakan untuk memengaruhi perilaku metode ini. Misalnya, abortSignal dapat diteruskan untuk memungkinkan pembatalan pemanggilan negotiateClaim yang sedang berlangsung.

Mengembalikan

Promise<CbsResponse>

Janji yang diselesaikan saat autentikasi $cbs berhasil dan menolak ketika kesalahan terjadi selama autentikasi $cbs.

remove()

Menghapus sesi AMQP cbs ke EventHub/ServiceBus untuk klien ini,

function remove()