CosmosDBv3OutputOptions interface

パッケージ:

@azure/functions

プロパティ

collectionName	監視対象のコレクションの名前
collectionThroughput	createIfNotExists が true の場合、作成されたコレクションの スループットを定義します
connectionStringSetting	Cosmos DB 接続文字列を含むアプリ設定 (または環境変数)
createIfNotExists	コレクションが存在しない場合に作成されるかどうかを示すブール値。 コストに影響を与える予約済みスループットで新しいコレクションが作成されるため、既定値は false です。 詳細については、価格に関するページを参照してください。
databaseName	監視対象のコレクションを含む Azure Cosmos DB データベースの名前
partitionKey	createIfNotExists が true の場合、作成されたコレクションのパーティション キー パスが定義されます。 バインド パラメーターを含めることができます。
preferredLocations	Azure Cosmos DB サービスで geo レプリケートされたデータベース アカウントの優先する場所 (リージョン) を定義します。 値はコンマ区切りにする必要があります。 たとえば、米国東部、米国中南部、北ヨーロッパなどです。
useMultipleWriteLocations	preferredLocations と共に true に設定すると、Azure Cosmos DB サービスで複数リージョンの書き込みがサポートされます。

プロパティの詳細

collectionName

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

collectionName: string

プロパティ値

string

collectionThroughput

createIfNotExists が true の場合、作成されたコレクションの スループットを定義します

collectionThroughput?: number

プロパティ値

number

connectionStringSetting

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

connectionStringSetting: string

プロパティ値

string

createIfNotExists

コレクションが存在しない場合に作成されるかどうかを示すブール値。 コストに影響を与える予約済みスループットで新しいコレクションが作成されるため、既定値は false です。 詳細については、価格に関するページを参照してください。

createIfNotExists?: boolean

プロパティ値

boolean

databaseName

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

databaseName: string

プロパティ値

string

partitionKey

createIfNotExists が true の場合、作成されたコレクションのパーティション キー パスが定義されます。 バインド パラメーターを含めることができます。

partitionKey?: string

プロパティ値

string

preferredLocations

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

preferredLocations?: string

プロパティ値

string

useMultipleWriteLocations

preferredLocations と共に true に設定すると、Azure Cosmos DB サービスで複数リージョンの書き込みがサポートされます。

useMultipleWriteLocations?: boolean

プロパティ値

boolean