Verwenden der Azure-Bibliotheken (SDK) für Python

  • Artikel

Die Open-Source-basierten Azure-Bibliotheken für Python vereinfachen die Bereitstellung, Verwaltung und Verwendung von Azure-Ressourcen über Python-Anwendungscode.

Die Details, die Sie wirklich interessieren

Nicht wesentliche, aber immer noch interessante Details

  • Da die Azure CLI mithilfe der Verwaltungsbibliotheken in Python geschrieben wird, können Sie alles, was Sie mit Azure CLI-Befehlen tun können, auch über ein Python-Skript ausführen. Dies bedeutet, dass CLI-Befehle viele hilfreiche Features bereitstellen, wie z. B. das gemeinsame Ausführen mehrerer Aufgaben, das automatische Verarbeiten asynchroner Vorgänge, das Formatieren von Ausgaben wie Verbindungszeichenfolgen usw. Daher kann die Verwendung der CLI (oder seiner Entsprechung, Azure PowerShell) für automatisierte Erstellungs- und Verwaltungsskripts bequemer sein als das Schreiben des entsprechenden Python-Codes, es sei denn, Sie möchten ein viel genaueres Maß an Kontrolle über den Prozess haben.

  • Die Azure-Bibliotheken für Python basieren auf der zugrunde liegenden Azure REST-API, sodass Sie diese APIs über vertraute Python-Paradigmen verwenden können. Sie können die REST-API aber auch immer direkt aus Python-Code heraus verwenden, wenn dies gewünscht ist.

  • Der Quellcode für die Azure-Bibliotheken steht unter https://github.com/Azure/azure-sdk-for-python zur Verfügung. Da es sich um ein Open-Source-Projekt handelt, sind Beiträge herzlich willkommen.

  • Die Bibliotheken können zwar mit anderen Interpretern wie IronPython und Jython verwendet werden, mit denen sie nicht getestet wurden, dabei kann es jedoch zu vereinzelten Problemen und Inkompatibilitäten kommen.

  • Das Quellrepository für die Referenzdokumentation zur Bibliotheks-API finden Sie unter https://github.com/MicrosoftDocs/azure-docs-sdk-python/.

  • Ab 2019 haben wir Azure Python-Bibliotheken aktualisiert, um gemeinsame Cloudmuster wie Authentifizierungsprotokolle, Protokollierung, Ablaufverfolgung, Transportprotokolle, gepufferte Antworten und Wiederholungen zu teilen. Die aktualisierten Bibliotheken entsprechen den aktuellen Azure SDK-Richtlinien.

    • Am 31. März 2023 haben wir die Unterstützung für Azure SDK-Bibliotheken eingestellt, die nicht den aktuellen Azure SDK-Richtlinien entsprechen. Ältere Bibliotheken können zwar noch über den 31. März 2023 hinaus verwendet werden, aber sie erhalten nicht mehr offiziellen Support und Updates von Microsoft. Weitere Informationen finden Sie im Hinweis zum Aktualisieren Ihrer Azure SDK-Bibliotheken.

    • Um zu vermeiden, dass Sicherheits- und Leistungsupdates auf die Azure SDKs fehlen, aktualisieren Sie bis zum 31. März 2023 auf die neuesten Azure SDK-Bibliotheken .

    • Um zu überprüfen, welche Python-Bibliotheken betroffen sind, lesen Sie die veralteten Versionen von Azure SDK für Python.

  • Ausführliche Informationen zu den Richtlinien, die wir für die Bibliotheken anwenden, finden Sie in den Python-Richtlinien: Einführung.

Erstellen und Verwalten von Azure-Ressourcen mit Verwaltungsbibliotheken

Die Verwaltungsbibliotheken (oder "Verwaltungsebene") des SDK, mit denen alle beginnenazure-mgmt-, helfen Ihnen, Azure-Ressourcen aus Python-Skripts zu erstellen, zu konfigurieren und anderweitig zu verwalten. Alle Azure-Dienste verfügen über entsprechende Verwaltungsbibliotheken. Weitere Informationen finden Sie unter Steuerungsebene und Datenebene von Azure.

Mit den Verwaltungsbibliotheken können Sie Konfigurations- und Bereitstellungsskripts schreiben, um dieselben Aufgaben auszuführen, die Sie auch über das Azure-Portal oder mithilfe der Azure CLI durchführen können. (Wie zuvor erwähnt, ist die Azure CLI in Python geschrieben und verwendet die Verwaltungsbibliotheken, um ihre verschiedenen Befehle zu implementieren.)

In den folgenden Beispielen wird die Verwendung einiger der primären Verwaltungsbibliotheken veranschaulicht:

Ausführliche Informationen zur Verwendung der Verwaltungsbibliotheken finden Sie im SDK-GitHub-Repository in der Datei README.md oder README.rst, die sich im Projektordner der jeweiligen Bibliothek befindet. Weitere Codeausschnitte stehen in der Referenzdokumentation sowie in den Azure-Beispielen zur Verfügung.

Migrieren aus älteren Verwaltungsbibliotheken

Wenn Sie Code aus älteren Versionen der Verwaltungsbibliotheken migrieren, lesen Sie die folgenden Details:

  • Wenn Sie die Klasse ServicePrincipalCredentials verwenden, lesen Sie Authentifizieren mit Zugriffstoken-Anmeldeinformationen.
  • Die Namen asynchroner APIs haben sich geändert. Entsprechende Informationen finden Sie unter Asynchrone Vorgänge. Die Namen asynchroner APIs in neueren Bibliotheken beginnen mit begin_. Die API-Signatur bleibt in den meisten Fällen unverändert.

Verbinden mit und Verwenden von Azure-Ressourcen mit Clientbibliotheken

Die Clientbibliotheken (oder die „Datenebene“) helfen Ihnen beim Schreiben von Python-Anwendungscode, um mit bereits bereitgestellten Diensten zu interagieren. Clientbibliotheken sind nur für Dienste mit Client-API-Unterstützung vorhanden.

Der Artikel " Beispiel: Verwenden von Azure Storage" bietet eine grundlegende Abbildung der Verwendung von Clientbibliotheken.

Für verschiedene Azure-Dienste stehen ebenfalls Beispiele mit diesen Bibliotheken zur Verfügung. Weitere Links finden Sie auf den folgenden Indexseiten:

Ausführliche Informationen zur Verwendung der Clientbibliotheken finden Sie im GitHub-Repository des SDK in der Datei README.md oder README.rst, die sich im Projektordner der jeweiligen Bibliothek befindet. Weitere Codeausschnitte stehen in der Referenzdokumentation sowie in den Azure-Beispielen zur Verfügung.

Hilfe erhalten und das SDK-Team kontaktieren

Nächster Schritt

Es wird dringend empfohlen, Ihre lokale Entwicklungsumgebung einmalig einzurichten, um die Azure-Bibliotheken für Python problemlos verwenden zu können.

Einrichten Ihrer lokalen Entwicklungsumgebung >>>