Compartir a través de

EventGridClient class

  • Referencia
Paquete:
azure-eventgrid
Extends

AzureServiceClient

Constructores

EventGridClient(ServiceClientCredentials, AzureServiceClientOptions)

Inicializa una nueva instancia de la clase EventGridClient.

Propiedades

acceptLanguage
apiVersion
credentials
generateClientRequestId
longRunningOperationRetryTimeout

Métodos

publishEvents(string, EventGridEvent[], ServiceCallback<void>)
publishEvents(string, EventGridEvent[], { customHeaders?: {[headerName: string]: string} })

Publica un lote de eventos en un tema de Azure Event Grid.
publishEvents(string, EventGridEvent[], { customHeaders?: {[headerName: string]: string} }, ServiceCallback<void>)
publishEventsWithHttpOperationResponse(string, EventGridEvent[], { customHeaders?: {[headerName: string]: string} })

Publica un lote de eventos en un tema de Azure Event Grid.

Métodos heredados

addUserAgentInfo(any)

Agrega información personalizada al encabezado del agente de usuario
getLongRunningOperationResult<TResult>(HttpOperationResponse<TResult>, RequestOptions)
getLongRunningOperationResult<TResult>(HttpOperationResponse<TResult>, RequestOptions, ServiceCallback<TResult>)
getLongRunningOperationResult<TResult>(HttpOperationResponse<TResult>, ServiceCallback<TResult>)
getPackageJsonInfo(string)

Intenta buscar package.json para el paquete de Azure nodejs especificado. Si se encuentra, devuelve el nombre y la versión del paquete leyendo package.json Si no se encuentra package.json, devuelve un valor predeterminado.
sendLongRunningRequest<TResult>(LongRunningUrlBasedRequestPrepareOptions | LongRunningPathTemplateBasedRequestPrepareOptions)
sendLongRunningRequest<TResult>(LongRunningUrlBasedRequestPrepareOptions | LongRunningPathTemplateBasedRequestPrepareOptions, ServiceCallback<TResult>)
sendLongRunningRequestWithHttpOperationResponse<TResult>(LongRunningUrlBasedRequestPrepareOptions | LongRunningPathTemplateBasedRequestPrepareOptions)
sendRequest<TResult>(UrlBasedRequestPrepareOptions | PathTemplateBasedRequestPrepareOptions)
sendRequest<TResult>(UrlBasedRequestPrepareOptions | PathTemplateBasedRequestPrepareOptions, ServiceCallback<TResult>)
sendRequestWithHttpOperationResponse<TResult>(UrlBasedRequestPrepareOptions | PathTemplateBasedRequestPrepareOptions)

Detalles del constructor

EventGridClient(ServiceClientCredentials, AzureServiceClientOptions)

Inicializa una nueva instancia de la clase EventGridClient.

new EventGridClient(credentials: ServiceClientCredentials, options?: AzureServiceClientOptions)

Parámetros

credentials

ServiceClientCredentials

Credenciales necesarias para que el cliente se conecte a Azure.

options

AzureServiceClientOptions

Las opciones de parámetro

Detalles de las propiedades

acceptLanguage 

acceptLanguage: string

Valor de propiedad

string

apiVersion 

apiVersion: string

Valor de propiedad

string

credentials 

credentials: ServiceClientCredentials

Valor de propiedad

ServiceClientCredentials

generateClientRequestId 

generateClientRequestId: boolean

Valor de propiedad

boolean

longRunningOperationRetryTimeout 

longRunningOperationRetryTimeout: number

Valor de propiedad

number

Detalles del método

publishEvents(string, EventGridEvent[], ServiceCallback<void>) 

function publishEvents(topicHostname: string, events: EventGridEvent[], callback: ServiceCallback<void>)

Parámetros

topicHostname

string

events

EventGridEvent[]

callback

ServiceCallback<void>

publishEvents(string, EventGridEvent[], { customHeaders?: {[headerName: string]: string} })

