CosmosDBv3FunctionOptions interface

Paket:

@azure/functions

Extends

CosmosDBv3TriggerOptions,Partial<FunctionOptions>

Özellikler

handler
retry	Başarılı bir tamamlama gerçekleşene veya yeniden deneme sayısı üst sınırına ulaşılana kadar başarısız bir yürütmeyi yeniden çalıştırmak için isteğe bağlı bir yeniden deneme ilkesi. Daha fazla bilgi edinmek için buraya bakın.
trigger

Devralınan Özellikler

checkpointDocumentCount	Kira denetim noktaları arasındaki belge miktarını özelleştirir. Varsayılan, her işlev çağrısının ardındandır.
checkpointInterval	Ayarlandığında, kira denetim noktaları arasındaki aralığı milisaniye cinsinden tanımlar. Varsayılan değer her zaman her İşlev çağrısının ardındandır.
collectionName	İzlenen koleksiyonun adı
connectionStringSetting	Cosmos DB bağlantı dizesi içeren bir uygulama ayarı (veya ortam değişkeni)
createLeaseCollectionIfNotExists	Varlığı denetler ve kira koleksiyonunu otomatik olarak oluşturur. Varsayılan değer: false
databaseName	Koleksiyonun izlendiği Azure Cosmos DB veritabanının adı
extraInputs	İsteğe bağlı bir ikincil giriş kümesi için yapılandırma Çağırma sırasında bu değerleri context.extraInputs.get()
extraOutputs	İsteğe bağlı bir ikincil çıkış kümesi için yapılandırma Çağırma sırasında bu değerleri context.extraOutputs.set()
feedPollDelay	Tüm geçerli değişiklikler boşaltıldıktan sonra akıştaki yeni değişiklikler için bölümü yoklama arasındaki gecikme süresi (milisaniye cinsinden). Varsayılan değer 5.000 milisaniye veya 5 saniyedir.
leaseAcquireInterval	Ayarlandığında, bölümlerin bilinen konak örnekleri arasında eşit olarak dağıtılıp dağıtılamadığını hesaplamak için bir görevi başlatma aralığını milisaniye cinsinden tanımlar. Varsayılan değer 13000 'dir (13 saniye).
leaseCollectionName	Kiraları depolamak için koleksiyonun adı. Ayarlanmadıysa , "kiraları" kullanır
leaseCollectionPrefix	Ayarlandığında, değer bu işlev için Kira koleksiyonunda oluşturulan kiralara ön ek olarak eklenir. Ön ek kullanmak, iki ayrı Azure İşlevi'nin farklı ön ekleri kullanarak aynı Kira koleksiyonunu paylaşmasına olanak tanır.
leaseCollectionThroughput	createLeaseCollectionIfNotExists trueolarak ayarlandığında, oluşturulan kira koleksiyonuna atanacak İstek Birimi miktarını tanımlar
leaseConnectionStringSetting	Kira koleksiyonunu barındıran hizmete bağlantı dizesini içeren bir uygulama ayarının adı. Ayarlanmazsa, connectionStringSetting tarafından tanımlanan hizmete bağlanır
leaseDatabaseName	Kiraları depolamak için koleksiyonu tutan veritabanının adı. Ayarlanmadıysa, databaseName değerini kullanır
leaseExpirationInterval	Ayarlandığında, bölümü temsil eden bir kirada kiranın alındığı aralığı milisaniye cinsinden tanımlar. Kira bu aralık içinde yenilenmezse süresi dolmasına neden olur ve bölümün sahipliği başka bir örneğe taşınır. Varsayılan değer 60000 'dir (60 saniye).
leaseRenewInterval	Ayarlandığında, o anda bir örnek tarafından tutulan bölümler için tüm kiralamalar için yenileme aralığını milisaniye cinsinden tanımlar. Varsayılan değer 17000 'dir (17 saniye).
maxItemsPerInvocation	Ayarlandığında, bu özellik İşlev çağrısı başına alınan en fazla öğe sayısını ayarlar. İzlenen kapsayıcıdaki işlemler saklı yordamlar aracılığıyla gerçekleştiriliyorsa, değişiklik akışındaki öğeler okunurken işlem kapsamı korunur. Sonuç olarak, alınan öğe sayısı belirtilen değerden yüksek olabilir, böylece aynı işlem tarafından değiştirilen öğeler tek bir atomik toplu işlemin parçası olarak döndürülür.
preferredLocations	Azure Cosmos DB hizmetinde coğrafi olarak çoğaltılan veritabanı hesapları için tercih edilen konumları (bölgeleri) tanımlar. Değerler virgülle ayrılmış olmalıdır. Örneğin, Doğu ABD,Orta Güney ABD,Kuzey Avrupa
return	İşlevin isteğe bağlı birincil çıkışı için yapılandırma Bu, çağırma sırasında işlev işleyicisinin dönüş değeri olarak ayarlamanız gereken ana çıkıştır
startFromBeginning	Bu seçenek Tetikleyici'ye geçerli zamanda başlamak yerine kapsayıcının değişiklik geçmişinin başından itibaren değişiklikleri okumasını söyler. Baştan okuma yalnızca tetikleyici ilk kez başlatıldığında çalışır, sonraki çalıştırmalarda olduğu gibi denetim noktaları zaten depolanır. Zaten oluşturulmuş kiralar olduğunda bu seçeneğin true olarak ayarlanmasının hiçbir etkisi yoktur.
useMultipleWriteLocations	Kiralama koleksiyonuna yazmak için çok bölgeli hesapları etkinleştirir.

