RequestOptions.SharedOfferThroughput 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.

Caution

Deprecated

Gets or sets shared offer throughput on a collection.

[System.Obsolete("Deprecated")]
public int? SharedOfferThroughput { get; set; }

[<System.Obsolete("Deprecated")>]
member this.SharedOfferThroughput : Nullable<int> with get, set

Public Property SharedOfferThroughput As Nullable(Of Integer)

Property Value

Nullable<Int32>

Attributes: ObsoleteAttribute

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