Delen via


API-versieprofielen beheren in Azure Stack Hub

API-profielen geven de Azure-resourceprovider en de API-versie voor Azure REST-eindpunten op. U kunt aangepaste clients in verschillende talen maken met behulp van API-profielen. Elke client gebruikt een API-profiel om contact op te maken met de juiste resourceprovider en API-versie voor Azure Stack Hub.

U kunt een app maken om met Azure-resourceproviders te werken zonder precies te hoeven weten welke versie van elke resourceprovider-API compatibel is met Azure Stack Hub. U hoeft uw app alleen uit te lijnen op een profiel en de SDK wordt teruggezet naar de juiste API-versie.

Dit onderwerp helpt u bij het volgende:

  • Api-profielen voor Azure Stack Hub begrijpen.
  • Meer informatie over hoe u API-profielen kunt gebruiken om uw oplossingen te ontwikkelen.
  • Zie waar u codespecifieke richtlijnen kunt vinden.

Overzicht van API-profielen

  • API-profielen worden gebruikt om een set Azure-resourceproviders en hun API-versies weer te geven.
  • API-profielen zijn gemaakt voor het maken van sjablonen in meerdere Azure-clouds. Profielen bieden een compatibele en stabiele interface.
  • Profielen worden vier keer per jaar uitgebracht.
  • Er worden drie naamconventies voor profielen gebruikt:
    • laatst
      Bevat de meest recente API-versies die zijn uitgebracht in globale Azure.
    • jjjj-mm-dd-hybride
      Deze release is bi-annual uitgebracht en richt zich op consistentie en stabiliteit in meerdere clouds. Dit profiel is gericht op optimale compatibiliteit met Azure Stack Hub.
    • jjjj-mm-dd-profiel
      Zorgt voor optimale stabiliteit en de nieuwste functies.

Azure API-profielen en Compatibiliteit met Azure Stack Hub

De nieuwste Azure API-profielen zijn niet compatibel met Azure Stack Hub. Gebruik de volgende naamconventies om te bepalen welke profielen moeten worden gebruikt voor uw Azure Stack Hub-oplossingen:

laatst
Dit profiel heeft de meest recente API-versies die zijn gevonden in globale Azure, die niet werken in Azure Stack Hub. nieuwste heeft het grootste aantal belangrijke wijzigingen. Het profiel zet stabiliteit en compatibiliteit met andere clouds opzij. Als u de meest recente API-versies probeert te gebruiken, is het meest recente profiel dat u moet gebruiken.

JJJJ-mm-dd-hybride
Dit profiel wordt elk jaar uitgebracht in maart en september. Het heeft optimale stabiliteit en compatibiliteit met verschillende clouds en is ontworpen om wereldwijde Azure en Azure Stack Hub te richten. De Azure API-versies die in dit profiel worden vermeld, zijn hetzelfde als de versies die worden vermeld in Azure Stack Hub. Gebruik dit profiel om code te ontwikkelen voor hybride cloudoplossingen.

jjjj-mm-dd-profiel
Dit profiel wordt uitgebracht voor wereldwijde Azure in juni en december. Het werkt niet met Azure Stack Hub en er zijn meestal veel belangrijke wijzigingen. Hoewel het optimale stabiliteit en de nieuwste functies in balans brengt, is het verschil tussen de nieuwste en dit profiel dat de nieuwste altijd bestaat uit de nieuwste API-versies, ongeacht wanneer de API wordt uitgebracht. Als er morgen bijvoorbeeld een nieuwe API-versie wordt gemaakt voor de Compute-API, wordt die API-versie vermeld in de meest recente, maar niet in het profiel jjjj-mm-dd-profiel , omdat dit profiel al bestaat. jjjj-mm-dd-profiel omvat de meest recente versies die vóór juni of vóór december zijn uitgebracht.

Api-profielen voor Azure Resource Manager

Azure Stack Hub gebruikt niet de nieuwste versie van de API-versies die zijn gevonden in globale Azure. Wanneer u een oplossing maakt, moet u de API-versie vinden voor elke Azure-resourceprovider die compatibel is met Azure Stack Hub.

