共通 Azure Cosmos DB REST 要求ヘッダーCommon Azure Cosmos DB REST request headers

次の要求ヘッダーは、SQL API を使用して実行するすべてのタスクに共通です。The following request headers are common to all tasks that you might do with the SQL API:

ヘッダーHeader 必須Required 種類Type 説明Description
承認Authorization 必須Required StringString 要求の承認トークン。The authorization token for the request. 有効な承認トークンの生成の詳細については、「 Cosmos DB リソースの Access Control 」を参照してください。For more information on generating a valid authorization token, see Access Control on Cosmos DB Resources
Content-TypeContent-Type 必須 (PUT および POST)Required (on PUT and POST) StringString クエリ操作の POST の場合は、application/query + json である必要があります。For POST on query operations, it must be application/query+json.

添付ファイルの場合は、を添付ファイルの Mime の種類に設定する必要があります。For attachments, must be set to the Mime type of the attachment. Mime の種類の詳細については、「添付ファイルの作成」を参照してください。For more information on Mime types, see Create an Attachment

その他のすべてのタスクでは、は application/json である必要があります。For all other tasks, must be application/json.
If-MatchIf-Match 省略可能 (PUT と DELETE にのみ適用可能)Optional (applicable only on PUT and DELETE) StringString オプティミスティック同時実行制御のために操作の条件を設定するために使用されます。Used to make operation conditional for optimistic concurrency. 値は、リソースの etag 値である必要があります。The value should be the etag value of the resource.
If-None-MatchIf-None-Match 省略可能 (GET にのみ適用可能)Optional (applicable only on GET) StringString 操作条件を、リソースが変更された場合にのみ実行するようにします。Makes operation conditional to only execute if the resource has changed. 値は、リソースの etag である必要があります。The value should be the etag of the resource.
If-Modified-SinceIf-Modified-Since 省略可能 (GET にのみ適用可能)Optional (applicable only on GET) DateDate 指定した日付より後に変更されたリソースの etag を RFC 1123 形式で返します。Returns etag of resource modified after specified date in RFC 1123 format. -None が指定されて いる場合 は無視されますIgnored when If-None-Match is specified
User-AgentUser-Agent 省略可能Optional StringString 要求を実行するクライアント ユーザー エージェントを示す文字列。A string that specifies the client user agent performing the request. 推奨される形式は {ユーザー エージェント名}/{バージョン} です。The recommended format is {user agent name}/{version}. たとえば、公式の SQL API .NET SDK では、ユーザーエージェント文字列が Microsoft.Document に設定されます。クライアント/1.0.0.0。For example, the official SQL API .NET SDK sets the User-Agent string to Microsoft.Document.Client/1.0.0.0. カスタムユーザーエージェントは、ContosoMarketingApp/1.0.0 のようなものにすることができます。A custom user-agent could be something like ContosoMarketingApp/1.0.0.
-ms-activity-idx-ms-activity-id 省略可能Optional StringString サーバーの応答でエコーされる、クライアントが指定した操作の識別子。A client supplied identifier for the operation, which is echoed in the server response. 推奨値は一意の識別子です。The recommended value is a unique identifier.
x-ms-consistency-levelx-ms-consistency-level 省略可能Optional StringString ドキュメントと添付ファイルに対する読み取りオプションの一貫性レベルの上書き。The consistency level override for read options against documents and attachments. 有効な値は、Strong、境界、セッション、または最終的 (最も強いものから最も弱い順) です。The valid values are: Strong, Bounded, Session, or Eventual (in order of strongest to weakest). オーバーライドは、アカウントの構成された整合性レベルと同じか、それよりも弱い必要があります。The override must be the same or weaker than the account’s configured consistency level.
x-ms-continuationx-ms-continuation 省略可能Optional StringString 読み取る結果がさらにある場合、クエリと読み取りフィード操作に対して返される文字列トークン。A string token returned for queries and read-feed operations if there are more results to be read. クライアントは、この値に設定された x ミリ秒の要求ヘッダーを使用して要求を再送信することによって、結果の次のページを取得できます。Clients can retrieve the next page of results by resubmitting the request with the x-ms-continuation request header set to this value.
x-ms-datex-ms-date 必須Required DateDate RFC 1123 日付形式による要求の日付を協定世界時 (たとえば、金曜日、08 Apr 2015 03:52:31 GMT) で表した日付。The date of the request per RFC 1123 date format expressed in Coordinated Universal Time, for example, Fri, 08 Apr 2015 03:52:31 GMT.
x-ms-max-item-countx-ms-max-item-count OptionalOptional NumberNumber 1ページあたりに返される項目の最大数を示す整数。An integer indicating the maximum number of items to be returned per page. サービスが最適な項目数を決定できるようにするには、-1 の値として-1 を指定できます。An x-ms-max-item-count of -1 can be specified to let the service determine the optimal item count. これは、[x--max-項目数] に推奨される構成値です。This is the recommended configuration value for x-ms-max-item-count
x--documentdb-partitionkeyx-ms-documentdb-partitionkey OptionalOptional ArrayArray 要求されたドキュメントまたは添付ファイル操作のパーティションキー値。The partition key value for the requested document or attachment operation. コレクション定義にパーティションキー定義が含まれている場合に、ドキュメントおよび添付ファイルに対する操作に必要です。Required for operations against documents and attachments when the collection definition includes a partition key definition. この値は、クエリのスコープをパーティションキー条件に一致するドキュメントに限定するために使用されます。This value is used to scope your query to documents that match the partition key criteria. 設計上、1つのパーティションクエリです。By design it's a single partition query. API バージョン2015-12-16 以降でサポートされています。Supported in API versions 2015-12-16 and newer. 現在、SQL API では1つのパーティションキーがサポートされているため、これは1つの値のみを含む配列です。Currently, the SQL API supports a single partition key, so this is an array containing just one value.
enablecrosspartition を実行します。x-ms-documentdb-query-enablecrosspartition OptionalOptional ブール型Boolean このヘッダーが true に設定されていて、クエリにパーティションキーがない場合、Azure Cosmos DB は複数のパーティションにわたってクエリを実行します。When this header is set to true and if your query doesn't have a partition key, Azure Cosmos DB fans out the query across partitions. この展開動作は、個々のクエリをすべてのパーティションに発行することによって行われます。The fan out is done by issuing individual queries to all the partitions. クエリの結果を読み取るためには、クライアント アプリケーションが FeedResponse から結果を取り込んで ContinuationToken プロパティを調べる必要があります。To read the query results, the client applications should consume the results from the FeedResponse and check for the ContinuationToken property. すべての結果を読み取るには、ContinuationToken が null になるまでデータを反復処理してください。To read all the results, keep iterating on the data until the ContinuationToken is null.
x-ms-session-tokenx-ms-session-token 必須 (セッションの整合性のみ)Required (for session consistency only) StringString セッションレベルの一貫性で使用される文字列トークン。A string token used with session level consistency. 詳細については、「For more information, see
Cosmos DB での整合性レベルの使用Using consistency levels in Cosmos DB
x-ms-versionx-ms-version 必須Required StringString Cosmos DB REST サービスのバージョン。The version of the Cosmos DB REST service.
サポートされている API バージョンの一覧については、「 Azure Cosmos DB REST API リファレンス」を参照してください。For a list of supported API versions, see Azure Cosmos DB REST API Reference
A-IMA-IM 省略可能Optional StringString Change feed要求を示します。Indicates a change feed request. "インクリメンタルフィード" に設定する必要があります。それ以外の場合は省略します。Must be set to "Incremental feed", or omitted otherwise.
x-ms-documentdb-partitionkeyrangeidx-ms-documentdb-partitionkeyrangeid OptionalOptional NumberNumber Change feed要求で使用されます。Used in change feed requests. 読み取りデータのパーティション キー範囲の ID です。The partition key range ID for reading data.
cosmos--許可-仮に書き込みx-ms-cosmos-allow-tentative-writes OptionalOptional ブール型Boolean 複数の書き込み場所で構成されている Azure Cosmos アカウントのこのヘッダーが true に設定されている場合、Azure Cosmos DB はすべての場所への書き込みを許可します。When this header is set to true for the Azure Cosmos accounts configured with multiple write locations, Azure Cosmos DB will allow writes to all locations. このヘッダーが false に設定された書き込み要求 (または、ヘッダーが存在しない場合) は、403応答状態コードで失敗し、"領域内で書き込みが許可されていません" というエラーメッセージが表示されます。Write requests with the value of this header set to false (or if the header is absent) will fail with 403 Response Status code with error message "Writes are not allowed in the region".

参照See also