CosmosDBv4FunctionOptions interface
- Extends
-
CosmosDBv4TriggerOptions,Partial<FunctionOptions>
プロパティ
| handler | 関数がトリガーされたときに実行されるコード |
| retry | 成功した完了または再試行の最大数に達するまで、失敗した実行を再実行するオプションの再試行ポリシー。 詳細 については、こちらを参照してください。 |
| trigger | 関数へのプライマリ入力の構成、つまりトリガーされる理由。これは呼び出し時に関数ハンドラーに引数として渡される唯一の入力です |
継承されたプロパティ
| connection | Cosmos DB 接続文字列を含むアプリ設定 (または環境変数) |
| container |
監視対象のコンテナーの名前 |
| create |
存在を確認し、リース コンテナーを自動的に作成します。 既定値は |
| database |
監視対象のコンテナーを含む Azure Cosmos DB データベースの名前 |
| extra |
呼び出し中にオプションのセカンダリ入力セットの構成を行い、 |
| extra |
呼び出し中にオプションのセカンダリ出力セットの構成を行う場合は、これらの値を |
| feed |
現在のすべての変更がドレインされた後の、フィードの新しい変更についてパーティションをポーリングするまでの遅延時間 (ミリ秒)。 既定値は 5,000 ミリ秒 (5 秒) です。 |
| lease |
設定すると、既知のホスト インスタンス間でパーティションが均等に分散されているかどうかを計算するタスクを開始する間隔がミリ秒単位で定義されます。 既定値は 13,000 (13 秒) です。 |
| lease |
リース コンテナーを保持するサービスへの接続文字列を含むアプリ設定の名前。
設定しない場合、 |
| lease |
リースを格納するコンテナーの名前。 設定されていない場合は、"リース" を使用します |
| lease |
この値を設定すると、この関数の Lease コンテナーで作成されたリースにプレフィックスとして値が追加されます。 プレフィックスを使用すると、異なるプレフィックスを使用して、2 つの別の Azure 関数が同じリース コンテナーを共有できるようになります。 |
| lease |
リースを格納するコンテナーを保持するデータベースの名前。 設定されていない場合は、 |
| lease |
設定すると、パーティションを表すリースでリースを取得する間隔をミリ秒単位で定義します。 この間隔内にリースが更新されない場合、リースは期限切れとなり、パーティションの所有権は別のインスタンスに移動します。 既定値は 60,000 (60 秒) です。 |
| lease |
設定すると、インスタンスによって現在保持されているパーティションのすべてのリースの更新間隔がミリ秒単位で定義されます。 既定値は 17,000 (17 秒) です。 |
| leases |
|
| max |
このプロパティを設定すると、関数呼び出しごとに受信したアイテムの最大数が設定されます。 監視対象コンテナーの操作がストアド プロシージャを通じて実行される場合、変更フィードから項目を読み取るときにトランザクション スコープが保持されます。 その結果、受信した項目数が指定した値よりも多くなり、同じトランザクションで変更された項目が 1 つのアトミック バッチの一部として返される可能性があります。 |
| preferred |
Azure Cosmos DB サービスで geo レプリケートされたデータベース アカウントの優先する場所 (リージョン) を定義します。 複数の値はコンマで区切る必要があります。 たとえば、米国東部、米国中南部、北ヨーロッパなどです。 |
| return | 関数のオプションのプライマリ出力の構成 これは、呼び出し時に関数ハンドラーの戻り値として設定する必要があるメイン出力です。 |
| start |
このオプションは、現在の時刻から開始するのではなく、コンテナーの変更履歴の先頭から変更を読み取るようにトリガーに指示します。 以降の実行ではチェックポイントが既に保存されているため、先頭からの読み取りが機能するのは、トリガーが初めて開始されたときのみです。 リースが既に作成されている場合にこのオプションを true に設定しても効果はありません。 |
| start |
変更フィードの読み取り操作を初期化する日付と時刻を取得または設定します。 推奨される形式は、2021-02-16T14:19:29Z など、UTC 指定子を含む ISO 8601 です。 これは、最初のトリガー状態を設定するためにのみ使われます。 トリガーがリース状態になった後にこの値を変更しても効果はありません。 |
プロパティの詳細
handler
retry
成功した完了または再試行の最大数に達するまで、失敗した実行を再実行するオプションの再試行ポリシー。 詳細 については、こちらを参照してください。
retry?: RetryOptionsプロパティ値
trigger
関数へのプライマリ入力の構成、つまりトリガーされる理由。これは呼び出し時に関数ハンドラーに引数として渡される唯一の入力です
trigger?: CosmosDBv4Triggerプロパティ値
継承されたプロパティの詳細
connection
Cosmos DB 接続文字列を含むアプリ設定 (または環境変数)
connection: stringプロパティ値
string
containerName
createLeaseContainerIfNotExists
存在を確認し、リース コンテナーを自動的に作成します。 既定値は false です
createLeaseContainerIfNotExists?: booleanプロパティ値
boolean
継承元:CosmosDBv4TriggerOptions.createLeaseContainerIfNotExists
databaseName
監視対象のコンテナーを含む Azure Cosmos DB データベースの名前
databaseName: stringプロパティ値
string
extraInputs
呼び出し中にオプションのセカンダリ入力セットの構成を行い、context.extraInputs.get() を使用してこれらの値を取得します
extraInputs?: FunctionInput[]プロパティ値
Partial.extraInputs から継承された
extraOutputs
呼び出し中にオプションのセカンダリ出力セットの構成を行う場合は、これらの値を context.extraOutputs.set()
extraOutputs?: FunctionOutput[]プロパティ値
Partial.extraOutputs から継承
feedPollDelay
現在のすべての変更がドレインされた後の、フィードの新しい変更についてパーティションをポーリングするまでの遅延時間 (ミリ秒)。 既定値は 5,000 ミリ秒 (5 秒) です。
feedPollDelay?: numberプロパティ値
number
leaseAcquireInterval
設定すると、既知のホスト インスタンス間でパーティションが均等に分散されているかどうかを計算するタスクを開始する間隔がミリ秒単位で定義されます。 既定値は 13,000 (13 秒) です。
leaseAcquireInterval?: numberプロパティ値
number
leaseConnection
リース コンテナーを保持するサービスへの接続文字列を含むアプリ設定の名前。
設定しない場合、connection によって定義されたサービスに接続されます
leaseConnection?: stringプロパティ値
string
leaseContainerName
リースを格納するコンテナーの名前。 設定されていない場合は、"リース" を使用します
leaseContainerName?: stringプロパティ値
string
leaseContainerPrefix
この値を設定すると、この関数の Lease コンテナーで作成されたリースにプレフィックスとして値が追加されます。 プレフィックスを使用すると、異なるプレフィックスを使用して、2 つの別の Azure 関数が同じリース コンテナーを共有できるようになります。
leaseContainerPrefix?: stringプロパティ値
string
leaseDatabaseName
リースを格納するコンテナーを保持するデータベースの名前。 設定されていない場合は、databaseName の値が使用されます
leaseDatabaseName?: stringプロパティ値
string
CosmosDBv4TriggerOptions.leaseDatabaseNameから継承
leaseExpirationInterval
設定すると、パーティションを表すリースでリースを取得する間隔をミリ秒単位で定義します。 この間隔内にリースが更新されない場合、リースは期限切れとなり、パーティションの所有権は別のインスタンスに移動します。 既定値は 60,000 (60 秒) です。
leaseExpirationInterval?: numberプロパティ値
number
leaseRenewInterval
設定すると、インスタンスによって現在保持されているパーティションのすべてのリースの更新間隔がミリ秒単位で定義されます。 既定値は 17,000 (17 秒) です。
leaseRenewInterval?: numberプロパティ値
number
leasesContainerThroughput
createLeaseContainerIfNotExists が trueに設定されている場合、作成されたリース コンテナーに割り当てる要求ユニットの量を定義します
leasesContainerThroughput?: numberプロパティ値
number
maxItemsPerInvocation
このプロパティを設定すると、関数呼び出しごとに受信したアイテムの最大数が設定されます。 監視対象コンテナーの操作がストアド プロシージャを通じて実行される場合、変更フィードから項目を読み取るときにトランザクション スコープが保持されます。 その結果、受信した項目数が指定した値よりも多くなり、同じトランザクションで変更された項目が 1 つのアトミック バッチの一部として返される可能性があります。
maxItemsPerInvocation?: numberプロパティ値
number
CosmosDBv4TriggerOptions.maxItemsPerInvocationから継承
preferredLocations
Azure Cosmos DB サービスで geo レプリケートされたデータベース アカウントの優先する場所 (リージョン) を定義します。 複数の値はコンマで区切る必要があります。 たとえば、米国東部、米国中南部、北ヨーロッパなどです。
preferredLocations?: stringプロパティ値
string
CosmosDBv4TriggerOptions.preferredLocationsから継承
return
関数のオプションのプライマリ出力の構成 これは、呼び出し時に関数ハンドラーの戻り値として設定する必要があるメイン出力です。
return?: FunctionOutputプロパティ値
partial.return から継承された
startFromBeginning
このオプションは、現在の時刻から開始するのではなく、コンテナーの変更履歴の先頭から変更を読み取るようにトリガーに指示します。 以降の実行ではチェックポイントが既に保存されているため、先頭からの読み取りが機能するのは、トリガーが初めて開始されたときのみです。 リースが既に作成されている場合にこのオプションを true に設定しても効果はありません。
startFromBeginning?: booleanプロパティ値
boolean
startFromTime
変更フィードの読み取り操作を初期化する日付と時刻を取得または設定します。 推奨される形式は、2021-02-16T14:19:29Z など、UTC 指定子を含む ISO 8601 です。 これは、最初のトリガー状態を設定するためにのみ使われます。 トリガーがリース状態になった後にこの値を変更しても効果はありません。
startFromTime?: stringプロパティ値
string