In plaats van elke resourceprovider en de specifieke versie te onderzoeken die wordt ondersteund door Azure Stack Hub, kunt u een API-profiel gebruiken. Het profiel geeft een set resourceproviders en API-versies op. De SDK, of een hulpprogramma dat is gebouwd met de SDK, wordt teruggezet naar het doel api-version dat is opgegeven in het profiel. Met API-profielen kunt u een profielversie opgeven die van toepassing is op een hele sjabloon. Tijdens runtime selecteert Azure Resource Manager de juiste versie van de resource.

API-profielen werken met hulpprogramma's die gebruikmaken van Azure Resource Manager, zoals PowerShell, Azure CLI, code die is opgegeven in de SDK en Microsoft Visual Studio. Hulpprogramma's en SDK's kunnen profielen gebruiken om te lezen welke versie van de modules en bibliotheken moeten worden opgenomen bij het bouwen van een app.

Als u bijvoorbeeld PowerShell gebruikt om een opslagaccount te maken met behulp van de Microsoft.Storage-resourceprovider, die api-versie 2016-03-30 en een VM ondersteunt met behulp van de Microsoft.Compute-resourceprovider met api-versie 2015-12-01, moet u opzoeken welke PowerShell-module ondersteuning biedt voor 2016-03-30 voor Opslag en welke module ondersteuning biedt voor 2015-02-01 voor Compute en deze vervolgens installeren. In plaats daarvan kunt u een profiel gebruiken. Gebruik de cmdlet Install-Profile <profilename>en PowerShell laadt de juiste versie van de modules.

Op dezelfde manier kunt u het profiel opgeven wanneer u de Python-SDK gebruikt om een Python-app te bouwen. De SDK laadt de juiste modules voor de resourceproviders die u in uw script hebt opgegeven.

Als ontwikkelaar betekent dit dat u zich kunt richten op het schrijven van uw oplossing. In plaats van te onderzoeken welke API-versies, resourceprovider en cloud samenwerken, kunt u een profiel gebruiken en weten dat uw code werkt in alle clouds die dat profiel ondersteunen.

Voorbeelden van API-profielcode

U vindt codevoorbeelden om u te helpen uw oplossing te integreren met uw voorkeurstaal met Azure Stack Hub met behulp van profielen. Op dit moment vindt u richtlijnen en voorbeelden voor de volgende talen:

  • .NET
    Gebruik het .NET API-profiel om de meest recente, stabiele versie van elk resourcetype in een resourceproviderpakket op te halen. Zie API-versieprofielen gebruiken met .NET in Azure Stack Hub voor meer informatie.
  • Powershell
    Gebruik de Az.Bootstrapper-module die beschikbaar is via de PowerShell Gallery om de PowerShell-cmdlets op te halen die nodig zijn om te werken met API-versieprofielen. Zie API-versieprofielen gebruiken voor PowerShell voor meer informatie. Gebruik de AzureRM.Bootstrapper-module die beschikbaar is via de PowerShell Gallery om de PowerShell-cmdlets op te halen die nodig zijn om te werken met API-versieprofielen. Zie API-versieprofielen gebruiken voor PowerShell voor meer informatie.
  • Azure-CLI
    Werk uw omgevingsconfiguratie bij om het specifieke API-versieprofiel van Azure Stack Hub te gebruiken. Zie API-versieprofielen gebruiken voor Azure CLI voor meer informatie.
  • Go
    In de Go SDK is een profiel een combinatie van verschillende resourcetypen met verschillende versies van verschillende services. Profielen zijn beschikbaar onder de profielen/het pad met hun versie in de JJJJ-MM-DD-indeling . Zie API-versieprofielen gebruiken voor Go voor meer informatie.
  • Python
    De Python SDK ondersteunt API-versieprofielen voor verschillende cloudplatforms, zoals Azure Stack Hub en globale Azure. Api-profielen gebruiken om oplossingen te maken voor een hybride cloud. Zie API-versieprofielen gebruiken met Python voor meer informatie.
  • Node.js
    De Node.js SDK voor Azure Stack Hub Resource Manager biedt hulpprogramma's waarmee u uw infrastructuur kunt bouwen en beheren. Zie API-versieprofielen gebruiken met Node.js voor meer informatie.

Volgende stappen