CosmosDBv3FunctionOptions interface

Memperluas

Properti

handler
retry

Kebijakan coba lagi opsional untuk menjalankan ulang eksekusi yang gagal hingga penyelesaian berhasil terjadi atau jumlah maksimum percobaan ulang tercapai. Pelajari lebih lanjut di sini

trigger

Properti yang Diwariskan

checkpointDocumentCount

Menyesuaikan jumlah dokumen di antara titik pemeriksaan sewa. Defaultnya adalah setelah setiap panggilan fungsi.

checkpointInterval

Ketika diatur, itu mendefinisikan, dalam milidetik, interval antara titik pemeriksaan sewa. Default selalu setelah setiap panggilan Fungsi.

collectionName

Nama koleksi yang sedang dipantau

connectionStringSetting

Pengaturan aplikasi (atau variabel lingkungan) dengan string koneksi Cosmos DB

createLeaseCollectionIfNotExists

Memeriksa keberadaan dan secara otomatis membuat koleksi sewa. Defaultnya adalah false

databaseName

Nama database Azure Cosmos DB dengan koleksi yang dipantau

extraInputs

Konfigurasi untuk sekumpulan input sekunder opsional Selama pemanggilan, dapatkan nilai-nilai ini dengan context.extraInputs.get()

extraOutputs

Konfigurasi untuk sekumpulan output sekunder opsional Selama pemanggilan, atur nilai-nilai ini dengan context.extraOutputs.set()

feedPollDelay

Waktu (dalam milidetik) untuk penundaan antara polling partisi untuk perubahan baru pada umpan, setelah semua perubahan saat ini dikosongkan. Defaultnya adalah 5.000 milidetik, atau 5 detik.

leaseAcquireInterval

Ketika diatur, itu mendefinisikan, dalam milidetik, interval untuk memulai tugas untuk menghitung apakah partisi didistribusikan secara merata di antara instans host yang diketahui. Defaultnya adalah 13000 (13 detik).

leaseCollectionName

Nama koleksi untuk menyimpan sewa. Jika tidak diatur, maka akan menggunakan "sewa"

leaseCollectionPrefix

Ketika diatur, nilai ditambahkan sebagai awalan ke sewa yang dibuat dalam koleksi Sewa untuk fungsi ini. Menggunakan awalan memungkinkan dua Azure Functions terpisah untuk berbagi koleksi Sewa yang sama dengan menggunakan awalan yang berbeda.

leaseCollectionThroughput

Ketika createLeaseCollectionIfNotExists diatur ke true, menentukan jumlah Unit Permintaan yang akan ditetapkan ke koleksi sewa yang dibuat

leaseConnectionStringSetting

Nama pengaturan aplikasi yang berisi string koneksi ke layanan yang menyimpan koleksi sewa. Jika tidak diatur, layanan akan tersambung ke layanan yang ditentukan oleh connectionStringSetting

leaseDatabaseName

Nama database yang menyimpan koleksi untuk menyimpan sewa. Jika tidak diatur, maka akan menggunakan nilai databaseName

leaseExpirationInterval

Ketika diatur, itu mendefinisikan, dalam milidetik, interval di mana sewa diambil pada sewa yang mewakili partisi. Jika sewa tidak diperbarui dalam interval ini, itu akan menyebabkannya kedaluwarsa dan kepemilikan partisi akan pindah ke instans lain. Defaultnya adalah 60000 (60 detik).

leaseRenewInterval

Ketika diatur, itu mendefinisikan, dalam milidetik, interval perpanjangan untuk semua sewa untuk partisi yang saat ini dipegang oleh instans. Defaultnya adalah 17000 (17 detik).

maxItemsPerInvocation

Ketika diatur, properti ini mengatur jumlah maksimum item yang diterima per panggilan Fungsi. Jika operasi dalam kontainer yang dipantau dilakukan melalui prosedur tersimpan, cakupan transaksi dipertahankan saat membaca item dari umpan perubahan. Akibatnya, jumlah item yang diterima bisa lebih tinggi dari nilai yang ditentukan sehingga item yang diubah oleh transaksi yang sama dikembalikan sebagai bagian dari satu batch atomik.

preferredLocations

Menentukan lokasi (wilayah) pilihan untuk akun database yang direplikasi secara geografis di layanan Azure Cosmos DB. Nilai harus dipisahkan koma. Misalnya, US Timur,US Tengah Selatan, Eropa Utara

return

