Membuat aplikasi Python dengan Azure SDK untuk Python

Artikel
03/30/2023

Dokumen ini memperlihatkan contoh cara menggunakan Azure SDK untuk Python untuk mengakses data Anda di Azure App Configuration.

Tip

App Configuration menawarkan pustaka penyedia Python yang dibangun di atas Python SDK dan dirancang agar lebih mudah digunakan dengan fitur yang lebih kaya. Ini memungkinkan pengaturan konfigurasi digunakan seperti kamus, dan menawarkan fitur lain seperti komposisi konfigurasi dari beberapa label, pemangkasan nama kunci, dan resolusi otomatis referensi Key Vault. Buka mulai cepat Python untuk mempelajari selengkapnya.

Prasyarat

Langganan Azure - buat akun secara gratis
Python 3.8 atau yang lebih baru - untuk informasi tentang menyiapkan Python di Windows, lihat dokumentasi Python di Windows
Penyimpanan App Configuration. Buat toko.

Membuat nilai kunci

Tambahkan nilai kunci berikut ke penyimpanan App Configuration dan biarkan Label dan Tipe Konten dengan nilai defaultnya. Untuk informasi selengkapnya tentang cara menambahkan nilai kunci ke penyimpanan menggunakan portal Azure atau CLI, buka Membuat nilai kunci.

Tombol	Nilai
TestApp:Pengaturan:Message	Data dari Azure App Configuration

Menyiapkan aplikasi Python

Buat direktori baru untuk proyek bernama app-configuration-example.
```
mkdir app-configuration-example
```
Beralih ke direktori app-configuration-example yang baru dibuat.
```
cd app-configuration-example
```
Instal pustaka klien Azure App Configuration dengan menggunakan perintah pip install.
```
pip install azure-appconfiguration
```

Buat file baru yang disebut app-configuration-example.py di direktori app-configuration-example dan tambahkan kode berikut:

import os
from azure.appconfiguration import AzureAppConfigurationClient, ConfigurationSetting

try:
    print("Azure App Configuration - Python example")
    # Example code goes here
except Exception as ex:
    print('Exception:')
    print(ex)

Catatan

Cuplikan kode dalam contoh ini akan membantu Anda memulai pustaka klien App Configuration untuk Python. Untuk aplikasi Anda, Anda juga harus mempertimbangkan menangani pengecualian sesuai dengan kebutuhan Anda. Untuk mempelajari lebih lanjut tentang penanganan pengecualian, rujuk ke dokumentasi Python SDK kami.

Mengonfigurasi string koneksi App Configuration Anda

Atur variabel lingkungan bernama AZURE_APPCONFIG_CONNECTION_STRING, dan atur ke string koneksi penyimpanan App Configuration Anda. Pada baris perintah, jalankan perintah berikut ini:
Untuk menjalankan aplikasi secara lokal menggunakan perintah Windows, jalankan perintah berikut dan ganti <app-configuration-store-connection-string> dengan string koneksi penyimpanan konfigurasi aplikasi Anda:
```
setx AZURE_APPCONFIG_CONNECTION_STRING "connection-string-of-your-app-configuration-store"
```
Jika Anda menggunakan Windows PowerShell, jalankan perintah berikut dan ganti <app-configuration-store-connection-string> dengan string koneksi penyimpanan konfigurasi aplikasi Anda:
```
$Env:AZURE_APPCONFIG_CONNECTION_STRING = "<app-configuration-store-connection-string>"
```
Jika Anda menggunakan macOS, jalankan perintah berikut dan ganti <app-configuration-store-connection-string> dengan string koneksi penyimpanan konfigurasi aplikasi Anda:
```
export AZURE_APPCONFIG_CONNECTION_STRING='<app-configuration-store-connection-string>'
```
Jika Anda menggunakan Linux, jalankan perintah berikut dan ganti <app-configuration-store-connection-string> dengan string koneksi penyimpanan konfigurasi aplikasi Anda:
```
export AZURE_APPCONFIG_CONNECTION_STRING='<app-configuration-store-connection-string>'
```
Cetak nilai variabel lingkungan untuk memvalidasi bahwa variabel diatur dengan benar dengan perintah di bawah ini.
Dengan menggunakan prompt perintah Windows, mulai ulang perintah untuk memungkinkan perubahan diterapkan dan jalankan perintah berikut:
```
echo %AZURE_APPCONFIG_CONNECTION_STRING%
```
Jika Anda menggunakan PowerShell Windows, jalankan perintah berikut:
```
$Env:AZURE_APPCONFIG_CONNECTION_STRING
```
Jika Anda menggunakan macOS, jalankan perintah berikut:
```
echo "$AZURE_APPCONFIG_CONNECTION_STRING"
```
Jika Anda menggunakan Linux, jalankan perintah berikut:
```
echo "$AZURE_APPCONFIG_CONNECTION_STRING"
```

Sampel kode

Cuplikan kode sampel di bagian ini menunjukkan cara melakukan operasi umum dengan pustaka klien App Configuration untuk Python. Tambahkan cuplikan kode ini ke try blok dalam file app-configuration-example.py yang Anda buat sebelumnya.

