EventHubConsumerClient class
A EventHubConsumerClient classe é usada para consumir eventos de um Hub de Eventos.
Há várias maneiras de criar um EventHubConsumerClient
- Use a cadeia de conexão da política SAS criada para sua instância do Hub de Eventos.
- Use a cadeia de conexão da política SAS criada para o namespace do Hub de Eventos e o nome da instância do Hub de Eventos
- Use o namespace completo, como
<yournamespace>.servicebus.windows.net, e um objeto de credenciais.
Opcionalmente, você também pode passar:
- Um recipiente de opções para definir a política de repetição ou as configurações de proxy.
- Um repositório de ponto de verificação usado pelo cliente para ler pontos de verificação para determinar a posição de onde ele deve retomar o recebimento de eventos quando seu aplicativo é reiniciado. O repositório de ponto de verificação também é usado pelo cliente para balancear a carga de várias instâncias do seu aplicativo.
Construtores
| Event |
A |
| Event |
A |
| Event |
A |
| Event |
A |
| Event |
A |
| Event |
A |
Propriedades
| default |
O nome do grupo de consumidores padrão no serviço hubs de eventos. |
| event |
O nome da instância do Hub de Eventos para a qual esse cliente é criado. |
| fully |
O namespace totalmente qualificado da instância do Hub de Eventos para a qual esse cliente é criado. É provável que isso seja semelhante a .servicebus.windows.net. |
| identifier | O nome usado para identificar este EventHubConsumerClient. Se não for especificado ou vazio, um aleatório exclusivo será gerado. |
Métodos
| close() | Fecha a conexão AMQP com a instância do Hub de Eventos, retornando uma promessa que será resolvida quando a desconexão for concluída. |
| get |
Fornece as informações de runtime do Hub de Eventos. |
| get |
Fornece a ID de cada partição associada ao Hub de Eventos. |
| get |
Fornece informações sobre o estado da partição especificada. |
| subscribe(string, Subscription |
Assine eventos de uma única partição. Chame close() no objeto retornado para parar de receber eventos. Exemplo de uso: |
| subscribe(Subscription |
Assine eventos de todas as partições. Se o Chame close() no objeto retornado para parar de receber eventos. Exemplo de uso: |
Detalhes do construtor
EventHubConsumerClient(string, string, CheckpointStore, EventHubConsumerClientOptions)
A EventHubConsumerClient classe é usada para consumir eventos de um Hub de Eventos.
Use o options parmeter para definir a política de repetição ou as configurações de proxy.
new EventHubConsumerClient(consumerGroup: string, connectionString: string, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)Parâmetros
- consumerGroup
-
string
O nome do grupo de consumidores do qual você deseja processar eventos.
- connectionString
-
string
A cadeia de conexão a ser usada para se conectar à instância do Hub de Eventos. Espera-se que as propriedades de chave compartilhada e o caminho do Hub de Eventos estejam contidos nessa cadeia de conexão. por exemplo, 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key; EntityPath=my-event-hub-name'.
- checkpointStore
- CheckpointStore
Um repositório de ponto de verificação usado pelo cliente para ler pontos de verificação para determinar a posição de onde ele deve retomar o recebimento de eventos quando seu aplicativo é reiniciado. Ele também é usado pelo cliente para balancear a carga de várias instâncias do aplicativo.
- options
- EventHubConsumerClientOptions
Um conjunto de opções a serem aplicadas ao configurar o cliente.
-
retryOptions: configura a política de repetição para todas as operações no cliente. Por exemplo,{ "maxRetries": 4 }ou{ "maxRetries": 4, "retryDelayInMs": 30000 }. -
webSocketOptions: configura a canalização da conexão AMQP por meio de Web Sockets. -
userAgent: uma cadeia de caracteres a ser acrescentada à cadeia de caracteres interna do agente de usuário que é passada para o serviço.
EventHubConsumerClient(string, string, EventHubConsumerClientOptions)
A EventHubConsumerClient classe é usada para consumir eventos de um Hub de Eventos.
Use o options parmeter para definir a política de repetição ou as configurações de proxy.
new EventHubConsumerClient(consumerGroup: string, connectionString: string, options?: EventHubConsumerClientOptions)Parâmetros
- consumerGroup
-
string
O nome do grupo de consumidores do qual você deseja processar eventos.
- connectionString
-
string
A cadeia de conexão a ser usada para se conectar à instância do Hub de Eventos. Espera-se que as propriedades de chave compartilhada e o caminho do Hub de Eventos estejam contidos nessa cadeia de conexão. por exemplo, 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key; EntityPath=my-event-hub-name'.
- options
- EventHubConsumerClientOptions
Um conjunto de opções a serem aplicadas ao configurar o cliente.
-
retryOptions: configura a política de repetição para todas as operações no cliente. Por exemplo,{ "maxRetries": 4 }ou{ "maxRetries": 4, "retryDelayInMs": 30000 }. -
webSocketOptions: configura a canalização da conexão AMQP por meio de Web Sockets. -
userAgent: uma cadeia de caracteres a ser acrescentada à cadeia de caracteres interna do agente de usuário que é passada para o serviço.
EventHubConsumerClient(string, string, string, CheckpointStore, EventHubConsumerClientOptions)
A EventHubConsumerClient classe é usada para consumir eventos de um Hub de Eventos.
Use o options parmeter para definir a política de repetição ou as configurações de proxy.
new EventHubConsumerClient(consumerGroup: string, connectionString: string, eventHubName: string, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)Parâmetros
- consumerGroup
-
string
O nome do grupo de consumidores do qual você deseja processar eventos.
- connectionString
-
string
A cadeia de conexão a ser usada para se conectar ao namespace dos Hubs de Eventos. Espera-se que as propriedades de chave compartilhada estejam contidas nessa cadeia de conexão, mas não no caminho do Hub de Eventos, por exemplo, 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key;'.
- eventHubName
-
string
O nome do Hub de Eventos específico ao qual conectar o cliente.
- checkpointStore
- CheckpointStore
Um repositório de ponto de verificação usado pelo cliente para ler pontos de verificação para determinar a posição de onde ele deve retomar o recebimento de eventos quando seu aplicativo é reiniciado. Ele também é usado pelo cliente para balancear a carga de várias instâncias do seu aplicativo.
- options
- EventHubConsumerClientOptions
Um conjunto de opções a serem aplicadas ao configurar o cliente.
-
retryOptions: configura a política de repetição para todas as operações no cliente. Por exemplo,{ "maxRetries": 4 }ou{ "maxRetries": 4, "retryDelayInMs": 30000 }. -
webSocketOptions: configura a canalização da conexão AMQP por meio de Web Sockets. -
userAgent: uma cadeia de caracteres a ser acrescentada à cadeia de caracteres interna do agente do usuário que é passada para o serviço.
EventHubConsumerClient(string, string, string, EventHubConsumerClientOptions)
A EventHubConsumerClient classe é usada para consumir eventos de um Hub de Eventos.
Use o options parmeter para definir a política de repetição ou as configurações de proxy.
new EventHubConsumerClient(consumerGroup: string, connectionString: string, eventHubName: string, options?: EventHubConsumerClientOptions)Parâmetros
- consumerGroup
-
string
O nome do grupo de consumidores do qual você deseja processar eventos.
- connectionString
-
string
A cadeia de conexão a ser usada para se conectar ao namespace dos Hubs de Eventos. Espera-se que as propriedades de chave compartilhada estejam contidas nessa cadeia de conexão, mas não no caminho do Hub de Eventos, por exemplo, 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key;'.
- eventHubName
-
string
O nome do Hub de Eventos específico ao qual conectar o cliente.
- options
- EventHubConsumerClientOptions
Um conjunto de opções a serem aplicadas ao configurar o cliente.
-
retryOptions: configura a política de repetição para todas as operações no cliente. Por exemplo,{ "maxRetries": 4 }ou{ "maxRetries": 4, "retryDelayInMs": 30000 }. -
webSocketOptions: configura a canalização da conexão AMQP por meio de Web Sockets. -
userAgent: uma cadeia de caracteres a ser acrescentada à cadeia de caracteres interna do agente do usuário que é passada para o serviço.
EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, CheckpointStore, EventHubConsumerClientOptions)
A EventHubConsumerClient classe é usada para consumir eventos de um Hub de Eventos.
Use o options parmeter para definir a política de repetição ou as configurações de proxy.
new EventHubConsumerClient(consumerGroup: string, fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential | NamedKeyCredential | SASCredential, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)Parâmetros
- consumerGroup
-
string
O nome do grupo de consumidores do qual você deseja processar eventos.
- fullyQualifiedNamespace
-
string
O namespace completo que provavelmente será semelhante a .servicebus.windows.net
- eventHubName
-
string
O nome do Hub de Eventos específico ao qual conectar o cliente.
- credential
Um objeto de credencial usado pelo cliente para obter o token para autenticar a conexão com o serviço Hubs de Eventos do Azure.
Confira @azure/identidade para criar credenciais que dão suporte à autenticação do AAD. Use o AzureNamedKeyCredential de @azure/core-auth se quiser passar um SharedAccessKeyName e SharedAccessKey sem usar uma cadeia de conexão. Esses campos são mapeados para o name campo e key , respectivamente, em AzureNamedKeyCredential.
Use o AzureSASCredential de @azure/core-auth se quiser passar um SharedAccessSignature sem usar uma cadeia de conexão. Esse campo é mapeado para signature em AzureSASCredential.
- checkpointStore
- CheckpointStore
Um repositório de ponto de verificação usado pelo cliente para ler pontos de verificação para determinar a posição de onde ele deve retomar o recebimento de eventos quando seu aplicativo é reiniciado. Ele também é usado pelo cliente para balancear a carga de várias instâncias do seu aplicativo.
- options
- EventHubConsumerClientOptions
Um conjunto de opções a serem aplicadas ao configurar o cliente.
-
retryOptions: configura a política de repetição para todas as operações no cliente. Por exemplo,{ "maxRetries": 4 }ou{ "maxRetries": 4, "retryDelayInMs": 30000 }. -
webSocketOptions: configura a canalização da conexão AMQP por meio de Web Sockets. -
userAgent: uma cadeia de caracteres a ser acrescentada à cadeia de caracteres interna do agente do usuário que é passada para o serviço.
EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, EventHubConsumerClientOptions)
A EventHubConsumerClient classe é usada para consumir eventos de um Hub de Eventos.
Use o options parmeter para definir a política de repetição ou as configurações de proxy.
new EventHubConsumerClient(consumerGroup: string, fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential | NamedKeyCredential | SASCredential, options?: EventHubConsumerClientOptions)Parâmetros
- consumerGroup
-
string
O nome do grupo de consumidores do qual você deseja processar eventos.
- fullyQualifiedNamespace
-
string
O namespace completo que provavelmente será semelhante a .servicebus.windows.net
- eventHubName
-
string
O nome do Hub de Eventos específico ao qual conectar o cliente.
- credential
Um objeto de credencial usado pelo cliente para obter o token para autenticar a conexão com o serviço Hubs de Eventos do Azure.
Confira @azure/identidade para criar credenciais que dão suporte à autenticação do AAD. Use o AzureNamedKeyCredential de @azure/core-auth se quiser passar um SharedAccessKeyName e SharedAccessKey sem usar uma cadeia de conexão. Esses campos são mapeados para o name campo e key , respectivamente, em AzureNamedKeyCredential.
Use o AzureSASCredential de @azure/core-auth se quiser passar um SharedAccessSignature sem usar uma cadeia de conexão. Esse campo é mapeado para signature em AzureSASCredential.
- options
- EventHubConsumerClientOptions
Um conjunto de opções a serem aplicadas ao configurar o cliente.
-
retryOptions: configura a política de repetição para todas as operações no cliente. Por exemplo,{ "maxRetries": 4 }ou{ "maxRetries": 4, "retryDelayInMs": 30000 }. -
webSocketOptions: configura a canalização da conexão AMQP por meio de Web Sockets. -
userAgent: uma cadeia de caracteres a ser acrescentada à cadeia de caracteres interna do agente do usuário que é passada para o serviço.
Detalhes da propriedade
defaultConsumerGroupName
O nome do grupo de consumidores padrão no serviço hubs de eventos.
static defaultConsumerGroupName: stringValor da propriedade
string
eventHubName
O nome da instância do Hub de Eventos para a qual esse cliente é criado.
string eventHubNameValor da propriedade
string
fullyQualifiedNamespace
O namespace totalmente qualificado da instância do Hub de Eventos para a qual esse cliente é criado. É provável que isso seja semelhante a .servicebus.windows.net.
string fullyQualifiedNamespaceValor da propriedade
string
identifier
O nome usado para identificar este EventHubConsumerClient. Se não for especificado ou vazio, um aleatório exclusivo será gerado.
identifier: stringValor da propriedade
string
Detalhes do método
close()
Fecha a conexão AMQP com a instância do Hub de Eventos, retornando uma promessa que será resolvida quando a desconexão for concluída.
function close(): Promise<void>Retornos
Promise<void>
Prometo
getEventHubProperties(GetEventHubPropertiesOptions)
Fornece as informações de runtime do Hub de Eventos.
function getEventHubProperties(options?: GetEventHubPropertiesOptions): Promise<EventHubProperties>Parâmetros
- options
- GetEventHubPropertiesOptions
O conjunto de opções a serem aplicadas à chamada de operação.
Retornos
Promise<EventHubProperties>
Uma promessa que é resolvida com informações sobre a instância do Hub de Eventos.
getPartitionIds(GetPartitionIdsOptions)
Fornece a ID de cada partição associada ao Hub de Eventos.
function getPartitionIds(options?: GetPartitionIdsOptions): Promise<string[]>Parâmetros
- options
- GetPartitionIdsOptions
O conjunto de opções a serem aplicadas à chamada de operação.
Retornos
Promise<string[]>
Uma promessa que é resolvida com uma Matriz de cadeias de caracteres que representa a ID de cada partição associada ao Hub de Eventos.
getPartitionProperties(string, GetPartitionPropertiesOptions)
Fornece informações sobre o estado da partição especificada.
function getPartitionProperties(partitionId: string, options?: GetPartitionPropertiesOptions): Promise<PartitionProperties>Parâmetros
- partitionId
-
string
A ID da partição para a qual as informações são necessárias.
- options
- GetPartitionPropertiesOptions
O conjunto de opções a serem aplicadas à chamada de operação.
Retornos
Promise<PartitionProperties>
Uma promessa que resolve com informações sobre o estado da partição .
subscribe(string, SubscriptionEventHandlers, SubscribeOptions)
Assine eventos de uma única partição. Chame close() no objeto retornado para parar de receber eventos.
Exemplo de uso:
const client = new EventHubConsumerClient(consumerGroup, connectionString, eventHubName);
const subscription = client.subscribe(
partitionId,
{
processEvents: (events, context) => { console.log("Received event count: ", events.length) },
processError: (err, context) => { console.log("Error: ", err) }
},
{ startPosition: earliestEventPosition }
);
function subscribe(partitionId: string, handlers: SubscriptionEventHandlers, options?: SubscribeOptions): SubscriptionParâmetros
- partitionId
-
string
A ID da partição a ser inscrita.
- handlers
- SubscriptionEventHandlers
Manipuladores para o ciclo de vida da assinatura – inicialização de assinatura da partição, recebimento de eventos, tratamento de erros e fechamento de uma assinatura para a partição.
- options
- SubscribeOptions
Configura a maneira como os eventos são recebidos.
Os mais comuns são maxBatchSize e maxWaitTimeInSeconds que controlam o fluxo de eventos para o manipulador fornecido para receber eventos, bem como a posição inicial. Por exemplo, { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }
Retornos
subscribe(SubscriptionEventHandlers, SubscribeOptions)
Assine eventos de todas as partições.
Se o EventHubConsumerClient repositório de ponto de verificação for fornecido ao e houver várias instâncias do aplicativo, cada instância assinará um subconjunto das partições de modo que a carga seja balanceada entre elas.
Chame close() no objeto retornado para parar de receber eventos.
Exemplo de uso:
const client = new EventHubConsumerClient(consumerGroup, connectionString, eventHubName);
const subscription = client.subscribe(
{
processEvents: (events, context) => { console.log("Received event count: ", events.length) },
processError: (err, context) => { console.log("Error: ", err) }
},
{ startPosition: earliestEventPosition }
);
function subscribe(handlers: SubscriptionEventHandlers, options?: SubscribeOptions): SubscriptionParâmetros
- handlers
- SubscriptionEventHandlers
Manipuladores para o ciclo de vida da assinatura – inicialização de assinatura por partição, recebimento de eventos, tratamento de erros e fechamento de uma assinatura por partição.
- options
- SubscribeOptions
Configura a maneira como os eventos são recebidos.
Os mais comuns são maxBatchSize e maxWaitTimeInSeconds que controlam o fluxo de eventos para o manipulador fornecido para receber eventos, bem como a posição inicial. Por exemplo, { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }