Class AccessCondition

Namespace

Microsoft.Azure.Documents.Client

Assembly

Microsoft.Azure.Documents.Client.dll

Represents a set of access conditions to be used for operations in the Azure Cosmos DB service.

public sealed class AccessCondition

Inheritance

object

AccessCondition

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

TypeCheckFunctionsExtensions.IsArray(object)

TypeCheckFunctionsExtensions.IsBool(object)

TypeCheckFunctionsExtensions.IsDefined(object)

TypeCheckFunctionsExtensions.IsNull(object)

TypeCheckFunctionsExtensions.IsNumber(object)

TypeCheckFunctionsExtensions.IsObject(object)

TypeCheckFunctionsExtensions.IsPrimitive(object)

TypeCheckFunctionsExtensions.IsString(object)

Examples

The following example shows how to use AccessCondition with DocumentClient.

// If ETag is current, then this will succeed. Otherwise the request will fail with HTTP 412 Precondition Failure
await client.ReplaceDocumentAsync(
    readCopyOfBook.SelfLink, 
    new Book { Title = "Moby Dick", Price = 14.99 },
    new RequestOptions 
    { 
        AccessCondition = new AccessCondition 
        { 
            Condition = readCopyOfBook.ETag, 
            Type = AccessConditionType.IfMatch 
        } 
     });

Constructors

AccessCondition()

public AccessCondition()

Properties

Condition

Gets or sets the value of the condition in the Azure Cosmos DB service.

public string Condition { get; set; }

Property Value

string

The value of the condition. For AccessConditionType IfMatch and IfNotMatch, this is the ETag that has to be compared to.

See Also

Resource

Type

Gets or sets the condition type in the Azure Cosmos DB service.

public AccessConditionType Type { get; set; }

Property Value

AccessConditionType

The condition type. Can be IfMatch or IfNoneMatch.

See Also

AccessConditionType

RequestOptions

Resource