Pemicu dan pengikatan Azure Cosmos DB untuk Azure Functions 2.x dan gambaran umum yang lebih tinggi

  • Artikel
  • 4 menit untuk membaca

Set artikel ini menjelaskan cara bekerja dengan pengikatan Azure Cosmos DB di Azure Functions 2.x dan yang lebih tinggi. Azure Functions mendukung pengikatan pemicu, input, dan output untuk Azure Cosmos DB.

Tindakan Jenis
Menjalankan fungsi saat dokumen Azure Cosmos DB dibuat atau dimodifikasi Pemicu
Membaca dokumen Azure Cosmos DB Pengikatan input
Menyimpan perubahan ke dokumen Azure Cosmos DB Pengikatan output

Catatan

Referensi ini untuk Azure Functions versi 2.x dan yang lebih tinggi. Untuk informasi tentang cara menggunakan pengikatan ini di Functions 1.x, lihat Pengikatan Azure Cosmos DB untuk Azure Functions 1.x.

Pengikatan ini awalnya bernama DocumentDB. Di Functions versi 2.x dan yang lebih tinggi, pemicu, pengikatan, dan paket semuanya bernama Cosmos DB.

API yang Didukung

Pengikatan Microsoft Azure Cosmos DB hanya didukung untuk digunakan dengan SQL API. Dukungan untuk Table API disediakan menggunakan Pengikatan penyimpanan tabel, dimulai dengan ekstensi 5.x. Untuk semua API Microsoft Azure Cosmos DB lainnya, Anda harus mengakses database dari fungsi menggunakan klien statik untuk API Anda, termasuk API Microsoft Azure Cosmos DB untuk MongoDB, Cassandra API, dan Gremlin API.

Menginstal ekstensi

Paket NuGet ekstensi yang Anda instal bergantung pada mode C# yang digunakan di aplikasi fungsi:

Functions berjalan dalam proses yang sama dengan host Functions. Untuk mempelajari lebih lanjut, lihat Mengembangkan fungsi pustaka kelas C# dengan menggunakan Azure Functions.

Proses penginstalan ekstensi bervariasi tergantung pada versi ekstensi:

Bekerja dengan pemicu dan pengikatan mengharuskan Anda mereferensikan paket NuGet yang sesuai. Instal paket NuGet, versi 3.x.

Menginstal bundel

Cosmos DB adalah bagian dari bundel ekstensi, yang ditentukan dalam file proyek host.json Anda. Anda mungkin perlu memodifikasi bundel ini untuk mengubah versi pengikatan, atau jika bundel belum diinstal. Untuk mempelajari lebih lanjut, lihat bundel ekstensi.

Anda dapat menginstal versi ekstensi ini di aplikasi fungsi dengan mendaftarkan bundel ekstensi, versi 2.x atau 3.x.

{
    "version": "2.0",
    "extensionBundle": {
        "id": "Microsoft.Azure.Functions.ExtensionBundle",
        "version": "[3.3.0, 4.0.0)"
    }
}

Karena perubahan skema di Azure Cosmos DB SDK, ekstensi Azure Cosmos DB versi 4.x saat ini tidak didukung untuk fungsi Java.

Anda dapat menambahkan versi ekstensi ini dari bundel ekstensi pratinjau v4 dengan menambahkan atau mengganti kode berikut dalam file host.json Anda:

{
  "version": "2.0",
  "extensionBundle": {
    "id": "Microsoft.Azure.Functions.ExtensionBundle.Preview",
    "version": "[4.0.0, 5.0.0)"
  }
}

Untuk mempelajari selengkapnya, lihat Perbarui ekstensi Anda.

Kode pengecualian dan pengembalian

Pengikatan Referensi
CosmosDB Kode Kesalahan CosmosDB

Pengaturan host.json

Bagian ini menjelaskan pengaturan konfigurasi yang tersedia untuk pengikatan ini dalam versi 2.x dan yang lebih tinggi. Pengaturan dalam file host.json berlaku untuk semua fungsi dalam instans aplikasi fungsi. Contohnya file host.json di bawah ini hanya berisi pengaturan versi 2.x+ untuk pengikatan ini. Untuk informasi selengkapnya tentang pengaturan konfigurasi aplikasi fungsi dalam versi 2.x dan seterusnya, lihat referensi host.json untuk Azure Functions.

{
    "version": "2.0",
    "extensions": {
        "cosmosDB": {
            "connectionMode": "Gateway",
            "protocol": "Https",
            "leaseOptions": {
                "leasePrefix": "prefix1"
            }
        }
    }
}
Properti Default Deskripsi
connectionMode Gateway Mode koneksi yang digunakan oleh fungsi saat menyambungkan ke layanan Microsoft Azure Cosmos DB. Opsi adalah Direct dan Gateway
protokol Https Protokol koneksi yang digunakan oleh fungsi saat koneksi ke layanan Microsoft Azure Cosmos DB. Baca di sini untuk penjelasan kedua mode tersebut.
leasePrefix n/a Sewa prefiks untuk digunakan di semua fungsi dalam aplikasi.

Langkah berikutnya