Skip to content

Commit c2c3438

Browse files
committed
updated docs
1 parent b14143e commit c2c3438

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

Microsoft.Azure.Cosmos/src/CosmosClient.cs

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,9 @@ protected CosmosClient()
184184
/// </example>
185185
/// <remarks>
186186
/// The returned reference doesn't guarantee credentials or connectivity validations because creation doesn't make any network calls.
187-
/// With emulator to ignore SSL Certificate please use connectionstring with "DisableServerCertificateValidation" flag. It cannot be used along with custom HttpClientFactory and NOT recommended to use this flag in production.
187+
/// With emulator to ignore SSL Certificate please use connectionstring with "DisableServerCertificateValidation" flag.
188+
/// This flag will be overrided for HTTP calls if custom HttpClientFactory is used.
189+
/// It is NOT recommended to use this flag in production.
188190
/// </remarks>
189191
/// <seealso cref="CosmosClientOptions"/>
190192
/// <seealso cref="Fluent.CosmosClientBuilder"/>
@@ -474,7 +476,7 @@ public static async Task<CosmosClient> CreateAndInitializeAsync(string accountEn
474476
/// of the application which enables efficient connection management and performance. Please refer to the
475477
/// <see href="https://learn.microsoft.com/azure/cosmos-db/nosql/performance-tips-dotnet-sdk-v3">performance guide</see>.
476478
/// </summary>
477-
/// <param name="connectionString">The connection string to the cosmos account. ex: AccountEndpoint=https://XXXXX.documents.azure.com:443/;AccountKey=SuperSecretKey;</param>
479+
/// <param name="connectionString">The connection string to the cosmos account. ex: AccountEndpoint=https://XXXXX.documents.azure.com:443/;AccountKey=SuperSecretKey; </param>
478480
/// <param name="containers">Containers to be initialized identified by it's database name and container name.</param>
479481
/// <param name="cosmosClientOptions">(Optional) client options</param>
480482
/// <param name="cancellationToken">(Optional) Cancellation Token</param>
@@ -497,7 +499,9 @@ public static async Task<CosmosClient> CreateAndInitializeAsync(string accountEn
497499
/// </code>
498500
/// </example>
499501
/// <remarks>
500-
/// With emulator to ignore SSL Certificate please use connectionstring with "DisableServerCertificateValidation" flag. It cannot be used along with custom HttpClientFactory and NOT recommended to use this flag in production.
502+
/// With emulator to ignore SSL Certificate please use connectionstring with "DisableServerCertificateValidation" flag.
503+
/// This flag will be overrided for HTTP calls if custom HttpClientFactory is used.
504+
/// It is NOT recommended to use this flag in production.
501505
/// </remarks>
502506
public static async Task<CosmosClient> CreateAndInitializeAsync(string connectionString,
503507
IReadOnlyList<(string databaseId, string containerId)> containers,

Microsoft.Azure.Cosmos/src/Fluent/CosmosClientBuilder.cs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,10 @@ public CosmosClientBuilder(
124124
/// </summary>
125125
/// <example>"AccountEndpoint=https://mytestcosmosaccount.documents.azure.com:443/;AccountKey={SecretAccountKey};"</example>
126126
/// <param name="connectionString">The connection string must contain AccountEndpoint and AccountKey or ResourceToken.</param>
127-
/// <remarks>With emulator to ignore SSL Certificate please use connectionstring with "DisableServerCertificateValidation" flag. It cannot be used along with custom HttpClientFactory and NOT recommended to use this flag in production.</remarks>
127+
/// <remarks>With emulator to ignore SSL Certificate please use connectionstring with "DisableServerCertificateValidation" flag.
128+
/// This flag will be overrided for HTTP calls if custom HttpClientFactory is used.
129+
/// It is NOT recommended to use this flag in production.
130+
/// </remarks>
128131
public CosmosClientBuilder(string connectionString)
129132
{
130133
if (connectionString == null)

0 commit comments

Comments
 (0)