De Azure-bibliotheken (SDK) voor Python gebruiken

Artikel
10/23/2023

De opensource-Azure-bibliotheken voor Python vereenvoudigen het inrichten, beheren en gebruiken van Azure-resources vanuit Python-toepassingscode.

De details die u echt wilt weten

De Azure-bibliotheken zijn hoe u communiceert met Azure-services vanuit Python-code die u lokaal of in de cloud uitvoert. (Of u Python-code binnen het bereik van een bepaalde service kunt uitvoeren, is afhankelijk van of die service zelf momenteel Python ondersteunt.)
De bibliotheken ondersteunen Python 3.8 of hoger. Zie het ondersteuningsbeleid voor Azure SDK's voor Python-versies voor meer informatie over ondersteunde versies van Python. Als u PyPy gebruikt, moet u ervoor zorgen dat de versie die u gebruikt ten minste ondersteuning biedt voor de Eerder genoemde Python-versie.
De Azure SDK voor Python bestaat alleen uit meer dan 180 afzonderlijke Python-bibliotheken die betrekking hebben op specifieke Azure-services. Er zijn geen andere hulpprogramma's in de SDK.
Wanneer u code lokaal uitvoert, is verificatie met Azure afhankelijk van omgevingsvariabelen, zoals beschreven in Het verifiëren van Python-apps voor Azure-services met behulp van de Azure SDK voor Python.
Als u bibliotheekpakketten met pip wilt installeren, gebruikt pip install <library_name> u bibliotheeknamen uit de pakketindex. Als u bibliotheekpakketten in conda-omgevingen wilt installeren, gebruikt conda install <package_name> u namen van het Microsoft-kanaal op anaconda.org. Zie Azure-bibliotheekpakketten installeren voor meer informatie.
Er zijn verschillende beheer- en clientbibliotheken (soms aangeduid als 'beheervlak' en 'gegevensvlak'-bibliotheken). Elke set dient verschillende doeleinden en wordt gebruikt door verschillende soorten code. Zie de volgende secties verderop in dit artikel voor meer informatie:
- Azure-resources maken en beheren met beheerbibliotheken
- Verbinding maken azure-resources gebruiken met clientbibliotheken
Documentatie voor de bibliotheken vindt u in de Naslaginformatie voor Azure voor Python, die is georganiseerd door Azure Service of de Python API-browser, die is ingedeeld op pakketnaam.
Als u de bibliotheken voor uzelf wilt proberen, raden we u eerst aan om uw lokale ontwikkelomgeving in te stellen. Vervolgens kunt u een van de volgende zelfstandige voorbeelden (in elke volgorde): Voorbeeld: Een resourcegroep maken, voorbeeld: Azure Storage maken en gebruiken, voorbeeld: een web-app maken en implementeren, voorbeeld: een MySQL-database maken en er query's op uitvoeren, en voorbeeld: een virtuele machine maken.
Zie Introductie van de Azure SDK voor Python (PyCon 2021) en Het gebruik van Azure SDK's om te communiceren met Azure-resources (PyCon 2020) voor demonstratievideo's.

Niet-essentiële maar nog steeds interessante details

Omdat de Azure CLI is geschreven in Python met behulp van de beheerbibliotheken, kunt u alles doen met Azure CLI-opdrachten die u ook kunt doen vanuit een Python-script. De CLI-opdrachten bieden veel nuttige functies, zoals het uitvoeren van meerdere taken, het automatisch verwerken van asynchrone bewerkingen, het opmaken van uitvoer zoals verbindingsreeks s, enzovoort. Het gebruik van de CLI (of het equivalent daarvan, Azure PowerShell) voor het automatisch maken en beheren van scripts kan dus handiger zijn dan het schrijven van de equivalente Python-code, tenzij u een veel preciezere mate van controle over het proces wilt hebben.
De Azure-bibliotheken voor Python bouwen op basis van de onderliggende Azure REST API, zodat u deze API's kunt gebruiken via bekende Python-paradigma's. U kunt de REST API echter altijd rechtstreeks vanuit Python-code gebruiken, indien gewenst.
U vindt de broncode voor de Azure-bibliotheken op https://github.com/Azure/azure-sdk-for-python. Als opensource-project zijn bijdragen welkom!
Hoewel u de bibliotheken kunt gebruiken met interpreters zoals IronPython en Jython waarop we niet testen, kunnen er geïsoleerde problemen en incompatibiliteit optreden.
De bronopslagplaats voor de bibliotheek-API-referentiedocumentatie bevindt zich op https://github.com/MicrosoftDocs/azure-docs-sdk-python/.
Vanaf 2019 hebben we Azure Python-bibliotheken bijgewerkt om algemene cloudpatronen te delen, zoals verificatieprotocollen, logboekregistratie, tracering, transportprotocollen, gebufferde antwoorden en nieuwe pogingen. De bijgewerkte bibliotheken voldoen aan de huidige Azure SDK-richtlijnen.
- Op 31 maart 2023 hebben we ondersteuning voor Azure SDK-bibliotheken buiten gebruik gesteld die niet voldoen aan de huidige Richtlijnen voor Azure SDK. Oudere bibliotheken kunnen nog steeds worden gebruikt na 31 maart 2023, maar ontvangen geen officiële ondersteuning en updates meer van Microsoft. Zie de kennisgeving Uw Azure SDK-bibliotheken bijwerken voor meer informatie.
- Als u wilt voorkomen dat er beveiligings- en prestatie-updates voor de Azure SDK's ontbreken, voert u een upgrade uit naar de nieuwste Azure SDK-bibliotheken op 31 maart 2023.
- Als u wilt controleren welke Python-bibliotheken worden beïnvloed, raadpleegt u de afgeschafte releases van Azure SDK voor Python.
Zie de Python-richtlijnen: Inleiding voor meer informatie over de richtlijnen die we toepassen op de bibliotheken.

