RequestOptions.SharedOfferThroughput Property

Definition

Namespace:: Microsoft.Azure.Documents.Client

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

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

Gets or sets shared offer throughput on a collection.

public int? SharedOfferThroughput { get; set; }

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

Public Property SharedOfferThroughput As Nullable(Of Integer)

Property Value

Nullable<Int32>

Examples

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

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

Remarks

This option is only valid when creating a document collection that shares offer throughput

provisioned at database level. Specifies maximum shared throughput available for collection

in the absence of contention. This value should be less than the throughput specified at

database level.

Applies to