Gunakan pustaka Azure (SDK) untuk Python

Artikel
10/23/2023

Pustaka Azure sumber terbuka untuk Python menyederhanakan provisi, pengelolaan, dan penggunaan sumber daya Azure dari kode aplikasi Python.

Detail yang benar-benar Anda ingin ketahui

Pustaka Azure adalah cara Anda berkomunikasi dengan layanan Azure dari kode Python yang Anda jalankan baik secara lokal maupun di cloud. (Bisa atau tidaknya Anda dalam menjalankan kode Python dalam lingkup layanan tertentu tergantung pada apakah layanan itu sendiri saat ini mendukung Python.)
Pustaka mendukung Python 3.8 atau yang lebih baru. Untuk informasi selengkapnya tentang versi Python yang didukung, lihat Kebijakan dukungan versi Azure SDK Python. Jika Anda menggunakan PyPy, pastikan versi yang Anda gunakan setidaknya mendukung versi Python yang disebutkan sebelumnya.
Azure SDK untuk Python hanya terdiri dari lebih dari 180 pustaka Python individual yang terhubung dengan layanan Azure tertentu. Tidak ada alat lain di "SDK".
Saat Anda menjalankan kode secara lokal, mengautentikasi dengan Azure bergantung pada variabel lingkungan seperti yang dijelaskan dalam Cara mengautentikasi aplikasi Python ke layanan Azure menggunakan Azure SDK untuk Python.
Untuk memasang paket pustaka dengan pip, gunakan pip install <library_name> menggunakan nama pustaka dari indeks paket. Untuk menginstal paket pustaka di lingkungan conda, gunakan conda install <package_name> menggunakan nama dari saluran Microsoft di anaconda.org. Untuk informasi selengkapnya, lihat Menginstal paket pustaka Azure.
Ada perpustakaan manajemen dan klien yang berbeda (kadang-kadang disebut sebagai pustaka "bidang manajemen" dan "data plane"). Setiap set melayani tujuan yang berbeda serta digunakan oleh berbagai jenis kode. Untuk informasi selengkapnya, lihat bagian berikut nanti dalam artikel ini:
- Membuat dan mengelola sumber daya Azure dengan pustaka manajemen
- Sambungkan ke dan gunakan sumber daya Azure dengan pustaka klien
Dokumentasi untuk pustaka ditemukan di Azure untuk Python Reference, yang diatur oleh Layanan Azure, atau browser API Python, yang diatur berdasarkan nama paket.
Untuk mencoba pustaka sendiri, pertama-tama Anda sebaiknya menyiapkan lingkungan dev lokal Anda. Kemudian Anda dapat mencoba salah satu contoh mandiri berikut (dalam urutan apa pun): Contoh: Membuat grup sumber daya, Contoh: Membuat dan menggunakan Azure Storage, Contoh: Membuat dan menyebarkan aplikasi web, Contoh: Membuat dan mengkueri database MySQL, dan Contoh: Membuat komputer virtual.
Untuk video demonstrasi, lihat Memperkenalkan Azure SDK untuk Python (PyCon 2021) dan Menggunakan Azure SDK untuk berinteraksi dengan sumber daya Azure (PyCon 2020).

Detail yang tidak penting namun masih menarik

Karena Azure CLI ditulis dalam Python menggunakan pustaka manajemen, apa pun yang dapat Anda lakukan dengan perintah Azure CLI yang juga dapat Anda lakukan dari skrip Python. Dengan demikian, perintah CLI menyediakan banyak fitur bermanfaat seperti melakukan banyak tugas bersama-sama, secara otomatis menangani operasi asinkron, memformat output seperti string koneksi, dan sebagainya. Jadi, menggunakan CLI (atau yang setara, Azure PowerShell) untuk pembuatan otomatis dan skrip manajemen bisa lebih nyaman daripada menulis kode Python yang setara, kecuali Anda ingin memiliki tingkat kontrol yang jauh lebih tepat atas proses.
Pustaka Azure untuk Python dibangun di atas Azure REST API yang mendasarinya, memungkinkan Anda menggunakan API tersebut melalui paradigma Python yang sudah dikenal. Namun, Anda selalu dapat menggunakan REST API secara langsung dari kode Python, jika Anda mau.
Anda bisa menemukan kode sumber untuk pustaka Azure di https://github.com/Azure/azure-sdk-for-python. Sebagai proyek sumber terbuka, kontribusi dipersilakan!
Meskipun dapat menggunakan pustaka dengan penerjemah seperti IronPython dan Jython yang tidak kami uji, Anda mungkin mengalami masalah serta ketidakcocokan yang terisolasi.
Repo sumber untuk dokumentasi referensi API pustaka terletak di https://github.com/MicrosoftDocs/azure-docs-sdk-python/.
Mulai tahun 2019, kami memperbarui pustaka Azure Python untuk berbagi pola cloud umum seperti protokol autentikasi, pengelogan, pelacakan, protokol transportasi, respons buffer, dan percobaan ulang. Pustaka yang diperbarui mematuhi panduan Azure SDK saat ini.
- Pada 31 Maret 2023, kami menghentikan dukungan untuk pustaka Azure SDK yang tidak sesuai dengan pedoman Azure SDK saat ini. Meskipun pustaka yang lebih lama masih dapat digunakan melebihi 31 Maret 2023, pustaka tersebut tidak akan lagi menerima dukungan dan pembaruan resmi dari Microsoft. Untuk informasi selengkapnya, lihat pemberitahuan Memperbarui pustaka Azure SDK Anda.
- Untuk menghindari pembaruan keamanan dan performa yang hilang ke Azure SDK, tingkatkan ke pustaka Azure SDK terbaru paling lambat 31 Maret 2023.
- Untuk memeriksa pustaka Python mana yang terpengaruh, lihat Azure SDK Deprecated Releases for Python.
Untuk detail mengenai panduan yang kami terapkan ke pustaka, lihat Panduan Python: Pendahuluan.

