Partager via

EventGridPublisherClient class

  • Référence
Paquet:
@azure/eventgrid

Classe cliente pour la publication d’événements dans le service Event Grid.

Constructeurs

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

Crée une instance d’EventGridPublisherClient qui envoie des événements à l’aide du schéma Event Grid.

Exemple d’utilisation :

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

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

Propriétés

apiVersion

Version du service Even Grid.
endpointUrl

URL du point de terminaison Event Grid.

Méthodes

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

Envoie des événements à une rubrique.

Détails du constructeur

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

Crée une instance d’EventGridPublisherClient qui envoie des événements à l’aide du schéma Event Grid.

Exemple d’utilisation :

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)

Paramètres

endpointUrl

string

URL du point de terminaison Event Grid, par exemple https://eg-topic.westus2-1.eventgrid.azure.net/api/events.

inputSchema

T

Schéma que le point de terminaison Event Grid est configuré pour accepter. Un des « EventGrid », « CloudEvent » ou « Personnalisé ».

credential

KeyCredential | SASCredential | TokenCredential

Utilisé pour authentifier les demandes adressées au service.

options
CommonClientOptions

Utilisé pour configurer le client Event Grid.

Détails de la propriété

apiVersion

Version du service Even Grid.

apiVersion: string

Valeur de propriété

string

endpointUrl

URL du point de terminaison Event Grid.

endpointUrl: string

Valeur de propriété

string

Détails de la méthode

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

Envoie des événements à une rubrique.

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

Paramètres

events

InputSchemaToInputTypeMap[T][]

Événements à envoyer. Les événements doivent se trouver dans le schéma utilisé lors de la construction du client.

options

InputSchemaToOptionsTypeMap[T]

Options permettant de contrôler l’opération sous-jacente.

Retours

Promise<void>