Skip to content

Commit

Permalink
[Internal] CosmosClient: Add a remarks section to AllowBulkExecution (#…
Browse files Browse the repository at this point in the history
…3987)

## Description

Add a remarks section to AllowBulkExecution explaining that it is not
recommended to be used with Resource Token authentication

## Type of change

Documentation fix

Fixes #1783
Closes #1783

---------

Co-authored-by: iain holmes <iaholmes@microsoft.com>
Co-authored-by: Ruben Bartelink <ruben@bartelink.com>
Co-authored-by: Kiran Kumar Kolli <kirankk@microsoft.com>
  • Loading branch information
4 people authored Oct 6, 2024
1 parent 0481ed5 commit 4df5455
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions Microsoft.Azure.Cosmos/src/CosmosClientOptions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -643,6 +643,9 @@ public CosmosSerializer Serializer

/// <summary>
/// Allows optimistic batching of requests to service. Setting this option might impact the latency of the operations. Hence this option is recommended for non-latency sensitive scenarios only.
/// <remarks>
/// The use of Resource Tokens scoped to a Partition Key as an authentication mechanism when Bulk is enabled is not recommended as it reduces the potential throughput benefit
/// </remarks>
/// </summary>
public bool AllowBulkExecution { get; set; }

Expand Down

0 comments on commit 4df5455

Please sign in to comment.