Condividi tramite


EventHubConsumerClient class

La EventHubConsumerClient classe viene usata per utilizzare gli eventi da un hub eventi.

Esistono più modi per creare un oggetto EventHubConsumerClient

  • Usare la stringa di connessione dal criterio sas creato per l'istanza di Hub eventi.
  • Usare la stringa di connessione dal criterio sas creato per lo spazio dei nomi dell'hub eventi e il nome dell'istanza di Hub eventi
  • Usare lo spazio dei nomi completo, ad esempio <yournamespace>.servicebus.windows.net, e un oggetto credenziali.

Facoltativamente, è anche possibile passare:

  • Un contenitore di opzioni per configurare i criteri di ripetizione dei tentativi o le impostazioni proxy.
  • Archivio checkpoint utilizzato dal client per leggere i checkpoint per determinare la posizione da cui deve riprendere la ricezione di eventi quando l'applicazione viene riavviata. L'archivio checkpoint viene usato anche dal client per bilanciare il carico di più istanze dell'applicazione.

Costruttori

EventHubConsumerClient(string, string, CheckpointStore, EventHubConsumerClientOptions)

La EventHubConsumerClient classe viene usata per utilizzare gli eventi da un hub eventi. Usare il parmeter per configurare i options criteri di ripetizione dei tentativi o le impostazioni proxy.

EventHubConsumerClient(string, string, EventHubConsumerClientOptions)

La EventHubConsumerClient classe viene usata per utilizzare gli eventi da un hub eventi. Usare il parmeter per configurare i options criteri di ripetizione dei tentativi o le impostazioni proxy.

EventHubConsumerClient(string, string, string, CheckpointStore, EventHubConsumerClientOptions)

La EventHubConsumerClient classe viene usata per utilizzare gli eventi da un hub eventi. Usare il parmeter per configurare i options criteri di ripetizione dei tentativi o le impostazioni proxy.

EventHubConsumerClient(string, string, string, EventHubConsumerClientOptions)

La EventHubConsumerClient classe viene usata per utilizzare gli eventi da un hub eventi. Usare il parmeter per configurare i options criteri di ripetizione dei tentativi o le impostazioni proxy.

EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, CheckpointStore, EventHubConsumerClientOptions)

La EventHubConsumerClient classe viene usata per utilizzare gli eventi da un hub eventi. Usare il parmeter per configurare i options criteri di ripetizione dei tentativi o le impostazioni proxy.

EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, EventHubConsumerClientOptions)

La EventHubConsumerClient classe viene usata per utilizzare gli eventi da un hub eventi. Usare il parmeter per configurare i options criteri di ripetizione dei tentativi o le impostazioni proxy.

Proprietà

defaultConsumerGroupName

Nome del gruppo consumer predefinito nel servizio Hub eventi.

eventHubName

Nome dell'istanza di Hub eventi per cui viene creato il client.

fullyQualifiedNamespace

Spazio dei nomi completo dell'istanza di Hub eventi per cui viene creato il client. È probabile che sia simile a .servicebus.windows.net.

identifier

Nome utilizzato per identificare questo oggetto EventHubConsumerClient. Se non specificato o vuoto, verrà generato un univoco casuale.

Metodi

close()

Chiude la connessione AMQP all'istanza dell'hub eventi, restituendo una promessa che verrà risolta al termine della disconnessione.

getEventHubProperties(GetEventHubPropertiesOptions)

Fornisce le informazioni di runtime dell'hub eventi.

getPartitionIds(GetPartitionIdsOptions)

Fornisce l'ID per ogni partizione associata all'hub eventi.

getPartitionProperties(string, GetPartitionPropertiesOptions)

Fornisce informazioni sullo stato della partizione specificata.

subscribe(string, SubscriptionEventHandlers, SubscribeOptions)

Sottoscrivere eventi da una singola partizione. Chiamare close() nell'oggetto restituito per arrestare la ricezione di eventi.

Esempio di utilizzo:

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 }
);
subscribe(SubscriptionEventHandlers, SubscribeOptions)

Sottoscrivere eventi da tutte le partizioni.

Se l'archivio checkpoint viene fornito all'oggetto EventHubConsumerClient e sono presenti più istanze dell'applicazione, ogni istanza sottoscriverà un subset delle partizioni in modo che il carico sia bilanciato tra di essi.

Chiamare close() nell'oggetto restituito per arrestare la ricezione di eventi.

Esempio di utilizzo:

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 }
);

Dettagli costruttore

EventHubConsumerClient(string, string, CheckpointStore, EventHubConsumerClientOptions)

La EventHubConsumerClient classe viene usata per utilizzare gli eventi da un hub eventi. Usare il parmeter per configurare i options criteri di ripetizione dei tentativi o le impostazioni proxy.

