azure-sdk-for-js/sdk/eventgrid/eventgrid-system-events
Jeremy Meng a28e8f0795 [EngSys] move to vendored version of cross-env via dev-tool
***NO_CI***

- apply the transformation

- update samples' README
2024-11-02 00:48:06 +00:00
..
review [@azure/eventgrid-system-events] Update System events for Version 1.0.0-beta.4 (#31188) 2024-09-23 15:27:58 -07:00
src [eslint-plugin] add rule "@typescript-eslint/consistent-type-imports": "warn" 2024-10-30 15:48:52 +00:00
test/public [eslint-plugin] add rule "@typescript-eslint/consistent-type-imports": "warn" 2024-10-30 15:48:52 +00:00
.nycrc [@azure/eventgrid-system-events]Initial Commit V1.0.0-beta.1 (#29688) 2024-06-06 21:07:44 -07:00
CHANGELOG.md [@azure/eventgrid-system-events] Update System events for Version 1.0.0-beta.4 (#31188) 2024-09-23 15:27:58 -07:00
LICENSE [@azure/eventgrid-system-events]Initial Commit V1.0.0-beta.1 (#29688) 2024-06-06 21:07:44 -07:00
README.md [@azure/eventgrid-namespaces] [@azure/evengrid-system-events] Update Readme file and Cloud Event Model (#29958) 2024-06-07 14:31:24 -07:00
api-extractor.json [@azure/eventgrid-system-events]Initial Commit V1.0.0-beta.1 (#29688) 2024-06-06 21:07:44 -07:00
eslint.config.mjs [eslint-plugin] upgrade typescript-eslint to v8 2024-08-23 10:19:23 -07:00
karma.conf.js [@azure/eventgrid-system-events]Initial Commit V1.0.0-beta.1 (#29688) 2024-06-06 21:07:44 -07:00
package.json [EngSys] move to vendored version of cross-env via dev-tool 2024-11-02 00:48:06 +00:00
tests.yml [Eng] Set Default for Federated Auth to True (#30163) 2024-07-22 17:24:20 -07:00
tsconfig.json [EngSys] remove tsconfig.package.json 2024-07-16 13:27:25 +00:00
tsdoc.json [@azure/eventgrid-system-events]Initial Commit V1.0.0-beta.1 (#29688) 2024-06-06 21:07:44 -07:00

README.md

Azure Event Grid Namespaces client library for JavaScript

Azure Event Grid system events are published by Azure services to system topics. The models in this package map to events sent by various Azure services.

Key links:

Getting started

Currently supported environments

See our support policy for more details.

Prerequisites

If you use the Azure CLI, replace <your-resource-group-name> and <your-resource-name> with your own unique names:

Create an Event Grid Topic

az eventgrid topic create --location <location> --resource-group <your-resource-group-name> --name <your-resource-name>

Create an Event Grid Domain

az eventgrid domain create --location <location> --resource-group <your-resource-group-name> --name <your-resource-name>

Install the @azure/eventgrid-system-events package

Install the Azure Event Grid System Events client library for JavaScript with npm:

npm install @azure/eventgrid-system-events

Key concepts

This package provides a list of System Events that could be used to publish events to EventGrid.

Troubleshooting

Logging

Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the AZURE_LOG_LEVEL environment variable to info. Alternatively, logging can be enabled at runtime by calling setLogLevel in the @azure/logger:

const { setLogLevel } = require("@azure/logger");

setLogLevel("info");

For more detailed instructions on how to enable the logs, you can look at the @azure/logger package docs.

Contributing

If you'd like to contribute to this library, please read the contributing guide to learn more about how to build and test the code.

Impressions