Publica un lote de eventos en un tema de Azure Event Grid.

function publishEvents(topicHostname: string, events: EventGridEvent[], options?: { customHeaders?: {[headerName: string]: string} }): Promise<void>

Parámetros

topicHostname

string

Nombre de host del tema, por ejemplo, topic1.westus2-1.eventgrid.azure.net

events

EventGridEvent[]

Matriz de eventos que se van a publicar en Event Grid.

options

{ customHeaders?: {[headerName: string]: string} }

Parámetros opcionales

Devoluciones

Promise<void>

Si se pasó una devolución de llamada como último parámetro, devuelve la devolución de llamada; de lo contrario, devuelve una promesa.

{Promise} Se devuelve una promesa.

publishEvents(string, EventGridEvent[], { customHeaders?: {[headerName: string]: string} }, ServiceCallback<void>) 

function publishEvents(topicHostname: string, events: EventGridEvent[], options: { customHeaders?: {[headerName: string]: string} }, callback: ServiceCallback<void>)

Parámetros

topicHostname

string

events

EventGridEvent[]

options

{ customHeaders?: {[headerName: string]: string} }

callback

ServiceCallback<void>

publishEventsWithHttpOperationResponse(string, EventGridEvent[], { customHeaders?: {[headerName: string]: string} })

Publica un lote de eventos en un tema de Azure Event Grid.

function publishEventsWithHttpOperationResponse(topicHostname: string, events: EventGridEvent[], options?: { customHeaders?: {[headerName: string]: string} }): Promise<HttpOperationResponse<void>>

Parámetros

topicHostname

string

Nombre de host del tema, por ejemplo, topic1.westus2-1.eventgrid.azure.net

events

EventGridEvent[]

Matriz de eventos que se van a publicar en Event Grid.

options

{ customHeaders?: {[headerName: string]: string} }

Parámetros opcionales

Devoluciones

Promise<HttpOperationResponse<void>>

Se devuelve una promesa.

Detalles de los métodos heredados

addUserAgentInfo(any)

Agrega información personalizada al encabezado del agente de usuario

function addUserAgentInfo(additionalUserAgentInfo: any)

Parámetros

additionalUserAgentInfo

any

información que se va a agregar al encabezado del agente de usuario, como cadena.

Heredado de AzureServiceClient.addUserAgentInfo

getLongRunningOperationResult<TResult>(HttpOperationResponse<TResult>, RequestOptions) 

function getLongRunningOperationResult<TResult>(resultOfInitialRequest: HttpOperationResponse<TResult>, options?: RequestOptions): Promise<TResult>

Parámetros

resultOfInitialRequest

HttpOperationResponse<TResult>

options

RequestOptions

Devoluciones

Promise<TResult>

Heredado de AzureServiceClient.getLongRunningOperationResult

getLongRunningOperationResult<TResult>(HttpOperationResponse<TResult>, RequestOptions, ServiceCallback<TResult>) 

function getLongRunningOperationResult<TResult>(resultOfInitialRequest: HttpOperationResponse<TResult>, options: RequestOptions, callback: ServiceCallback<TResult>)

Parámetros

resultOfInitialRequest

HttpOperationResponse<TResult>

options

RequestOptions

callback

ServiceCallback<TResult>

Heredado de AzureServiceClient.getLongRunningOperationResult

getLongRunningOperationResult<TResult>(HttpOperationResponse<TResult>, ServiceCallback<TResult>) 

function getLongRunningOperationResult<TResult>(resultOfInitialRequest: HttpOperationResponse<TResult>, callback: ServiceCallback<TResult>)

Parámetros

resultOfInitialRequest

HttpOperationResponse<TResult>

callback

ServiceCallback<TResult>

Heredado de AzureServiceClient.getLongRunningOperationResult

getPackageJsonInfo(string)

Intenta buscar package.json para el paquete de Azure nodejs especificado. Si se encuentra, devuelve el nombre y la versión del paquete leyendo package.json Si no se encuentra package.json, devuelve un valor predeterminado.