new EventHubConsumerClient(consumerGroup: string, connectionString: string, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)

Parametri

consumerGroup

string

Nome del gruppo consumer da cui si desidera elaborare gli eventi.

connectionString

string

Stringa di connessione da usare per la connessione all'istanza di Hub eventi. Si prevede che le proprietà della chiave condivisa e il percorso dell'hub eventi siano contenuti in questa stringa di connessione. Ad esempio, 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key; EntityPath=my-event-hub-name'.

checkpointStore
CheckpointStore

Archivio checkpoint utilizzato dal client per leggere i checkpoint per determinare la posizione da cui deve riprendere la ricezione di eventi quando l'applicazione viene riavviata. Viene usato anche dal client per bilanciare il carico di più istanze dell'applicazione.

options
EventHubConsumerClientOptions

Set di opzioni da applicare durante la configurazione del client.

  • retryOptions : configura i criteri di ripetizione dei tentativi per tutte le operazioni nel client. Ad esempio, { "maxRetries": 4 } o { "maxRetries": 4, "retryDelayInMs": 30000 }.
  • webSocketOptions: configura il canale della connessione AMQP su Web Sockets.
  • userAgent : stringa da aggiungere alla stringa predefinita dell'agente utente passata al servizio.

EventHubConsumerClient(string, string, EventHubConsumerClientOptions)

La EventHubConsumerClient classe viene usata per utilizzare gli eventi da un hub eventi. Usare il parmeter per configurare i options criteri di ripetizione dei tentativi o le impostazioni proxy.

new EventHubConsumerClient(consumerGroup: string, connectionString: string, options?: EventHubConsumerClientOptions)

Parametri

consumerGroup

string

Nome del gruppo consumer da cui si desidera elaborare gli eventi.

connectionString

string

Stringa di connessione da usare per la connessione all'istanza di Hub eventi. Si prevede che le proprietà della chiave condivisa e il percorso dell'hub eventi siano contenuti in questa stringa di connessione. Ad esempio, 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key; EntityPath=my-event-hub-name'.

options
EventHubConsumerClientOptions

Set di opzioni da applicare durante la configurazione del client.

  • retryOptions : configura i criteri di ripetizione dei tentativi per tutte le operazioni nel client. Ad esempio, { "maxRetries": 4 } o { "maxRetries": 4, "retryDelayInMs": 30000 }.
  • webSocketOptions: configura il canale della connessione AMQP su Web Sockets.
  • userAgent : stringa da aggiungere alla stringa predefinita dell'agente utente passata al servizio.

EventHubConsumerClient(string, string, string, CheckpointStore, EventHubConsumerClientOptions)

La EventHubConsumerClient classe viene usata per utilizzare gli eventi da un hub eventi. Usare il parmeter per configurare i options criteri di ripetizione dei tentativi o le impostazioni proxy.

new EventHubConsumerClient(consumerGroup: string, connectionString: string, eventHubName: string, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)

Parametri

consumerGroup

string

Nome del gruppo consumer da cui si desidera elaborare gli eventi.

connectionString

string

Stringa di connessione da usare per la connessione allo spazio dei nomi hub eventi. Si prevede che le proprietà della chiave condivisa siano contenute in questa stringa di connessione, ma non il percorso dell'hub eventi, ad esempio 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key;'.

eventHubName

string

Nome dell'hub eventi specifico a cui connettere il client.

checkpointStore
CheckpointStore

Archivio checkpoint utilizzato dal client per leggere i checkpoint per determinare la posizione da cui deve riprendere la ricezione di eventi quando l'applicazione viene riavviata. Viene usato anche dal client per bilanciare il carico di più istanze dell'applicazione.

options
EventHubConsumerClientOptions

Set di opzioni da applicare durante la configurazione del client.

  • retryOptions : configura i criteri di ripetizione dei tentativi per tutte le operazioni nel client. Ad esempio, { "maxRetries": 4 } o { "maxRetries": 4, "retryDelayInMs": 30000 }.
  • webSocketOptions: configura il canale della connessione AMQP su Web Sockets.
  • userAgent : stringa da aggiungere alla stringa predefinita dell'agente utente passata al servizio.

EventHubConsumerClient(string, string, string, EventHubConsumerClientOptions)

La EventHubConsumerClient classe viene usata per utilizzare gli eventi da un hub eventi. Usare il parmeter per configurare i options criteri di ripetizione dei tentativi o le impostazioni proxy.

new EventHubConsumerClient(consumerGroup: string, connectionString: string, eventHubName: string, options?: EventHubConsumerClientOptions)

Parametri

