Använda Azure-bibliotek (SDK) för Python

Artikel
10/23/2023

Azure-bibliotek med öppen källkod för Python förenklar etablering, hantering och användning av Azure-resurser från Python-programkod.

Den information som du verkligen vill veta

Azure-biblioteken är hur du kommunicerar med Azure-tjänster från Python-kod som du kör antingen lokalt eller i molnet. (Om du kan köra Python-kod inom omfånget för en viss tjänst beror på om själva tjänsten för närvarande stöder Python.)
Biblioteken stöder Python 3.8 eller senare. Mer information om versioner av Python som stöds finns i Supportprincip för Python-version av Azure SDK:er. Om du använder PyPy kontrollerar du att den version som du använder åtminstone stöder den Python-version som nämnts tidigare.
Azure SDK för Python består enbart av över 180 enskilda Python-bibliotek som är relaterade till specifika Azure-tjänster. Det finns inga andra verktyg i "SDK".
När du kör kod lokalt förlitar sig autentisering med Azure på miljövariabler enligt beskrivningen i Autentisera Python-appar till Azure-tjänster med hjälp av Azure SDK för Python.
Om du vill installera bibliotekspaket med pip använder du pip install <library_name> biblioteksnamn från paketindexet. Om du vill installera bibliotekspaket i Conda-miljöer använder du conda install <package_name> namn från Microsoft-kanalen på anaconda.org. Mer information finns i Installera Azure-bibliotekspaket.
Det finns distinkta hanterings- och klientbibliotek (kallas ibland för "hanteringsplan" och "dataplan"-bibliotek). Varje uppsättning har olika syften och används av olika typer av kod. Mer information finns i följande avsnitt senare i den här artikeln:
- Skapa och hantera Azure-resurser med hanteringsbibliotek
- Anslut till och använda Azure-resurser med klientbibliotek
Dokumentation för biblioteken finns i Azure for Python-referensen, som organiseras av Azure Service eller Python API-webbläsaren, som är ordnad efter paketnamn.
Om du vill prova biblioteken själv rekommenderar vi först att du konfigurerar din lokala utvecklingsmiljö. Sedan kan du prova något av följande fristående exempel (i valfri ordning): Exempel: Skapa en resursgrupp, Exempel: Skapa och använda Azure Storage, Exempel: Skapa och distribuera en webbapp, Exempel: Skapa och fråga en MySQL-databas och Exempel: Skapa en virtuell dator.
För demonstrationsvideor, se Introduktion till Azure SDK för Python (PyCon 2021) och Använda Azure SDK:er för att interagera med Azure-resurser (PyCon 2020).

Icke-väsentliga men fortfarande intressanta detaljer

Eftersom Azure CLI är skrivet i Python med hjälp av hanteringsbiblioteken kan du göra allt du kan göra med Azure CLI-kommandon från ett Python-skript. Med det sagt tillhandahåller CLI-kommandona många användbara funktioner, till exempel att utföra flera uppgifter tillsammans, automatiskt hantera asynkrona åtgärder, formatera utdata som anslutningssträng och så vidare. Det kan därför vara enklare att använda CLI (eller motsvarande Azure PowerShell) för automatiserade skapande- och hanteringsskript än att skriva motsvarande Python-kod, såvida du inte vill ha en mycket mer krävande kontroll över processen.
Azure-biblioteken för Python bygger på det underliggande Azure REST API:et, så att du kan använda dessa API:er via välbekanta Python-paradigm. Du kan dock alltid använda REST-API:et direkt från Python-koden om du vill.
Du hittar källkoden för Azure-biblioteken på https://github.com/Azure/azure-sdk-for-python. Som ett projekt med öppen källkod är bidrag välkomna!
Även om du kan använda biblioteken med tolkar som IronPython och Jython som vi inte testar mot, kan du stöta på isolerade problem och inkompatibiliteter.
Källdatabasen för biblioteks-API-referensdokumentationen finns på https://github.com/MicrosoftDocs/azure-docs-sdk-python/.
Från och med 2019 uppdaterade vi Azure Python-bibliotek för att dela vanliga molnmönster som autentiseringsprotokoll, loggning, spårning, transportprotokoll, buffrade svar och återförsök. De uppdaterade biblioteken följer de aktuella riktlinjerna för Azure SDK.
- Den 31 mars 2023 drog vi tillbaka stödet för Azure SDK-bibliotek som inte följer de aktuella riktlinjerna för Azure SDK. Äldre bibliotek kan fortfarande användas efter den 31 mars 2023, men de får inte längre officiell support och uppdateringar från Microsoft. Mer information finns i meddelandet Uppdatera dina Azure SDK-bibliotek.
- Uppgradera till de senaste Azure SDK-biblioteken senast den 31 mars 2023 för att undvika saknade säkerhets- och prestandauppdateringar för Azure SDK:er.
- Information om vilka Python-bibliotek som påverkas finns i Inaktuella versioner av Azure SDK för Python.
Mer information om de riktlinjer som vi tillämpar på biblioteken finns i Python-riktlinjerna: Introduktion.

