EventHubConnectionConfig interface

Paket:

@azure/amqp-common

Beschreibt das Verbindungskonfigurationsobjekt, das nach der Analyse einer EventHub-Verbindungszeichenfolge erstellt wird. Es bietet auch einige Komfortmethoden zum Abrufen der Adresse und Zielgruppe für verschiedene Entitäten.

Extends

ConnectionConfig

Eigenschaften

entityPath

Der Name/Pfad der Entität (Event Hub-Name), mit der die Verbindung erfolgen muss.

Geerbte Eigenschaften

connectionString	Die Verbindungszeichenfolge.
endpoint	Der Service Bus-Endpunkt "sb://< yournamespace.servicebus.windows.net/>".
host	Der Host "<yournamespace.servicebus.windows.net>".
sharedAccessKey	Der geheime Wert der Zugriffstaste.
sharedAccessKeyName	Der Name der Zugriffstaste.
webSocket	Der WebSocket-Konstruktor, der zum Erstellen einer AMQP-Verbindung über ein WebSocket verwendet wird. In Browsern wird das integrierte WebSocket standardmäßig verwendet. In Node wird ein TCP-Socket verwendet, wenn kein WebSocket-Konstruktor bereitgestellt wird.
webSocketConstructorOptions	Optionen, die an den WebSocket-Konstruktor übergeben werden sollen
webSocketEndpointPath	Der Pfad für den Endpunkt, der eine AMQP-Verbindung über WebSockets akzeptiert.

Methoden

getManagementAddress()	Stellt die EventHub-Verwaltungsadresse bereit. "<hub-name>/$management"
getManagementAudience()	Stellt die EventHub-Verwaltungsgruppe bereit. "sb://<your-namespace>.servicebus.windows.net/<hub-name>/$management"
getReceiverAddress(string | number, string)	Stellt die EventHub-Empfängeradresse bereit: "<hub-name>/ConsumerGroups/<consumer-group-name>/Partitions/<partition-id>"
getReceiverAudience(string | number, string)	Stellt die EventHub-Empfängergruppe bereit. "sb://<your-namespace>.servicebus.windows.net/<hub-name>/ConsumerGroups/<consumer-group-name>/Partitions/<partition-id>"
getSenderAddress(string | number)	Stellt die EventHub-Absenderadresse in einem der folgenden Formulare basierend auf der Eingabe bereit: "<hubName>" "<hubName>/Partitions/<partitionId>"
getSenderAudience(string | number)	Stellt die EventHub-Absendergruppe in einem der folgenden Formulare basierend auf der Eingabe bereit: "sb://<yournamespace>.servicebus.windows.net/<hubName>" "sb://<yournamespace>.servicebus.windows.net/<hubName>/Partitions/<partitionId>"

Details zur Eigenschaft

entityPath

Der Name/Pfad der Entität (Event Hub-Name), mit der die Verbindung erfolgen muss.

entityPath: string

Eigenschaftswert

string

Geerbte Eigenschaftsdetails

connectionString

Die Verbindungszeichenfolge.

connectionString: string

Eigenschaftswert

string

geerbt vonConnectionConfig.connectionString-

endpoint

Der Service Bus-Endpunkt "sb://< yournamespace.servicebus.windows.net/>".

endpoint: string

Eigenschaftswert

string

vonConnectionConfig.endpoint geerbt

host

Der Host "<yournamespace.servicebus.windows.net>".

host: string

Eigenschaftswert

string

geerbt vonConnectionConfig.host-

sharedAccessKey

Der geheime Wert der Zugriffstaste.

sharedAccessKey: string

Eigenschaftswert

string

geerbt vonConnectionConfig.sharedAccessKey

sharedAccessKeyName

Der Name der Zugriffstaste.

sharedAccessKeyName: string

Eigenschaftswert

string

geerbt vonConnectionConfig.sharedAccessKeyName

webSocket

Der WebSocket-Konstruktor, der zum Erstellen einer AMQP-Verbindung über ein WebSocket verwendet wird. In Browsern wird das integrierte WebSocket standardmäßig verwendet. In Node wird ein TCP-Socket verwendet, wenn kein WebSocket-Konstruktor bereitgestellt wird.

webSocket?: WebSocketImpl

Eigenschaftswert

WebSocketImpl

vonConnectionConfig.webSocket geerbt

webSocketConstructorOptions

Optionen, die an den WebSocket-Konstruktor übergeben werden sollen

webSocketConstructorOptions?: any

Eigenschaftswert

any

vonConnectionConfig.webSocketConstructorOptions

webSocketEndpointPath

Der Pfad für den Endpunkt, der eine AMQP-Verbindung über WebSockets akzeptiert.

webSocketEndpointPath?: string

Eigenschaftswert

string

vonConnectionConfig.webSocketEndpointPath

Details zur Methode

getManagementAddress()

Stellt die EventHub-Verwaltungsadresse bereit.

• "<hub-name>/$management"

function getManagementAddress(): string

Gibt zurück

string

getManagementAudience()

Stellt die EventHub-Verwaltungsgruppe bereit.

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

function getManagementAudience(): string

Gibt zurück

string

getReceiverAddress(string | number, string)

Stellt die EventHub-Empfängeradresse bereit:

• "<hub-name>/ConsumerGroups/<consumer-group-name>/Partitions/<partition-id>"

function getReceiverAddress(partitionId: string | number, consumergroup?: string): string

Parameter

partitionId

string | number

Die partitionId im EventHub, von dem Nachrichten empfangen werden.

consumergroup

string

Der Consumergoup im EventHub, von dem die Nachrichten empfangen werden. Standard: $default.

Gibt zurück

string

getReceiverAudience(string | number, string)

Stellt die EventHub-Empfängergruppe bereit.

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

function getReceiverAudience(partitionId: string | number, consumergroup?: string): string

Parameter

partitionId

string | number

Die partitionId im EventHub, von dem Nachrichten empfangen werden.

consumergroup

string

Der Consumergoup im EventHub, von dem die Nachrichten empfangen werden. Standard: $default.

Gibt zurück

string

getSenderAddress(string | number)

Stellt die EventHub-Absenderadresse in einem der folgenden Formulare basierend auf der Eingabe bereit:

• "<hubName>"
• "<hubName>/Partitions/<partitionId>"

function getSenderAddress(partitionId?: string | number): string

Parameter

partitionId

string | number

Die partitionId im EventHub, an die Nachrichten gesendet werden.

Gibt zurück

string

getSenderAudience(string | number)

Stellt die EventHub-Absendergruppe in einem der folgenden Formulare basierend auf der Eingabe bereit:

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

function getSenderAudience(partitionId?: string | number): string

Parameter

partitionId

string | number

Die partitionId im EventHub, an die Nachrichten gesendet werden.

Gibt zurück

string