RequestOptions.OfferThroughput Property

Reference

Definition

Namespace:: Microsoft.Azure.Documents.Client

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.

Gets or sets the offer throughput provisioned for a collection in measurement of Requests-per-Unit in the Azure Cosmos DB service.

public int? OfferThroughput { get; set; }

member this.OfferThroughput : Nullable<int> with get, set

Public Property OfferThroughput As Nullable(Of Integer)

Property Value

Nullable<Int32>

The provisioned throughtput for this offer.

Examples

The followng example shows how to create a collection with offer throughtput.

await client.CreateDocumentCollectionAsync(
    database.SelfLink,
    new DocumentCollection { Id = "newcoll" },
    new RequestOptions { OfferThroughput = 50000 });

Remarks

This option is only valid when creating a document collection.

Refer to http://azure.microsoft.com/documentation/articles/documentdb-performance-levels/ for details on provision offer throughput.

Applies to

Share via