API-versieprofielen beheren in Azure Stack Hub

  • Artikel
  • 5 minuten om te lezen

MET API-profielen geeft u 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 nemen met de juiste resourceprovider en API-versie voor Azure Stack Hub.

U kunt een app maken om te werken met Azure-resourceproviders zonder dat u precies weet welke versie van elke resourceprovider-API compatibel is met Azure Stack Hub. Lijn uw app uit op een profiel en de SDK keert terug naar de juiste API-versie.

In dit onderwerp wordt uitgelegd hoe u het volgende kunt doen:

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

Samenvatting van API-profielen

  • API-profielen worden gebruikt om een set Azure-resourceproviders en hun API-versies te vertegenwoordigen.
  • ER zijn API-profielen 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 naamconventen voor profielen gebruikt:
    • meest recente
      Bevat de meest recente API-versies die zijn uitgebracht in azure wereldwijd.
    • yyyy-mm-dd-hybrid
      Deze release wordt twee keer per jaar uitgebracht en is gericht op consistentie en stabiliteit in meerdere clouds. Dit profiel is gericht op optimale Azure Stack Hub compatibiliteit.
    • yyyy-mm-dd-profile
      Zorgt voor optimale stabiliteit en de nieuwste functies.

Azure API-profielen en Azure Stack Hub compatibiliteit

De nieuwste Azure API-profielen zijn niet compatibel met Azure Stack Hub. Gebruik de volgende naamconventen om te bepalen welke profielen u voor uw Azure Stack Hub gebruiken:

meest recente
Dit profiel heeft de meest recente API-versies in Azure wereldwijd, die niet werken in Azure Stack Hub. latest heeft het grootste aantal belangrijke wijzigingen. In het profiel worden stabiliteit en compatibiliteit met andere clouds weggelaten. Als u de meest recente API-versies probeert te gebruiken, is de meest recente versie het profiel dat u moet gebruiken.

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

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

Azure Resource Manager API-profielen

Azure Stack Hub maakt geen gebruik van de nieuwste versie van de API-versies die in Azure wereldwijd worden gevonden. 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 door Azure Stack Hub wordt ondersteund, kunt u een API-profiel gebruiken. Het profiel geeft een set resourceproviders en API-versies aan. De SDK, of een hulpprogramma dat is gebouwd met de SDK, api-version keert terug naar het doel dat is opgegeven in het profiel. Met API-profielen kunt u een profielversie opgeven die van toepassing is op een volledige sjabloon. Tijdens runtime selecteert Azure Resource Manager de juiste versie van de resource.

API-profielen werken met hulpprogramma's 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 moet worden gebruikt bij het bouwen van een app.

Als u bijvoorbeeld PowerShell gebruikt om een opslagaccount te maken met behulp van de resourceprovider Microsoft.Storage, die ondersteuning biedt voor API-versie 2016-03-30 en een VM die gebruik maakt van de resourceprovider Microsoft.Compute met API-versie 2015-12-01, moet u nalezen welke PowerShell-module 2016-03-30 voor Storage ondersteunt en welke module 2015-02-01 ondersteunt voor Compute en deze vervolgens installeert. 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 hebt opgegeven in het script.

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.

Codevoorbeelden voor API-profiel

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

Volgende stappen