Sdílet prostřednictvím

EventGridPublisherClient class

  • Reference
Balíček:
@azure/eventgrid

Klientská třída pro publikování událostí do služby Event Grid.

Konstruktory

EventGridPublisherClient<T>(string, T, KeyCredential | SASCredential | TokenCredential, CommonClientOptions)

Vytvoří instanci EventGridPublisherClient, která odesílá události pomocí schématu Event Grid.

Příklad použití:

import { EventGridPublisherClient, AzureKeyCredential } from "@azure/eventgrid";

const client = new EventGridPublisherClient(
   "<service endpoint>",
   "EventGrid",
   new AzureKeyCredential("<api key>")
);

Vlastnosti

apiVersion

Verze služby Even Grid.
endpointUrl

Adresa URL koncového bodu Služby Event Grid.

Metody

send(InputSchemaToInputTypeMap[T][], InputSchemaToOptionsTypeMap[T])

Odesílá události do tématu.

Podrobnosti konstruktoru

EventGridPublisherClient<T>(string, T, KeyCredential | SASCredential | TokenCredential, CommonClientOptions)

Vytvoří instanci EventGridPublisherClient, která odesílá události pomocí schématu Event Grid.

Příklad použití:

import { EventGridPublisherClient, AzureKeyCredential } from "@azure/eventgrid";

const client = new EventGridPublisherClient(
   "<service endpoint>",
   "EventGrid",
   new AzureKeyCredential("<api key>")
);

new EventGridPublisherClient(endpointUrl: string, inputSchema: T, credential: KeyCredential | SASCredential | TokenCredential, options?: CommonClientOptions)

Parametry

endpointUrl

string

Adresa URL koncového bodu Event Gridu, například https://eg-topic.westus2-1.eventgrid.azure.net/api/events.

inputSchema

T

Schéma, které je koncový bod Event Gridu nakonfigurovaný tak, aby přijímal. Jedna z "EventGrid", "CloudEvent" nebo "Custom".

credential

KeyCredential | SASCredential | TokenCredential

Používá se k ověřování požadavků na službu.

options
CommonClientOptions

Slouží ke konfiguraci klienta Služby Event Grid.

Podrobnosti vlastnosti

apiVersion

Verze služby Even Grid.

apiVersion: string

Hodnota vlastnosti

string

endpointUrl

Adresa URL koncového bodu Služby Event Grid.

endpointUrl: string

Hodnota vlastnosti

string

Podrobnosti metody

send(InputSchemaToInputTypeMap[T][], InputSchemaToOptionsTypeMap[T])

Odesílá události do tématu.

function send(events: InputSchemaToInputTypeMap[T][], options?: InputSchemaToOptionsTypeMap[T]): Promise<void>

Parametry

events

InputSchemaToInputTypeMap[T][]

Události, které se mají odeslat. Události by měly být ve schématu použitém při vytváření klienta.

options

InputSchemaToOptionsTypeMap[T]

Možnosti řízení základní operace

Návraty

Promise<void>