Document Class

Reference

Definition

Namespace:: Microsoft.Azure.Documents

Assemblies:: Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

Packages:: Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents a document in the Azure Cosmos DB service.

public class Document : Microsoft.Azure.Documents.Resource, System.Dynamic.IDynamicMetaObjectProvider

type Document = class
    inherit Resource
    interface IDynamicMetaObjectProvider

Public Class Document
Inherits Resource
Implements IDynamicMetaObjectProvider

Inheritance: Object

JsonSerializable

Resource
Document

Implements: IDynamicMetaObjectProvider

Remarks

A document is a structured JSON document. There is no set schema for the JSON documents, and a document may contain any number of custom properties as well as an optional list of attachments. Document is an application resource and can be authorized using the master key or resource keys.

Constructors

Document()

Initializes a new instance of the Document class for the Azure Cosmos DB service.

Properties

AltLink	Gets the alt-link associated with the resource from the Azure Cosmos DB service. (Inherited from Resource)
AttachmentsLink	Gets the self-link corresponding to attachments of the document from the Azure Cosmos DB service.
ETag	Gets the entity tag associated with the resource from the Azure Cosmos DB service. (Inherited from Resource)
Id	Gets or sets the Id of the resource in the Azure Cosmos DB service. (Inherited from Resource)
ResourceId	Gets or sets the Resource Id associated with the resource in the Azure Cosmos DB service. (Inherited from Resource)
SelfLink	Gets the self-link associated with the resource from the Azure Cosmos DB service. (Inherited from Resource)
Timestamp	Gets the last modified timestamp associated with the resource from the Azure Cosmos DB service. (Inherited from Resource)
TimeToLive	Gets or sets the time to live in seconds of the document in the Azure Cosmos DB service.

Methods

GetPropertyValue<T>(String)	Gets property value associated with the specified property name from the Azure Cosmos DB service. (Inherited from Resource)
LoadFrom(JsonReader)	Loads the object from the specified JSON reader in the Azure Cosmos DB service. (Inherited from JsonSerializable)
LoadFrom(JsonReader, JsonSerializerSettings)	Loads the object from the specified JSON reader in the Azure Cosmos DB service. (Inherited from JsonSerializable)
SaveTo(Stream, SerializationFormattingPolicy)	Saves the object to the specified stream in the Azure Cosmos DB service. (Inherited from JsonSerializable)
SaveTo(Stream, SerializationFormattingPolicy, JsonSerializerSettings)	Saves the object to the specified stream in the Azure Cosmos DB service. (Inherited from JsonSerializable)
SetPropertyValue(String, Object)	Sets property value associated with the specified property name in the Azure Cosmos DB service. (Inherited from Resource)
ToByteArray()	Serialize to a byte array via SaveTo for the Azure Cosmos DB service. (Inherited from Resource)
ToString()	Returns the string representation of the object in the Azure Cosmos DB service. (Inherited from JsonSerializable)

Explicit Interface Implementations

IDynamicMetaObjectProvider.GetMetaObject(Expression)

Applies to