EventGridClient class

عميل مساحات أسماء شبكة الأحداث

المنشئون

EventGridClient(string, AzureKeyCredential | TokenCredential, EventGridClientOptions)

عميل Azure Messaging EventGrid

الأساليب

acknowledgeCloudEvents(string[], string, string, AcknowledgeCloudEventsOptions)

الاعتراف دفعة من أحداث السحابة. يستجيب الخادم برمز حالة HTTP 200 إذا تم التعرف على حدث واحد على الأقل بنجاح. سيتضمن نص الاستجابة مجموعة رموز التأمين المميزة المعترف بها بنجاح، جنبا إلى جنب مع رموز التأمين الفاشلة الأخرى مع معلومات الخطأ المقابلة لها. لن تكون الأحداث المعترف بها بنجاح متاحة لأي مستهلك.

publishCloudEvent<T>(CloudEvent<T>, string, PublishCloudEventOptions)

نشر حدث سحابة واحدة إلى موضوع مساحة الاسم. في حالة النجاح، يستجيب الخادم برمز حالة HTTP 200 مع كائن JSON فارغ استجابة لذلك. وإلا، يمكن للخادم إرجاع رموز خطأ مختلفة. على سبيل المثال، 401: الذي يشير إلى فشل التخويل، 403: الذي يشير إلى تجاوز الحصة النسبية أو الرسالة كبيرة جدا، 410: الذي يشير إلى عدم العثور على موضوع معين، و400: للطلب غير الصحيح، و500: لخطأ خادم داخلي.

publishCloudEvents<T>(CloudEvent<T>[], string, PublishCloudEventsOptions)

نشر حدث سحابة دفعة إلى موضوع مساحة الاسم. في حالة النجاح، يستجيب الخادم برمز حالة HTTP 200 مع كائن JSON فارغ استجابة لذلك. وإلا، يمكن للخادم إرجاع رموز خطأ مختلفة. على سبيل المثال، 401: الذي يشير إلى فشل التخويل، 403: الذي يشير إلى تجاوز الحصة النسبية أو الرسالة كبيرة جدا، 410: الذي يشير إلى عدم العثور على موضوع معين، و400: للطلب غير الصحيح، و500: لخطأ خادم داخلي.

receiveCloudEvents(string, string, ReceiveCloudEventsOptions)

تلقي دفعة من أحداث السحابة من اشتراك الحدث.

rejectCloudEvents(string[], string, string, RejectCloudEventsOptions)

رفض دفعة من أحداث السحابة.

releaseCloudEvents(string[], string, string, ReleaseCloudEventsOptions)

إصدار دفعة من أحداث السحابة. يستجيب الخادم برمز حالة HTTP 200 إذا تم إصدار حدث واحد على الأقل بنجاح. سيتضمن نص الاستجابة مجموعة رموز التأمين المميزة التي تم تحريرها بنجاح، جنبا إلى جنب مع رموز التأمين الفاشلة الأخرى مع معلومات الخطأ المقابلة لها.

renewCloudEventLocks(string[], string, string, RenewCloudEventLocksOptions)

تجديد التأمين لمجموعة أحداث السحابة.

تفاصيل المنشئ

EventGridClient(string, AzureKeyCredential | TokenCredential, EventGridClientOptions)

عميل Azure Messaging EventGrid

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

المعلمات

endpoint

string

تفاصيل الأسلوب

acknowledgeCloudEvents(string[], string, string, AcknowledgeCloudEventsOptions)

الاعتراف دفعة من أحداث السحابة. يستجيب الخادم برمز حالة HTTP 200 إذا تم التعرف على حدث واحد على الأقل بنجاح. سيتضمن نص الاستجابة مجموعة رموز التأمين المميزة المعترف بها بنجاح، جنبا إلى جنب مع رموز التأمين الفاشلة الأخرى مع معلومات الخطأ المقابلة لها. لن تكون الأحداث المعترف بها بنجاح متاحة لأي مستهلك.

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

المعلمات

lockTokens

string[]

تأمين الرموز المميزة

topicName

string

