Documentation: Fixes article links (replaced links V2 to V3 SDK version) + Azure Cosmos DB typo (#4031)

* Documentation link fix

* Fixed Typo "Azure CosmosDB"→"Azure Cosmos DB"
This commit is contained in:
Rinat Minibaev 2023-08-10 18:14:47 -07:00 коммит произвёл GitHub
Родитель efb90f0941
Коммит e708ec9025
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
7 изменённых файлов: 29 добавлений и 29 удалений

Просмотреть файл

@ -131,7 +131,7 @@ namespace Microsoft.Azure.Cosmos
/// Default value is <see cref="Cosmos.ConnectionMode.Gateway"/>
/// </value>
/// <remarks>
/// For more information, see <see href="https://docs.microsoft.com/en-us/azure/documentdb/documentdb-performance-tips#direct-connection">Connection policy: Use direct connection mode</see>.
/// For more information, see <see href="https://learn.microsoft.com/azure/cosmos-db/nosql/performance-tips-dotnet-sdk-v3#direct-connection">Connection policy: Use direct connection mode</see>.
/// </remarks>
public ConnectionMode ConnectionMode
{
@ -160,7 +160,7 @@ namespace Microsoft.Azure.Cosmos
/// <remarks>
/// This setting is not used when <see cref="ConnectionMode"/> is set to <see cref="Cosmos.ConnectionMode.Gateway"/>.
/// Gateway mode only supports HTTPS.
/// For more information, see <see href="https://docs.microsoft.com/en-us/azure/documentdb/documentdb-performance-tips#use-tcp">Connection policy: Use the TCP protocol</see>.
/// For more information, see <see href="https://learn.microsoft.com/azure/cosmos-db/nosql/performance-tips-dotnet-sdk-v3#networking">Connection policy: Use the HTTPS protocol</see>.
/// </remarks>
public Protocol ConnectionProtocol
{
@ -369,7 +369,7 @@ namespace Microsoft.Azure.Cosmos
/// set to 9 and <see cref="Cosmos.RetryOptions.MaxRetryWaitTimeInSeconds"/> set to 30 seconds.
/// </value>
/// <remarks>
/// For more information, see <see href="https://docs.microsoft.com/en-us/azure/documentdb/documentdb-performance-tips#429">Handle rate limiting/request rate too large</see>.
/// For more information, see <see href="https://learn.microsoft.com/azure/cosmos-db/nosql/performance-tips-dotnet-sdk-v3#429">Handle rate limiting/request rate too large</see>.
/// </remarks>
public RetryOptions RetryOptions
{

Просмотреть файл

@ -28,7 +28,7 @@ namespace Microsoft.Azure.Cosmos
///
/// CosmosClient is thread-safe. Its recommended to maintain a single instance of CosmosClient per lifetime
/// of the application which enables efficient connection management and performance. Please refer to the
/// <see href="https://docs.microsoft.com/azure/cosmos-db/performance-tips">performance guide</see>.
/// <see href="https://learn.microsoft.com/azure/cosmos-db/nosql/performance-tips-dotnet-sdk-v3">performance guide</see>.
/// </summary>
/// <example>
/// This example create a <see cref="CosmosClient"/>, <see cref="Database"/>, and a <see cref="Container"/>.
@ -97,7 +97,7 @@ namespace Microsoft.Azure.Cosmos
/// </remarks>
/// <seealso cref="CosmosClientOptions"/>
/// <seealso cref="Fluent.CosmosClientBuilder"/>
/// <seealso href="https://docs.microsoft.com/azure/cosmos-db/performance-tips">Performance Tips</seealso>
/// <seealso href="https://learn.microsoft.com/azure/cosmos-db/nosql/performance-tips-dotnet-sdk-v3">Performance Tips</seealso>
/// <seealso href="https://docs.microsoft.com/azure/cosmos-db/troubleshoot-dot-net-sdk">Diagnose and troubleshoot issues</seealso>
/// <seealso href="https://docs.microsoft.com/azure/cosmos-db/distribute-data-globally">Global data distribution</seealso>
/// <seealso href="https://docs.microsoft.com/azure/cosmos-db/partitioning-overview">Partitioning and horizontal scaling</seealso>
@ -160,7 +160,7 @@ namespace Microsoft.Azure.Cosmos
///
/// CosmosClient is thread-safe. Its recommended to maintain a single instance of CosmosClient per lifetime
/// of the application which enables efficient connection management and performance. Please refer to the
/// <see href="https://docs.microsoft.com/azure/cosmos-db/performance-tips">performance guide</see>.
/// <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="clientOptions">(Optional) client options</param>
@ -187,7 +187,7 @@ namespace Microsoft.Azure.Cosmos
/// </remarks>
/// <seealso cref="CosmosClientOptions"/>
/// <seealso cref="Fluent.CosmosClientBuilder"/>
/// <seealso href="https://docs.microsoft.com/azure/cosmos-db/performance-tips">Performance Tips</seealso>
/// <seealso href="https://learn.microsoft.com/azure/cosmos-db/nosql/performance-tips-dotnet-sdk-v3">Performance Tips</seealso>
/// <seealso href="https://docs.microsoft.com/azure/cosmos-db/troubleshoot-dot-net-sdk">Diagnose and troubleshoot issues</seealso>
public CosmosClient(
string connectionString,
@ -204,7 +204,7 @@ namespace Microsoft.Azure.Cosmos
///
/// CosmosClient is thread-safe. Its recommended to maintain a single instance of CosmosClient per lifetime
/// of the application which enables efficient connection management and performance. Please refer to the
/// <see href="https://docs.microsoft.com/azure/cosmos-db/performance-tips">performance guide</see>.
/// <see href="https://learn.microsoft.com/azure/cosmos-db/nosql/performance-tips-dotnet-sdk-v3">performance guide</see>.
/// </summary>
/// <param name="accountEndpoint">The cosmos service endpoint to use</param>
/// <param name="authKeyOrResourceToken">The cosmos account key or resource token to use to create the client.</param>
@ -232,7 +232,7 @@ namespace Microsoft.Azure.Cosmos
/// </remarks>
/// <seealso cref="CosmosClientOptions"/>
/// <seealso cref="Fluent.CosmosClientBuilder"/>
/// <seealso href="https://docs.microsoft.com/azure/cosmos-db/performance-tips">Performance Tips</seealso>
/// <seealso href="https://learn.microsoft.com/azure/cosmos-db/nosql/performance-tips-dotnet-sdk-v3">Performance Tips</seealso>
/// <seealso href="https://docs.microsoft.com/azure/cosmos-db/troubleshoot-dot-net-sdk">Diagnose and troubleshoot issues</seealso>
public CosmosClient(
string accountEndpoint,
@ -250,7 +250,7 @@ namespace Microsoft.Azure.Cosmos
///
/// CosmosClient is thread-safe. Its recommended to maintain a single instance of CosmosClient per lifetime
/// of the application which enables efficient connection management and performance. Please refer to the
/// <see href="https://docs.microsoft.com/azure/cosmos-db/performance-tips">performance guide</see>.
/// <see href="https://learn.microsoft.com/azure/cosmos-db/nosql/performance-tips-dotnet-sdk-v3">performance guide</see>.
/// </summary>
/// <param name="accountEndpoint">The cosmos service endpoint to use</param>
/// <param name="authKeyOrResourceTokenCredential">AzureKeyCredential with master-key or resource token..</param>
@ -281,7 +281,7 @@ namespace Microsoft.Azure.Cosmos
/// </example>
/// <seealso cref="CosmosClientOptions"/>
/// <seealso cref="Fluent.CosmosClientBuilder"/>
/// <seealso href="https://docs.microsoft.com/azure/cosmos-db/performance-tips">Performance Tips</seealso>
/// <seealso href="https://learn.microsoft.com/azure/cosmos-db/nosql/performance-tips-dotnet-sdk-v3">Performance Tips</seealso>
/// <seealso href="https://docs.microsoft.com/azure/cosmos-db/troubleshoot-dot-net-sdk">Diagnose and troubleshoot issues</seealso>
/// <remarks>
/// AzureKeyCredential enables changing/updating master-key/ResourceToken whle CosmosClient is still in use.
@ -302,7 +302,7 @@ namespace Microsoft.Azure.Cosmos
///
/// CosmosClient is thread-safe. Its recommended to maintain a single instance of CosmosClient per lifetime
/// of the application which enables efficient connection management and performance. Please refer to the
/// <see href="https://docs.microsoft.com/azure/cosmos-db/performance-tips">performance guide</see>.
/// <see href="https://learn.microsoft.com/azure/cosmos-db/nosql/performance-tips-dotnet-sdk-v3">performance guide</see>.
/// </summary>
/// <remarks>
/// The returned reference doesn't guarantee credentials or connectivity validations because creation doesn't make any network calls.
@ -357,7 +357,7 @@ namespace Microsoft.Azure.Cosmos
/// connections before the first call to the service is made. Use this to obtain lower latency while startup of your application.
/// CosmosClient is thread-safe. Its recommended to maintain a single instance of CosmosClient per lifetime
/// of the application which enables efficient connection management and performance. Please refer to the
/// <see href="https://docs.microsoft.com/azure/cosmos-db/performance-tips">performance guide</see>.
/// <see href="https://learn.microsoft.com/azure/cosmos-db/nosql/performance-tips-dotnet-sdk-v3">performance guide</see>.
/// </summary>
/// <param name="accountEndpoint">The cosmos service endpoint to use</param>
/// <param name="authKeyOrResourceToken">The cosmos account key or resource token to use to create the client.</param>
@ -413,7 +413,7 @@ namespace Microsoft.Azure.Cosmos
/// connections before the first call to the service is made. Use this to obtain lower latency while startup of your application.
/// CosmosClient is thread-safe. Its recommended to maintain a single instance of CosmosClient per lifetime
/// of the application which enables efficient connection management and performance. Please refer to the
/// <see href="https://docs.microsoft.com/azure/cosmos-db/performance-tips">performance guide</see>.
/// <see href="https://learn.microsoft.com/azure/cosmos-db/nosql/performance-tips-dotnet-sdk-v3">performance guide</see>.
/// </summary>
/// <param name="accountEndpoint">The cosmos service endpoint to use</param>
/// <param name="authKeyOrResourceTokenCredential">AzureKeyCredential with master-key or resource token.</param>
@ -471,7 +471,7 @@ namespace Microsoft.Azure.Cosmos
/// connections before the first call to the service is made. Use this to obtain lower latency while startup of your application.
/// CosmosClient is thread-safe. Its recommended to maintain a single instance of CosmosClient per lifetime
/// of the application which enables efficient connection management and performance. Please refer to the
/// <see href="https://docs.microsoft.com/azure/cosmos-db/performance-tips">performance guide</see>.
/// <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="containers">Containers to be initialized identified by it's database name and container name.</param>
@ -518,7 +518,7 @@ namespace Microsoft.Azure.Cosmos
/// connections before the first call to the service is made. Use this to obtain lower latency while startup of your application.
/// CosmosClient is thread-safe. Its recommended to maintain a single instance of CosmosClient per lifetime
/// of the application which enables efficient connection management and performance. Please refer to the
/// <see href="https://docs.microsoft.com/azure/cosmos-db/performance-tips">performance guide</see>.
/// <see href="https://learn.microsoft.com/azure/cosmos-db/nosql/performance-tips-dotnet-sdk-v3">performance guide</see>.
/// </summary>
/// <param name="accountEndpoint">The cosmos service endpoint to use.</param>
/// <param name="tokenCredential"><see cref="TokenCredential"/>The token to provide AAD token for authorization.</param>

Просмотреть файл

@ -250,7 +250,7 @@ namespace Microsoft.Azure.Cosmos
/// Default value is <see cref="Cosmos.ConnectionMode.Direct"/>
/// </value>
/// <remarks>
/// For more information, see <see href="https://docs.microsoft.com/azure/documentdb/documentdb-performance-tips#direct-connection">Connection policy: Use direct connection mode</see>.
/// For more information, see <see href="https://learn.microsoft.com/azure/cosmos-db/nosql/performance-tips-dotnet-sdk-v3#direct-connection">Connection policy: Use direct connection mode</see>.
/// </remarks>
/// <seealso cref="CosmosClientBuilder.WithConnectionModeDirect()"/>
/// <seealso cref="CosmosClientBuilder.WithConnectionModeGateway(int?, IWebProxy)"/>
@ -614,7 +614,7 @@ namespace Microsoft.Azure.Cosmos
/// Quorum Read allowed with eventual consistency account or consistent prefix account.
/// </summary>
internal bool EnableUpgradeConsistencyToLocalQuorum { get; set; } = false;
/// <summary>
/// Gets or sets the connection protocol when connecting to the Azure Cosmos service.
/// </summary>
@ -624,7 +624,7 @@ namespace Microsoft.Azure.Cosmos
/// <remarks>
/// This setting is not used when <see cref="ConnectionMode"/> is set to <see cref="Cosmos.ConnectionMode.Gateway"/>.
/// Gateway mode only supports HTTPS.
/// For more information, see <see href="https://docs.microsoft.com/azure/documentdb/documentdb-performance-tips#use-tcp">Connection policy: Use the TCP protocol</see>.
/// For more information, see <see href="https://learn.microsoft.com/azure/cosmos-db/nosql/performance-tips-dotnet-sdk-v3#networking">Connection policy: Use the HTTPS protocol</see>.
/// </remarks>
internal Protocol ConnectionProtocol
{

Просмотреть файл

@ -44,9 +44,9 @@ namespace Microsoft.Azure.Cosmos
}
/// <summary>
/// Gets the string field <see cref="CosmosDiagnostics"/> instance in the Azure CosmosDB database service.
/// Gets the string field <see cref="CosmosDiagnostics"/> instance in the Azure Cosmos DB database service.
/// </summary>
/// <returns>The string field <see cref="CosmosDiagnostics"/> instance in the Azure CosmosDB database service.</returns>
/// <returns>The string field <see cref="CosmosDiagnostics"/> instance in the Azure Cosmos DB database service.</returns>
/// <remarks>
/// <see cref="CosmosDiagnostics"/> implements lazy materialization and is only materialized when <see cref="CosmosDiagnostics.ToString"/> is called.
/// </remarks>

Просмотреть файл

@ -349,7 +349,7 @@ namespace Microsoft.Azure.Cosmos.Fluent
/// Sets the connection mode to Direct. This is used by the client when connecting to the Azure Cosmos DB service.
/// </summary>
/// <remarks>
/// For more information, see <see href="https://docs.microsoft.com/azure/documentdb/documentdb-performance-tips#direct-connection">Connection policy: Use direct connection mode</see>.
/// For more information, see <see href="https://learn.microsoft.com/azure/cosmos-db/nosql/performance-tips-dotnet-sdk-v3#direct-connection">Connection policy: Use direct connection mode</see>.
/// </remarks>
/// <returns>The current <see cref="CosmosClientBuilder"/>.</returns>
/// <seealso cref="CosmosClientOptions.ConnectionMode"/>
@ -396,7 +396,7 @@ namespace Microsoft.Azure.Cosmos.Fluent
/// The default value is false.
/// </param>
/// <remarks>
/// For more information, see <see href="https://docs.microsoft.com/azure/documentdb/documentdb-performance-tips#direct-connection">Connection policy: Use direct connection mode</see>.
/// For more information, see <see href="https://learn.microsoft.com/azure/cosmos-db/nosql/performance-tips-dotnet-sdk-v3#direct-connection">Connection policy: Use direct connection mode</see>.
/// </remarks>
/// <returns>The current <see cref="CosmosClientBuilder"/>.</returns>
/// <seealso cref="CosmosClientOptions.ConnectionMode"/>
@ -472,7 +472,7 @@ namespace Microsoft.Azure.Cosmos.Fluent
/// <param name="maxConnectionLimit">The number specifies the number of connections that may be opened simultaneously. Default is 50 connections</param>
/// <param name="webProxy">Get or set the proxy information used for web requests.</param>
/// <remarks>
/// For more information, see <see href="https://docs.microsoft.com/azure/documentdb/documentdb-performance-tips#direct-connection">Connection policy: Use direct connection mode</see>.
/// For more information, see <see href="https://learn.microsoft.com/azure/cosmos-db/nosql/performance-tips-dotnet-sdk-v3#direct-connection">Connection policy: Use direct connection mode</see>.
/// </remarks>
/// <returns>The current <see cref="CosmosClientBuilder"/>.</returns>
/// <seealso cref="CosmosClientOptions.ConnectionMode"/>
@ -529,7 +529,7 @@ namespace Microsoft.Azure.Cosmos.Fluent
/// If the cumulative wait time exceeds the this value, the client will stop retrying and return the error to the application.
/// </para>
/// <para>
/// For more information, see <see href="https://docs.microsoft.com/azure/documentdb/documentdb-performance-tips#429">Handle rate limiting/request rate too large</see>.
/// For more information, see <see href="https://learn.microsoft.com/azure/cosmos-db/nosql/performance-tips-dotnet-sdk-v3#429">Handle rate limiting/request rate too large</see>.
/// </para>
/// <returns>The current <see cref="CosmosClientBuilder"/>.</returns>
/// <seealso cref="CosmosClientOptions.MaxRetryWaitTimeOnRateLimitedRequests"/>

Просмотреть файл

@ -14,7 +14,7 @@ namespace Microsoft.Azure.Cosmos
public class DedicatedGatewayRequestOptions
{
/// <summary>
/// Gets or sets the staleness value associated with the request in the Azure CosmosDB service.
/// Gets or sets the staleness value associated with the request in the Azure Cosmos DB service.
/// </summary>
/// <value>Default value is null.</value>
/// <remarks>
@ -24,7 +24,7 @@ namespace Microsoft.Azure.Cosmos
public TimeSpan? MaxIntegratedCacheStaleness { get; set; }
/// <summary>
/// Gets or sets if bypass the integrated cache or not associated with the request in the Azure CosmosDB service.
/// Gets or sets if bypass the integrated cache or not associated with the request in the Azure Cosmos DB service.
/// When set this value to true, the request will not be served from the integrated cache, and the response will not be cached either.
/// </summary>
/// <value>Default value is false.</value>

Просмотреть файл

@ -56,7 +56,7 @@ namespace Microsoft.Azure.Cosmos
/// retry after the time has elapsed.
/// </para>
/// <para>
/// For more information, see <see href="https://docs.microsoft.com/en-us/azure/documentdb/documentdb-performance-tips#429">Handle rate limiting/request rate too large</see>.
/// For more information, see <see href="https://learn.microsoft.com/azure/cosmos-db/nosql/performance-tips-dotnet-sdk-v3#429">Handle rate limiting/request rate too large</see>.
/// </para>
/// </remarks>
public int MaxRetryAttemptsOnThrottledRequests
@ -91,7 +91,7 @@ namespace Microsoft.Azure.Cosmos
/// If the cumulative wait time exceeds the this value, the client will stop retrying and return the error to the application.
/// </para>
/// <para>
/// For more information, see <see href="https://docs.microsoft.com/en-us/azure/documentdb/documentdb-performance-tips#429">Handle rate limiting/request rate too large</see>.
/// For more information, see <see href="https://learn.microsoft.com/azure/cosmos-db/nosql/performance-tips-dotnet-sdk-v3#429">Handle rate limiting/request rate too large</see>.
/// </para>
/// </remarks>
public int MaxRetryWaitTimeInSeconds