ServiceBusOptions Klasse

Definition

Namespace:

Microsoft.Azure.WebJobs.ServiceBus

Assembly:

Microsoft.Azure.WebJobs.Extensions.ServiceBus.dll

Paket:

Microsoft.Azure.WebJobs.Extensions.ServiceBus v5.16.5

Quelle:

ServiceBusOptions.cs

Konfigurationsoptionen für die ServiceBus-Erweiterung.

public class ServiceBusOptions : Microsoft.Azure.WebJobs.Hosting.IOptionsFormatter

type ServiceBusOptions = class
    interface IOptionsFormatter

Public Class ServiceBusOptions
Implements IOptionsFormatter

Vererbung

Object

ServiceBusOptions

Implementiert

Microsoft.Azure.WebJobs.Hosting.IOptionsFormatter

Konstruktoren

ServiceBusOptions()

Erstellt eine neue instance.

Eigenschaften

AutoCompleteMessages	Ruft ab oder legt fest, ob Nachrichten nach erfolgreicher Ausführung der Funktion automatisch abgeschlossen werden sollen. Der Standardwert lautet „true“.
ClientRetryOptions	Der Satz von Optionen, die verwendet werden sollen, um zu bestimmen, ob ein fehlgeschlagener Vorgang wiederholt werden soll, und, falls ja, die Zeitspanne, die zwischen Wiederholungsversuchen gewartet werden muss. Diese Optionen steuern auch die Zeit, die für den Empfang von Nachrichten und anderen Interaktionen mit dem Service Bus-Dienst zulässig ist.
EnableCrossEntityTransactions	Ruft ein Flag ab, das angibt, ob Transaktionen mehrere Service Bus-Entitäten umfassen oder nicht, oder legt es fest.
JsonSerializerSettings	Ruft die JSON-Serialisierungseinstellungen ab, die beim Binden an POCOs verwendet werden sollen, oder legt diese fest.
MaxAutoLockRenewalDuration	Ruft die maximale Dauer ab, innerhalb der die Sperre automatisch verlängert wird, oder legt diese fest. Dieser Wert sollte größer als die längste Dauer der Nachrichtensperre sein. beispielsweise die LockDuration-Eigenschaft. Der Standardwert beträgt 5 Minuten. Dies gilt nicht für Funktionen, die einen Batch von Nachrichten empfangen. Um eine unendliche Dauer anzugeben, verwenden Sie InfiniteTimeSpan oder -00:00:00.0010000 , wenn Sie über host.json angeben.
MaxBatchWaitTime	Ruft die maximale Zeit ab, die der Trigger warten soll, um einen Batch auszufüllen, bevor die Funktion aufgerufen wird, oder legt diese fest. Dies wird nur berücksichtigt, wenn MinMessageBatchSize auf größer als 1 festgelegt und andernfalls nicht verwendet wird. Wenn weniger als MinMessageBatchSize Nachrichten verfügbar waren, bevor die Wartezeit verstrichen ist, wird die Funktion mit einem Teilbatch aufgerufen. Dieser Wert sollte nicht mehr 50 % der Dauer der Entitätsnachrichtensperre betragen. Daher beträgt der maximal zulässige Wert 2 Minuten und 30 Sekunden. Andernfalls erhalten Sie möglicherweise Sperrausnahmen, wenn Nachrichten aus dem Cache abgerufen werden. Der Standardwert ist 30 Sekunden.
MaxConcurrentCalls	Ruft die maximale Anzahl von Nachrichten ab, die gleichzeitig von einer Funktion verarbeitet werden können, oder legt diese fest. Diese Einstellung gilt nicht für Funktionen, die einen Batch von Nachrichten empfangen. Der Standardwert ist das 16-fache des Rückgabewerts von Microsoft.Azure.WebJobs.ServiceBus.Utility.GetProcessorCount. Wenn Microsoft.Azure.WebJobs.Host.Scale.ConcurrencyOptions.DynamicConcurrencyEnabled true ist, wird dieser Wert ignoriert, und die Parallelität wird dynamisch erhöht/verringert.
MaxConcurrentCallsPerSession	Ruft die maximale Anzahl gleichzeitiger Aufrufe der Funktion pro Sitzung ab oder legt diese fest. Daher entspricht die Gesamtanzahl gleichzeitiger Anrufe MaxConcurrentSessions * MaxConcurrentCallsPerSession. Der Standardwert ist 1. Dies gilt nur für Funktionen, die auf festgelegt IsSessionsEnabled sind true. Dies gilt nicht für Funktionen, die einen Batch von Nachrichten empfangen. Wenn Microsoft.Azure.WebJobs.Host.Scale.ConcurrencyOptions.DynamicConcurrencyEnabled true ist, wird dieser Wert ignoriert, und die Parallelität wird dynamisch erhöht/verringert.
MaxConcurrentSessions	Ruft die maximale Anzahl von Sitzungen ab, die gleichzeitig von einer Funktion verarbeitet werden können, oder legt diese fest. Der Standardwert ist 8. Dies gilt nur für Funktionen, die auf festgelegt IsSessionsEnabled sind true. Dies gilt nicht für Funktionen, die einen Batch von Nachrichten empfangen. Wenn Microsoft.Azure.WebJobs.Host.Scale.ConcurrencyOptions.DynamicConcurrencyEnabled true ist, wird dieser Wert ignoriert, und die Parallelität wird dynamisch erhöht/verringert.
MaxMessageBatchSize	Ruft die maximale Anzahl von Nachrichten ab, die an jeden Funktionsaufruf übergeben werden, oder legt diese fest. Dies gilt nur für Funktionen, die einen Nachrichtenbatch empfangen. Der Standardwert lautet „1000“.
MinMessageBatchSize	Ruft die Mindestanzahl von Nachrichten ab, die für einen Batch gewünscht werden sollen, oder legt diese fest. Diese Einstellung gilt nur für Funktionen, die mehrere Nachrichten empfangen. Dieser Wert muss kleiner als MaxMessageBatchSize sein und wird in Verbindung mit MaxBatchWaitTimeverwendet. Wenn MaxBatchWaitTime Läufe und weniger als MinMessageBatchSize empfangen wurden, wird die Funktion mit einem Teilbatch aufgerufen. Standard 1.
PrefetchCount	Ruft den PrefetchCount ab, der beim Empfangen von Nachrichten verwendet wird, oder legt diesen fest. Der Standardwert ist 0.
ProcessErrorAsync	Ruft einen optionalen Fehlerhandler ab, der aufgerufen wird, wenn beim Versuch, eine Nachricht zu verarbeiten, eine Ausnahme auftritt, oder legt diesen fest. Dies gilt nicht für Funktionen, die einen Batch von Nachrichten empfangen.
SessionClosingAsync	Optionaler Handler, der so festgelegt werden kann, dass er benachrichtigt wird, wenn eine Sitzung für die Verarbeitung geschlossen werden soll.
SessionIdleTimeout	Ruft die maximale Wartezeit ab, bis eine Nachricht für die aktuell aktive Sitzung empfangen wird, oder legt diese fest. Nach Ablauf dieser Zeit schließt der Prozessor die Sitzung, und versucht, eine weitere Sitzung zu verarbeiten. Falls nicht angegeben, wird der TryTimeout verwendet.
SessionInitializingAsync	Optionaler Handler, der so festgelegt werden kann, dass er benachrichtigt wird, wenn eine neue Sitzung verarbeitet werden soll.
TransportType	Der Protokoll- und Transporttyp, der für die Kommunikation mit dem Service Bus-Dienst verwendet wird.
WebProxy	Der Proxy, der für die Kommunikation über Websockets verwendet werden soll.

Explizite Schnittstellenimplementierungen

IOptionsFormatter.Format()

Formatiert die Optionen als JSON-Objekte zur Anzeige.