Skapa och hantera Azure-resurser med hanteringsbibliotek

SDK:s hanteringsbibliotek (eller "hanteringsplan") som alla börjar med azure-mgmt-, hjälper dig att skapa, konfigurera och på annat sätt hantera Azure-resurser från Python-skript. Alla Azure-tjänster har motsvarande hanteringsbibliotek. Mer information finns i Azure-kontrollplan och dataplan.

Med hanteringsbiblioteken kan du skriva konfigurations- och distributionsskript för att utföra samma uppgifter som du kan via Azure-portalen eller Azure CLI. (Som tidigare nämnts är Azure CLI skrivet i Python och använder hanteringsbiblioteken för att implementera sina olika kommandon.)

Följande exempel visar hur du använder några av de primära hanteringsbiblioteken:

Mer information om hur du arbetar med varje hanteringsbibliotek finns i filen README.md eller README.rst som finns i bibliotekets projektmapp på SDK GitHub-lagringsplatsen. Du kan också hitta fler kodfragment i referensdokumentationen och Azure-exempel.

Migrera från äldre hanteringsbibliotek

Om du migrerar kod från äldre versioner av hanteringsbiblioteken kan du läsa följande information:

Om du använder klassen kan du läsa Autentisera ServicePrincipalCredentials med tokenautentiseringsuppgifter.
Namnen på asynkrona API:er har ändrats enligt beskrivningen i Biblioteksanvändningsmönster – asynkrona åtgärder. Namnen på asynkrona API:er i nyare bibliotek börjar med begin_. I de flesta fall förblir API-signaturen densamma.

Anslut till och använda Azure-resurser med klientbibliotek

SDK:s klientbibliotek (eller "dataplan") hjälper dig att skriva Python-programkod för att interagera med redan etablerade tjänster. Klientbibliotek finns bara för de tjänster som stöder ett klient-API.

Artikeln Exempel : Använd Azure Storage ger en grundläggande bild av hur du använder klientbiblioteket.

Olika Azure-tjänster innehåller också exempel med hjälp av dessa bibliotek. Se följande indexsidor för andra länkar:

Mer information om hur du arbetar med varje klientbibliotek finns i filen README.md eller README.rst som finns i bibliotekets projektmapp på SDK:s GitHub-lagringsplats. Du kan också hitta fler kodfragment i referensdokumentationen och Azure-exempel.

Få hjälp och få kontakt med SDK-teamet

Gå till Dokumentation om Azure-bibliotek för Python
Skicka frågor till communityn på Stack Overflow
Öppna problem mot SDK:et på GitHub
Nämn @AzureSDK på Twitter
Slutför en kort undersökning om Azure SDK för Python

Gå vidare

Vi rekommenderar starkt att du gör en engångskonfiguration av din lokala utvecklingsmiljö så att du enkelt kan använda något av Azure-biblioteken för Python.

Konfigurera din lokala utvecklingsmiljö >>>