Azure AlertsManagement client library for JavaScript - version 1.0.0-beta.1

Dieses Paket enthält ein isomorphes SDK (läuft sowohl in Node.js als auch in Browsern) für Azure AlertsManagement-Client.

Der Azure Alerts Management Service bietet eine einheitliche Palette von Warnungen im gesamten Azure Monitor.

Wichtige Links:

Erste Schritte

Derzeit unterstützte Umgebungen

Weitere Details finden Sie in unserer Supportrichtlinie .

Voraussetzungen

Installieren Sie das @azure/arm-alertsmanagement-Paket

Installieren Sie die Azure AlertsManagement-Client-Bibliothek für JavaScript mit npm:

npm install @azure/arm-alertsmanagement

Erstellen und Authentifizieren einer AlertsManagementClient

Um ein Client-Objekt zu erstellen, das auf die Azure AlertsManagement-API zugreift, benötigen Sie die endpoint Ihrer Azure AlertsManagement-Ressource sowie ein credential. Der Azure AlertsManagement-Client kann Azure Active Directory-Zugangsdaten zur Authentifizierung verwenden. Den Endpunkt für deine Azure AlertsManagement-Ressource findest du in der Azure-Portal.

Sie können sich mit Azure Active Directory mithilfe einer Anmeldeinformationen aus der @azure/Identitätsbibliothek oder einem vorhandenen AAD-Token authentifizieren.

Um den unten gezeigten DefaultAzureCredential-Anbieter oder andere anmeldeinformationsanbieter zu verwenden, die mit dem Azure SDK bereitgestellt werden, installieren Sie das @azure/identity Paket:

npm install @azure/identity

Sie müssen außerdem eine neue AAD-Bewerbung registrieren und Zugang zu Azure AlertsManagement gewähren, indem Sie die geeignete Rolle Ihrem Service Principal zuweisen (Hinweis: Rollen wie "Owner" gewähren nicht die erforderlichen Berechtigungen).

Weitere Informationen zum Erstellen einer Azure AD-Anwendung finden Sie in diesem Handbuch.

Mithilfe von Node.js- und Node-ähnlichen Umgebungen können Sie die DefaultAzureCredential Klasse verwenden, um den Client zu authentifizieren.

import { AlertsManagementClient } from "@azure/arm-alertsmanagement";
import { DefaultAzureCredential } from "@azure/identity";

const client = new AlertsManagementClient(new DefaultAzureCredential());

Verwenden Sie für Browserumgebungen die InteractiveBrowserCredential aus dem @azure/identity Paket, um sich zu authentifizieren.

import { InteractiveBrowserCredential } from "@azure/identity";
import { AlertsManagementClient } from "@azure/arm-alertsmanagement";

const credential = new InteractiveBrowserCredential({
  tenantId: "<YOUR_TENANT_ID>",
  clientId: "<YOUR_CLIENT_ID>",
});
const client = new AlertsManagementClient(credential);

JavaScript-Bündel

Um diese Clientbibliothek im Browser zu verwenden, müssen Sie zuerst einen Bundler verwenden. Ausführliche Informationen dazu finden Sie in unserer Bündelungsdokumentation.

Wichtige Konzepte

AlertsManagementClient

AlertsManagementClient ist die primäre Schnittstelle für Entwickler, die die Client-Bibliothek Azure AlertsManagement verwenden. Erkunden Sie die Methoden auf diesem Client-Objekt, um die verschiedenen Funktionen des Azure AlertsManagement-Dienstes zu verstehen, auf die Sie zugreifen können.

Problembehandlung

Protokollierung

Das Aktivieren der Protokollierung kann hilfreiche Informationen zu Fehlern aufdecken. Um ein Protokoll von HTTP-Anforderungen und -Antworten anzuzeigen, legen Sie die AZURE_LOG_LEVEL Umgebungsvariable auf infofest. Alternativ kann die Protokollierung zur Laufzeit durch Aufrufen von setLogLevel im @azure/loggeraktiviert werden:

import { setLogLevel } from "@azure/logger";

setLogLevel("info");

Ausführlichere Anweisungen zum Aktivieren von Protokollen finden Sie in den @azure/Logger-Paketdokumenten.

Nächste Schritte

Ausführliche Beispiele zur Verwendung dieser Bibliothek finden Sie im Beispielverzeichnis .

Contributing

Wenn Sie an dieser Bibliothek mitwirken möchten, lesen Sie bitte den Beitragsleitfaden , um mehr über das Erstellen und Testen des Codes zu erfahren.