AzureRedHatOpenShift client library for JavaScript

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

Rest API for Azure Red Hat OpenShift 4

Wichtige Links:

Erste Schritte

Derzeit unterstützte Umgebungen

Weitere Informationen finden Sie in unserer Supportrichtlinie.

Voraussetzungen

Installieren Sie das @azure/arm-redhatopenshift-Paket

Installiere die AzureRedHatOpenShift-Clientbibliothek für JavaScript mit npm:

npm install @azure/arm-redhatopenshift

Erstellen und Authentifizieren einer AzureRedHatOpenShiftClient

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

Sie können sich mit Azure Active Directory authentifizieren, indem Sie eine Berechtigung aus der Bibliothek @azure/identity oder einem bestehenden AAD Token authentifizieren.

Um den unten gezeigten Anbieter DefaultAzureCredential oder andere mit dem Azure SDK bereitgestellte Zugangsdatenanbieter zu verwenden, installieren Sie bitte das @azure/identity-Paket:

npm install @azure/identity

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

Für weitere Informationen darüber, wie man eine Azure AD-Anwendung erstellt, siehe diesen Leitfaden.

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

import { AzureRedHatOpenShiftClient } from "@azure/arm-redhatopenshift";
import { DefaultAzureCredential } from "@azure/identity";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new AzureRedHatOpenShiftClient(new DefaultAzureCredential(), subscriptionId);

Für Browserumgebungen verwenden Sie zur Authentifizierung das InteractiveBrowserCredential aus dem @azure/identity-Paket.

import { InteractiveBrowserCredential } from "@azure/identity";
import { AzureRedHatOpenShiftClient } from "@azure/arm-redhatopenshift";

const credential = new InteractiveBrowserCredential({
  tenantId: "<YOUR_TENANT_ID>",
  clientId: "<YOUR_CLIENT_ID>",
});
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new AzureRedHatOpenShiftClient(credential, subscriptionId);

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.

Zentrale Konzepte

AzureRedHatOpenShiftClient

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

Troubleshooting

Logging

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 in den Beispielen Verzeichnis.

Contributing

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

  • Last updated on