CosmosDBv3TriggerOptions interface

パッケージ:

@azure/functions

プロパティ

checkpointDocumentCount	リース チェックポイント間のドキュメントの量をカスタマイズします。 既定値は、すべての関数呼び出しの後です。
checkpointInterval	設定すると、リース チェックポイント間の間隔がミリ秒単位で定義されます。 既定値は、各関数呼び出しの後に常に設定されます。
collectionName	監視対象のコレクションの名前
connectionStringSetting	Cosmos DB 接続文字列を含むアプリ設定 (または環境変数)
createLeaseCollectionIfNotExists	存在するかどうかを確認し、リース コレクションを自動的に作成します。 既定値は false
databaseName	監視対象のコレクションを含む Azure Cosmos DB データベースの名前
feedPollDelay	現在のすべての変更がドレインされた後の、フィードの新しい変更についてパーティションをポーリングするまでの遅延時間 (ミリ秒)。 既定値は 5,000 ミリ秒または 5 秒です。
leaseAcquireInterval	設定すると、既知のホスト インスタンス間でパーティションが均等に分散されているかどうかを計算するタスクを開始する間隔がミリ秒単位で定義されます。 既定値は 13000 (13 秒) です。
leaseCollectionName	リースを格納するコレクションの名前。 設定されていない場合は、"リース" を使用します
leaseCollectionPrefix	この値を設定すると、この関数の Lease コレクションに作成されたリースのプレフィックスとして値が追加されます。 プレフィックスを使用すると、2 つの異なる Azure Functions で、異なるプレフィックスを使用して同じ Lease コレクションを共有できます。
leaseCollectionThroughput	createLeaseCollectionIfNotExists が trueに設定されている場合、作成されたリース コレクションに割り当てる要求ユニットの量を定義します
leaseConnectionStringSetting	リース コレクションを保持するサービスへの接続文字列を含むアプリ設定の名前。 設定しない場合、connectionStringSetting によって定義されたサービスに接続されます
leaseDatabaseName	リースを格納するコレクションを保持するデータベースの名前。 設定されていない場合は、databaseName の値が使用されます
leaseExpirationInterval	設定すると、パーティションを表すリースでリースを取得する間隔をミリ秒単位で定義します。 リースがこの期間内に更新されない場合、リースは期限切れになり、パーティションの所有権は別のインスタンスに移動します。 既定値は 60000 (60 秒) です。
leaseRenewInterval	設定すると、インスタンスによって現在保持されているパーティションのすべてのリースの更新間隔がミリ秒単位で定義されます。 既定値は 17000 (17 秒) です。
maxItemsPerInvocation	このプロパティを設定すると、関数呼び出しごとに受信したアイテムの最大数が設定されます。 監視対象コンテナーの操作がストアド プロシージャを通じて実行される場合、変更フィードから項目を読み取るときにトランザクション スコープが保持されます。 その結果、同じトランザクションによって変更されたアイテムが 1 つのアトミック バッチの一部として返されるように、受信した項目の数が指定された値より大きくなる可能性があります。
preferredLocations	Azure Cosmos DB サービスで geo レプリケートされたデータベース アカウントの優先する場所 (リージョン) を定義します。 値はコンマ区切りにする必要があります。 たとえば、米国東部、米国中南部、北ヨーロッパなどです。
startFromBeginning	このオプションは、現在の時刻から開始するのではなく、コンテナーの変更履歴の先頭から変更を読み取るようにトリガーに指示します。 最初からの読み取りは、トリガーが初めて開始されたときにのみ機能します。後続の実行と同様に、チェックポイントは既に格納されています。 リースが既に作成されている場合にこのオプションを true に設定しても効果はありません。
useMultipleWriteLocations	リース コレクションに書き込むための複数リージョン アカウントを有効にします。

プロパティの詳細

checkpointDocumentCount

リース チェックポイント間のドキュメントの量をカスタマイズします。 既定値は、すべての関数呼び出しの後です。

checkpointDocumentCount?: number

プロパティ値

number

checkpointInterval

設定すると、リース チェックポイント間の間隔がミリ秒単位で定義されます。 既定値は、各関数呼び出しの後に常に設定されます。

checkpointInterval?: number

プロパティ値

number

collectionName

監視対象のコレクションの名前

collectionName: string

