RequestOptions interface

要求に関連付けられている条件。

accessCondition?: { condition: string, type: string }

プロパティ値

false に設定すると、サービスは応答でペイロードを返しません。 ペイロードをネットワーク経由で送り返さないことで、ネットワークと CPU の負荷を軽減します。 既定値は true です。

注: 現在、このオプションは一括操作とバッチ操作でのみサポートされています。

contentResponseOnWriteEnabled?: boolean

プロパティ値

ID の自動生成を無効にする (ID が定義に含まれていない場合、作成が失敗する)

disableAutomaticIdGeneration?: boolean

プロパティ値

JavaScript ストアド プロシージャのログ記録を有効または無効にします。

enableScriptLogging?: boolean

プロパティ値

インデックス作成ディレクティブを指定します (インデックスを作成する、インデックスを作成しないなど)。

indexingDirective?: string

プロパティ値

ユニットあたりの要求数の測定でコンテナー用にプロビジョニングされたオファースループット。

offerThroughput?: number

プロパティ値

ドキュメント コンテナーを作成するときのオファーの種類。

このオプションは、ドキュメント コンテナーを作成する場合にのみ有効です。

offerType?: string

プロパティ値

ドキュメント コンテナーの読み取り要求に関するドキュメント コンテナー クォータ関連の統計の取得を有効または無効にします。

populateQuotaInfo?: boolean

プロパティ値

操作後に呼び出されるポスト トリガーを示します。

postTriggerInclude?: string | string[]

プロパティ値

操作の前に呼び出される事前トリガーを示します。

preTriggerInclude?: string | string[]

プロパティ値

アクセス許可に関連付けられているリソース トークンの有効期限 (秒単位) (アクセス許可に対する要求にのみ適用されます)。

resourceTokenExpirySeconds?: number

プロパティ値

(高度なユース ケース)接続先の URL。

urlConnection?: string

プロパティ値

abortSignal を使用して、このメソッド呼び出しによって作成されたすべての基になるネットワーク要求に渡します。 https://developer.mozilla.org/en-US/docs/Web/API/AbortController を参照してください

例

読み取り要求を取り消す

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const controller = new AbortController();
const results = container.items.query("SELECT * from c", {
  abortSignal: controller.signal,
});

abortSignal?: AbortSignal

プロパティ値

継承元SharedOptions.abortSignal

Azure CosmosDB サービスの要求に対して統合キャッシュをバイパスするか有効にするかを設定します。

既定値は false です。 既定では、統合キャッシュが有効になっています

bypassIntegratedCache?: boolean

プロパティ値

SharedOptions.bypassIntegratedCacheから継承されます

クライアントに必要な整合性レベル。

consistencyLevel?: string

プロパティ値

SharedOptions.consistencyLevelから継承

DisableRUPerMinuteUsage は、通常のプロビジョニングされた RU/秒が使い果たされた場合に要求を処理するために、要求ユニット (RU)/分の容量を有効または無効にするために使用されます。

disableRUPerMinuteUsage?: boolean

プロパティ値

SharedOptions.disableRUPerMinuteUsageから継承されます

(高度なユース ケース)Cosmos に要求を送信するときに開始する初期ヘッダー

initialHeaders?: CosmosHeaders

プロパティ値

継承元SharedOptions.initialHeaders

Azure CosmosDB サービスの要求に関連付けられている制約値を設定します。 <xref:com.azure.cosmos.ConsistencyLevel> が <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> または <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>されている要求の場合、統合キャッシュからの応答は、この maxIntegratedCacheStaleness で示される値よりも古くないことを保証されます。 整合性レベルが設定されていない場合、このプロパティは無視されます。

既定値は null です

キャッシュの制約はミリ秒単位の細分性でサポートされます。 ミリ秒未満の値は無視されます。

maxIntegratedCacheStalenessInMs?: number

プロパティ値

SharedOptions.maxIntegratedCacheStalenessInMsから継承されます

各要求の優先度レベル (低/高)。 優先度の低い要求は、優先度の高い要求の前に常に調整されます。

既定値は null です。 既定では、すべての要求の優先度が高い

priorityLevel?: PriorityLevel

プロパティ値

継承元SharedOptions.priorityLevel

ドキュメント コンテナーの読み取り要求に関するドキュメント コンテナー クォータ関連の統計の取得を有効または無効にします。

sessionToken?: string

プロパティ値

SharedOptions.sessionTokenから継承されます

要求のスループットバケット。

既定値は null です。 この場合、要求ではパーティションのスループットの 100% を使用できます。

詳細については、[Cosmos DB スループット バケット](https://aka.ms/cosmsodb-bucketing).

throughputBucket?: number

プロパティ値

SharedOptions.throughputBucketから継承