Azure Event Grid client library samples for TypeScript
These sample programs show how to use the TypeScript client libraries for Azure Event Grid in some common scenarios.
|consumeEventsFromServiceBusQueue.ts||Consume events delivered by Event Grid to a Service Bus Queue|
|sendEventGridEvent.ts||Send events to Event Grid using the Event Grid Schema.|
|sendCloudEvent.ts||Send events to Event Grid using the Cloud Events 1.0 Schema.|
The sample programs are compatible with LTS versions of Node.js.
npm install -g typescript
You need an Azure subscription and the following Azure resources to run these sample programs:
- Azure Event Grid Custom Topic, configured to use the Event Grid Schema
- Azure Event Grid Custom Topic, configured to use the Cloud Event 1.0 Schema
- Azure Service Bus Queue
Samples retrieve credentials to access the service endpoint from environment variables. Alternatively, edit the source code to include the appropriate credentials. See each individual sample for details on which environment variables/credentials it requires to function.
Adapting the samples to run in the browser may require some additional consideration. For details, please see the package README.
To run the samples using the published version of the package:
- Install the dependencies using
- Compile the samples:
npm run build
Edit the file
sample.env, adding the correct credentials to access the Azure service and run the samples. Then rename the file from
.env. The sample programs will read this file automatically.
Run whichever samples you like (note that some samples may require additional setup, see the table above):
Alternatively, run a single sample with the correct environment variables set (setting up the
.env file is not required if you do this), for example (cross-platform):
npx cross-env SERVICE_BUS_CONNECTION_STRING="<service bus connection string>" SERVICE_BUS_QUEUE_NAME="<service bus queue name>" node dist/consumeEventsFromServiceBusQueue.js
Take a look at our API Documentation for more information about the APIs that are available in the clients.