EventGridClient class

Azure Messaging EventGrid クライアント

new EventGridClient(endpoint: string, credential: AzureKeyCredential | TokenCredential, options?: EventGridClientOptions)

パラメーター

クラウド イベントのバッチを確認します。 少なくとも 1 つのイベントが正常に確認されると、サーバーは HTTP 200 状態コードで応答します。 応答本文には、正常に確認された lockToken のセットと、対応するエラー情報を含む他の失敗した lockToken が含まれます。 正常に確認されたイベントは、コンシューマーが使用できなくなります。

function acknowledgeCloudEvents(lockTokens: string[], topicName: string, eventSubscriptionName: string, options?: AcknowledgeCloudEventsOptions): Promise<AcknowledgeResult>

パラメーター

戻り値

「シングル・クラウド・イベントを名前空間に公開」トピック。 成功した場合、サーバーは HTTP 200 状態コードで応答し、応答として空の JSON オブジェクトが返されます。 それ以外の場合、サーバーはさまざまなエラー コードを返すことができます。 たとえば、401: 承認エラーを示します。403: クォータ超過またはメッセージが大きすぎることを示します。410: 特定のトピックが見つからないことを示し、400: 無効な要求の場合は 500: 内部サーバー エラーです。

function publishCloudEvent<T>(event: CloudEvent<T>, topicName: string, options?: PublishCloudEventOptions): Promise<void>

パラメーター

戻り値

Batch Cloud イベントを名前空間に公開するトピック。 成功した場合、サーバーは HTTP 200 状態コードで応答し、応答として空の JSON オブジェクトが返されます。 それ以外の場合、サーバーはさまざまなエラー コードを返すことができます。 たとえば、401: 承認エラーを示します。403: クォータ超過またはメッセージが大きすぎることを示します。410: 特定のトピックが見つからないことを示し、400: 無効な要求の場合は 500: 内部サーバー エラーです。

function publishCloudEvents<T>(events: CloudEvent<T>[], topicName: string, options?: PublishCloudEventsOptions): Promise<void>

パラメーター

戻り値

イベント サブスクリプションからクラウド イベントのバッチを受信します。

function receiveCloudEvents(topicName: string, eventSubscriptionName: string, options?: ReceiveCloudEventsOptions): Promise<ReceiveResult>

パラメーター

戻り値

クラウド イベントのバッチを拒否します。

function rejectCloudEvents(lockTokens: string[], topicName: string, eventSubscriptionName: string, options?: RejectCloudEventsOptions): Promise<RejectResult>

パラメーター

戻り値

クラウド イベントのリリース バッチ。 少なくとも 1 つのイベントが正常に解放されると、サーバーは HTTP 200 状態コードで応答します。 応答本文には、正常に解放された lockToken のセットと、対応するエラー情報を含む他の失敗した lockToken が含まれます。

function releaseCloudEvents(lockTokens: string[], topicName: string, eventSubscriptionName: string, options?: ReleaseCloudEventsOptions): Promise<ReleaseResult>

パラメーター

戻り値

クラウド イベントのバッチのロックを更新します。

function renewCloudEventLocks(lockTokens: string[], topicName: string, eventSubscriptionName: string, options?: RenewCloudEventLocksOptions): Promise<RenewCloudEventLocksResult>

パラメーター

戻り値