Compartilhar via

EventGridPublisherClient class

Pacote:
@azure/eventgrid

Classe cliente para publicar eventos no Serviço de Grade de Eventos.

Construtores

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

Cria uma instância de EventGridPublisherClient que envia eventos usando o Esquema de Grade de Eventos.

Uso de exemplo:

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

const client = new EventGridPublisherClient(
  "<endpoint>",
  "EventGrid",
  new AzureKeyCredential("<Access Key>"),
);

Propriedades

apiVersion

A versão do serviço Even Grid.
endpointUrl

A URL para o ponto de extremidade da Grade de Eventos.

Métodos

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

Envia eventos para um tópico.

Detalhes do construtor

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

Cria uma instância de EventGridPublisherClient que envia eventos usando o Esquema de Grade de Eventos.

Uso de exemplo:

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

const client = new EventGridPublisherClient(
  "<endpoint>",
  "EventGrid",
  new AzureKeyCredential("<Access Key>"),
);

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

Parâmetros

endpointUrl

string

A URL para o ponto de extremidade da Grade de Eventos, por exemplo, https://eg-topic.westus2-1.eventgrid.azure.net/api/events.

inputSchema

T

O esquema que o ponto de extremidade da Grade de Eventos está configurado para aceitar. Um de "EventGrid", "CloudEvent" ou "Custom".

credential

KeyCredential | SASCredential | TokenCredential

Usado para autenticar solicitações no serviço.

options
CommonClientOptions

Usado para configurar o cliente da Grade de Eventos.

Detalhes da propriedade

apiVersion

A versão do serviço Even Grid.

apiVersion: string

Valor da propriedade

string

endpointUrl

A URL para o ponto de extremidade da Grade de Eventos.

endpointUrl: string

Valor da propriedade

string

Detalhes do método

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

Envia eventos para um tópico.

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

Parâmetros

events

InputSchemaToInputTypeMap[T][]

Os eventos a serem enviados. Os eventos devem estar no esquema usado ao construir o cliente.

options

InputSchemaToOptionsTypeMap[T]

Opções para controlar a operação subjacente.

Retornos

Promise<void>