Azure RedHatOpenShift Client-Bibliothek für 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 RedHatOpenShift-Client.

Wichtige Links:

Erste Schritte

Derzeit unterstützte Umgebungen

Weitere Informationen finden Sie in unserer Supportrichtlinie.

Voraussetzungen

Installieren Sie das @azure/arm-redhatopenshifthcp-Paket

Installieren Sie die Azure RedHatOpenShift-Clientbibliothek für JavaScript mit npm:

npm install @azure/arm-redhatopenshifthcp

Erstellen und Authentifizieren einer RedHatOpenShiftClient

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

Sie können sich mit der Microsoft Entra ID authentifizieren, indem Sie eine Zugangsdaten aus der @azure/identity-Bibliothek oder ein bestehendes Microsoft Entra-Token verwenden.

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

npm install @azure/identity

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

Weitere Informationen darüber, wie man eine Microsoft Entra-Anwendung erstellt, finden Sie in diesem Leitfaden.

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

import { RedHatOpenShiftClient } from "@azure/arm-redhatopenshifthcp";
import { DefaultAzureCredential } from "@azure/identity";

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

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

import { InteractiveBrowserCredential } from "@azure/identity";
import { RedHatOpenShiftClient } from "@azure/arm-redhatopenshifthcp";

const credential = new InteractiveBrowserCredential({
  tenantId: "<YOUR_TENANT_ID>",
  clientId: "<YOUR_CLIENT_ID>",
});
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new RedHatOpenShiftClient(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.

Wichtige Konzepte

RedHatOpenShiftClient

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

Troubleshooting

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 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.