你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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

表示在 Azure Cosmos DB 服务中返回单个对象的方法使用的模板类。

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 对象中包装的响应。 这包含来自 Azure Cosmos DB 调用的响应标头的元数据，包括请求单位 (RequestCharge) 、活动 ID、配额/资源使用情况，以及类型化文档对象 (TDocument) 。

构造函数

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 服务获取集合的最大大小（以 KB 为单位）。 (继承自 ResourceResponseBase)
CollectionSizeUsage	从 Azure Cosmos DB 服务获取集合的当前大小（以 KB 为单位）。 (继承自 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 服务获取集合中文档的当前大小（以 KB 为单位）。 (继承自 ResourceResponseBase)
IndexTransformationProgress	获取索引转换的进度（如果正在从 Azure Cosmos DB 服务进行）。 (继承自 ResourceResponseBase)
IsRUPerMinuteUsed	获取与 Azure Cosmos DB 服务响应关联的标志，无论此请求是否来自请求单位 (RU) /分钟容量。 (继承自 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 服务隐式返回响应中的文档。