RequestOptions.OfferEnableRUPerMinuteThroughput 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 OfferEnableRUPerMinuteThroughput for a collection in the Azure Cosmos DB service

public bool OfferEnableRUPerMinuteThroughput { get; set; }

member this.OfferEnableRUPerMinuteThroughput : bool with get, set

Public Property OfferEnableRUPerMinuteThroughput As Boolean

Property Value

Boolean

Represents Request Units(RU)/Minute throughput is enabled/disabled for a collection in the Azure Cosmos DB service.

Examples

The followng example shows how to create a collection with RU/Minute throughput offer.

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

Remarks

This option is only valid when creating a document collection.

Applies to

Share via