اسم الموضوع

eventSubscriptionName

string

اسم الاشتراك في الحدث

options
AcknowledgeCloudEventsOptions

خيارات الإقرار

المرتجعات

publishCloudEvent<T>(CloudEvent<T>, string, PublishCloudEventOptions)

نشر حدث سحابة واحدة إلى موضوع مساحة الاسم. في حالة النجاح، يستجيب الخادم برمز حالة HTTP 200 مع كائن JSON فارغ استجابة لذلك. وإلا، يمكن للخادم إرجاع رموز خطأ مختلفة. على سبيل المثال، 401: الذي يشير إلى فشل التخويل، 403: الذي يشير إلى تجاوز الحصة النسبية أو الرسالة كبيرة جدا، 410: الذي يشير إلى عدم العثور على موضوع معين، و400: للطلب غير الصحيح، و500: لخطأ خادم داخلي.

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

المعلمات

event

CloudEvent<T>

الحدث المراد نشره

topicName

string

موضوع نشر الحدث

options
PublishCloudEventOptions

خيارات النشر

المرتجعات

Promise<void>

publishCloudEvents<T>(CloudEvent<T>[], string, PublishCloudEventsOptions)

نشر حدث سحابة دفعة إلى موضوع مساحة الاسم. في حالة النجاح، يستجيب الخادم برمز حالة HTTP 200 مع كائن JSON فارغ استجابة لذلك. وإلا، يمكن للخادم إرجاع رموز خطأ مختلفة. على سبيل المثال، 401: الذي يشير إلى فشل التخويل، 403: الذي يشير إلى تجاوز الحصة النسبية أو الرسالة كبيرة جدا، 410: الذي يشير إلى عدم العثور على موضوع معين، و400: للطلب غير الصحيح، و500: لخطأ خادم داخلي.

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

المعلمات

events

CloudEvent<T>[]

الأحداث التي يجب نشرها

topicName

string

موضوع نشر الحدث

options
PublishCloudEventsOptions

خيارات النشر

المرتجعات

Promise<void>

receiveCloudEvents(string, string, ReceiveCloudEventsOptions)

تلقي دفعة من أحداث السحابة من اشتراك الحدث.

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

المعلمات

topicName

string

الموضوع المطلوب استلامه

eventSubscriptionName

string

اسم الاشتراك في الحدث

options
ReceiveCloudEventsOptions

خيارات الاستلام

المرتجعات

Promise<ReceiveResult>

rejectCloudEvents(string[], string, string, RejectCloudEventsOptions)

رفض دفعة من أحداث السحابة.

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

المعلمات

lockTokens

string[]

تأمين الرموز المميزة

topicName

string

اسم الموضوع

eventSubscriptionName

string

اسم الاشتراك في الحدث

options
RejectCloudEventsOptions

خيارات الرفض

المرتجعات

Promise<RejectResult>

releaseCloudEvents(string[], string, string, ReleaseCloudEventsOptions)

إصدار دفعة من أحداث السحابة. يستجيب الخادم برمز حالة HTTP 200 إذا تم إصدار حدث واحد على الأقل بنجاح. سيتضمن نص الاستجابة مجموعة رموز التأمين المميزة التي تم تحريرها بنجاح، جنبا إلى جنب مع رموز التأمين الفاشلة الأخرى مع معلومات الخطأ المقابلة لها.

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

المعلمات

lockTokens

string[]

تأمين الرموز المميزة

topicName

string

اسم الموضوع

eventSubscriptionName

string

اسم الاشتراك في الحدث

options
ReleaseCloudEventsOptions

خيارات الإصدار

المرتجعات

Promise<ReleaseResult>

renewCloudEventLocks(string[], string, string, RenewCloudEventLocksOptions)

تجديد التأمين لمجموعة أحداث السحابة.

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

المعلمات

lockTokens

string[]

تأمين الرموز المميزة

topicName

string

اسم الموضوع

eventSubscriptionName

string

اسم الاشتراك في الحدث

options
RenewCloudEventLocksOptions

خيارات التجديد

المرتجعات