プロパティ値

string

connectionStringSetting

Cosmos DB 接続文字列を含むアプリ設定 (または環境変数)

connectionStringSetting: string

プロパティ値

string

createLeaseCollectionIfNotExists

存在するかどうかを確認し、リース コレクションを自動的に作成します。 既定値は false

createLeaseCollectionIfNotExists?: boolean

プロパティ値

boolean

databaseName

監視対象のコレクションを含む Azure Cosmos DB データベースの名前

databaseName: string

プロパティ値

string

feedPollDelay

現在のすべての変更がドレインされた後の、フィードの新しい変更についてパーティションをポーリングするまでの遅延時間 (ミリ秒)。 既定値は 5,000 ミリ秒または 5 秒です。

feedPollDelay?: number

プロパティ値

number

leaseAcquireInterval

設定すると、既知のホスト インスタンス間でパーティションが均等に分散されているかどうかを計算するタスクを開始する間隔がミリ秒単位で定義されます。 既定値は 13000 (13 秒) です。

leaseAcquireInterval?: number

プロパティ値

number

leaseCollectionName

リースを格納するコレクションの名前。 設定されていない場合は、"リース" を使用します

leaseCollectionName?: string

プロパティ値

string

leaseCollectionPrefix

この値を設定すると、この関数の Lease コレクションに作成されたリースのプレフィックスとして値が追加されます。 プレフィックスを使用すると、2 つの異なる Azure Functions で、異なるプレフィックスを使用して同じ Lease コレクションを共有できます。

leaseCollectionPrefix?: string

プロパティ値

string

leaseCollectionThroughput

createLeaseCollectionIfNotExists が trueに設定されている場合、作成されたリース コレクションに割り当てる要求ユニットの量を定義します

leaseCollectionThroughput?: number

プロパティ値

number

leaseConnectionStringSetting

リース コレクションを保持するサービスへの接続文字列を含むアプリ設定の名前。 設定しない場合、connectionStringSetting によって定義されたサービスに接続されます

leaseConnectionStringSetting?: string

プロパティ値

string

leaseDatabaseName

リースを格納するコレクションを保持するデータベースの名前。 設定されていない場合は、databaseName の値が使用されます

leaseDatabaseName?: string

プロパティ値

string

leaseExpirationInterval

設定すると、パーティションを表すリースでリースを取得する間隔をミリ秒単位で定義します。 リースがこの期間内に更新されない場合、リースは期限切れになり、パーティションの所有権は別のインスタンスに移動します。 既定値は 60000 (60 秒) です。

leaseExpirationInterval?: number

プロパティ値

number

leaseRenewInterval

設定すると、インスタンスによって現在保持されているパーティションのすべてのリースの更新間隔がミリ秒単位で定義されます。 既定値は 17000 (17 秒) です。

leaseRenewInterval?: number

プロパティ値

number

maxItemsPerInvocation

このプロパティを設定すると、関数呼び出しごとに受信したアイテムの最大数が設定されます。 監視対象コンテナーの操作がストアド プロシージャを通じて実行される場合、変更フィードから項目を読み取るときにトランザクション スコープが保持されます。 その結果、同じトランザクションによって変更されたアイテムが 1 つのアトミック バッチの一部として返されるように、受信した項目の数が指定された値より大きくなる可能性があります。

maxItemsPerInvocation?: number

プロパティ値

number

preferredLocations

Azure Cosmos DB サービスで geo レプリケートされたデータベース アカウントの優先する場所 (リージョン) を定義します。 値はコンマ区切りにする必要があります。 たとえば、米国東部、米国中南部、北ヨーロッパなどです。

preferredLocations?: string

プロパティ値

string

startFromBeginning

このオプションは、現在の時刻から開始するのではなく、コンテナーの変更履歴の先頭から変更を読み取るようにトリガーに指示します。 最初からの読み取りは、トリガーが初めて開始されたときにのみ機能します。後続の実行と同様に、チェックポイントは既に格納されています。 リースが既に作成されている場合にこのオプションを true に設定しても効果はありません。

startFromBeginning?: boolean

プロパティ値

boolean

useMultipleWriteLocations

リース コレクションに書き込むための複数リージョン アカウントを有効にします。

useMultipleWriteLocations?: boolean

プロパティ値

boolean