DocumentResponse<TDocument> クラス

リファレンス

定義

名前空間:: Microsoft.Azure.Documents.Client

アセンブリ:: Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

パッケージ:: Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

Azure Cosmos DB サービスで 1 つのオブジェクトを返すメソッドで使用されるテンプレートクラスを表します。

public sealed class DocumentResponse<TDocument> : Microsoft.Azure.Documents.Client.ResourceResponseBase, Microsoft.Azure.Documents.Client.IDocumentResponse<TDocument>

type DocumentResponse<'Document> = class
    inherit ResourceResponseBase
    interface IDocumentResponse<'Document>
    interface IResourceResponseBase

Public NotInheritable Class DocumentResponse(Of TDocument)
Inherits ResourceResponseBase
Implements IDocumentResponse(Of TDocument)

型パラメーター

TDocument

ドキュメントの種類。

継承: Object

ResourceResponseBase
DocumentResponse<TDocument>

実装: IDocumentResponse<TDocument> IResourceResponseBase

例

次の例では、ReadDocumentAsync{Customer} 呼び出しから CustomerName プロパティ、使用された要求ユニット、アクティビティ ID、StatusCode を抽出します。

DocumentResponse<Customer> response = await client.ReadDocumentAsync<Customer>(documentLink);
Console.WriteLine(response.Document.CustomerName);
Console.WriteLine(response.RequestCharge);
Console.WriteLine(response.ActivityId); 
Console.WriteLine(response.StatusCode); // HttpStatusCode.Created or 201

注釈

Document リソースの型固有の読み取りからの応答 (ReadDocumentAsync{TDocument}) は、DocumentResponse オブジェクトでラップされた応答を返します。これには、要求ユニット (RequestCharge)、アクティビティ ID、リソースのクォータ/使用状況、型指定されたドキュメントオブジェクト (TDocument) など、Azure Cosmos DB 呼び出しからの応答ヘッダーからのメタデータが含まれます。

コンストラクター

DocumentResponse<TDocument>()	Azure Cosmos DB サービスのモック目的で公開されるコンストラクター。
DocumentResponse<TDocument>(TDocument)	Azure Cosmos DB サービスのモック目的で公開されるコンストラクター。

プロパティ

