Partilhar via

EventGridPublisherClient class

  • Referência
Pacote:
@azure/eventgrid

Classe de cliente para publicar eventos no Serviço Event Grid.

Construtores

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

Cria uma instância do EventGridPublisherClient que envia eventos com o Esquema do Event Grid.

Utilização de exemplo: 

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

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

Propriedades

apiVersion

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

O URL para o ponto final do Event Grid.

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 do EventGridPublisherClient que envia eventos com o Esquema do Event Grid.

Utilização de exemplo: 

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)

Parâmetros

endpointUrl

string

O URL para o ponto final do Event Grid, por exemplo, https://eg-topic.westus2-1.eventgrid.azure.net/api/events.

inputSchema

T

O esquema que o ponto final do Event Grid está configurado para aceitar. Um de "EventGrid", "CloudEvent" ou "Personalizado".

credential

KeyCredential | SASCredential | TokenCredential

Utilizado para autenticar pedidos para o serviço.

options
CommonClientOptions

Utilizado para configurar o Cliente do Event Grid.

Detalhes de Propriedade

apiVersion

A versão do serviço Even Grid.

apiVersion: string

Valor de Propriedade

string

endpointUrl

O URL para o ponto final do Event Grid.

endpointUrl: string

Valor de Propriedade

string

Detalhes de 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 enviar. Os eventos devem estar no esquema utilizado ao construir o cliente.

options

InputSchemaToOptionsTypeMap[T]

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

Devoluções

Promise<void>