API-versieprofielen gebruiken met Node.js Software Development Kit (SDK) in Azure Stack Hub

Artikel
04/08/2024

Node.js- en API-versieprofielen

U kunt Node.js SDK gebruiken om de infrastructuur voor uw apps te bouwen en te beheren. API-profielen in de Node.js SDK helpen bij uw hybride cloudoplossingen doordat u kunt schakelen tussen globale Azure-resources en Azure Stack Hub-resources. U kunt één keer code schrijven en vervolgens zowel globale Azure als Azure Stack Hub targeten.

In dit artikel kunt u Visual Studio Code gebruiken als ontwikkelhulpprogramma. Visual Studio Code kan fouten opsporen in de Node.js SDK en stelt u in staat om de app uit te voeren en de app naar uw Azure Stack Hub-exemplaar te pushen. U kunt fouten opsporen vanuit Visual Studio Code of via een terminalvenster waarop de opdracht node <nodefile.js>wordt uitgevoerd.

De Node.js SDK

De Node.js SDK biedt Azure Stack Hub Resource Manager hulpprogramma's. Resourceproviders in de SDK omvatten compute, netwerken, opslag, app-services en KeyVault. Er zijn 10 clientbibliotheken van de resourceprovider die u in uw node.js-toepassing kunt installeren. U kunt ook downloaden welke resourceprovider u wilt gebruiken voor het profiel 2020-09-01 om het geheugen voor uw toepassing te optimaliseren. Elke module bestaat uit een resourceprovider, de respectieve API-versie en het API-profiel.

Een API-profiel is een combinatie van resourceproviders en API-versies. U kunt een API-profiel gebruiken om de meest recente, meest stabiele versie van elk resourcetype in een resourceproviderpakket op te halen.

Als u gebruik wilt maken van de nieuwste versies van alle services, gebruikt u het meest recente profiel van de pakketten.
Als u de services wilt gebruiken die compatibel zijn met Azure Stack Hub, gebruikt u de @azure/arm-resources-profile-hybrid-2020-09-01 of @azure/arm-storage-profile-2020-09-01-hybrid

NPM-pakketten

Elke resourceprovider heeft een eigen pakket. U kunt het pakket ophalen uit het npm-register.

U kunt de volgende pakketten vinden:

Resourceprovider	Pakket
App Service	@azure/arm-resources-profile-2020-09-01-hybrid
Azure Resource Manager-abonnementen	@azure/arm-subscriptions-profile-hybrid-2020-09-01
Azure Resource Manager Policy	@azure/arm-policy-profile-hybrid-2020-09-01
Azure Resource Manager DNS	@azure/arm-dns-profile-2020-09-01-hybrid
Autorisatie	@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
Netwerk	@azure/arm-network-profile-2020-09-01-hybrid
Bronnen	@azure/arm-resources-profile-hybrid-2020-09-01
Sleutelkluis	@azure/arm-keyvault-profile-2020-09-01-hybrid

Als u de nieuwste API-versie van een service wilt gebruiken, gebruikt u het profiel Nieuwste van de specifieke clientbibliotheek. Als u bijvoorbeeld alleen de meest recente API-versie van de resourceservice wilt gebruiken, gebruikt u het azure-arm-resource profiel van het pakket Resource Management Client Library.

Gebruik de specifieke API-versies die in het pakket zijn gedefinieerd voor de specifieke API-versies van een resourceprovider.

@azure/arm-resourceprovider-profile-2020-09-01-hybrid

Meest recente profiel dat is gemaakt voor Azure Stack Hub. Gebruik dit profiel voor services die het meest compatibel zijn met Azure Stack Hub, zolang u een 1808-zegel of hoger hebt.
@azure arm-resource

Profiel bestaat uit de nieuwste versies van alle services. Gebruik de nieuwste versies van alle services in Azure.

Profielen

Als u een ander SDK-profiel of -versie wilt gebruiken voor profielen die datums bevatten, kunt u de datum vervangen in @azure/arm-keyvault-profile-<date>-hybrid. Voor versie 2008 is het profiel bijvoorbeeld , en wordt 2019-03-01de tekenreeks @azure/arm-keyvault-profile-2019-03-01-hybrid. Houd er rekening mee dat het SDK-team soms de naam van de pakketten wijzigt, dus het vervangen van de datum van een tekenreeks door een andere datum werkt mogelijk niet. Zie de volgende tabel voor het koppelen van profielen en Azure Stack-versies.