function getPackageJsonInfo(managementClientDir: string): { name: string, version: string }

Parámetros

managementClientDir

string

pase el directorio del cliente de administración de Azure específico.

Devoluciones

{ name: string, version: string }

packageJsonInfo: "name" y "version" del paquete deseado.

Heredado de AzureServiceClient.getPackageJsonInfo

sendLongRunningRequest<TResult>(LongRunningUrlBasedRequestPrepareOptions | LongRunningPathTemplateBasedRequestPrepareOptions) 

function sendLongRunningRequest<TResult>(options: LongRunningUrlBasedRequestPrepareOptions | LongRunningPathTemplateBasedRequestPrepareOptions): Promise<TResult>

Parámetros

options

LongRunningUrlBasedRequestPrepareOptions | LongRunningPathTemplateBasedRequestPrepareOptions

Devoluciones

Promise<TResult>

Heredado de AzureServiceClient.sendLongRunningRequest

sendLongRunningRequest<TResult>(LongRunningUrlBasedRequestPrepareOptions | LongRunningPathTemplateBasedRequestPrepareOptions, ServiceCallback<TResult>) 

function sendLongRunningRequest<TResult>(options: LongRunningUrlBasedRequestPrepareOptions | LongRunningPathTemplateBasedRequestPrepareOptions, callback: ServiceCallback<TResult>)

Parámetros

options

LongRunningUrlBasedRequestPrepareOptions | LongRunningPathTemplateBasedRequestPrepareOptions

callback

ServiceCallback<TResult>

Heredado de AzureServiceClient.sendLongRunningRequest

sendLongRunningRequestWithHttpOperationResponse<TResult>(LongRunningUrlBasedRequestPrepareOptions | LongRunningPathTemplateBasedRequestPrepareOptions) 

function sendLongRunningRequestWithHttpOperationResponse<TResult>(options: LongRunningUrlBasedRequestPrepareOptions | LongRunningPathTemplateBasedRequestPrepareOptions): Promise<HttpOperationResponse<TResult>>

Parámetros

options

LongRunningUrlBasedRequestPrepareOptions | LongRunningPathTemplateBasedRequestPrepareOptions

Devoluciones

Promise<HttpOperationResponse<TResult>>

Heredado de AzureServiceClient.sendLongRunningRequestWithHttpOperationResponse

sendRequest<TResult>(UrlBasedRequestPrepareOptions | PathTemplateBasedRequestPrepareOptions) 

function sendRequest<TResult>(options: UrlBasedRequestPrepareOptions | PathTemplateBasedRequestPrepareOptions): Promise<TResult>

Parámetros

options

UrlBasedRequestPrepareOptions | PathTemplateBasedRequestPrepareOptions

Devoluciones

Promise<TResult>

Heredado de AzureServiceClient.sendRequest

sendRequest<TResult>(UrlBasedRequestPrepareOptions | PathTemplateBasedRequestPrepareOptions, ServiceCallback<TResult>) 

function sendRequest<TResult>(options: UrlBasedRequestPrepareOptions | PathTemplateBasedRequestPrepareOptions, callback: ServiceCallback<TResult>)

Parámetros

options

UrlBasedRequestPrepareOptions | PathTemplateBasedRequestPrepareOptions

callback

ServiceCallback<TResult>

Heredado de AzureServiceClient.sendRequest

sendRequestWithHttpOperationResponse<TResult>(UrlBasedRequestPrepareOptions | PathTemplateBasedRequestPrepareOptions) 

function sendRequestWithHttpOperationResponse<TResult>(options: UrlBasedRequestPrepareOptions | PathTemplateBasedRequestPrepareOptions): Promise<HttpOperationResponse<TResult>>

Parámetros

options

UrlBasedRequestPrepareOptions | PathTemplateBasedRequestPrepareOptions

Devoluciones

Promise<HttpOperationResponse<TResult>>

Heredado de AzureServiceClient.sendRequestWithHttpOperationResponse