Megosztás a következőn keresztül:


Azure Event Grid Namespaces ügyfélkódtár JavaScripthez – 1.0.0-s verzió

Azure Event Grid egy felhőalapú szolgáltatás, amely nagy léptékben biztosít megbízható eseménykézbesítést.

Események küldése event grid-névterekbe az ügyfélkódtár használatával

Főbb hivatkozások:

Kezdetekhez

Jelenleg támogatott környezetek

  • Node.js LTS-verziói
  • A Safari, a Chrome, az Edge és a Firefox legújabb verziói.

További részletekért tekintse meg a támogatási szabályzat.

Előfeltételek

Ha az Azure CLI-t használja, cserélje le a <your-resource-group-name> és <your-resource-name> a saját egyedi nevére:

Event Grid-témakör létrehozása

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

Event Grid-tartomány létrehozása

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

A @azure/eventgrid-namespaces csomag telepítése

Telepítse a JavaScripthez készült Azure Event Grid-névterek ügyfélkódtárát npm:

npm install @azure/eventgrid-namespaces

Névtér-ügyfelek létrehozása és hitelesítése

Ahhoz, hogy létrehozhasson egy ügyfélobjektumot az Event Grid Namespaces API eléréséhez, szüksége lesz az Event Grid-témakör endpoint és egy credential. Az Event Grid-névterek ügyfelei használhatnak hozzáférési kulcsot.

Az Event Grid-témakör végpontját az Azure Portal vagy az alábbi Azure CLI--kódrészlettel találja meg:

az eventgrid topic show --name <your-resource-name> --resource-group <your-resource-group-name> --query "endpoint"

Hozzáférési kulcs használata

Az Azure Portal segítségével keresse meg az Event Grid-erőforrást, és kérjen le egy hozzáférési kulcsot, vagy használja az alábbi Azure CLI- kódrészletet:

az eventgrid topic key list --resource-group <your-resource-group-name> --name <your-event-grid-topic-name>

Miután rendelkezik API-kulccsal és végpontokkal, a AzureKeyCredential osztály használatával hitelesítheti az ügyfelet az alábbiak szerint:

const { EventGridSenderClient, EventGridReceiverClient, AzureKeyCredential } = require("@azure/eventgrid-namespaces");

const eventGridSenderClient = new EventGridSenderClient(
  "<endpoint>",
  new AzureKeyCredential("<Access Key>")
);

const eventGridReceiverClient = new EventGridReceiverClient(
  "<endpoint>",
  new AzureKeyCredential("<Access Key>")
);

Az Azure EventGrid integrációt biztosít az Azure Active Directoryval (Azure AD) a kérések identitásalapú hitelesítéséhez. Az Azure AD-vel szerepköralapú hozzáférés-vezérléssel (RBAC) hozzáférést biztosíthat az Azure Event Grid-erőforrásokhoz felhasználók, csoportok vagy alkalmazások számára.

Ha egy TokenCredentialrendelkező témakörbe vagy tartományba szeretne eseményeket küldeni, a hitelesített identitáshoz hozzá kell rendelni az "EventGrid Data Sender" szerepkört.

A @azure/identity csomaggal zökkenőmentesen engedélyezheti a kéréseket mind a fejlesztési, mind az éles környezetben. Az Azure Active Directoryról további információt a @azure/identity READMEcímű cikkben talál.

A DefaultAzureCredential használatával például létrehozhat egy olyan ügyfelet, amely az Azure Active Directoryval hitelesít:

const { EventGridSenderClient, EventGridReceiverClient } = require("@azure/eventgrid-namespaces");
const { DefaultAzureCredential } = require("@azure/identity");

const eventGridSenderClient = new EventGridSenderClient(
  "<endpoint>",
  new DefaultAzureCredential(),
  "<topicName>"
);

const eventGridReceiverClient = new EventGridReceiverClient(
  "<endpoint>",
  new DefaultAzureCredential(),
  "<topicName>",
  "<subscriptionName>"
);

Főbb fogalmak

Események küldése és fogadása

EventGridSenderClient események Event Gridbe való küldéséhez használható. Inicializálhatja a következő módon:

const eventGridSenderClient = new EventGridSenderClient(
  "<endpoint>",
  new AzureKeyCredential("<API Key>"),
  "<topicName>"
);

EventGridReceiverClient esemény fogadására használható az Event Gridből. Inicializálhatja a következő módon:

const eventGridReceiverClient = new EventGridReceiverClient(
  "<endpoint>",
  new AzureKeyCredential("<API Key>"),
  "<topicName>",
  "<subscriptionName>"
);

Elosztott nyomkövetési és felhőesemények

Ez a kódtár támogatja az elosztott nyomkövetést @azure/core-tracinghasználatával. Elosztott nyomkövetés használata esetén ez a kódtár egy send művelet során létrehoz egy időtartamot. Ezenkívül amikor a Cloud Events 1.0 sémával küld eseményeket, az SDK elosztott nyomkövetési metaadatokat ad hozzá az eseményekhez az Elosztott nyomkövetés bővítményhasználatával. A traceparent és tracestate bővítménytulajdonságok értékei megfelelnek az eseményeket küldő HTTP-kérés traceparent és tracestate fejléceinek. Ha egy esemény már rendelkezik traceparent bővítménytulajdonságsal, az nem frissül.

Event Grid a Kubernetesen

Ezt a kódtárat teszteltük és ellenőriztük Kubernetesen az Azure Archasználatával.

Példák

Esemény közzététele Event Grid-témakörben

const { EventGridSenderClient, AzureKeyCredential } = require("@azure/eventgrid-namespaces");

const client = new EventGridSenderClient(
  "<endpoint>",
  new AzureKeyCredential("<API key>"),
  "<topicName>"
);

const cloudEvent: CloudEvent = {
  type: "example",
  source: "https://example.com",
  id: `singleEventIdV210001`,
  time: new Date(),
  data: {
    resourceUri: "https://dummyurl.com",
  },
  specversion: "1.0",
};
// Publish the Cloud Event
await client.sendEvents(cloudEvent);

Hibaelhárítás

Fakitermelés

A naplózás engedélyezése segíthet a hibákról szóló hasznos információk feltárásában. A HTTP-kérések és válaszok naplójának megtekintéséhez állítsa a AZURE_LOG_LEVEL környezeti változót info. Másik lehetőségként a naplózás futásidőben is engedélyezhető a setLogLevel meghívásával a @azure/logger:

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

setLogLevel("info");

A naplók engedélyezésére vonatkozó részletesebb útmutatásért tekintse meg a @azure/logger csomag dokumentációit.

Következő lépések

A kódtár használatára vonatkozó részletes példákért tekintse meg a mintákat könyvtárat.

Hozzájárulás

Ha hozzá szeretne járulni ehhez a kódtárhoz, olvassa el a közreműködői útmutatót, amelyből többet is megtudhat a kód összeállításáról és teszteléséről.

benyomások