EventGridClient class
- Extends
Constructors
| Event |
Initializes a new instance of the EventGridClient class. |
Inherited Properties
| accept |
|
| api |
|
| credentials | |
| long |
The retry timeout in seconds for Long Running Operations. Default value is 30. |
Methods
| publish |
Publishes a batch of events to an Azure Event Grid topic. |
| publish |
|
| publish |
Inherited Methods
| begin |
Send the initial request of a LRO (long running operation) and get back an HttpLongRunningOperationResponse that provides methods for polling the LRO and checking if the LRO is finished. |
| restore |
Restore an LROPoller from the provided LROPollState. This method can be used to recreate an LROPoller on a different process or machine. |
| send |
Provides a mechanism to make a request that will poll and provide the final result. |
| send |
Send the initial request of a LRO (long running operation) and get back an LROPoller that provides methods for polling the LRO and checking if the LRO is finished. |
| send |
Send an HTTP request that is populated using the provided OperationSpec. |
| send |
Send the provided httpRequest. |
Constructor Details
EventGridClient(ServiceClientCredentials, AzureServiceClientOptions)
Initializes a new instance of the EventGridClient class.
new EventGridClient(credentials: ServiceClientCredentials, options?: AzureServiceClientOptions)Parameters
- credentials
- ServiceClientCredentials
Credentials needed for the client to connect to Azure.
- options
- @azure/ms-rest-azure-js.AzureServiceClientOptions
The parameter options
Inherited Property Details
acceptLanguage
apiVersion
credentials
credentials: ServiceClientCredentialsProperty Value
Inherited From EventGridClientContext.credentials
longRunningOperationRetryTimeout
The retry timeout in seconds for Long Running Operations. Default value is 30.
longRunningOperationRetryTimeout?: numberProperty Value
number
Inherited From EventGridClientContext.longRunningOperationRetryTimeout
Method Details
publishEvents(string, EventGridEvent[], RequestOptionsBase)
Publishes a batch of events to an Azure Event Grid topic.
function publishEvents(topicHostname: string, events: EventGridEvent[], options?: RequestOptionsBase): Promise<RestResponse>Parameters
- topicHostname
-
string
The host name of the topic, e.g. topic1.westus2-1.eventgrid.azure.net
- events
An array of events to be published to Event Grid.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
publishEvents(string, EventGridEvent[], RequestOptionsBase, ServiceCallback<void>)
function publishEvents(topicHostname: string, events: EventGridEvent[], options: RequestOptionsBase, callback: ServiceCallback<void>)Parameters
- topicHostname
-
string
The host name of the topic, e.g. topic1.westus2-1.eventgrid.azure.net
- events
An array of events to be published to Event Grid.
- options
- RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<void>
The callback
publishEvents(string, EventGridEvent[], ServiceCallback<void>)
function publishEvents(topicHostname: string, events: EventGridEvent[], callback: ServiceCallback<void>)Parameters
- topicHostname
-
string
The host name of the topic, e.g. topic1.westus2-1.eventgrid.azure.net
- events
An array of events to be published to Event Grid.
- callback
-
ServiceCallback<void>
The callback
Inherited Method Details
beginLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)
Send the initial request of a LRO (long running operation) and get back an HttpLongRunningOperationResponse that provides methods for polling the LRO and checking if the LRO is finished.
function beginLongRunningRequest(request: RequestPrepareOptions | WebResource, options?: RequestOptionsBase): Promise<LROPoller>Parameters
- request
The request object
- options
- RequestOptionsBase
Additional options to be sent while making the request
Returns
Promise<@azure/ms-rest-azure-js.LROPoller>
The HttpLongRunningOperationResponse that provides methods for interacting with the LRO.
Inherited From EventGridClientContext.beginLongRunningRequest
restoreLROPoller(LROPollState)
Restore an LROPoller from the provided LROPollState. This method can be used to recreate an LROPoller on a different process or machine.
function restoreLROPoller(lroPollState: LROPollState): LROPollerParameters
- lroPollState
- @azure/ms-rest-azure-js.LROPollState
Returns
Inherited From EventGridClientContext.restoreLROPoller
sendLongRunningRequest(RequestPrepareOptions | WebResource, RequestOptionsBase)
Provides a mechanism to make a request that will poll and provide the final result.
function sendLongRunningRequest(request: RequestPrepareOptions | WebResource, options?: RequestOptionsBase): Promise<HttpOperationResponse>Parameters
- request
The request object
- options
- RequestOptionsBase
Additional options to be sent while making the request
Returns
Promise<HttpOperationResponse>
The HttpOperationResponse containing the final polling request, response and the responseBody.
Inherited From EventGridClientContext.sendLongRunningRequest
sendLRORequest(OperationArguments, OperationSpec, RequestOptionsBase)
Send the initial request of a LRO (long running operation) and get back an LROPoller that provides methods for polling the LRO and checking if the LRO is finished.
function sendLRORequest(operationArguments: OperationArguments, operationSpec: OperationSpec, options?: RequestOptionsBase): Promise<LROPoller>Parameters
- operationArguments
- OperationArguments
The arguments to the operation.
- operationSpec
- OperationSpec
The specification for the operation.
- options
- RequestOptionsBase
Additional options to be sent while making the request.
Returns
Promise<@azure/ms-rest-azure-js.LROPoller>
The LROPoller object that provides methods for interacting with the LRO.
Inherited From EventGridClientContext.sendLRORequest
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)
Send an HTTP request that is populated using the provided OperationSpec.
function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>): Promise<RestResponse>Parameters
- operationArguments
- OperationArguments
The arguments that the HTTP request's templated values will be populated from.
- operationSpec
- OperationSpec
The OperationSpec to use to populate the httpRequest.
- callback
-
ServiceCallback<any>
The callback to call when the response is received.
Returns
Promise<RestResponse>
Inherited From EventGridClientContext.sendOperationRequest
sendRequest(RequestPrepareOptions | WebResourceLike)
Send the provided httpRequest.
function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>Parameters
- options
Returns
Promise<HttpOperationResponse>
Inherited From EventGridClientContext.sendRequest
Azure SDK for JavaScript