Class ThroughputProperties

Namespace

Microsoft.Azure.Cosmos

Assembly

Microsoft.Azure.Cosmos.Client.dll

Represents a throughput of the resources in the Azure Cosmos DB service. It is the standard pricing for the resource in the Azure Cosmos DB service.

public class ThroughputProperties

Inheritance

object

ThroughputProperties

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

CosmosLinqExtensions.DocumentId(object)

CosmosLinqExtensions.IsArray(object)

CosmosLinqExtensions.IsBool(object)

CosmosLinqExtensions.IsDefined(object)

CosmosLinqExtensions.IsNull(object)

CosmosLinqExtensions.IsNumber(object)

CosmosLinqExtensions.IsObject(object)

CosmosLinqExtensions.IsPrimitive(object)

CosmosLinqExtensions.IsString(object)

CosmosLinqExtensions.RegexMatch(object, string, string)

CosmosLinqExtensions.RegexMatch(object, string)

Examples

The example below fetch the ThroughputProperties on testContainer.

ThroughputProperties throughputProperties = await testContainer.ReadThroughputAsync().Resource;

Remarks

It contains provisioned container throughput in measurement of request units per second in the Azure Cosmos service.

Properties

AutoscaleMaxThroughput

The maximum throughput the autoscale will scale to.

public int? AutoscaleMaxThroughput { get; }

Property Value

int?

See Also

Request Units

Set throughput on resources

ETag

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

public string ETag { get; }

Property Value

string

The entity tag associated with the resource.

Remarks

ETags are used for concurrency checking when updating resources.

See Also

Request Units

Set throughput on resources

LastModified

Gets the last modified time stamp associated with DatabaseProperties from the Azure Cosmos DB service.

public DateTime? LastModified { get; }

Property Value

DateTime?

The last modified time stamp associated with the resource.

See Also

Request Units

Set throughput on resources

SelfLink

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

public string SelfLink { get; }

Property Value

string

The self-link associated with the resource.

Remarks

A self-link is a static addressable Uri for each resource within a database account and follows the Azure Cosmos DB resource model. E.g. a self-link for a document could be dbs/db_resourceid/colls/coll_resourceid/documents/doc_resourceid

See Also

Request Units

Set throughput on resources

Throughput

Gets the provisioned throughput for a resource in measurement of request units per second in the Azure Cosmos service.

public int? Throughput { get; }

Property Value

int?

See Also

Request Units

Set throughput on resources

Methods

CreateAutoscaleThroughput(int)

The Throughput properties for autoscale provisioned throughput offering

public static ThroughputProperties CreateAutoscaleThroughput(int autoscaleMaxThroughput)

Parameters

autoscaleMaxThroughput int

The maximum throughput the resource can scale to.

Returns

ThroughputProperties

Returns a ThroughputProperties for autoscale provisioned throughput

See Also

Request Units

Set throughput on resources

CreateManualThroughput(int)

The Throughput properties for manual provisioned throughput offering

public static ThroughputProperties CreateManualThroughput(int throughput)

Parameters

throughput int

The current provisioned throughput for the resource.

Returns

ThroughputProperties

Returns a ThroughputProperties for manual throughput

See Also

Request Units

Set throughput on resources

See Also

Request Units

Set throughput on resources