Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sourabh1007 committed Jan 22, 2024
1 parent b14143e commit c2c3438
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 4 deletions.
10 changes: 7 additions & 3 deletions Microsoft.Azure.Cosmos/src/CosmosClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,9 @@ protected CosmosClient()
/// </example>
/// <remarks>
/// The returned reference doesn't guarantee credentials or connectivity validations because creation doesn't make any network calls.
/// 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.
/// With emulator to ignore SSL Certificate please use connectionstring with "DisableServerCertificateValidation" flag.
/// This flag will be overrided for HTTP calls if custom HttpClientFactory is used.
/// It is NOT recommended to use this flag in production.
/// </remarks>
/// <seealso cref="CosmosClientOptions"/>
/// <seealso cref="Fluent.CosmosClientBuilder"/>
Expand Down Expand Up @@ -474,7 +476,7 @@ public static async Task<CosmosClient> CreateAndInitializeAsync(string accountEn
/// of the application which enables efficient connection management and performance. Please refer to the
/// <see href="https://learn.microsoft.com/azure/cosmos-db/nosql/performance-tips-dotnet-sdk-v3">performance guide</see>.
/// </summary>
/// <param name="connectionString">The connection string to the cosmos account. ex: AccountEndpoint=https://XXXXX.documents.azure.com:443/;AccountKey=SuperSecretKey;</param>
/// <param name="connectionString">The connection string to the cosmos account. ex: AccountEndpoint=https://XXXXX.documents.azure.com:443/;AccountKey=SuperSecretKey; </param>
/// <param name="containers">Containers to be initialized identified by it's database name and container name.</param>
/// <param name="cosmosClientOptions">(Optional) client options</param>
/// <param name="cancellationToken">(Optional) Cancellation Token</param>
Expand All @@ -497,7 +499,9 @@ public static async Task<CosmosClient> CreateAndInitializeAsync(string accountEn
/// </code>
/// </example>
/// <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.
/// With emulator to ignore SSL Certificate please use connectionstring with "DisableServerCertificateValidation" flag.
/// This flag will be overrided for HTTP calls if custom HttpClientFactory is used.
/// It is NOT recommended to use this flag in production.
/// </remarks>
public static async Task<CosmosClient> CreateAndInitializeAsync(string connectionString,
IReadOnlyList<(string databaseId, string containerId)> containers,
Expand Down
5 changes: 4 additions & 1 deletion Microsoft.Azure.Cosmos/src/Fluent/CosmosClientBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,10 @@ public CosmosClientBuilder(
/// </summary>
/// <example>"AccountEndpoint=https://mytestcosmosaccount.documents.azure.com:443/;AccountKey={SecretAccountKey};"</example>
/// <param name="connectionString">The connection string must contain AccountEndpoint and AccountKey or ResourceToken.</param>
/// <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>
/// <remarks>With emulator to ignore SSL Certificate please use connectionstring with "DisableServerCertificateValidation" flag.
/// This flag will be overrided for HTTP calls if custom HttpClientFactory is used.
/// It is NOT recommended to use this flag in production.
/// </remarks>
public CosmosClientBuilder(string connectionString)
{
if (connectionString == null)
Expand Down

0 comments on commit c2c3438

Please sign in to comment.