Catatan

Pustaka klien App Configuration mengacu pada objek kunci-nilai sebagai ConfigurationSetting. Oleh karena itu, dalam artikel ini, kunci-nilai di penyimpanan App Configuration akan disebut sebagai pengaturan konfigurasi.

Pelajari cara:

Tersambung ke Penyimpanan App Configuration
Mendapatkan pengaturan konfigurasi
Menambahkan pengaturan konfigurasi
Mendapatkan daftar pengaturan konfigurasi
Mengunci pengaturan konfigurasi
Membuka kunci pengaturan konfigurasi
Memperbarui pengaturan konfigurasi
Menghapus pengaturan konfigurasi

Tersambung ke Penyimpanan App Configuration

Cuplikan kode berikut membuat instans AzureAppConfigurationClient menggunakan string koneksi yang tersimpan di variabel lingkungan Anda.

    connection_string = os.getenv('AZURE_APPCONFIG_CONNECTION_STRING')
    app_config_client = AzureAppConfigurationClient.from_connection_string(connection_string)

Mendapatkan pengaturan konfigurasi

Cuplikan kode berikut mengambil pengaturan konfigurasi menurut nama key.

    retrieved_config_setting = app_config_client.get_configuration_setting(key='TestApp:Settings:Message')
    print("\nRetrieved configuration setting:")
    print("Key: " + retrieved_config_setting.key + ", Value: " + retrieved_config_setting.value)

Menambahkan pengaturan konfigurasi

Cuplikan kode berikut membuat objek ConfigurationSetting dengan bidang key dan value serta mengaktifkan metode add_configuration_setting. Metode ini akan memberikan pengecualian jika Anda mencoba menambahkan pengaturan konfigurasi yang telah ada dalam penyimpanan Anda. Jika Anda ingin menghindari pengecualian ini, metode set_configuration_setting dapat digunakan sebagai gantinya.

    config_setting = ConfigurationSetting(
        key='TestApp:Settings:NewSetting',
        value='New setting value'
    )
    added_config_setting = app_config_client.add_configuration_setting(config_setting)
    print("\nAdded configuration setting:")
    print("Key: " + added_config_setting.key + ", Value: " + added_config_setting.value)

Mendapatkan daftar pengaturan konfigurasi

Cuplikan kode berikut mengambil daftar pengaturan konfigurasi. Argumen key_filter dan label_filter dapat disediakan untuk memfilter kunci-nilai berdasarkan masing-masing key dan label. Untuk informasi selengkapnya tentang pemfilteran, lihat cara melakukan kueri pengaturan konfigurasi.

    filtered_settings_list = app_config_client.list_configuration_settings(key_filter="TestApp*")
    print("\nRetrieved list of configuration settings:")
    for item in filtered_settings_list:
        print("Key: " + item.key + ", Value: " + item.value)

Mengunci pengaturan konfigurasi

Status kunci dari kunci-nilai dalam App Configuration ditandai dengan atribut read_only dari objek ConfigurationSetting. Jika read_only adalah True, maka pengaturan terkunci. Metode set_read_only dapat diaktifkan dengan argumen read_only=True untuk mengunci pengaturan konfigurasi.

    locked_config_setting = app_config_client.set_read_only(added_config_setting, read_only=True)
    print("\nRead-only status for " + locked_config_setting.key + ": " + str(locked_config_setting.read_only))

Membuka kunci pengaturan konfigurasi

Jika atribut read_only dari ConfigurationSetting adalah False, maka pengaturan tidak terkunci. Metode set_read_only dapat diaktifkan dengan argumen read_only=False untuk membuka kunci pengaturan konfigurasi.

    unlocked_config_setting = app_config_client.set_read_only(locked_config_setting, read_only=False)
    print("\nRead-only status for " + unlocked_config_setting.key + ": " + str(unlocked_config_setting.read_only))

Memperbarui pengaturan konfigurasi

Metode set_configuration_setting dapat digunakan untuk memperbarui pengaturan yang ada atau membuat pengaturan baru. Cuplikan kode berikut mengubah nilai pengaturan konfigurasi yang sudah ada.

    added_config_setting.value = "Value has been updated!"
    updated_config_setting = app_config_client.set_configuration_setting(added_config_setting)
    print("\nUpdated configuration setting:")
    print("Key: " + updated_config_setting.key + ", Value: " + updated_config_setting.value)

Menghapus pengaturan konfigurasi

Cuplikan kode berikut menghapus pengaturan konfigurasi menurut nama key.


    deleted_config_setting = app_config_client.delete_configuration_setting(key="TestApp:Settings:NewSetting")
    print("\nDeleted configuration setting:")
    print("Key: " + deleted_config_setting.key + ", Value: " + deleted_config_setting.value)

Menjalankan aplikasi

Dalam contoh ini, Anda membuat aplikasi Python yang menggunakan pustaka klien Azure App Configuration untuk mengambil pengaturan konfigurasi yang dibuat melalui portal Azure, menambahkan pengaturan baru, mengambil daftar pengaturan yang ada, mengunci dan membuka kunci pengaturan, memperbarui pengaturan, dan akhirnya menghapus pengaturan.

