EventHubProducerClient class

A EventHubProducerClient classe é utilizada para enviar eventos para um Hub de Eventos. Utilize o options parmeter para configurar a política de repetição ou as definições de proxy.

new EventHubProducerClient(connectionString: string, options?: EventHubClientOptions)

Parâmetros

A EventHubProducerClient classe é utilizada para enviar eventos para um Hub de Eventos. Utilize o options parmeter para configurar a política de repetição ou as definições de proxy.

new EventHubProducerClient(connectionString: string, eventHubName: string, options?: EventHubClientOptions)

Parâmetros

A EventHubProducerClient classe é utilizada para enviar eventos para um Hub de Eventos. Utilize o options parmeter para configurar a política de repetição ou as definições de proxy.

new EventHubProducerClient(fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential | NamedKeyCredential | SASCredential, options?: EventHubClientOptions)

Parâmetros

O nome da instância do Hub de Eventos para a qual este cliente é criado.

string eventHubName

Valor de Propriedade

O espaço de nomes completamente qualificado da instância do Hub de Eventos para a qual este cliente é criado. É provável que seja semelhante a .servicebus.windows.net.

string fullyQualifiedNamespace

Valor de Propriedade

O nome utilizado para identificar este EventHubProducerClient. Se não for especificado ou estiver vazio, será gerado um exclusivo aleatório.

identifier: string

Valor de Propriedade

Fecha a ligação AMQP à instância do Hub de Eventos, devolvendo uma promessa que será resolvida quando a interrupção da ligação for concluída.

function close(): Promise<void>

Devoluções

Promessa

Cria uma instância da EventDataBatch qual se pode adicionar eventos até atingir o tamanho máximo suportado. O lote pode ser transmitido para o método sendBatch do EventHubProducerClient a ser enviado para Hubs de Eventos do Azure.

Os eventos com valores diferentes para partitionKey ou partitionId terão de ser colocados em diferentes lotes. Para simplificar essa gestão de lotes entre partições ou para que o cliente crie automaticamente eventos em lote e os envie em intervalos específicos, utilize EventHubBufferedProducerClient em alternativa.

O exemplo abaixo pressupõe que tem à mão uma matriz de eventos para serem agrupados em segurança. Se tiver eventos a chegar um a um, recomenda-se, em vez disso, EventHubBufferedProducerClient uma gestão eficiente de lotes.

Utilização de exemplo:

const client = new EventHubProducerClient(connectionString);
let batch = await client.createBatch();
for (let i = 0; i < messages.length; i++) {
 if (!batch.tryAdd(messages[i])) {
   await client.sendBatch(batch);
   batch = await client.createBatch();
   if (!batch.tryAdd(messages[i])) {
     throw new Error("Message too big to fit")
   }
   if (i === messages.length - 1) {
     await client.sendBatch(batch);
   }
  }
}

function createBatch(options?: CreateBatchOptions): Promise<EventDataBatch>

Parâmetros

Devoluções

Promessa

Fornece as informações de runtime do Hub de Eventos.

function getEventHubProperties(options?: GetEventHubPropertiesOptions): Promise<EventHubProperties>

Parâmetros

Devoluções

Uma promessa que é resolvida com informações sobre a instância do Hub de Eventos.

Fornece o ID para cada partição associada ao Hub de Eventos.

function getPartitionIds(options?: GetPartitionIdsOptions): Promise<string[]>

Parâmetros

Devoluções

Uma promessa que é resolvida com uma Matriz de cadeias que representa o ID de cada partição associada ao Hub de Eventos.

Fornece informações sobre o estado da partição especificada.

function getPartitionProperties(partitionId: string, options?: GetPartitionPropertiesOptions): Promise<PartitionProperties>

Parâmetros

Devoluções

Uma promessa que é resolvida com informações sobre o estado da partição .

Envia um lote de eventos criados com EventHubProducerClient.createBatch() para o Hub de Eventos associado.

Os eventos com valores diferentes para partitionKey ou partitionId terão de ser colocados em diferentes lotes. Para simplificar essa gestão de lotes entre partições ou para que o cliente crie automaticamente eventos em lote e os envie em intervalos específicos, utilize EventHubBufferedProducerClient em alternativa.

O exemplo abaixo pressupõe que tem à mão uma matriz de eventos para serem agrupados em segurança. Se tiver eventos a chegar um a um, recomenda-se, em vez disso, EventHubBufferedProducerClient uma gestão eficiente de lotes.

Utilização de exemplo:

const client = new EventHubProducerClient(connectionString);
let batch = await client.createBatch();
for (let i = 0; i < messages.length; i++) {
 if (!batch.tryAdd(messages[i])) {
   await client.sendBatch(batch);
   batch = await client.createBatch();
   if (!batch.tryAdd(messages[i])) {
     throw new Error("Message too big to fit")
   }
   if (i === messages.length - 1) {
     await client.sendBatch(batch);
   }
  }
}

function sendBatch(batch: EventDataBatch, options?: OperationOptions): Promise<void>

Parâmetros

Devoluções

Promessa

Envia uma matriz de eventos como um lote para o Hub de Eventos associado.

Hubs de Eventos do Azure tem um limite no tamanho do lote que pode ser enviado, o que, se for excedido, resultará num erro com o código MessageTooLargeError. Para enviar com segurança dentro dos limites de tamanho do lote, utilize EventHubProducerClient.createBatch() ou EventHubBufferedProducerClient em alternativa.

Utilização de exemplo:

const client = new EventHubProducerClient(connectionString);
await client.sendBatch(messages);

function sendBatch(batch: EventData[] | AmqpAnnotatedMessage[], options?: SendBatchOptions): Promise<void>

Parâmetros

Devoluções

Promessa