consumerGroup

string

Nome del gruppo consumer da cui si desidera elaborare gli eventi.

connectionString

string

Stringa di connessione da usare per la connessione allo spazio dei nomi hub eventi. Si prevede che le proprietà della chiave condivisa siano contenute in questa stringa di connessione, ma non il percorso dell'hub eventi, ad esempio 'Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/;SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key;'.

eventHubName

string

Nome dell'hub eventi specifico a cui connettere il client.

options
EventHubConsumerClientOptions

Set di opzioni da applicare durante la configurazione del client.

  • retryOptions : configura i criteri di ripetizione dei tentativi per tutte le operazioni nel client. Ad esempio, { "maxRetries": 4 } o { "maxRetries": 4, "retryDelayInMs": 30000 }.
  • webSocketOptions: configura il canale della connessione AMQP su Web Sockets.
  • userAgent : stringa da aggiungere alla stringa predefinita dell'agente utente passata al servizio.

EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, CheckpointStore, EventHubConsumerClientOptions)

La EventHubConsumerClient classe viene usata per utilizzare gli eventi da un hub eventi. Usare il parmeter per configurare i options criteri di ripetizione dei tentativi o le impostazioni proxy.

new EventHubConsumerClient(consumerGroup: string, fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential | NamedKeyCredential | SASCredential, checkpointStore: CheckpointStore, options?: EventHubConsumerClientOptions)

Parametri

consumerGroup

string

Nome del gruppo consumer da cui si desidera elaborare gli eventi.

fullyQualifiedNamespace

string

Spazio dei nomi completo che probabilmente è simile a .servicebus.windows.net

eventHubName

string

Nome dell'hub eventi specifico a cui connettere il client.

credential

TokenCredential | NamedKeyCredential | SASCredential

Oggetto credenziale usato dal client per ottenere il token per autenticare la connessione con il servizio Hub eventi di Azure. Vedere @azure/identity per la creazione di credenziali che supportano l'autenticazione AAD. Usare l'oggetto AzureNamedKeyCredential da @azure/core-auth se si vuole passare un SharedAccessKeyName oggetto e SharedAccessKey senza usare una stringa di connessione. Questi campi vengono mappati rispettivamente al name campo e key in AzureNamedKeyCredential. Usare l'oggetto AzureSASCredential da @azure/core-auth se si vuole passare un SharedAccessSignature oggetto senza usare una stringa di connessione. Questo campo viene mappato a signature in AzureSASCredential.

checkpointStore
CheckpointStore

Archivio checkpoint utilizzato dal client per leggere i checkpoint per determinare la posizione da cui deve riprendere la ricezione di eventi quando l'applicazione viene riavviata. Viene usato anche dal client per bilanciare il carico di più istanze dell'applicazione.

options
EventHubConsumerClientOptions

Set di opzioni da applicare durante la configurazione del client.

  • retryOptions : configura i criteri di ripetizione dei tentativi per tutte le operazioni nel client. Ad esempio, { "maxRetries": 4 } o { "maxRetries": 4, "retryDelayInMs": 30000 }.
  • webSocketOptions: configura il canale della connessione AMQP su Web Sockets.
  • userAgent : stringa da aggiungere alla stringa predefinita dell'agente utente passata al servizio.

EventHubConsumerClient(string, string, string, TokenCredential | NamedKeyCredential | SASCredential, EventHubConsumerClientOptions)

La EventHubConsumerClient classe viene usata per utilizzare gli eventi da un hub eventi. Usare il parmeter per configurare i options criteri di ripetizione dei tentativi o le impostazioni proxy.

new EventHubConsumerClient(consumerGroup: string, fullyQualifiedNamespace: string, eventHubName: string, credential: TokenCredential | NamedKeyCredential | SASCredential, options?: EventHubConsumerClientOptions)

Parametri

consumerGroup

string

Nome del gruppo consumer da cui si desidera elaborare gli eventi.

fullyQualifiedNamespace

string

Spazio dei nomi completo che probabilmente è simile a .servicebus.windows.net

eventHubName

string

Nome dell'hub eventi specifico a cui connettere il client.

credential

TokenCredential | NamedKeyCredential | SASCredential

Oggetto credenziale usato dal client per ottenere il token per autenticare la connessione con il servizio Hub eventi di Azure. Vedere @azure/identity per la creazione di credenziali che supportano l'autenticazione AAD. Usare l'oggetto AzureNamedKeyCredential da @azure/core-auth se si vuole passare un SharedAccessKeyName oggetto e SharedAccessKey senza usare una stringa di connessione. Questi campi vengono mappati rispettivamente al name campo e key in AzureNamedKeyCredential. Usare l'oggetto AzureSASCredential da @azure/core-auth se si vuole passare un SharedAccessSignature oggetto senza usare una stringa di connessione. Questo campo viene mappato a signature in AzureSASCredential.