Konfigurasi untuk output utama opsional dari fungsi Ini adalah output utama yang harus Anda tetapkan sebagai nilai pengembalian handler fungsi selama pemanggilan

startFromBeginning

Opsi ini memberi tahu Pemicu untuk membaca perubahan dari awal riwayat perubahan kontainer alih-alih memulai pada waktu saat ini. Membaca dari awal hanya berfungsi saat pertama kali pemicu dimulai, seperti dalam eksekusi berikutnya, titik pemeriksaan sudah disimpan. Mengatur opsi ini ke true ketika ada sewa yang sudah dibuat tidak berpengaruh.

useMultipleWriteLocations

Memungkinkan akun multi-wilayah untuk menulis ke koleksi sewa.

Detail Properti

handler

handler: CosmosDBv3Handler

Nilai Properti

retry

Kebijakan coba lagi opsional untuk menjalankan ulang eksekusi yang gagal hingga penyelesaian berhasil terjadi atau jumlah maksimum percobaan ulang tercapai. Pelajari lebih lanjut di sini

retry?: RetryOptions

Nilai Properti

trigger

trigger?: CosmosDBv3Trigger

Nilai Properti

Detail Properti yang Diwariskan

checkpointDocumentCount

Menyesuaikan jumlah dokumen di antara titik pemeriksaan sewa. Defaultnya adalah setelah setiap panggilan fungsi.

checkpointDocumentCount?: number

Nilai Properti

number

Diwarisi DariCosmosDBv3TriggerOptions.checkpointDocumentCount

checkpointInterval

Ketika diatur, itu mendefinisikan, dalam milidetik, interval antara titik pemeriksaan sewa. Default selalu setelah setiap panggilan Fungsi.

checkpointInterval?: number

Nilai Properti

number

Diwarisi DariCosmosDBv3TriggerOptions.checkpointInterval

collectionName

Nama koleksi yang sedang dipantau

collectionName: string

Nilai Properti

string

Diwarisi DariCosmosDBv3TriggerOptions.collectionName

connectionStringSetting

Pengaturan aplikasi (atau variabel lingkungan) dengan string koneksi Cosmos DB

connectionStringSetting: string

Nilai Properti

string

Diwarisi DariCosmosDBv3TriggerOptions.connectionStringSetting

createLeaseCollectionIfNotExists

Memeriksa keberadaan dan secara otomatis membuat koleksi sewa. Defaultnya adalah false

createLeaseCollectionIfNotExists?: boolean

Nilai Properti

boolean

Diwarisi DariCosmosDBv3TriggerOptions.createLeaseCollectionIfNotExists

databaseName

Nama database Azure Cosmos DB dengan koleksi yang dipantau

databaseName: string

Nilai Properti

string

Diwarisi DariCosmosDBv3TriggerOptions.databaseName

extraInputs

Konfigurasi untuk sekumpulan input sekunder opsional Selama pemanggilan, dapatkan nilai-nilai ini dengan context.extraInputs.get()

extraInputs?: FunctionInput[]

Nilai Properti

Diwariskan Dari Partial.extraInputs

extraOutputs

Konfigurasi untuk sekumpulan output sekunder opsional Selama pemanggilan, atur nilai-nilai ini dengan context.extraOutputs.set()

extraOutputs?: FunctionOutput[]

Nilai Properti

Diwariskan Dari Partial.extraOutputs

feedPollDelay

Waktu (dalam milidetik) untuk penundaan antara polling partisi untuk perubahan baru pada umpan, setelah semua perubahan saat ini dikosongkan. Defaultnya adalah 5.000 milidetik, atau 5 detik.

feedPollDelay?: number

Nilai Properti

number

Diwarisi DariCosmosDBv3TriggerOptions.feedPollDelay

leaseAcquireInterval

Ketika diatur, itu mendefinisikan, dalam milidetik, interval untuk memulai tugas untuk menghitung apakah partisi didistribusikan secara merata di antara instans host yang diketahui. Defaultnya adalah 13000 (13 detik).

leaseAcquireInterval?: number

Nilai Properti

number

Diwarisi DariCosmosDBv3TriggerOptions.leaseAcquireInterval

leaseCollectionName

Nama koleksi untuk menyimpan sewa. Jika tidak diatur, maka akan menggunakan "sewa"

leaseCollectionName?: string

Nilai Properti

string

Diwarisi DariCosmosDBv3TriggerOptions.leaseCollectionName

leaseCollectionPrefix

