EventHubConnectionConfig interface

Pacote:

@azure/amqp-common

Descreve o objeto de configuração de conexão que é criado após a análise de uma cadeia de conexão EventHub. Ele também fornece alguns métodos de conveniência para obter o endereço e o público para diferentes entidades.

Extends

ConnectionConfig

Propriedades

entityPath

O nome/caminho da entidade (nome do hub de eventos) com a qual a conexão precisa acontecer.

Propriedades Herdadas

connectionString	A cadeia de conexão.
endpoint	O ponto de extremidade do barramento de serviço "sb://< yournamespace.servicebus.windows.net/>".
host	O host "<yournamespace.servicebus.windows.net>".
sharedAccessKey	O valor secreto da chave de acesso.
sharedAccessKeyName	O nome da chave de acesso.
webSocket	O construtor WebSocket usado para criar uma conexão AMQP sobre um WebSocket. Nos navegadores, o WebSocket integrado será usado por padrão. Em Node, um soquete TCP será usado se um construtor WebSocket não for fornecido.
webSocketConstructorOptions	Opções a serem passadas para o construtor WebSocket
webSocketEndpointPath	O caminho para o ponto de extremidade que aceita uma conexão AMQP sobre WebSockets.

Métodos

getManagementAddress()	Fornece o endereço de gerenciamento do EventHub. "<hub-name>/$management"
getManagementAudience()	Fornece o público de gerenciamento do EventHub. "sb://<your-namespace>.servicebus.windows.net/<hub-name>/$management"
getReceiverAddress(string | number, string)	Fornece o endereço do recetor do EventHub: "<hub-name>/ConsumerGroups/<consumer-group-name>/Partitions/<partition-id>"
getReceiverAudience(string | number, string)	Fornece o público recetor do EventHub. "sb://<your-namespace>.servicebus.windows.net/<hub-name>/ConsumerGroups/<consumer-group-name>/Partitions/<partition-id>"
getSenderAddress(string | number)	Fornece o endereço do remetente do EventHub em um dos seguintes formulários com base na entrada: "<hubName>" "<hubName>/Partitions/<partitionId>"
getSenderAudience(string | number)	Fornece o público do EventHub Sender em um dos seguintes formulários com base na entrada: "sb://<yournamespace>.servicebus.windows.net/<hubName>" "sb://<yournamespace>.servicebus.windows.net/<hubName>/Partitions/<partitionId>"

Detalhes de Propriedade

entityPath

O nome/caminho da entidade (nome do hub de eventos) com a qual a conexão precisa acontecer.

entityPath: string

Valor de Propriedade

string

Detalhes da Propriedade Herdada

connectionString

A cadeia de conexão.

connectionString: string

Valor de Propriedade

string

herdado de ConnectionConfig.connectionString

endpoint

O ponto de extremidade do barramento de serviço "sb://< yournamespace.servicebus.windows.net/>".

endpoint: string

Valor de Propriedade

string

herdado doConnectionConfig.endpoint

host

O host "<yournamespace.servicebus.windows.net>".

host: string

Valor de Propriedade

string

herdado de ConnectionConfig.host

sharedAccessKey

O valor secreto da chave de acesso.

sharedAccessKey: string

Valor de Propriedade

string

herdado de ConnectionConfig.sharedAccessKey

sharedAccessKeyName

O nome da chave de acesso.

sharedAccessKeyName: string

Valor de Propriedade

string

herdado de ConnectionConfig.sharedAccessKeyName

webSocket

O construtor WebSocket usado para criar uma conexão AMQP sobre um WebSocket. Nos navegadores, o WebSocket integrado será usado por padrão. Em Node, um soquete TCP será usado se um construtor WebSocket não for fornecido.

webSocket?: WebSocketImpl

Valor de Propriedade

WebSocketImpl

herdado de ConnectionConfig.webSocket

webSocketConstructorOptions

Opções a serem passadas para o construtor WebSocket

webSocketConstructorOptions?: any

Valor de Propriedade

any

herdado deConnectionConfig.webSocketConstructorOptions

webSocketEndpointPath

O caminho para o ponto de extremidade que aceita uma conexão AMQP sobre WebSockets.

webSocketEndpointPath?: string

Valor de Propriedade

string

herdado de ConnectionConfig.webSocketEndpointPath

Detalhes de Método

getManagementAddress()

Fornece o endereço de gerenciamento do EventHub.

• "<hub-name>/$management"

function getManagementAddress(): string

Devoluções

string

getManagementAudience()

Fornece o público de gerenciamento do EventHub.

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

function getManagementAudience(): string

Devoluções

string

getReceiverAddress(string | number, string)

Fornece o endereço do recetor do EventHub:

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

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

Parâmetros

partitionId

string | number

O partitionId no EventHub a partir do qual as mensagens serão recebidas.

consumergroup

string

O consumergoup no EventHub a partir do qual as mensagens serão recebidas. Padrão: $default.

Devoluções

string

getReceiverAudience(string | number, string)

Fornece o público recetor do EventHub.

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

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

Parâmetros

partitionId

string | number

O partitionId no EventHub a partir do qual as mensagens serão recebidas.

consumergroup

string

O consumergoup no EventHub a partir do qual as mensagens serão recebidas. Padrão: $default.

Devoluções

string

getSenderAddress(string | number)

Fornece o endereço do remetente do EventHub em um dos seguintes formulários com base na entrada:

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

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

Parâmetros

partitionId

string | number

O partitionId no EventHub para o qual as mensagens serão enviadas.

Devoluções

string

getSenderAudience(string | number)

Fornece o público do EventHub Sender em um dos seguintes formulários com base na entrada:

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

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

Parâmetros

partitionId

string | number

O partitionId no EventHub para o qual as mensagens serão enviadas.

Devoluções

string