Membuat dan mengelola sumber daya Azure dengan pustaka manajemen

Pustaka manajemen SDK (atau "bidang manajemen"), yang semuanya dimulai dengan azure-mgmt-, membantu Anda membuat, mengonfigurasi, dan mengelola sumber daya Azure dari skrip Python. Semua layanan Azure memiliki pustaka manajemen yang sesuai. Untuk informasi selengkapnya, lihat sarana kontrol dan sarana data Azure.

Dengan pustaka manajemen, Anda dapat menulis skrip konfigurasi dan penyebaran untuk melakukan tugas yang sama dengan yang Anda dapat melalui portal Azure atau Azure CLI. (Seperti yang disebutkan sebelumnya, Azure CLI ditulis dalam Python dan menggunakan pustaka manajemen untuk mengimplementasikan berbagai perintahnya.)

Contoh-contoh berikut ini mengilustrasikan cara menggunakan beberapa pustaka manajemen utama:

Untuk detail tentang bekerja dengan setiap pustaka manajemen, lihat file README.md atau README.rst yang terletak di folder proyek pustaka di repositori GitHub SDK. Anda juga dapat menemukan lebih banyak cuplikan kode dalam dokumentasi referensi dan Sampel Azure.

Bermigrasi dari pustaka manajemen sebelumnya

Jika Anda memigrasikan kode dari versi pustaka manajemen yang lebih lama, lihat detail berikut:

Jika Anda menggunakan kelas ServicePrincipalCredentials, lihat Autentikasi dengan info masuk token.
Nama API asinkron sudah berubah seperti yang dijelaskan pada pola penggunaan Pustaka - operasi asinkron. Nama API asinkron di pustaka yang lebih baru dimulai dengan begin_. Pada kebanyakan kasus, tanda tangan API tetap sama.

Membuat sambungan ke serta menggunakan sumber daya Azure dengan pustaka klien

Pustaka klien SDK (atau "data plane") membantu Anda menulis kode aplikasi Python untuk berinteraksi dengan layanan yang sudah diprovisikan. Pustaka klien hanya ada untuk layanan yang mendukung API klien.

Artikel, Contoh: Gunakan Azure Storage, memberikan ilustrasi dasar penggunaan pustaka klien.

Layanan Azure yang berbeda juga memberikan contoh tentang menggunakan pustaka ini. Lihat halaman indeks berikut untuk tautan lain:

Untuk detail tentang bekerja dengan setiap pustaka klien, lihat file README.md atau README.rst yang terletak di folder proyek pustaka di repositori GitHub SDK. Anda juga dapat menemukan lebih banyak cuplikan kode dalam dokumentasi referensi dan Sampel Azure.

Mendapatkan bantuan dan tersambung dengan tim SDK

Kunjungi pustaka Azure untuk dokumentasi Python
Kirimkan pertanyaan kepada komunitas di Stack Overflow
Buka masalah terkait SDK di GitHub
Sebutkan @AzureSDK di Twitter
Menyelesaikan survei singkat tentang SDK Azure untuk Python

Langkah selanjutnya

Kami sangat menyarankan pengaturan satu kali pada lingkungan pengembangan lokal Anda sehingga Anda bisa dengan mudah menggunakan salah satu pustaka Azure untuk Python.

Menyiapkan lingkungan dev lokal Anda>>>

Bagikan melalui