Azure Stack-versie	Profiel
2311	2020_09_01
2301	2020_09_01
2206	2020_09_01
2108	2020-09-01
2102	2020-09-01
2008	2019-03-01

Zie de Samenvatting van API-profielen voor meer informatie over Azure Stack Hub- en API-profielen.

De Node.js SDK installeren

Installeer Git. Zie Aan de slag - Git installeren voor instructies.
Installeer of upgrade naar de huidige versie van Node.js. Node.js bevat ook het npm JavaScript-pakketbeheer.
Installeer of upgrade Visual Studio Code en installeer de Node.js-extensie voor Visual Studio Code.
Installeer de clientpakketten voor het Azure Stack Hub-resourcebeheer. Zie clientbibliotheken installeren voor meer informatie.
Welke pakketten moeten worden geïnstalleerd, is afhankelijk van de profielversie die u wilt gebruiken. U vindt een lijst met resourceproviders in de sectie Pakketten in npm .

Abonnement

Als u nog geen abonnement hebt, maakt u een abonnement en slaat u de abonnements-id op die u later wilt gebruiken. Zie dit document voor meer informatie over het maken van een abonnement.

Service-principal

Een service-principal en de bijbehorende omgevingsgegevens moeten ergens worden gemaakt en opgeslagen. Service-principal met owner rol wordt aanbevolen, maar afhankelijk van het voorbeeld kan een contributor rol voldoende zijn. Raadpleeg leesmij in de voorbeeldopslagplaats voor de vereiste waarden. U kunt deze waarden lezen in elke indeling die wordt ondersteund door de SDK-taal, zoals in een JSON-bestand (dat in onze voorbeelden wordt gebruikt). Afhankelijk van het voorbeeld dat wordt uitgevoerd, kunnen niet al deze waarden worden gebruikt. Zie de voorbeeldopslagplaats voor bijgewerkte voorbeeldcode of meer informatie.

Tenant-id

Volg de instructies in dit artikel om de map of tenant-id voor uw Azure Stack Hub te vinden.

Resourceprovider registreren

Registreer vereiste resourceproviders door dit document te volgen. Deze resourceproviders zijn vereist, afhankelijk van de voorbeelden die u wilt uitvoeren. Als u bijvoorbeeld een VM-voorbeeld wilt uitvoeren, is de registratie van de Microsoft.Compute resourceprovider vereist.

Azure Stack Resource Manager-eindpunt

Azure Resource Manager (ARM) is een beheerframework waarmee beheerders Azure-resources kunnen implementeren, beheren en bewaken. Azure Resource Manager kunnen deze taken als een groep in plaats van afzonderlijk in één bewerking verwerken. U kunt de metagegevensgegevens ophalen uit het Resource Manager-eindpunt. Het eindpunt retourneert een JSON-bestand met de informatie die nodig is om uw code uit te voeren.

Overweeg de volgende:

De ResourceManagerEndpointUrl in de Azure Stack Development Kit (ASDK) is: https://management.local.azurestack.external/.
De ResourceManagerEndpointUrl in geïntegreerde systemen is: https://management.region.<fqdn>/, waarbij <fqdn> uw fully qualified domain name is.
Ga als volgende te werk om de vereiste metagegevens op te halen: <ResourceManagerUrl>/metadata/endpoints?api-version=1.0

Voorbeeld van JSON:

{
   "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"]
      }
}

Voorbeelden

Zie de voorbeeldopslagplaats voor voorbeeldcode bijwerken tot heden. In de hoofdmap README.md worden algemene vereisten beschreven en elke submap bevat een specifiek voorbeeld met een eigen README.md voorbeeld over het uitvoeren van dat voorbeeld.

Kijk hier voor het voorbeeld dat van toepassing is op azure Stack-versie 2008 of -profiel 2019-03-01 en hieronder.

Volgende stappen

Meer informatie over API-profielen:

Share via