SubscribeOptions interface

Paket:

@azure/event-hubs

Optionen zum Konfigurieren der subscribe -Methode für .EventHubConsumerClient Zum Beispiel, { maxBatchSize: 20, maxWaitTimeInSeconds: 120, startPosition: { sequenceNumber: 123 } }

Eigenschaften

maxBatchSize	Die Anzahl von Ereignissen, die pro Batch angefordert werden sollen.
maxWaitTimeInSeconds	Die maximale Zeit, die auf das Erstellen der angeforderten Nachrichtenanzahl gewartet werden muss, bevor die Daten zur Verarbeitung an Den Benutzercode übergeben werden. Wenn nicht angegeben, beträgt die Standardeinstellung 60 Sekunden.
ownerLevel	Die Besitzerebene, die verwendet werden soll, wenn dieses Abonnement Partitionen abonniert.
prefetchCount	Die Anzahl der Ereignisse, die eifrig angefordert und in die Warteschlange gestellt wurden, ohne zu berücksichtigen, ob ein Lesevorgang angefordert wurde.
skipParsingBodyAsJson	Option zum Deaktivieren der Ausführung von JSON.parse() auf dem Client im Nachrichtentext, wenn die Nachricht empfangen wird. Gilt nicht, wenn die Nachricht mit dem WERT oder der Sequenz des AMQP-Texttyps gesendet wurde. Verwenden Sie diese Option, wenn Sie es vorziehen, direkt mit den im Nachrichtentext vorhandenen Bytes zu arbeiten, anstatt den Client zu analysieren.
startPosition	Die Ereignisposition in einer Partition, von der ereignisse empfangen werden sollen, wenn kein Prüfpunkt gefunden wird. Übergeben Sie eine Zuordnung der Partitions-ID an die Position, wenn Sie für jede Partition eine andere Anfangsposition verwenden möchten.
tracingOptions	Optionen zum Konfigurieren der Ablaufverfolgung.
trackLastEnqueuedEventProperties	Gibt an, ob der Consumer Informationen zum letzten Ereignis in der Warteschlange auf der zugeordneten Partition anfordern und diese Informationen nachverfolgen soll, wenn Ereignisse empfangen werden. Wenn Informationen zum letzten Warteschlangenereignis der Partition nachverfolgt werden, enthält jedes vom Event Hubs-Dienst empfangene Ereignis Metadaten über die Partition, die andernfalls nicht vorhanden wäre. Dies führt zu einem geringen zusätzlichen Netzwerkbandbreitenverbrauch, der in der Regel ein günstiger Kompromiss ist, wenn er bei regelmäßigen Anforderungen für Partitionseigenschaften mithilfe des Event Hub-Clients berücksichtigt wird.

Details zur Eigenschaft

maxBatchSize

Die Anzahl von Ereignissen, die pro Batch angefordert werden sollen.

maxBatchSize?: number

Eigenschaftswert

number

maxWaitTimeInSeconds

Die maximale Zeit, die auf das Erstellen der angeforderten Nachrichtenanzahl gewartet werden muss, bevor die Daten zur Verarbeitung an Den Benutzercode übergeben werden. Wenn nicht angegeben, beträgt die Standardeinstellung 60 Sekunden.

maxWaitTimeInSeconds?: number

Eigenschaftswert

number

ownerLevel

Die Besitzerebene, die verwendet werden soll, wenn dieses Abonnement Partitionen abonniert.

ownerLevel?: number

Eigenschaftswert

number

prefetchCount

Die Anzahl der Ereignisse, die eifrig angefordert und in die Warteschlange gestellt wurden, ohne zu berücksichtigen, ob ein Lesevorgang angefordert wurde.

prefetchCount?: number

Eigenschaftswert

number

skipParsingBodyAsJson

Option zum Deaktivieren der Ausführung von JSON.parse() auf dem Client im Nachrichtentext, wenn die Nachricht empfangen wird. Gilt nicht, wenn die Nachricht mit dem WERT oder der Sequenz des AMQP-Texttyps gesendet wurde. Verwenden Sie diese Option, wenn Sie es vorziehen, direkt mit den im Nachrichtentext vorhandenen Bytes zu arbeiten, anstatt den Client zu analysieren.

skipParsingBodyAsJson?: boolean

Eigenschaftswert

boolean

startPosition

Die Ereignisposition in einer Partition, von der ereignisse empfangen werden sollen, wenn kein Prüfpunkt gefunden wird. Übergeben Sie eine Zuordnung der Partitions-ID an die Position, wenn Sie für jede Partition eine andere Anfangsposition verwenden möchten.

startPosition?: EventPosition | {[partitionId: string]: EventPosition}

Eigenschaftswert

EventPosition | {[partitionId: string]: EventPosition}

tracingOptions

Optionen zum Konfigurieren der Ablaufverfolgung.

tracingOptions?: OperationTracingOptions

Eigenschaftswert

OperationTracingOptions

trackLastEnqueuedEventProperties

Gibt an, ob der Consumer Informationen zum letzten Ereignis in der Warteschlange auf der zugeordneten Partition anfordern und diese Informationen nachverfolgen soll, wenn Ereignisse empfangen werden.

Wenn Informationen zum letzten Warteschlangenereignis der Partition nachverfolgt werden, enthält jedes vom Event Hubs-Dienst empfangene Ereignis Metadaten über die Partition, die andernfalls nicht vorhanden wäre. Dies führt zu einem geringen zusätzlichen Netzwerkbandbreitenverbrauch, der in der Regel ein günstiger Kompromiss ist, wenn er bei regelmäßigen Anforderungen für Partitionseigenschaften mithilfe des Event Hub-Clients berücksichtigt wird.

trackLastEnqueuedEventProperties?: boolean

Eigenschaftswert

boolean