Özellik Ayrıntıları

handler

handler: CosmosDBv3Handler

Özellik Değeri

CosmosDBv3Handler

retry

Başarılı bir tamamlama gerçekleşene veya yeniden deneme sayısı üst sınırına ulaşılana kadar başarısız bir yürütmeyi yeniden çalıştırmak için isteğe bağlı bir yeniden deneme ilkesi. Daha fazla bilgi edinmek için buraya bakın.

retry?: RetryOptions

Özellik Değeri

RetryOptions

trigger

trigger?: CosmosDBv3Trigger

Özellik Değeri

CosmosDBv3Trigger

Devralınan Özellik Detayları

checkpointDocumentCount

Kira denetim noktaları arasındaki belge miktarını özelleştirir. Varsayılan, her işlev çağrısının ardındandır.

checkpointDocumentCount?: number

Özellik Değeri

number

Devralındığı yer:CosmosDBv3TriggerOptions.checkpointDocumentCount

checkpointInterval

Ayarlandığında, kira denetim noktaları arasındaki aralığı milisaniye cinsinden tanımlar. Varsayılan değer her zaman her İşlev çağrısının ardındandır.

checkpointInterval?: number

Özellik Değeri

number

Devralındığı yer:CosmosDBv3TriggerOptions.checkpointInterval

collectionName

İzlenen koleksiyonun adı

collectionName: string

Özellik Değeri

string

Devralındığı yer:CosmosDBv3TriggerOptions.collectionName

connectionStringSetting

Cosmos DB bağlantı dizesi içeren bir uygulama ayarı (veya ortam değişkeni)

connectionStringSetting: string

Özellik Değeri

string

Devralındığı yer:CosmosDBv3TriggerOptions.connectionStringSetting

createLeaseCollectionIfNotExists

Varlığı denetler ve kira koleksiyonunu otomatik olarak oluşturur. Varsayılan değer: false

createLeaseCollectionIfNotExists?: boolean

Özellik Değeri

boolean

Devralındığı yer:CosmosDBv3TriggerOptions.createLeaseCollectionIfNotExists

databaseName

Koleksiyonun izlendiği Azure Cosmos DB veritabanının adı

databaseName: string

Özellik Değeri

string

Devralındığı yer:CosmosDBv3TriggerOptions.databaseName

extraInputs

İsteğe bağlı bir ikincil giriş kümesi için yapılandırma Çağırma sırasında bu değerleri context.extraInputs.get()

extraInputs?: FunctionInput[]

Özellik Değeri

FunctionInput[]

Partial.extraInputs Devralındı

extraOutputs

İsteğe bağlı bir ikincil çıkış kümesi için yapılandırma Çağırma sırasında bu değerleri context.extraOutputs.set()

extraOutputs?: FunctionOutput[]

Özellik Değeri

FunctionOutput[]

Partial.extraOutputs Devralındı

feedPollDelay

Tüm geçerli değişiklikler boşaltıldıktan sonra akıştaki yeni değişiklikler için bölümü yoklama arasındaki gecikme süresi (milisaniye cinsinden). Varsayılan değer 5.000 milisaniye veya 5 saniyedir.

feedPollDelay?: number

Özellik Değeri

number

Devralındığı yer:CosmosDBv3TriggerOptions.feedPollDelay

leaseAcquireInterval

Ayarlandığında, bölümlerin bilinen konak örnekleri arasında eşit olarak dağıtılıp dağıtılamadığını hesaplamak için bir görevi başlatma aralığını milisaniye cinsinden tanımlar. Varsayılan değer 13000 'dir (13 saniye).

leaseAcquireInterval?: number

Özellik Değeri

number

Devralındığı yer:CosmosDBv3TriggerOptions.leaseAcquireInterval

leaseCollectionName

Kiraları depolamak için koleksiyonun adı. Ayarlanmadıysa , "kiraları" kullanır

leaseCollectionName?: string

Özellik Değeri

string

Devralındığı yer:CosmosDBv3TriggerOptions.leaseCollectionName

leaseCollectionPrefix

