次の方法で共有

一般的な Azure Cosmos DB REST 要求ヘッダー

  • [アーティクル]

次の要求ヘッダーは、SQL API で実行できるすべてのタスクに共通です。

ヘッダ 必須 種類 形容
承認 の 必須 糸 要求の承認トークン。 有効な承認トークンの生成の詳細については、「Cosmos DB リソースでのアクセス制御 を参照してください。
Content-Type 必須 (PUT、PATCH、POST) 糸 クエリ操作の POST の場合は、アプリケーション/query+json する必要があります。

PATCH 操作の場合は、アプリケーション/json_patch+json する必要があります。

添付ファイルの場合は、添付ファイルの Mime の種類に設定する必要があります。 Mime の種類の詳細については、「添付ファイルの作成 」を参照してください。

他のすべてのタスクでは、application/json である必要があります。
if-match の 省略可能 (PUT と DELETE にのみ適用) 糸 オプティミスティック コンカレンシーの条件付き操作を行うために使用されます。 値は、リソースの etag 値である必要があります。
If-None-Match の 省略可能 (GET でのみ適用) 糸 リソースが変更された場合にのみ、操作を条件付きで実行します。 値はリソースの etag である必要があります。
If-Modified-Since 省略可能 (GET でのみ適用) 日付 RFC 1123 形式で指定した日付より後に変更されたリソースの etag を返します。 If-None-Match を指定 場合は無視されます
ユーザー エージェント の 随意 糸 要求を実行するクライアント ユーザー エージェントを指定する文字列。 推奨される形式は {user agent name}/{version} です。 たとえば、公式の SQL API .NET SDK では、User-Agent 文字列が Microsoft.Document.Client/1.0.0.0 に設定されます。 カスタム ユーザー エージェントは、ContosoMarketingApp/1.0.0 のようになります。
x-ms-activity-id を する 随意 糸 クライアントが指定した操作の識別子。サーバーの応答でエコーされます。 推奨値は一意識別子です。
x-ms-consistency レベルの を する 随意 糸 ドキュメントと添付ファイルに対する読み取りオプションの整合性レベルのオーバーライド。 有効な値は、Strong、Bounded、Session、または Eventual (最も強いものから弱い順) です。 オーバーライドは、アカウントの構成済みの整合性レベルと同じか弱い必要があります。
x-ms-continuation を する 随意 糸 読み取る結果が多い場合に、クエリと読み取りフィード操作に対して返される文字列トークン。 クライアントは、x-ms-continuation 要求ヘッダーをこの値に設定して要求を再送信することで、結果の次のページを取得できます。
x-ms-date を する 必須 日付 協定世界時で表される RFC 1123 の日付形式に基づいた要求の日付 。たとえば、2015 年 4 月 8 日 (金) 03:52:31 GMT。
x-ms-max-item-count を する 随意 数 ページごとに返されるアイテムの最大数を示す整数。 -1 の x-ms-max-item-count を指定して、サービスが最適な項目数を判断できるようにすることができます。 これは、x-ms-max-item-count に推奨される構成値です
x-ms-documentdb-partitionkey を する 随意 配列 要求されたドキュメントまたは添付ファイル操作のパーティション キー値。 コレクション定義にパーティション キー定義が含まれている場合、ドキュメントと添付ファイルに対する操作に必要です。 この値は、パーティション キーの条件に一致するドキュメントにクエリのスコープを設定するために使用されます。 仕様上、これは単一のパーティション クエリです。 API バージョン 2015-12-16 以降でサポートされています。 現在、SQL API では 1 つのパーティション キーがサポートされているため、これは 1 つの値のみを含む配列です。
x-ms-documentdb-query-enablecrosspartition を する 随意 ブーリアン このヘッダーが true に設定されていて、クエリにパーティション キーがない場合、Azure Cosmos DB はパーティション間でクエリをファンアウトします。 ファン アウトは、すべてのパーティションに対して個々のクエリを発行することによって行われます。 クエリ結果を読み取るには、クライアント アプリケーションで FeedResponse の結果を使用し、ContinuationToken プロパティを確認する必要があります。 すべての結果を読み取るには、ContinuationToken が null になるまでデータを反復処理し続けます。
x-ms-session-token を する 必須 (セッション整合性の場合のみ) 糸 セッション レベルの整合性で使用される文字列トークン。 詳細については、次を参照してください。
Cosmos DB での整合性レベルの使用
x-ms-version を する 必須 糸 Cosmos DB REST サービスのバージョン。
サポートされている API バージョンの一覧については、Azure Cosmos DB REST API リファレンス 参照してください
A-IM を する 随意 糸 変更フィード 要求を示します。 "増分フィード" に設定するか、それ以外の場合は省略する必要があります。
x-ms-documentdb-partitionkeyrangeid を する 随意 数 変更フィード 要求で使用されます。 データを読み取るためのパーティション キー範囲 ID。
x-ms-cosmos-allow-tentative-writes 随意 ブーリアン 複数の書き込み場所で構成された Azure Cosmos アカウントに対してこのヘッダーが true に設定されている場合、Azure Cosmos DB はすべての場所への書き込みを許可します。 このヘッダーの値を false に設定した書き込み要求 (またはヘッダーが存在しない場合) は、"リージョンで書き込みが許可されていません" というエラー メッセージが表示された 403 応答状態コードで失敗します。

も参照