EventGridClient class

Klient usługi Azure Messaging EventGrid

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

Parametry

Potwierdzanie partii zdarzeń w chmurze. Serwer odpowiada kodem stanu HTTP 200, jeśli co najmniej jedno zdarzenie zostało pomyślnie potwierdzone. Treść odpowiedzi będzie zawierać zestaw pomyślnie potwierdzonych blokadTokens wraz z innymi nieudanych blokadTokens z odpowiednimi informacjami o błędzie. Pomyślnie potwierdzone zdarzenia nie będą już dostępne dla żadnego konsumenta.

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

Parametry

Zwraca

Temat Publikowanie pojedynczego zdarzenia w chmurze w przestrzeni nazw. W przypadku powodzenia serwer odpowiada kodem stanu HTTP 200 z pustym obiektem JSON w odpowiedzi. W przeciwnym razie serwer może zwrócić różne kody błędów. Na przykład 401: który wskazuje błąd autoryzacji, 403: który wskazuje przekroczenie limitu przydziału lub komunikat jest zbyt duży, 410: co wskazuje, że nie znaleziono określonego tematu, 400: dla nieprawidłowego żądania i 500: dla wewnętrznego błędu serwera.

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

Parametry

Zwraca

Temat Publikowanie zdarzenia w chmurze wsadowej w przestrzeni nazw. W przypadku powodzenia serwer odpowiada kodem stanu HTTP 200 z pustym obiektem JSON w odpowiedzi. W przeciwnym razie serwer może zwrócić różne kody błędów. Na przykład 401: który wskazuje błąd autoryzacji, 403: który wskazuje przekroczenie limitu przydziału lub komunikat jest zbyt duży, 410: co wskazuje, że nie znaleziono określonego tematu, 400: dla nieprawidłowego żądania i 500: dla wewnętrznego błędu serwera.

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

Parametry

Zwraca

Odbieranie partii zdarzeń w chmurze z subskrypcji zdarzeń.

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

Parametry

Zwraca

Odrzuć partię zdarzeń w chmurze.

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

Parametry

Zwraca

Wydanie partii zdarzeń w chmurze. Serwer odpowiada kodem stanu HTTP 200, jeśli co najmniej jedno zdarzenie zostało pomyślnie wydane. Treść odpowiedzi będzie zawierać zestaw pomyślnie zwolniony lockTokens wraz z innymi zablokowanymi blokadami Zakończone niepowodzeniemTokens z odpowiednimi informacjami o błędzie.

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

Parametry

Zwraca

Odnów blokadę dla partii zdarzeń w chmurze.

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

Parametry

Zwraca