Verwenden von API-Versionsprofilen mit dem Node.js-SDK (Software Development Kit) in Azure Stack Hub
Node.js und API-Versionsprofile
Sie können das Node. js-SDK verwenden, um das Erstellen und Verwalten der Infrastruktur für Ihre Apps zu unterstützen. API-Profile im Node.js-SDK stellen eine Hilfe für Hybrid Cloud-Lösungen dar, indem Sie Ihnen den Wechsel zwischen globalen Azure-Ressourcen und Azure Stack Hub-Ressourcen ermöglichen. Sie können Ihren Code einmal erstellen und ihn sowohl für globales Azure als auch Azure Stack Hub nutzen.
In diesem Artikel können Sie Visual Studio Code als Entwicklungstool verwenden. Visual Studio Code kann das Node.js-SDK debuggen und ermöglicht Ihnen das Ausführen der App und das Hochladen der App auf Ihre Azure Stack Hub-Instanz. Sie können in Visual Studio Code oder mithilfe eines Terminalfensters debuggen, in dem Sie den Befehl node <nodefile.js> ausführen.
Das Node.js SDK
Das Node.js-SDK stellt Tools des Azure Stack Hub Resource Manager zur Verfügung. Zu den Ressourcenanbietern im SDK zählen Compute, Netzwerk, Speicher, App-Dienste und KeyVault. Es gibt 10 Clientbibliotheken für Ressourcenanbieter, die Sie in Ihrer Node.js-Anwendung installieren können. Sie können jedoch auch gezielt den Ressourcenanbieter herunterladen, den Sie für das Profil 2020-09-01-profile verwenden möchten, um den Arbeitsspeicher für Ihre Anwendung zu optimieren. Jedes Modul besteht aus einem Ressourcenanbieter, der entsprechenden API-Version und dem API-Profil.
Ein API-Profil ist eine Kombination aus Ressourcenanbietern und API-Versionen. Sie können ein API-Profil verwenden, um die aktuelle, stabilste Version der einzelnen Ressourcentypen in einem Ressourcenanbieterpaket abzurufen.
Verwenden Sie das aktuelle Profil von Paketen, um die aktuellen Versionen aller Dienste zu nutzen.
Um die mit Azure Stack Hub kompatiblen Dienste einzusetzen, verwenden Sie @azure/arm-resources-profile-hybrid-2020-09-01 oder @azure/arm-storage-profile-2020-09-01-hybrid.
NPM-Pakete
Jeder Ressourcenanbieter verfügt über ein eigenes Paket. Sie können das Paket aus der NPM-Registrierung abrufen.
Dort sind die folgenden Pakete zu finden:
| Ressourcenanbieter | Paket |
|---|---|
| App Service | @azure/arm-resources-profile-2020-09-01-hybrid |
| Azure Resource Manager-Abonnements | @azure/arm-subscriptions-profile-hybrid-2020-09-01 |
| Azure Resource Manager-Richtlinien | @azure/arm-policy-profile-hybrid-2020-09-01 |
| Azure Resource Manager-DNS | @azure/arm-dns-profile-2020-09-01-hybrid |
| Autorisierung | @azure/arm-authorization-profile-2020-09-01-hybrid |
| Compute | @azure/arm-compute-profile-2020-09-01-hybrid |
| Storage | @azure/arm-storage-profile-2020-09-01-hybrid |
| Network | @azure/arm-network-profile-2020-09-01-hybrid |
| Ressourcen | @azure/arm-resources-profile-hybrid-2020-09-01 |
| KeyVault | @azure/arm-keyvault-profile-2020-09-01-hybrid |
Um mit der aktuellsten API-Version eines Diensts zu arbeiten, verwenden Sie das aktuellste Profil der spezifischen Clientbibliothek. Wenn Sie beispielsweise die aktuellste API-Version des Ressourcendiensts allein verwenden möchten, verwenden Sie das azure-arm-resource-Profil des Pakets für die Resource Management-Clientbibliothek.
Die spezifischen API-Versionen eines Ressourcenanbieters zu erhalten Sie, indem Sie die im Paket definierten spezifischen API-Versionen verwenden.
@azure/arm-resourceprovider-profile-2020-09-01-hybrid
Für Azure Stack Hub erstelltes neuestes Profil. Verwenden Sie dieses Profil für Dienste für die höchste Kompatibilität mit Azure Stack Hub, sofern Sie bei Stempel 1808 oder weiter sind.
@azure-arm-resource
Das Profil umfasst die aktuellen Versionen aller Dienste. Verwenden Sie die neuesten Versionen aller Dienste in Azure.
Profiles
Sie können bei Profilen, die Datumsangaben enthalten, das Datum in @azure/arm-keyvault-profile-<date>-hybrid ersetzen, um ein anderes SDK-Profil oder eine andere SDK-Version zu verwenden. Für die Version 2008 lautet das Profil beispielsweise 2019-03-01, und die Zeichenfolge wird zu @azure/arm-keyvault-profile-2019-03-01-hybrid. Beachten Sie, dass das SDK-Team manchmal den Namen der Pakete ändert, sodass das einfache Ersetzen des Datums einer Zeichenfolge durch ein anderes Datum möglicherweise nicht funktioniert. Informationen zur Zuordnung zwischen Profilen und Azure Stack-Versionen finden Sie in der folgenden Tabelle.
| Azure Stack-Version | Profil |
|---|---|
| 2311 | 2020_09_01 |
| 2301 | 2020_09_01 |
| 2206 | 2020_09_01 |
| 2108 | 2020-09-01 |
| 2102 | 2020-09-01 |
| 2008 | 2019-03-01 |
Weitere Informationen zu Azure Stack Hub und API-Profilen finden Sie in der Zusammenfassung zu API-Profilen.
Installieren des Node.js SDK
Installieren Sie Git. Anweisungen hierzu finden Sie unter Getting Started - Installing Git (Erste Schritte: Installieren von Git).
Installieren Sie die aktuelle Version von Node.js, oder führen Sie ein Upgrade darauf aus. Node.js enthält außerdem den JavaScript-Paket-Manager npm.
Installieren Sie Visual Studio Code, oder führen Sie ein Upgrade aus, und installieren Sie die Node.js-Erweiterung für Visual Studio Code.
Installieren Sie die Clientpakete für den Azure Stack Hub Resource Manger. Weitere Informationen finden Sie unter Installieren von Clientbibliotheken.
Welche Pakete installiert werden müssen, hängt von der Profilversion ab, die Sie verwenden möchten. Eine Liste der Ressourcenanbieter finden Sie im Abschnitt Pakete in npm.
Subscription
Wenn Sie noch nicht über ein Abonnement verfügen, erstellen Sie ein Abonnement, und speichern Sie die Abonnement-ID zur späteren Verwendung. Weitere Informationen zum Erstellen eines Abonnements finden Sie in diesem Dokument.
Dienstprinzipal
Ein Dienstprinzipal und seine zugehörigen Umgebungsinformationen sollten erstellt und an einem Ort gespeichert werden. Ein Dienstprinzipal mit der Rolle owner wird empfohlen, aber je nach Beispiel kann eine contributor-Rolle ausreichen. Die erforderlichen Werte finden Sie in der Infodatei im Beispielrepository. Sie können diese Werte in jedem von der SDK-Sprache unterstützten Format lesen, z. B. aus einer JSON-Datei (die in unseren Beispielen verwendet wird). Je nachdem, wie das Beispiel ausgeführt wird, werden möglicherweise nicht alle diese Werte verwendet. Den aktualisierten Beispielcode bzw. weitere Informationen finden Sie im Beispielrepository.
Mandanten-ID
Folgen Sie den Anweisungen in diesem Artikel, um das Verzeichnis oder die Mandanten-ID für Ihre Azure Stack Hub-Instanz zu suchen.
Registrieren von Ressourcenanbietern
Registrieren Sie die erforderlichen Ressourcenanbieter, indem Sie dieses Dokument befolgen. Diese Ressourcenanbieter sind abhängig von den Beispielen, die Sie ausführen möchten, erforderlich. Wenn Sie beispielsweise ein VM-Beispiel ausführen möchten, ist die Registrierung des Ressourcenanbieters Microsoft.Compute erforderlich.
Azure Stack Resource Manager-Endpunkt
Azure Resource Manager (ARM) ist ein Verwaltungsframework, mit dem Administratoren Azure-Ressourcen bereitstellen, verwalten und überwachen können. Azure Resource Manager kann diese Aufgaben als Gruppe – anstatt einzeln – in einem gemeinsamen Vorgang verarbeiten. Sie können die Metadateninformationen vom Resource Manager-Endpunkt abrufen. Der Endpunkt gibt eine JSON-Datei mit den zum Ausführen des Codes erforderlichen Informationen zurück.
Beachten Sie Folgendes:
Der ResourceManagerEndpointUrl-Wert im Azure Stack Development Kit (ASDK) lautet:
https://management.local.azurestack.external/.Die ResourceManagerUrl in integrierten Systemen lautet
https://management.region.<fqdn>/, wobei<fqdn>Ihr vollqualifizierter Domänenname ist.Zum Abrufen der erforderlichen Metadaten verwenden Sie Folgendes:
<ResourceManagerUrl>/metadata/endpoints?api-version=1.0.
JSON-Beispielcode:
{
"galleryEndpoint": "https://portal.local.azurestack.external:30015/",
"graphEndpoint": "https://graph.windows.net/",
"portal Endpoint": "https://portal.local.azurestack.external/",
"authentication":
{
"loginEndpoint": "https://login.windows.net/",
"audiences": ["https://management.yourtenant.onmicrosoft.com/3cc5febd-e4b7-4a85-a2ed-1d730e2f5928"]
}
}
Beispiele
Aktuellen Beispielcode finden Sie im Beispielrepository. In der Stammdatei README.md sind allgemeine Anforderungen beschrieben, und jedes Unterverzeichnis enthält ein bestimmtes Beispiel mit einer eigenen Datei vom Typ README.md, die Informationen zum Ausführen dieses Beispiels enthält.
Hier finden Sie die Beispielanwendung für die Azure Stack-Version 2008 oder das Profil 2019-03-01 und niedriger.
Nächste Schritte
Weitere Informationen zu API-Profilen: