ReceiveEventsOptionalParams interface

パッケージ:

@azure/eventgrid-namespaces

すべての操作の基本オプションの種類。

Extends

OperationOptions

プロパティ

maxEvents	受信する最大イベント数。 最小値は 1、最大値は 100 イベントです。 指定しない場合は、既定値は 1 です。
maxWaitTime	受信操作の最大待機時間の値 (秒単位)。 サーバーがイベントの可用性をほぼ待機し、要求に応答する時間 (秒) です。 イベントが使用可能な場合、ブローカーはクライアントに直ちに応答します。 最小値は 10 秒で、最大値は 120 秒です。 指定しない場合、既定値は 60 秒です。

継承されたプロパティ

abortSignal	要求を中止するために使用できるシグナル。
onResponse	要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。
requestOptions	この操作の HTTP 要求を作成および送信するときに使用されるオプション。
tracingOptions	トレースが有効な場合に使用されるオプション。

プロパティの詳細

maxEvents

受信する最大イベント数。 最小値は 1、最大値は 100 イベントです。 指定しない場合は、既定値は 1 です。

maxEvents?: number

プロパティ値

number

maxWaitTime

受信操作の最大待機時間の値 (秒単位)。 サーバーがイベントの可用性をほぼ待機し、要求に応答する時間 (秒) です。 イベントが使用可能な場合、ブローカーはクライアントに直ちに応答します。 最小値は 10 秒で、最大値は 120 秒です。 指定しない場合、既定値は 60 秒です。

maxWaitTime?: number

プロパティ値

number

継承されたプロパティの詳細

abortSignal

要求を中止するために使用できるシグナル。

abortSignal?: AbortSignalLike

プロパティ値

AbortSignalLike

OperationOptions.abortSignalから継承

onResponse

要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。

onResponse?: RawResponseCallback

プロパティ値

RawResponseCallback

継承元OperationOptions.onResponse

requestOptions

この操作の HTTP 要求を作成および送信するときに使用されるオプション。

requestOptions?: OperationRequestOptions

プロパティ値

OperationRequestOptions

継承元OperationOptions.requestOptions

tracingOptions

トレースが有効な場合に使用されるオプション。

tracingOptions?: OperationTracingOptions

プロパティ値

OperationTracingOptions

OperationOptions.tracingOptionsから継承