Pada titik ini, file app-configuration-example.py Anda harus memiliki kode berikut:

import os
from azure.appconfiguration import AzureAppConfigurationClient, ConfigurationSetting

try:
    print("Azure App Configuration - Python example")
    # Example code goes here

    connection_string = os.getenv('AZURE_APPCONFIG_CONNECTION_STRING')
    app_config_client = AzureAppConfigurationClient.from_connection_string(connection_string)

    retrieved_config_setting = app_config_client.get_configuration_setting(key='TestApp:Settings:Message')
    print("\nRetrieved configuration setting:")
    print("Key: " + retrieved_config_setting.key + ", Value: " + retrieved_config_setting.value)

    config_setting = ConfigurationSetting(
        key='TestApp:Settings:NewSetting',
        value='New setting value'
    )
    added_config_setting = app_config_client.add_configuration_setting(config_setting)
    print("\nAdded configuration setting:")
    print("Key: " + added_config_setting.key + ", Value: " + added_config_setting.value)

    filtered_settings_list = app_config_client.list_configuration_settings(key_filter="TestApp*")
    print("\nRetrieved list of configuration settings:")
    for item in filtered_settings_list:
        print("Key: " + item.key + ", Value: " + item.value)

    locked_config_setting = app_config_client.set_read_only(added_config_setting, read_only=True)
    print("\nRead-only status for " + locked_config_setting.key + ": " + str(locked_config_setting.read_only))

    unlocked_config_setting = app_config_client.set_read_only(locked_config_setting, read_only=False)
    print("\nRead-only status for " + unlocked_config_setting.key + ": " + str(unlocked_config_setting.read_only))

    added_config_setting.value = "Value has been updated!"
    updated_config_setting = app_config_client.set_configuration_setting(added_config_setting)
    print("\nUpdated configuration setting:")
    print("Key: " + updated_config_setting.key + ", Value: " + updated_config_setting.value)

    deleted_config_setting = app_config_client.delete_configuration_setting(key="TestApp:Settings:NewSetting")
    print("\nDeleted configuration setting:")
    print("Key: " + deleted_config_setting.key + ", Value: " + deleted_config_setting.value)

except Exception as ex:
    print('Exception:')
    print(ex)

Di jendela konsol Anda, navigasikan ke direktori yang berisi file app-configuration-example.py dan jalankan perintah Python berikut untuk menjalankan aplikasi:

python app-configuration-example.py

Anda akan menemukan output berikut:

Azure App Configuration - Python example

Retrieved configuration setting:
Key: TestApp:Settings:Message, Value: Data from Azure App Configuration

Added configuration setting:
Key: TestApp:Settings:NewSetting, Value: New setting value

Retrieved list of configuration settings:
Key: TestApp:Settings:Message, Value: Data from Azure App Configuration
Key: TestApp:Settings:NewSetting, Value: New setting value

Read-only status for TestApp:Settings:NewSetting: True

Read-only status for TestApp:Settings:NewSetting: False

Updated configuration setting:
Key: TestApp:Settings:NewSetting, Value: Value has been updated!

Deleted configuration setting:
Key: TestApp:Settings:NewSetting, Value: Value has been updated!

Membersihkan sumber daya

Jika Anda tidak ingin terus menggunakan sumber daya yang dibuat dalam artikel ini, hapus grup sumber daya yang Anda buat di sini untuk menghindari biaya.

Penting

Penghapusan grup sumber daya tidak bisa dipulihkan. Grup sumber daya dan semua sumber daya yang ada di dalamnya akan dihapus secara permanen. Pastikan Anda tidak menghapus grup atau sumber daya yang salah secara tidak sengaja. Jika Anda membuat sumber daya untuk artikel ini dalam grup sumber daya yang ada yang berisi sumber daya lain yang ingin disimpan, hapus setiap sumber daya satu per satu dari panelnya masing-masing, bukan menghapus grup sumber daya.

Masuk ke portal Azure, lalu pilih Grup sumber daya.
Dalam kotak Filter menurut nama, masukkan nama grup sumber daya Anda.
Dalam daftar hasil, pilih nama grup sumber daya untuk melihat gambaran umum.
Pilih Hapus grup sumber daya.
Anda akan diminta untuk mengonfirmasi penghapusan grup sumber daya. Masukkan nama grup sumber daya Anda untuk mengonfirmasi, dan pilih Hapus.

Setelah beberapa saat, grup sumber daya dan semua sumber dayanya akan dihapus.

Langkah berikutnya

Panduan ini menunjukkan kepada Anda cara menggunakan Azure SDK for Python untuk mengakses data Anda di Azure App Configuration.

Untuk sampel kode tambahan, kunjungi:

Sampel pustaka klien Azure App Configuration

Untuk mempelajari cara menggunakan Azure App Configuration dengan aplikasi Python, buka:

Membuat aplikasi Python dengan Azure App Configuration

Bagikan melalui