options
EventHubConsumerClientOptions

Set di opzioni da applicare durante la configurazione del client.

  • retryOptions : configura i criteri di ripetizione dei tentativi per tutte le operazioni nel client. Ad esempio, { "maxRetries": 4 } o { "maxRetries": 4, "retryDelayInMs": 30000 }.
  • webSocketOptions: configura il canale della connessione AMQP su Web Sockets.
  • userAgent : stringa da aggiungere alla stringa predefinita dell'agente utente passata al servizio.

Dettagli proprietà

defaultConsumerGroupName

Nome del gruppo consumer predefinito nel servizio Hub eventi.

static defaultConsumerGroupName: string

Valore della proprietà

string

eventHubName

Nome dell'istanza di Hub eventi per cui viene creato il client.

string eventHubName

Valore della proprietà

string

fullyQualifiedNamespace

Spazio dei nomi completo dell'istanza di Hub eventi per cui viene creato il client. È probabile che sia simile a .servicebus.windows.net.

string fullyQualifiedNamespace

Valore della proprietà

string

identifier

Nome utilizzato per identificare questo oggetto EventHubConsumerClient. Se non specificato o vuoto, verrà generato un univoco casuale.

identifier: string

Valore della proprietà

string

Dettagli metodo

close()

Chiude la connessione AMQP all'istanza dell'hub eventi, restituendo una promessa che verrà risolta al termine della disconnessione.

function close(): Promise<void>

Restituisce

Promise<void>

Promise

getEventHubProperties(GetEventHubPropertiesOptions)

Fornisce le informazioni di runtime dell'hub eventi.

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

Parametri

options
GetEventHubPropertiesOptions

Set di opzioni da applicare alla chiamata all'operazione.

Restituisce

Promessa che risolve con informazioni sull'istanza di Hub eventi.

getPartitionIds(GetPartitionIdsOptions)

Fornisce l'ID per ogni partizione associata all'hub eventi.

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

Parametri

options
GetPartitionIdsOptions

Set di opzioni da applicare alla chiamata all'operazione.

Restituisce

Promise<string[]>

Promessa che viene risolta con una matrice di stringhe che rappresentano l'ID per ogni partizione associata all'hub eventi.

getPartitionProperties(string, GetPartitionPropertiesOptions)

Fornisce informazioni sullo stato della partizione specificata.

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

Parametri

partitionId

string

ID della partizione per cui sono necessarie informazioni.

options
GetPartitionPropertiesOptions

Set di opzioni da applicare alla chiamata all'operazione.

Restituisce

Promessa che risolve con informazioni sullo stato della partizione .

subscribe(string, SubscriptionEventHandlers, SubscribeOptions)

Sottoscrivere eventi da una singola partizione. Chiamare close() nell'oggetto restituito per arrestare la ricezione di eventi.

Esempio di utilizzo:

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): Subscription

Parametri

partitionId

string

ID della partizione da sottoscrivere.

handlers
SubscriptionEventHandlers

Gestori per il ciclo di vita della sottoscrizione : inizializzazione della sottoscrizione della partizione, ricezione di eventi, gestione degli errori e chiusura di una sottoscrizione alla partizione.

options
SubscribeOptions

Configura il modo in cui vengono ricevuti gli eventi. La maggior parte comune è maxBatchSize e maxWaitTimeInSeconds controlla il flusso di eventi al gestore fornito per ricevere eventi e la posizione iniziale. Ad esempio, usare { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }

Restituisce

subscribe(SubscriptionEventHandlers, SubscribeOptions)

Sottoscrivere eventi da tutte le partizioni.

Se l'archivio checkpoint viene fornito all'oggetto EventHubConsumerClient e sono presenti più istanze dell'applicazione, ogni istanza sottoscriverà un subset delle partizioni in modo che il carico sia bilanciato tra di essi.

Chiamare close() nell'oggetto restituito per arrestare la ricezione di eventi.

Esempio di utilizzo:

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): Subscription

Parametri

handlers
SubscriptionEventHandlers

Gestori per il ciclo di vita della sottoscrizione : inizializzazione della sottoscrizione per partizione, ricezione di eventi, gestione degli errori e chiusura di una sottoscrizione per partizione.

options
SubscribeOptions

Configura il modo in cui vengono ricevuti gli eventi. La maggior parte comune è maxBatchSize e maxWaitTimeInSeconds controlla il flusso di eventi al gestore fornito per ricevere eventi e la posizione iniziale. Ad esempio, usare { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }

Restituisce