Ketika diatur, nilai ditambahkan sebagai awalan ke sewa yang dibuat dalam koleksi Sewa untuk fungsi ini. Menggunakan awalan memungkinkan dua Azure Functions terpisah untuk berbagi koleksi Sewa yang sama dengan menggunakan awalan yang berbeda.

leaseCollectionPrefix?: string

Nilai Properti

string

Diwarisi DariCosmosDBv3TriggerOptions.leaseCollectionPrefix

leaseCollectionThroughput

Ketika createLeaseCollectionIfNotExists diatur ke true, menentukan jumlah Unit Permintaan yang akan ditetapkan ke koleksi sewa yang dibuat

leaseCollectionThroughput?: number

Nilai Properti

number

Diwariskan DariCosmosDBv3TriggerOptions.leaseCollectionThroughput

leaseConnectionStringSetting

Nama pengaturan aplikasi yang berisi string koneksi ke layanan yang menyimpan koleksi sewa. Jika tidak diatur, layanan akan tersambung ke layanan yang ditentukan oleh connectionStringSetting

leaseConnectionStringSetting?: string

Nilai Properti

string

Diwarisi DariCosmosDBv3TriggerOptions.leaseConnectionStringSetting

leaseDatabaseName

Nama database yang menyimpan koleksi untuk menyimpan sewa. Jika tidak diatur, maka akan menggunakan nilai databaseName

leaseDatabaseName?: string

Nilai Properti

string

Diwariskan DariCosmosDBv3TriggerOptions.leaseDatabaseName

leaseExpirationInterval

Ketika diatur, itu mendefinisikan, dalam milidetik, interval di mana sewa diambil pada sewa yang mewakili partisi. Jika sewa tidak diperbarui dalam interval ini, itu akan menyebabkannya kedaluwarsa dan kepemilikan partisi akan pindah ke instans lain. Defaultnya adalah 60000 (60 detik).

leaseExpirationInterval?: number

Nilai Properti

number

Diwarisi DariCosmosDBv3TriggerOptions.leaseExpirationInterval

leaseRenewInterval

Ketika diatur, itu mendefinisikan, dalam milidetik, interval perpanjangan untuk semua sewa untuk partisi yang saat ini dipegang oleh instans. Defaultnya adalah 17000 (17 detik).

leaseRenewInterval?: number

Nilai Properti

number

Diwarisi DariCosmosDBv3TriggerOptions.leaseRenewInterval

maxItemsPerInvocation

Ketika diatur, properti ini mengatur jumlah maksimum item yang diterima per panggilan Fungsi. Jika operasi dalam kontainer yang dipantau dilakukan melalui prosedur tersimpan, cakupan transaksi dipertahankan saat membaca item dari umpan perubahan. Akibatnya, jumlah item yang diterima bisa lebih tinggi dari nilai yang ditentukan sehingga item yang diubah oleh transaksi yang sama dikembalikan sebagai bagian dari satu batch atomik.

maxItemsPerInvocation?: number

Nilai Properti

number

Diwarisi DariCosmosDBv3TriggerOptions.maxItemsPerInvocation

preferredLocations

Menentukan lokasi (wilayah) pilihan untuk akun database yang direplikasi secara geografis di layanan Azure Cosmos DB. Nilai harus dipisahkan koma. Misalnya, US Timur,US Tengah Selatan, Eropa Utara

preferredLocations?: string

Nilai Properti

string

Diwarisi DariCosmosDBv3TriggerOptions.preferredLocations

return

Konfigurasi untuk output utama opsional dari fungsi Ini adalah output utama yang harus Anda tetapkan sebagai nilai pengembalian handler fungsi selama pemanggilan

return?: FunctionOutput

Nilai Properti

Diwariskan Dari Partial.return

startFromBeginning

Opsi ini memberi tahu Pemicu untuk membaca perubahan dari awal riwayat perubahan kontainer alih-alih memulai pada waktu saat ini. Membaca dari awal hanya berfungsi saat pertama kali pemicu dimulai, seperti dalam eksekusi berikutnya, titik pemeriksaan sudah disimpan. Mengatur opsi ini ke true ketika ada sewa yang sudah dibuat tidak berpengaruh.

startFromBeginning?: boolean

Nilai Properti

boolean

Diwariskan DariCosmosDBv3TriggerOptions.startFromBeginning

useMultipleWriteLocations

Memungkinkan akun multi-wilayah untuk menulis ke koleksi sewa.

useMultipleWriteLocations?: boolean

Nilai Properti

boolean

Diwarisi DariCosmosDBv3TriggerOptions.useMultipleWriteLocations