CbsClient class

Pakket:

@azure/core-amqp

Beschrijft de EventHub/ServiceBus Cbs-client die met het $cbs-eindpunt praat via AMQP-verbinding.

Constructors

CbsClient(Connection, string)

Eigenschappen

cbsLock	De unieke vergrendelingsnaam per $cbs sessie per verbinding die wordt gebruikt om de vergrendeling te verkrijgen voor het tot stand brengen van een CBS-sessie als er geen bestaat voor een amqp-verbinding.
connection	De AMQP-verbinding.
connectionLock	De unieke vergrendelingsnaam per verbinding die wordt gebruikt om de vergrendeling te verkrijgen voor het tot stand brengen van een amqp-verbinding als deze niet bestaat.
endpoint	CBS-eindpunt - "$cbs"
replyTo	CBS replyTo - De naam van de ontvangerkoppeling waarop de service moet reageren.

Methoden

close()	Sluit de AMQP cbs-sessie naar de EventHub/ServiceBus voor deze client en retourneert een belofte die wordt opgelost wanneer de verbinding is voltooid.
init({ abortSignal?: AbortSignalLike, timeoutInMs?: number })	Hiermee maakt u een singleton-instantie van de CBS-sessie als deze nog niet eerder op de opgegeven verbinding is geïnitialiseerd.
isOpen()	Geeft aan of de ontvangerkoppeling van de cbs-afzender open of gesloten is.
negotiateClaim(string, string, TokenType, { abortSignal?: AbortSignalLike, timeoutInMs?: number })	Onderhandelt de CBS-claim met de EventHub/ServiceBus Service.
remove()	Hiermee verwijdert u de AMQP CBS-sessie naar de EventHub/ServiceBus voor deze client,

Constructordetails

CbsClient(Connection, string)

new CbsClient(connection: Connection, connectionLock: string)

Parameters

connection

Connection

De AMQP-verbinding.

connectionLock

string

Een unieke tekenreeks (meestal een GUID) per verbinding.

Eigenschapdetails

cbsLock

De unieke vergrendelingsnaam per $cbs sessie per verbinding die wordt gebruikt om de vergrendeling te verkrijgen voor het tot stand brengen van een CBS-sessie als er geen bestaat voor een amqp-verbinding.

cbsLock: string

Waarde van eigenschap

string

connection

De AMQP-verbinding.

connection: Connection

Waarde van eigenschap

Connection

connectionLock

De unieke vergrendelingsnaam per verbinding die wordt gebruikt om de vergrendeling te verkrijgen voor het tot stand brengen van een amqp-verbinding als deze niet bestaat.

connectionLock: string

Waarde van eigenschap

string

endpoint

CBS-eindpunt - "$cbs"

endpoint: string

Waarde van eigenschap

string

replyTo

CBS replyTo - De naam van de ontvangerkoppeling waarop de service moet reageren.

replyTo: string

Waarde van eigenschap

string

Methodedetails

close()

Sluit de AMQP cbs-sessie naar de EventHub/ServiceBus voor deze client en retourneert een belofte die wordt opgelost wanneer de verbinding is voltooid.

function close(): Promise<void>

Retouren

Promise<void>

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

Hiermee maakt u een singleton-instantie van de CBS-sessie als deze nog niet eerder op de opgegeven verbinding is geïnitialiseerd.

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

Parameters

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

Optionele parameters die kunnen worden gebruikt om het gedrag van deze methode te beïnvloeden. abortSignal kan bijvoorbeeld worden doorgegeven om het annuleren van een actieve init aanroep toe te staan.

Retouren

Promise<void>

Beloof<ongeldig>.

isOpen()

Geeft aan of de ontvangerkoppeling van de cbs-afzender open of gesloten is.

function isOpen(): boolean

Retouren

boolean

true geopend, false gesloten.

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

Onderhandelt de CBS-claim met de EventHub/ServiceBus Service.

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

Parameters

audience

string

De entiteitstokendoelgroep waarvoor het token wordt aangevraagd in een van de volgende formulieren:

• ServiceBus-

  • afzender

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

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

  • afzender

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

  • ontvanger

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

Het token dat moet worden verzonden in de put-tokenaanvraag.

tokenType

TokenType

Het type token dat wordt gebruikt. Bijvoorbeeld 'jwt' of 'servicebus.windows.net:sastoken'.

options

{ abortSignal?: AbortSignalLike, timeoutInMs?: number }

Optionele parameters die kunnen worden gebruikt om het gedrag van deze methode te beïnvloeden. abortSignal kan bijvoorbeeld worden doorgegeven om het annuleren van een actieve negotiateClaim aanroep toe te staan.

Retouren

Promise<CbsResponse>

Een belofte die wordt opgelost wanneer $cbs verificatie is geslaagd en weigert wanneer er een fout optreedt tijdens $cbs verificatie.

remove()

Hiermee verwijdert u de AMQP CBS-sessie naar de EventHub/ServiceBus voor deze client,

function remove()