CbsClient class

Csomag:

@azure/core-amqp

Az EventHub/ServiceBus Cbs-ügyfelet ismerteti, amely amqp-kapcsolaton keresztül kommunikál a $cbs végponttal.

Konstruktorok

CbsClient(Connection, string)

Tulajdonságok

cbsLock	Kapcsolatonként $cbs munkamenetenként megadott egyedi zárolási név, amely a cbs-munkamenet létrehozására szolgáló zárolás beszerzésére szolgál, ha nem létezik amqp-kapcsolathoz.
connection	Az AMQP-kapcsolat.
connectionLock	Az amqp-kapcsolat létrehozásához használt, kapcsolatonkénti egyedi zárolásnév, ha nem létezik.
endpoint	CBS-végpont – "$cbs"
replyTo	CBS replyTo – A fogadó hivatkozás neve, amelyre a szolgáltatásnak válaszolnia kell.

Metódusok

close()	Bezárja az AMQP cbs-munkamenetet az ügyfél EventHub/ServiceBus szolgáltatásához, és visszaad egy ígéretet, amely a leválasztás befejezésekor megoldódik.
init({ abortSignal?: AbortSignalLike, timeoutInMs?: number })	Létrehozza a CBS-munkamenet egyetlen példányát, ha korábban még nem inicializálták az adott kapcsolaton.
isOpen()	Azt jelzi, hogy a CBS-feladó fogadójának hivatkozása nyitva vagy zárva van-e.
negotiateClaim(string, string, TokenType, { abortSignal?: AbortSignalLike, timeoutInMs?: number })	Egyezteti a CBS-jogcímet az EventHub/ServiceBus szolgáltatással.
remove()	Eltávolítja az AMQP cbs-munkamenetet az eventHub/ServiceBus ügyfélhez,

Konstruktor adatai

CbsClient(Connection, string)

new CbsClient(connection: Connection, connectionLock: string)

Paraméterek

connection

Connection

Az AMQP-kapcsolat.

connectionLock

string

Kapcsolatonként egyedi sztring (általában guid).

Tulajdonság adatai

cbsLock

Kapcsolatonként $cbs munkamenetenként megadott egyedi zárolási név, amely a cbs-munkamenet létrehozására szolgáló zárolás beszerzésére szolgál, ha nem létezik amqp-kapcsolathoz.

cbsLock: string

Tulajdonság értéke

string

connection

Az AMQP-kapcsolat.

connection: Connection

Tulajdonság értéke

Connection

connectionLock

Az amqp-kapcsolat létrehozásához használt, kapcsolatonkénti egyedi zárolásnév, ha nem létezik.

connectionLock: string

Tulajdonság értéke

string

endpoint

CBS-végpont – "$cbs"

endpoint: string

Tulajdonság értéke

string

replyTo

CBS replyTo – A fogadó hivatkozás neve, amelyre a szolgáltatásnak válaszolnia kell.

replyTo: string

Tulajdonság értéke

string

Metódus adatai

close()

Bezárja az AMQP cbs-munkamenetet az ügyfél EventHub/ServiceBus szolgáltatásához, és visszaad egy ígéretet, amely a leválasztás befejezésekor megoldódik.

function close(): Promise<void>

Válaszok

Promise<void>

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

Létrehozza a CBS-munkamenet egyetlen példányát, ha korábban még nem inicializálták az adott kapcsolaton.

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

Paraméterek

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

Nem kötelező paraméterek, amelyek a metódus viselkedésének befolyásolására használhatók. Például abortSignal továbbíthatók a folyamatban lévő init hívás megszakításának engedélyezéséhez.

Válaszok

Promise<void>

Ígéret<üres.>

isOpen()

Azt jelzi, hogy a CBS-feladó fogadójának hivatkozása nyitva vagy zárva van-e.

function isOpen(): boolean

Válaszok

boolean

true nyitva, false zárva.

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

Egyezteti a CBS-jogcímet az EventHub/ServiceBus szolgáltatással.

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

Paraméterek

audience

string

Az entitásjogkivonat célközönsége, amelyhez a jogkivonatot az alábbi űrlapok egyikén kérik:

• ServiceBus

  • Feladó

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

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

  • Menedzsment ügyfél. - "sb://<your-namespace>.servicebus.windows.net/<queue-name>/$management" - "sb://<your-namespace>.servicebus.windows.net/<topic-name>/$management".

• EventHubs

  • Feladó

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

  • fogadó

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

A put-token kérésben elküldendő jogkivonat.

tokenType

TokenType

A használt jogkivonat típusa. Például: "jwt" vagy "servicebus.windows.net:sastoken".

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

Nem kötelező paraméterek, amelyek a metódus viselkedésének befolyásolására használhatók. Például abortSignal továbbíthatók a folyamatban lévő negotiateClaim hívás megszakításának engedélyezéséhez.

Válaszok

Promise<CbsResponse>

Egy ígéret, amely megoldja $cbs hitelesítés sikeres voltát, és elutasítja, ha hiba történik $cbs hitelesítés során.

remove()

Eltávolítja az AMQP cbs-munkamenetet az eventHub/ServiceBus ügyfélhez,

function remove()