ActivityId	Azure Cosmos DB サービスからの要求のアクティビティ ID を取得します。 (継承元 ResourceResponseBase)
CollectionQuota	Azure Cosmos DB サービスから、アカウント内のコレクションリソースの最大クォータを取得します。 (継承元 ResourceResponseBase)
CollectionSizeQuota	Azure Cosmos DB サービスからコレクションの最大サイズをキロバイト単位で取得します。 (継承元 ResourceResponseBase)
CollectionSizeUsage	Azure Cosmos DB サービスからコレクションの現在のサイズをキロバイト単位で取得します。 (継承元 ResourceResponseBase)
CollectionUsage	Azure Cosmos DB サービスから、アカウント内のコレクションリソースの現在の数を取得します。 (継承元 ResourceResponseBase)
ContentLocation	コンテンツの親の場所 (Azure Cosmos DB サービスの dbs/foo/colls/bar など)。 (継承元 ResourceResponseBase)
CurrentResourceQuotaUsage	Azure Cosmos DB サービスからこのエンティティの現在のサイズを取得します。 (継承元 ResourceResponseBase)
DatabaseQuota	Azure Cosmos DB サービスから、アカウント内のデータベースリソースの最大クォータを取得します。 (継承元 ResourceResponseBase)
DatabaseUsage	Azure Cosmos DB サービスから、アカウント内のデータベースリソースの現在の数を取得します。 (継承元 ResourceResponseBase)
Document	Azure Cosmos DB サービスからの応答で返されるドキュメントを取得します。
DocumentQuota	Azure Cosmos DB サービスからコレクション内のドキュメントの最大サイズをキロバイト単位で取得します。 (継承元 ResourceResponseBase)
DocumentUsage	Azure Cosmos DB サービスからコレクション内のドキュメントの現在のサイズをキロバイト単位で取得します。 (継承元 ResourceResponseBase)
IndexTransformationProgress	インデックス変換の進行状況を取得します (Azure Cosmos DB サービスから進行中の場合)。 (継承元 ResourceResponseBase)
IsRUPerMinuteUsed	この要求が要求ユニット(RU)/分の容量から提供されるかどうかにかかわらず、Azure Cosmos DB サービスからの応答に関連付けられているフラグを取得します。 (継承元 ResourceResponseBase)
LazyIndexingProgress	Azure Cosmos DB サービスから遅延インデックス作成の進行状況を取得します。 (継承元 ResourceResponseBase)
MaxResourceQuota	Azure Cosmos DB サービスからこのエンティティの最大サイズ制限を取得します。 (継承元 ResourceResponseBase)
PermissionQuota	Azure Cosmos DB サービスから、アカウント内のアクセス許可リソースの最大クォータを取得します。 (継承元 ResourceResponseBase)
PermissionUsage	Azure Cosmos DB サービスから、アカウント内のアクセス許可リソースの現在の数を取得します。 (継承元 ResourceResponseBase)
RequestCharge	Azure Cosmos DB サービスからこの要求の要求料金を取得します。 (継承元 ResourceResponseBase)
RequestDiagnosticsString	Azure Cosmos DB サービスに対する現在の要求の診断情報を取得します。 (継承元 ResourceResponseBase)
RequestLatency	Azure Cosmos DB サービスに対する現在の要求のエンドツーエンドの要求待機時間を取得します。 (継承元 ResourceResponseBase)
ResponseHeaders	Azure Cosmos DB サービスから応答ヘッダーを取得します。 (継承元 ResourceResponseBase)
ResponseStream	Azure Cosmos DB サービスからの応答の基になるストリームを取得します。 (継承元 ResourceResponseBase)
SessionToken	Azure Cosmos DB サービスからの sesssion 整合性読み取りで使用するセッショントークンを取得します。 (継承元 ResourceResponseBase)
StatusCode	Azure Cosmos DB サービスからの応答に関連付けられている HTTP 状態コードを取得します。 (継承元 ResourceResponseBase)
StoredProceduresQuota	Azure Cosmos DB サービスからコレクションのストアドプロシージャの最大クォータを取得します。 (継承元 ResourceResponseBase)
StoredProceduresUsage	Azure Cosmos DB サービスからコレクションの現在の数のストアドプロシージャを取得します。 (継承元 ResourceResponseBase)
TriggersQuota	Azure Cosmos DB サービスからコレクションのトリガーの最大クォータを取得します。 (継承元 ResourceResponseBase)
TriggersUsage	Azure Cosmos DB サービスからコレクションの現在のトリガー数を取得します。 (継承元 ResourceResponseBase)
UserDefinedFunctionsQuota	Azure Cosmos DB サービスからコレクションのユーザー定義関数の最大クォータを取得します。 (継承元 ResourceResponseBase)
UserDefinedFunctionsUsage	Azure Cosmos DB サービスからコレクションの現在の数のユーザー定義関数を取得します。 (継承元 ResourceResponseBase)
UserQuota	Azure Cosmos DB サービスから、アカウント内のユーザーリソースの最大クォータを取得します。 (継承元 ResourceResponseBase)
UserUsage	Azure Cosmos DB サービスから、アカウント内のユーザーリソースの現在の数を取得します。 (継承元 ResourceResponseBase)

演算子

Implicit(DocumentResponse<TDocument> to TDocument)

Azure Cosmos DB サービスから暗黙的に応答でドキュメントを返します。

適用対象

次の方法で共有

DocumentResponse<TDocument> クラス

定義

型パラメーター

例

注釈

コンストラクター

プロパティ

演算子

適用対象

その他のリソース