Azure-resources maken en beheren met beheerbibliotheken

De beheerbibliotheken (of 'beheervlak') van de SDK, waarvan alles begintazure-mgmt-, helpen bij het maken, configureren en anderszins beheren van Azure-resources op basis van Python-scripts. Alle Azure-services hebben bijbehorende beheerbibliotheken. Zie het Azure-besturingsvlak en het gegevensvlak voor meer informatie.

Met de beheerbibliotheken kunt u configuratie- en implementatiescripts schrijven om dezelfde taken uit te voeren die u kunt uitvoeren via Azure Portal of de Azure CLI. (Zoals eerder vermeld, wordt de Azure CLI geschreven in Python en worden de beheerbibliotheken gebruikt om de verschillende opdrachten te implementeren.)

In de volgende voorbeelden ziet u hoe u enkele primaire beheerbibliotheken gebruikt:

Zie het bestand README.md of README.rst in de projectmap van de bibliotheek in de SDK GitHub-opslagplaats voor meer informatie over het werken met elke beheerbibliotheek. U kunt ook meer codefragmenten vinden in de referentiedocumentatie en de Azure-voorbeelden.

Migreren vanuit oudere beheerbibliotheken

Als u code migreert van oudere versies van de beheerbibliotheken, raadpleegt u de volgende details:

Zie Verifiëren met tokenreferenties als u de ServicePrincipalCredentials klasse gebruikt.
De namen van asynchrone API's zijn gewijzigd zoals beschreven in bibliotheekgebruikspatronen: asynchrone bewerkingen. De namen van asynchrone API's in nieuwere bibliotheken beginnen met begin_. In de meeste gevallen blijft de API-handtekening hetzelfde.

Verbinding maken azure-resources gebruiken met clientbibliotheken

De clientbibliotheken van de SDK (of 'gegevensvlak') helpen u bij het schrijven van Python-toepassingscode om te communiceren met al ingerichte services. Clientbibliotheken bestaan alleen voor services die ondersteuning bieden voor een client-API.

Het artikel, Voorbeeld: Azure Storage gebruiken, biedt een eenvoudige illustratie van het gebruik van de clientbibliotheek.

Verschillende Azure-services bieden ook voorbeelden met behulp van deze bibliotheken. Zie de volgende indexpagina's voor andere koppelingen:

Zie het bestand README.md of README.rst in de projectmap van de bibliotheek in de GitHub-opslagplaats van de SDK voor meer informatie over het werken met elke clientbibliotheek. U kunt ook meer codefragmenten vinden in de referentiedocumentatie en de Azure-voorbeelden.

Hulp krijgen en verbinding maken met het SDK-team

Ga naar de Azure-bibliotheken voor Python-documentatie
Stel vragen in de community op Stack Overflow
Problemen met de SDK openen op GitHub
@AzureSDK vermelden op Twitter
Een korte enquête over de Azure SDK voor Python voltooien

Volgende stap

We raden u ten zeerste aan een eenmalige installatie van uw lokale ontwikkelomgeving uit te voeren, zodat u eenvoudig een van de Azure-bibliotheken voor Python kunt gebruiken.

Uw lokale ontwikkelomgeving instellen >>>

Delen via