ServiceBusOptions クラス

定義

名前空間:

Microsoft.Azure.WebJobs.ServiceBus

アセンブリ:

Microsoft.Azure.WebJobs.Extensions.ServiceBus.dll

パッケージ:

Microsoft.Azure.WebJobs.Extensions.ServiceBus v5.16.1

ソース:

ServiceBusOptions.cs

ServiceBus 拡張機能の構成オプション。

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

type ServiceBusOptions = class
    interface IOptionsFormatter

Public Class ServiceBusOptions
Implements IOptionsFormatter

継承

Object

ServiceBusOptions

実装

Microsoft.Azure.WebJobs.Hosting.IOptionsFormatter

コンストラクター

ServiceBusOptions()

新しいインスタンスを構築します。

プロパティ

AutoCompleteMessages	関数の正常な実行後にメッセージを自動的に完了するかどうかを取得または設定します。 既定値は、true です。
ClientRetryOptions	失敗した操作を再試行する必要があるかどうかを判断するために使用するオプションのセット。再試行する必要がある場合は、再試行の間に待機する時間です。 これらのオプションは、メッセージの受信やその他の Service Bus サービスとの対話に許容される時間も制御します。
EnableCrossEntityTransactions	トランザクションが複数の Service Bus エンティティにまたがるかどうかを示すフラグを取得または設定します。
JsonSerializerSettings	POCO にバインドするときに使用する JSON シリアル化設定を取得または設定します。
MaxAutoLockRenewalDuration	ロックが自動的に更新される最大期間を取得または設定します。 この値は、最も長いメッセージ ロック期間を超える必要があります。たとえば、LockDuration プロパティです。 既定値は［5 分］です。 これは、メッセージのバッチを受信する関数には適用されません。 無限継続時間を指定するには、host.json を使用して を指定する場合は、-00:00:00.0010000 を使用InfiniteTimeSpanします。
MaxBatchWaitTime	関数を呼び出す前に、トリガーがバッチの入力を待機する最大時間を取得または設定します。 これは、 が 1 より大きく設定されていて、それ以外の場合は使用されていない場合 MinMessageBatchSize にのみ考慮されます。 待機時間が経過する前に使用可能なメッセージより MinMessageBatchSize 小さい場合、関数は部分的なバッチで呼び出されます。 この値は、エンティティ メッセージ ロック期間の 50% ではなくなります。 したがって、許容される最大値は 2 分 30 秒です。 それ以外の場合は、メッセージがキャッシュからプルされるときにロック例外が発生する可能性があります。 既定値は 30 秒です。
MaxConcurrentCalls	関数によって同時に処理できるメッセージの最大数を取得または設定します。 この設定は、メッセージのバッチを受信する関数には適用されません。 既定値は、 の戻り値の Microsoft.Azure.WebJobs.ServiceBus.Utility.GetProcessorCount16 倍です。 が true の場合 Microsoft.Azure.WebJobs.Host.Scale.ConcurrencyOptions.DynamicConcurrencyEnabled 、この値は無視され、コンカレンシーは動的に増減されます。
MaxConcurrentCallsPerSession	セッションごとの関数の同時呼び出しの最大数を取得または設定します。 したがって、同時呼び出しの合計数は MaxConcurrentSessions * MaxConcurrentCallsPerSession と等しくなります。 既定値は 1 です。 これは、 に設定IsSessionsEnabledtrueされた関数にのみ適用されます。 これは、メッセージのバッチを受信する関数には適用されません。 が true の場合 Microsoft.Azure.WebJobs.Host.Scale.ConcurrencyOptions.DynamicConcurrencyEnabled 、この値は無視され、コンカレンシーは動的に増減されます。
MaxConcurrentSessions	関数によって同時に処理できるセッションの最大数を取得または設定します。 既定値は 8 です。 これは、 に設定IsSessionsEnabledtrueされた関数にのみ適用されます。 これは、メッセージのバッチを受信する関数には適用されません。 が true の場合 Microsoft.Azure.WebJobs.Host.Scale.ConcurrencyOptions.DynamicConcurrencyEnabled 、この値は無視され、コンカレンシーは動的に増減されます。
MaxMessageBatchSize	各関数呼び出しに渡されるメッセージの最大数を取得または設定します。 これは、メッセージをバッチで受け取る関数にのみ適用されます。 既定値は 1000 です。
MinMessageBatchSize	バッチに必要なメッセージの最小数を取得または設定します。 この設定は、複数のメッセージを受信する関数にのみ適用されます。 この値は より MaxMessageBatchSize 小さくする必要があり、 と組み合わせて MaxBatchWaitTime使用されます。 パスが受け取られたよりもMinMessageBatchSize小さい場合MaxBatchWaitTime、関数は部分バッチで呼び出されます。 既定値は 1。
PrefetchCount	メッセージの受信時に使用される PrefetchCount を取得または設定します。 既定値は 0 です。
ProcessErrorAsync	メッセージの処理中に例外が発生した場合に呼び出されるオプションのエラー ハンドラーを取得または設定します。 これは、メッセージのバッチを受信する関数には適用されません。
SessionClosingAsync	セッションが処理のために閉じようとしているときに通知されるように設定できるオプションのハンドラー。
SessionIdleTimeout	現在アクティブなセッションのメッセージの受信を待機する最大時間を取得または設定します。 この時間が経過すると、プロセッサのセッションが終了し、別のセッションの処理が試みられます。 指定しない場合は、 が TryTimeout 使用されます。
SessionInitializingAsync	新しいセッションが処理されるときに通知されるように設定できるオプションのハンドラー。
TransportType	Service Bus サービスとの通信に使用されるプロトコルとトランスポートの種類。
WebProxy	Web ソケット経由の通信に使用するプロキシ。

明示的なインターフェイスの実装

IOptionsFormatter.Format()

オプションを表示用の JSON オブジェクトとして書式設定します。