Table of Contents

Class DocumentClientException

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

The base class for client exceptions in the Azure Cosmos DB service.

public class DocumentClientException : Exception, ISerializable
Inheritance
DocumentClientException
Implements
Derived
Inherited Members
Extension Methods

Properties

ActivityId

Gets the activity ID associated with the request from the Azure Cosmos DB service.

public string ActivityId { get; }

Property Value

string

Error

Gets the error code associated with the exception in the Azure Cosmos DB service.

public Error Error { get; }

Property Value

Error

Message

Gets a message that describes the current exception from the Azure Cosmos DB service.

public override string Message { get; }

Property Value

string

RequestCharge

Cost of the request in the Azure Cosmos DB service.

public double RequestCharge { get; }

Property Value

double

ResponseHeaders

Gets the headers associated with the response from the Azure Cosmos DB service.

public NameValueCollection ResponseHeaders { get; }

Property Value

NameValueCollection

RetryAfter

Gets the recommended time interval after which the client can retry failed requests from the Azure Cosmos DB service

public TimeSpan RetryAfter { get; }

Property Value

TimeSpan

ScriptLog

Gets the console.log output from server side scripts statements when script logging is enabled.

public string ScriptLog { get; }

Property Value

string

StatusCode

Gets or sets the request status code in the Azure Cosmos DB service.

public HttpStatusCode? StatusCode { get; }

Property Value

HttpStatusCode?