Table of Contents

Class ResourceResponse<TResource>

Namespace
Microsoft.Azure.Documents.Client
Assembly
Microsoft.Azure.Documents.Client.dll

Represents the template class used by methods returning single objects in the Azure Cosmos DB service.

public class ResourceResponse<TResource> : ResourceResponseBase, IResourceResponse<TResource>, IResourceResponseBase where TResource : Resource, new()

Type Parameters

TResource

the resource type.

Inheritance
ResourceResponse<TResource>
Implements
Inherited Members
Extension Methods

Examples

The following example extracts the request units consumed, activity ID and StatusCode from a CreateDocumentAsync call.

ResourceResponse<Document> response = await client.CreateDocumentAsync(collectionLink, document);
Console.WriteLine(response.RequestCharge);
Console.WriteLine(response.ActivityId); 
Console.WriteLine(response.StatusCode); // HttpStatusCode.Created or 201

Remarks

All responses from creates, reads, updates and deletes of Azure Cosmos DB resources return the response wrapped in a ResourceResponse object. This contains the metadata from the response headers from the Azure Cosmos DB call including the request units (RequestCharge), activity ID and quotas/usage of resources.

Constructors

ResourceResponse()

Constructor exposed for mocking purposes for the Azure Cosmos DB service.

public ResourceResponse()

ResourceResponse(TResource)

Constructor exposed for mocking purposes for the Azure Cosmos DB service.

public ResourceResponse(TResource resource)

Parameters

resource TResource

Properties

Resource

Gets the resource returned in the response from the Azure Cosmos DB service.

public TResource Resource { get; }

Property Value

TResource

The resource returned in the response.

Operators

implicit operator TResource(ResourceResponse<TResource>)

Returns the resource in the response implicitly from the Azure Cosmos DB service.

public static implicit operator TResource(ResourceResponse<TResource> source)

Parameters

source ResourceResponse<TResource>

The ResourceResponse source.

Returns

TResource

The resource object.

See Also