[Internal] CosmosClient: Add a remarks section to AllowBulkExecution #3987
Conversation
Add a remarks section to AllowBulkExecution explaining that it is not recommended to be used with Resource Token authentication Fixes #1783
iainx
requested review from
kirankumarkolli,
ealsur,
FabianMeiswinkel,
kirillg and
sboshra
as code owners
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Please follow the required format: "[Internal] Category: (Adds|Fixes|Refactors|Removes) Description"
Internal should be used for PRs that have no customer impact. This flag is used to help generate the changelog to know which PRs should be included. Examples:
Diagnostics: Adds GetElapsedClientLatency to CosmosDiagnostics
PartitionKey: Fixes null reference when using default(PartitionKey)
[v4] Client Encryption: Refactors code to external project
[Internal] Query: Adds code generator for CosmosNumbers for easy additions in the future.
iainx
changed the title
iainx
changed the title
Co-authored-by: Ruben Bartelink <ruben@bartelink.com>
| @@ -557,6 +557,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 | |||
There was a problem hiding this comment.
The use of Resource Tokens scoped to a Partition Key as an authentication mechanism is not recommended, as it reduces the potential throughput benefit. you can rephrase it something like this.
There was a problem hiding this comment.
But is it only not recommended when Bulk is enabled?
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