Document Document Document Class

Definition

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
Implements

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() Document() Document()

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

Properties

AltLink AltLink AltLink

Gets the alt-link associated with the resource from the Azure Cosmos DB service.

(Inherited from Resource)
AttachmentsLink AttachmentsLink AttachmentsLink

Gets the self-link corresponding to attachments of the document from the Azure Cosmos DB service.

ETag ETag ETag

Gets the entity tag associated with the resource from the Azure Cosmos DB service.

(Inherited from Resource)
Id Id Id

Gets or sets the Id of the resource in the Azure Cosmos DB service.

(Inherited from Resource)
ResourceId ResourceId ResourceId

Gets or sets the Resource Id associated with the resource in the Azure Cosmos DB service.

(Inherited from Resource)
SelfLink SelfLink SelfLink

Gets the self-link associated with the resource from the Azure Cosmos DB service.

(Inherited from Resource)
Timestamp Timestamp Timestamp

Gets the last modified timestamp associated with the resource from the Azure Cosmos DB service.

(Inherited from Resource)
TimeToLive TimeToLive TimeToLive

Gets or sets the time to live in seconds of the document in the Azure Cosmos DB service.

Explicit Interface Implementations

IDynamicMetaObjectProvider.GetMetaObject(Expression) IDynamicMetaObjectProvider.GetMetaObject(Expression) IDynamicMetaObjectProvider.GetMetaObject(Expression)

Methods

GetPropertyValue<T>(String) GetPropertyValue<T>(String) GetPropertyValue<T>(String)

Gets property value associated with the specified property name from the Azure Cosmos DB service.

(Inherited from Resource)
LoadFrom(JsonReader) LoadFrom(JsonReader) LoadFrom(JsonReader)

Loads the object from the specified JSON reader in the Azure Cosmos DB service.

(Inherited from JsonSerializable)
LoadFrom(JsonReader, JsonSerializerSettings) LoadFrom(JsonReader, JsonSerializerSettings) LoadFrom(JsonReader, JsonSerializerSettings)

Loads the object from the specified JSON reader in the Azure Cosmos DB service.

(Inherited from JsonSerializable)
SaveTo(Stream, SerializationFormattingPolicy) SaveTo(Stream, SerializationFormattingPolicy) SaveTo(Stream, SerializationFormattingPolicy)

Saves the object to the specified stream in the Azure Cosmos DB service.

(Inherited from JsonSerializable)
SaveTo(Stream, SerializationFormattingPolicy, JsonSerializerSettings) SaveTo(Stream, SerializationFormattingPolicy, JsonSerializerSettings) SaveTo(Stream, SerializationFormattingPolicy, JsonSerializerSettings)

Saves the object to the specified stream in the Azure Cosmos DB service.

(Inherited from JsonSerializable)
SetPropertyValue(String, Object) SetPropertyValue(String, Object) SetPropertyValue(String, Object)

Sets property value associated with the specified property name in the Azure Cosmos DB service.

(Inherited from Resource)
ToByteArray() ToByteArray() ToByteArray()

Serialize to a byte array via SaveTo for the Azure Cosmos DB service.

(Inherited from Resource)
ToString() ToString() ToString()

Returns the string representation of the object in the Azure Cosmos DB service.

(Inherited from JsonSerializable)

Extension Methods

IsDefined(Object) IsDefined(Object) IsDefined(Object)

Determines if a certain property is defined or not.

IsNull(Object) IsNull(Object) IsNull(Object)

Determines if a certain property is null or not.

IsPrimitive(Object) IsPrimitive(Object) IsPrimitive(Object)

Determines if a certain property is of premitive JSON type.

Applies to