Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
API-Profile geben den Azure-Ressourcenanbieter und die API-Version für Azure-REST-Endpunkte an. Mithilfe von API-Profilen können Sie benutzerdefinierte Clients in verschiedenen Sprachen erstellen. Jeder Client nutzt ein API-Profil, um eine Verbindung mit dem richtigen Ressourcenanbieter und der richtigen API-Version für Azure Stack Hub herzustellen.
Sie können eine App für die Verwendung mit Azure-Ressourcenanbietern erstellen, ohne genau wissen zu müssen, welche Version der jeweiligen Ressourcenanbieter-API mit Azure Stack Hub kompatibel ist. Richten Sie Ihre App einfach an einem Profil aus, und das SDK richtet sich an die richtige API-Version aus.
Dieses Thema enthält folgende Informationen:
- Grundlegende Informationen zu API-Profilen für Azure Stack Hub.
- Informationen zur Verwendung von API-Profilen für die Entwicklung Ihrer Lösungen
- Informationen dazu, wo Sie codespezifische Anleitungen finden
Zusammenfassung zu API-Profilen
- API-Profile werden zur Darstellung mehrerer Azure-Ressourcenanbieter und ihrer API-Versionen verwendet.
- API-Profile wurden erstellt, damit Sie Vorlagen für mehrere Azure-Clouds generieren können. Profile bieten eine kompatible und stabile Schnittstelle.
- Profile werden viermal pro Jahr veröffentlicht.
- Es werden drei Benennungskonventionen für Profile verwendet:
-
neueste
Enthält die neuesten in der globalen Azure-Umgebung veröffentlichen API-Versionen. -
jjjj-mm-tt-hybrid
Halbjährliche Veröffentlichung. Bei dieser Veröffentlichung stehen die cloudübergreifende Konsistenz und Stabilität im Vordergrund. Das Ziel dieses Profils ist die optimale Kompatibilität mit Azure Stack Hub. -
yyyy-mm-dd-Profil
Stellt einen Kompromiss zwischen optimaler Stabilität und neuesten Features dar.
-
neueste
Azure-API-Profile und Azure Stack Hub-Kompatibilität
Die neuesten Azure-API-Profile sind nicht mit Azure Stack Hub kompatibel. Verwenden Sie die folgenden Benennungskonventionen, um die Profile für Ihre Azure Stack Hub-Lösungen zu identifizieren:
neueste
Dieses Profil enthält die aktuellsten API-Versionen in der globalen Azure-Umgebung, die in Azure Stack Hub nicht funktionieren.
latest umfasst die größte Anzahl von Breaking Changes. Das Profil vernachlässigt die Stabilität und Kompatibilität mit anderen Clouds. Wenn Sie die neuesten API-Versionen nutzen möchten, sollten Sie das Profil latest verwenden.
jjjj-mm-tt-hybrid
Dieses Profil wird jedes Jahr im März und im September veröffentlicht. Es verfügt über eine optimale Stabilität und Kompatibilität mit verschiedenen Clouds und ist für die Verwendung von globalem Azure und Azure Stack Hub konzipiert. Die in diesem Profil aufgeführten Azure-API-Versionen sind mit den Versionen identisch, die in Azure Stack Hub aufgeführt werden. Verwenden Sie dieses Profil, um Code für Hybridcloudlösungen zu entwickeln.
yyyy-mm-dd-Profil
Dieses Profil wird für die globale Azure-Umgebung im Juni und Dezember veröffentlicht. Es funktioniert nicht für Azure Stack Hub. In der Regel kommt es zu zahlreichen Breaking Changes. Obwohl es eine optimale Stabilität und die neuesten Features bietet, besteht der Unterschied zwischen dem neuesten und diesem Profil darin, dass die neuesten API-Versionen immer bestehen, unabhängig davon, wann die API veröffentlicht wird. Wenn beispielsweise morgen eine neue API-Version für die Compute-API erstellt wird, wird diese API-Version in der neuesten, aber nicht im yyyy-mm-dd-Profil aufgeführt, da dieses Profil bereits vorhanden ist.
jjjj-mm-tt-profile umfasst die neuesten Versionen, die vor Juni oder vor Dezember veröffentlicht wurden.
Azure Resource Manager-API-Profile
Azure Stack Hub verwendet nicht die aktuellste Version der API-Versionen in der globalen Azure-Umgebung. Wenn Sie Ihre eigene Lösung erstellen, müssen Sie für jeden Azure-Ressourcenanbieter die API-Version ermitteln, die mit Azure Stack Hub kompatibel ist.
Sie können ein API-Profil verwenden, um nicht die einzelnen Ressourcenanbieter und die jeweils von Azure Stack Hub unterstützten spezifischen Versionen ermitteln zu müssen. Das Profil gibt verschiedene Ressourcenanbieter und API-Versionen an. Das SDK bzw. ein mit dem SDK erstelltes Tool wählt dann das im Profil angegebene api-version-Zielelement aus. Mit API-Profilen können Sie eine Profilversion angeben, die für eine gesamte Vorlage gilt. Zur Laufzeit wählt der Azure Resource Manager die richtige Version der Ressource aus.
API-Profile können mit Tools verwendet werden, die Azure Resource Manager nutzen, beispielsweise mit PowerShell, der Azure CLI, im SDK bereitgestelltem Code und Microsoft Visual Studio. Tools und SDKs können mithilfe von Profilen lesen, welche Version der Module und Bibliotheken beim Erstellen einer App aufgenommen werden soll.
Wenn Sie beispielsweise PowerShell zum Erstellen eines Speicherkontos mit dem Microsoft.Storage-Ressourcenanbieter verwenden, die api-Version 2016-03-30 und einen virtuellen Computer mit dem Microsoft.Compute-Ressourcenanbieter mit API-Version 2015-12-01 unterstützt, müssen Sie nachschlagen, welches PowerShell-Modul 2016-03-30 für Speicher unterstützt und welches Modul 2015-02-01 für Compute unterstützt, und installieren Sie sie dann. Stattdessen können Sie ein Profil verwenden. Verwenden Sie das Cmdlet Install-Profile <profilename>, und PowerShell lädt die richtige Version der Module.
Analog dazu können Sie das Profil angeben, wenn Sie das Python SDK zum Erstellen einer Python-basierten App verwenden. Das SDK lädt die richtigen Module für die Ressourcenanbieter, die Sie in Ihrem Skript angegeben haben.
Als Entwickler können Sie sich so auf das Schreiben Ihrer Lösung konzentrieren. Statt zu ermitteln, welche API-Versionen, Ressourcenanbieter und Clouds zusammen verwendet werden können, verwenden Sie ein Profil und können sicher sein, dass Ihr Code in allen Clouds funktioniert, die dieses Profil unterstützen.
Codebeispiele für API-Profile
Es gibt Codebeispiele, die Sie dabei unterstützen, mithilfe von Profilen Ihre Lösung mit Ihrer bevorzugten Sprache in Azure Stack Hub zu integrieren. Derzeit stehen Anleitungen und Beispiele für die folgenden Sprachen zur Verfügung:
-
.NETTO
Verwenden Sie das API-Profil, um die aktuelle stabilste Version der einzelnen Ressourcentypen in einem Ressourcenanbieterpaket abzurufen. Weitere Informationen finden Sie unter Verwenden von API-Versionsprofilen mit .NET im Azure Stack Hub. -
PowerShell
Verwenden Sie das Az.Bootstrapper-Modul , das über den PowerShell-Katalog verfügbar ist, um die PowerShell-Cmdlets abzurufen, die zum Arbeiten mit API-Versionsprofilen erforderlich sind. Weitere Informationen finden Sie unter Verwenden von API-Versionsprofilen für PowerShell. Verwenden Sie das über den PowerShell-Katalog verfügbare AzureRM.Bootstrapper-Modul , um die PowerShell-Cmdlets abzurufen, die zum Arbeiten mit API-Versionsprofilen erforderlich sind. Weitere Informationen finden Sie unter Verwenden von API-Versionsprofilen für PowerShell. -
Azure CLI
Aktualisieren Sie Ihre Umgebungskonfiguration so, dass das spezifische API-Versionsprofil für Azure Stack Hub verwendet wird. Für weitere Informationen sehen Sie unter API-Versionsprofile für die Azure CLI verwenden nach. -
Los geht's
Im Go SDK ist ein Profil eine Kombination aus verschiedenen Ressourcentypen mit unterschiedlichen Versionen aus verschiedenen Diensten. Profile sind unter dem Pfad profiles mit ihrer Version im Format JJJJ-MM-DD verfügbar. Weitere Informationen finden Sie unter Verwenden von API-Versionsprofilen für Go. -
Python
Das Python SDK unterstützt API-Versionsprofile für unterschiedliche Cloudplattformen, z. B. Azure Stack Hub und globales Azure. Verwenden Sie API-Profile zum Erstellen von Lösungen für Hybrid Cloud. Weitere Informationen finden Sie unter Verwenden von API-Versionsprofilen mit Python. -
Node.js
Das Node.js SDK für Azure Stack Hub Resource Manager umfasst Tools zum Erstellen und Verwalten Ihrer Infrastruktur. Weitere Informationen finden Sie unter Verwenden von API-Versionsprofilen mit Node.js.