EventGridReceiverClient class
Event Grid 名前空間クライアント
コンストラクター
| Event |
Azure Messaging EventGrid クライアント |
メソッド
| acknowledge |
クラウド イベントのバッチを確認します。 少なくとも 1 つのイベントが正常に確認されると、サーバーは HTTP 200 状態コードで応答します。 応答本文には、正常に確認された lockToken のセットと、対応するエラー情報を含む他の失敗した lockToken が含まれます。 正常に確認されたイベントは、コンシューマーが使用できなくなります。 |
| receive |
イベント サブスクリプションからクラウド イベントのバッチを受信します。 |
| reject |
クラウド イベントのバッチを拒否します。 |
| release |
クラウド イベントのリリース バッチ。 少なくとも 1 つのイベントが正常に解放されると、サーバーは HTTP 200 状態コードで応答します。 応答本文には、正常に解放された lockToken のセットと、対応するエラー情報を含む他の失敗した lockToken が含まれます。 |
| renew |
クラウド イベントのバッチのロックを更新します。 |
コンストラクターの詳細
EventGridReceiverClient(string, AzureKeyCredential | TokenCredential, string, string, EventGridReceiverClientOptions)
Azure Messaging EventGrid クライアント
new EventGridReceiverClient(endpoint: string, credential: AzureKeyCredential | TokenCredential, topicName: string, subscriptionName: string, options?: EventGridReceiverClientOptions)パラメーター
- endpoint
-
string
- credential
- topicName
-
string
- subscriptionName
-
string
- options
- EventGridReceiverClientOptions
メソッドの詳細
acknowledgeEvents(string[], AcknowledgeEventsOptions)
クラウド イベントのバッチを確認します。 少なくとも 1 つのイベントが正常に確認されると、サーバーは HTTP 200 状態コードで応答します。 応答本文には、正常に確認された lockToken のセットと、対応するエラー情報を含む他の失敗した lockToken が含まれます。 正常に確認されたイベントは、コンシューマーが使用できなくなります。
function acknowledgeEvents(lockTokens: string[], options?: AcknowledgeEventsOptions): Promise<AcknowledgeResult>パラメーター
- lockTokens
-
string[]
ロック トークン
- options
- AcknowledgeEventsOptions
確認するオプション
戻り値
Promise<AcknowledgeResult>
receiveEvents<T>(ReceiveEventsOptions)
イベント サブスクリプションからクラウド イベントのバッチを受信します。
function receiveEvents<T>(options?: ReceiveEventsOptions): Promise<ReceiveResult<T>>パラメーター
- options
- ReceiveEventsOptions
受け取るオプション
戻り値
Promise<ReceiveResult<T>>
rejectEvents(string[], RejectEventsOptions)
クラウド イベントのバッチを拒否します。
function rejectEvents(lockTokens: string[], options?: RejectEventsOptions): Promise<RejectResult>パラメーター
- lockTokens
-
string[]
ロック トークン
- options
- RejectEventsOptions
拒否するオプション
戻り値
Promise<RejectResult>
releaseEvents(string[], ReleaseEventsOptions)
クラウド イベントのリリース バッチ。 少なくとも 1 つのイベントが正常に解放されると、サーバーは HTTP 200 状態コードで応答します。 応答本文には、正常に解放された lockToken のセットと、対応するエラー情報を含む他の失敗した lockToken が含まれます。
function releaseEvents(lockTokens: string[], options?: ReleaseEventsOptions): Promise<ReleaseResult>パラメーター
- lockTokens
-
string[]
ロック トークン
- options
- ReleaseEventsOptions
リリースするオプション
戻り値
Promise<ReleaseResult>
renewEventLocks(string[], RenewEventLocksOptions)
クラウド イベントのバッチのロックを更新します。
function renewEventLocks(lockTokens: string[], options?: RenewEventLocksOptions): Promise<RenewLocksResult>パラメーター
- lockTokens
-
string[]
ロック トークン
- options
- RenewEventLocksOptions
更新するオプション
戻り値
Promise<RenewLocksResult>