Ayarlandığında, değer bu işlev için Kira koleksiyonunda oluşturulan kiralara ön ek olarak eklenir. Ön ek kullanmak, iki ayrı Azure İşlevi'nin farklı ön ekleri kullanarak aynı Kira koleksiyonunu paylaşmasına olanak tanır.

leaseCollectionPrefix?: string

Özellik Değeri

string

Devralındığı yer:CosmosDBv3TriggerOptions.leaseCollectionPrefix

leaseCollectionThroughput

createLeaseCollectionIfNotExists trueolarak ayarlandığında, oluşturulan kira koleksiyonuna atanacak İstek Birimi miktarını tanımlar

leaseCollectionThroughput?: number

Özellik Değeri

number

Devralındığı yer:CosmosDBv3TriggerOptions.leaseCollectionThroughput

leaseConnectionStringSetting

Kira koleksiyonunu barındıran hizmete bağlantı dizesini içeren bir uygulama ayarının adı. Ayarlanmazsa, connectionStringSetting tarafından tanımlanan hizmete bağlanır

leaseConnectionStringSetting?: string

Özellik Değeri

string

Devralındığı yer:CosmosDBv3TriggerOptions.leaseConnectionStringSetting

leaseDatabaseName

Kiraları depolamak için koleksiyonu tutan veritabanının adı. Ayarlanmadıysa, databaseName değerini kullanır

leaseDatabaseName?: string

Özellik Değeri

string

Devralındığı yer:CosmosDBv3TriggerOptions.leaseDatabaseName

leaseExpirationInterval

Ayarlandığında, bölümü temsil eden bir kirada kiranın alındığı aralığı milisaniye cinsinden tanımlar. Kira bu aralık içinde yenilenmezse süresi dolmasına neden olur ve bölümün sahipliği başka bir örneğe taşınır. Varsayılan değer 60000 'dir (60 saniye).

leaseExpirationInterval?: number

Özellik Değeri

number

Devralındığı yer:CosmosDBv3TriggerOptions.leaseExpirationInterval

leaseRenewInterval

Ayarlandığında, o anda bir örnek tarafından tutulan bölümler için tüm kiralamalar için yenileme aralığını milisaniye cinsinden tanımlar. Varsayılan değer 17000 'dir (17 saniye).

leaseRenewInterval?: number

Özellik Değeri

number

Devralındığı yer:CosmosDBv3TriggerOptions.leaseRenewInterval

maxItemsPerInvocation

Ayarlandığında, bu özellik İşlev çağrısı başına alınan en fazla öğe sayısını ayarlar. İzlenen kapsayıcıdaki işlemler saklı yordamlar aracılığıyla gerçekleştiriliyorsa, değişiklik akışındaki öğeler okunurken işlem kapsamı korunur. Sonuç olarak, alınan öğe sayısı belirtilen değerden yüksek olabilir, böylece aynı işlem tarafından değiştirilen öğeler tek bir atomik toplu işlemin parçası olarak döndürülür.

maxItemsPerInvocation?: number

Özellik Değeri

number

Devralındığı yer:CosmosDBv3TriggerOptions.maxItemsPerInvocation

preferredLocations

Azure Cosmos DB hizmetinde coğrafi olarak çoğaltılan veritabanı hesapları için tercih edilen konumları (bölgeleri) tanımlar. Değerler virgülle ayrılmış olmalıdır. Örneğin, Doğu ABD,Orta Güney ABD,Kuzey Avrupa

preferredLocations?: string

Özellik Değeri

string

Devralındığı yer:CosmosDBv3TriggerOptions.preferredLocations

return

İşlevin isteğe bağlı birincil çıkışı için yapılandırma Bu, çağırma sırasında işlev işleyicisinin dönüş değeri olarak ayarlamanız gereken ana çıkıştır

return?: FunctionOutput

Özellik Değeri

FunctionOutput

Partial.return Devralındı

startFromBeginning

Bu seçenek Tetikleyici'ye geçerli zamanda başlamak yerine kapsayıcının değişiklik geçmişinin başından itibaren değişiklikleri okumasını söyler. Baştan okuma yalnızca tetikleyici ilk kez başlatıldığında çalışır, sonraki çalıştırmalarda olduğu gibi denetim noktaları zaten depolanır. Zaten oluşturulmuş kiralar olduğunda bu seçeneğin true olarak ayarlanmasının hiçbir etkisi yoktur.

startFromBeginning?: boolean

Özellik Değeri

boolean

Devralındığı yer:CosmosDBv3TriggerOptions.startFromBeginning

useMultipleWriteLocations

Kiralama koleksiyonuna yazmak için çok bölgeli hesapları etkinleştirir.

useMultipleWriteLocations?: boolean

Özellik Değeri

boolean

Devralındığı yer:CosmosDBv3TriggerOptions.useMultipleWriteLocations