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

  • Artikel
  • 4 minuter för att läsa

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 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 stöder Python för närvarande.)

  • Biblioteken stöder Python 2.7 och Python 3.6 eller senare och testas också med PyPy 5.4+.

  • Azure SDK för Python består endast 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 Konfigurera din lokala utvecklingsmiljö.

  • Om du vill installera bibliotekspaket med pip använder pip install <library_name> du biblioteksnamn från pip install <library_name>. Om du vill installera bibliotekspaket i Conda-miljöer använder conda install <package_name> du namn från conda install <package_name>. Mer information finns i Installera Azure-bibliotek.

  • Det finns olika hanterings-och klientbibliotek (kallas ibland för "hanteringsplan" och "dataplansbibliotek"). 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:

  • Dokumentation för biblioteken finns i Azure for Python-referensen, som är ordnad efter Azure-tjänst eller Python API-webbläsaren, som är ordnad efter paketnamn. För närvarande behöver du ofta klicka på ett antal lager för att komma till de klasser och metoder som du bryr dig om. Låt oss be om ursäkt i förväg för den här delupplevelsen. Vi arbetar med att förbättra det!

  • Om du vill prova biblioteken själv rekommenderar vi först att du ställer in din lokala utvecklingsmiljö. Sedan kan du prova något av följande fristående exempel (i valfri ordning): Exempel:Etablera en resursgrupp , Exempel:Etablera och använd Azure Storage , Exempel: Etableraen webbapp och distribuera kod , Exempel: Etablera och använda en MySQL-databasoch Exempel:Etablera en virtuell dator .

  • Demonstrationsvideor finns i Introduktion till Azure SDK för Python (PyCon 2021) och Använda Azure SDK:er för att interagera med Azure-resursen (PyCon 2020).

Icke-viktig men fortfarande intressant information

  • 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 som du också kan göra från ett Python-skript. Med detta sagt innehå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ängar och så vidare. Därför kan det vara betydligt enklare att använda CLI (eller motsvarande Azure PowerShell) för automatiserade etablerings- och hanteringsskript än att skriva motsvarande Python-kod, om du inte vill ha en mycket mer exakt kontroll över processen.

  • Azure-biblioteken för Python bygger på den underliggande Azure REST API, så att du kan använda dessa API:er via välbekanta Python-paradigm. Du kan dock alltid använda REST API direkt från Python-kod 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älkommen!

  • Ä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/ .

  • Vi uppdaterar för närvarande Azure-biblioteken för Python-bibliotek för att dela vanliga molnmönster som autentiseringsprotokoll, loggning, spårning, transportprotokoll, buffrade svar och återförsök.

  • Mer information om de riktlinjer som vi tillämpar för biblioteken finns i Python Guidelines: Introduction (Python-riktlinjer: Introduktion).

Etablera och hantera Azure-resurser med hanteringsbibliotek

SDK:s hanteringsbibliotek (eller "hanteringsplan"), vars namn börjar med , hjälper dig att skapa, etablera och på annat sätt hantera Azure-resurser från Python-skript. Alla Azure-tjänster har motsvarande hanteringsbibliotek.

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

I följande exempel visas 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 i SDK GitHub-lagringsplatsen. Du kan också hitta ytterligare kodfragment i referensdokumentationen och Azure-exemplen.

Migrera från äldre hanteringsbibliotek

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

  • Om du använder klassen ServicePrincipalCredentials kan du se Autentisera med ServicePrincipalCredentials
  • Namnen på asynkrona API:er har ändrats enligt beskrivningen i Användningsmönster för bibliotek – 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 illustration 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 ytterligare länkar:

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

Få hjälp och anslut till SDK-teamet

Nästa steg

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

Konfigurera din lokala utvecklingsmiljö