CosmosDBv4FunctionOptions interface

Paket:

@azure/functions

Extends

CosmosDBv4TriggerOptions,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

connection	Cosmos DB bağlantı dizesi içeren bir uygulama ayarı (veya ortam değişkeni)
containerName	İzlenen kapsayıcının adı
createLeaseContainerIfNotExists	Varlığı denetler ve kira kapsayıcısını otomatik olarak oluşturur. Varsayılan değer: false
databaseName	Kapsayıcının 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).
leaseConnection	Kira kapsayıcısını barındıran hizmete bağlantı dizesini içeren bir uygulama ayarının adı. Ayarlanmazsa, connection tarafından tanımlanan hizmete bağlanır
leaseContainerName	Kiraları depolamak için kapsayıcının adı. Ayarlanmadıysa , "kiraları" kullanır
leaseContainerPrefix	Ayarlandığında, değer bu işlev için Kira kapsayıcısında oluşturulan kiralara ön ek olarak eklenir. Ön ek kullanmak, iki ayrı Azure İşlevleri farklı ön ekleri kullanarak aynı Kira kapsayıcısını paylaşmasına olanak tanır.
leaseDatabaseName	Kiraları depolamak için kapsayıcıyı 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).
leasesContainerThroughput	createLeaseContainerIfNotExists trueolarak ayarlandığında, oluşturulan kira kapsayıcısına atanacak İstek Birimi miktarını tanımlar
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.
startFromTime	Değişiklik akışı okuma işleminin başlatıldığı tarih ve saati alır veya ayarlar. Önerilen biçim, 2021-02-16T14:19:29Z gibi UTC belirleyicisiyle ISO 8601'dir. Bu yalnızca ilk tetikleyici durumunu ayarlamak için kullanılır. Tetikleyici kiralama durumuna geldikten sonra bu değerin değiştirilmesinin hiçbir etkisi olmaz.

Özellik Ayrıntıları

handler

handler: CosmosDBv4Handler

Özellik Değeri

CosmosDBv4Handler

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?: CosmosDBv4Trigger

Özellik Değeri

CosmosDBv4Trigger

Devralınan Özellik Detayları

connection

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

connection: string

Özellik Değeri

string

Devralındığı yer:CosmosDBv4TriggerOptions.connection

containerName

İzlenen kapsayıcının adı

containerName: string

Özellik Değeri

string

Devralındığı yer:CosmosDBv4TriggerOptions.containerName

createLeaseContainerIfNotExists

Varlığı denetler ve kira kapsayıcısını otomatik olarak oluşturur. Varsayılan değer: false

createLeaseContainerIfNotExists?: boolean

Özellik Değeri

boolean

Devralındığı yer:CosmosDBv4TriggerOptions.createLeaseContainerIfNotExists

databaseName

Kapsayıcının izlendiği Azure Cosmos DB veritabanının adı

databaseName: string

Özellik Değeri

string

Devralındığı yer:CosmosDBv4TriggerOptions.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:CosmosDBv4TriggerOptions.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:CosmosDBv4TriggerOptions.leaseAcquireInterval

leaseConnection

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

leaseConnection?: string

Özellik Değeri

string

Devralındığı yer:CosmosDBv4TriggerOptions.leaseConnection

leaseContainerName

Kiraları depolamak için kapsayıcının adı. Ayarlanmadıysa , "kiraları" kullanır

leaseContainerName?: string

Özellik Değeri

string

Devralındığı yer:CosmosDBv4TriggerOptions.leaseContainerName

leaseContainerPrefix

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

leaseContainerPrefix?: string

Özellik Değeri

string

Devralındığı yer:CosmosDBv4TriggerOptions.leaseContainerPrefix

leaseDatabaseName

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

leaseDatabaseName?: string

Özellik Değeri

string

Devralındığı yer:CosmosDBv4TriggerOptions.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:CosmosDBv4TriggerOptions.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:CosmosDBv4TriggerOptions.leaseRenewInterval

leasesContainerThroughput

createLeaseContainerIfNotExists trueolarak ayarlandığında, oluşturulan kira kapsayıcısına atanacak İstek Birimi miktarını tanımlar

leasesContainerThroughput?: number

Özellik Değeri

number

Devralındığı yer:CosmosDBv4TriggerOptions.leasesContainerThroughput

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:CosmosDBv4TriggerOptions.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:CosmosDBv4TriggerOptions.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:CosmosDBv4TriggerOptions.startFromBeginning

startFromTime

Değişiklik akışı okuma işleminin başlatıldığı tarih ve saati alır veya ayarlar. Önerilen biçim, 2021-02-16T14:19:29Z gibi UTC belirleyicisiyle ISO 8601'dir. Bu yalnızca ilk tetikleyici durumunu ayarlamak için kullanılır. Tetikleyici kiralama durumuna geldikten sonra bu değerin değiştirilmesinin hiçbir etkisi olmaz.

startFromTime?: string

Özellik Değeri

string

Devralındığı yer:CosmosDBv4TriggerOptions.startFromTime