你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

CosmosClient 构造函数

参考

定义

命名空间:: Microsoft.Azure.Cosmos

程序集:: Microsoft.Azure.Cosmos.Client.dll

包:: Microsoft.Azure.Cosmos v3.36.0

重要

一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。

重载

CosmosClient()	创建用于模拟测试的新 CosmosClient
CosmosClient(String, CosmosClientOptions)	使用连接字符串创建新的 CosmosClient。 CosmosClient 是线程安全的。建议在应用程序的生命周期内维护 CosmosClient 的单个实例，从而实现高效的连接管理和性能。请参阅性能指南。
CosmosClient(String, AzureKeyCredential, CosmosClientOptions)	使用帐户终结点 URI 字符串和 AzureKeyCredential 创建新的 CosmosClient。 AzureKeyCredential 允许在 CosmosClient 仍在使用时更改/更新 master-key/ResourceToken。 CosmosClient 是线程安全的。建议在应用程序的生命周期内维护 CosmosClient 的单个实例，从而实现高效的连接管理和性能。请参阅性能指南。
CosmosClient(String, TokenCredential, CosmosClientOptions)	使用帐户终结点 URI 字符串和 TokenCredential 创建新的 CosmosClient。 CosmosClient 是线程安全的。建议在应用程序的生命周期内维护 CosmosClient 的单个实例，从而实现高效的连接管理和性能。请参阅性能指南。
CosmosClient(String, String, CosmosClientOptions)	使用帐户终结点 URI 字符串和帐户密钥创建新的 CosmosClient。 CosmosClient 是线程安全的。建议在应用程序的生命周期内维护 CosmosClient 的单个实例，从而实现高效的连接管理和性能。请参阅性能指南。

CosmosClient()

创建用于模拟测试的新 CosmosClient

protected CosmosClient ();

Protected Sub New ()

适用于

CosmosClient(String, CosmosClientOptions)

使用连接字符串创建新的 CosmosClient。

CosmosClient 是线程安全的。建议在应用程序的生命周期内维护 CosmosClient 的单个实例，从而实现高效的连接管理和性能。请参阅性能指南。

public CosmosClient (string connectionString, Microsoft.Azure.Cosmos.CosmosClientOptions clientOptions = default);

new Microsoft.Azure.Cosmos.CosmosClient : string * Microsoft.Azure.Cosmos.CosmosClientOptions -> Microsoft.Azure.Cosmos.CosmosClient

Public Sub New (connectionString As String, Optional clientOptions As CosmosClientOptions = Nothing)

参数

connectionString: String

cosmos 帐户的连接字符串。例如：AccountEndpoint=https://XXXXX.documents.azure.com:443/;AccountKey=SuperSecretKey;

clientOptions: CosmosClientOptions

(可选) 客户端选项

示例

CosmosClient 是使用连接字符串创建的，并配置为使用“美国东部 2”区域。

using Microsoft.Azure.Cosmos;

CosmosClient cosmosClient = new CosmosClient(
            "account-endpoint-from-portal", 
            "account-key-from-portal", 
            new CosmosClientOptions()
            {
                ApplicationRegion = Regions.EastUS2,
            });

// Dispose cosmosClient at application exit

注解

返回的引用不保证凭据或连接验证，因为创建不会进行任何网络调用。

另请参阅

适用于

CosmosClient(String, AzureKeyCredential, CosmosClientOptions)

使用帐户终结点 URI 字符串和 AzureKeyCredential 创建新的 CosmosClient。 AzureKeyCredential 允许在 CosmosClient 仍在使用时更改/更新 master-key/ResourceToken。

CosmosClient 是线程安全的。建议在应用程序的生命周期内维护 CosmosClient 的单个实例，从而实现高效的连接管理和性能。请参阅性能指南。

public CosmosClient (string accountEndpoint, Azure.AzureKeyCredential authKeyOrResourceTokenCredential, Microsoft.Azure.Cosmos.CosmosClientOptions clientOptions = default);

new Microsoft.Azure.Cosmos.CosmosClient : string * Azure.AzureKeyCredential * Microsoft.Azure.Cosmos.CosmosClientOptions -> Microsoft.Azure.Cosmos.CosmosClient

Public Sub New (accountEndpoint As String, authKeyOrResourceTokenCredential As AzureKeyCredential, Optional clientOptions As CosmosClientOptions = Nothing)

参数

accountEndpoint: String

要使用的 cosmos 服务终结点

authKeyOrResourceTokenCredential: AzureKeyCredential

具有主密钥或资源令牌的 AzureKeyCredential。

clientOptions: CosmosClientOptions

(可选) 客户端选项

示例

CosmosClient 是使用 AccountEndpoint、AccountKey 或 ResourceToken 创建的，并配置为使用“美国东部 2”区域。

using Microsoft.Azure.Cosmos;

AzureKeyCredential keyCredential = new AzureKeyCredential("account-master-key/ResourceToken");
CosmosClient cosmosClient = new CosmosClient(
            "account-endpoint-from-portal", 
            keyCredential, 
            new CosmosClientOptions()
            {
                ApplicationRegion = Regions.EastUS2,
            });

....

// To udpate key/credentials 
keyCredential.Update("updated master-key/ResourceToken");

// Dispose cosmosClient at application exit

注解

AzureKeyCredential 允许更改/更新 master-key/ResourceToken whle CosmosClient 仍在使用中。返回的引用不保证凭据或连接验证，因为创建不会进行任何网络调用。

另请参阅

适用于

CosmosClient(String, TokenCredential, CosmosClientOptions)

使用帐户终结点 URI 字符串和 TokenCredential 创建新的 CosmosClient。

CosmosClient 是线程安全的。建议在应用程序的生命周期内维护 CosmosClient 的单个实例，从而实现高效的连接管理和性能。请参阅性能指南。

public CosmosClient (string accountEndpoint, Azure.Core.TokenCredential tokenCredential, Microsoft.Azure.Cosmos.CosmosClientOptions clientOptions = default);

new Microsoft.Azure.Cosmos.CosmosClient : string * Azure.Core.TokenCredential * Microsoft.Azure.Cosmos.CosmosClientOptions -> Microsoft.Azure.Cosmos.CosmosClient

Public Sub New (accountEndpoint As String, tokenCredential As TokenCredential, Optional clientOptions As CosmosClientOptions = Nothing)

参数

accountEndpoint: String

要使用的 cosmos 服务终结点。

tokenCredential: TokenCredential

TokenCredential用于为授权提供 AAD 令牌的令牌。

clientOptions: CosmosClientOptions

(可选) 客户端选项

注解

返回的引用不保证凭据或连接验证，因为创建不会进行任何网络调用。

适用于

CosmosClient(String, String, CosmosClientOptions)

使用帐户终结点 URI 字符串和帐户密钥创建新的 CosmosClient。

CosmosClient 是线程安全的。建议在应用程序的生命周期内维护 CosmosClient 的单个实例，从而实现高效的连接管理和性能。请参阅性能指南。

public CosmosClient (string accountEndpoint, string authKeyOrResourceToken, Microsoft.Azure.Cosmos.CosmosClientOptions clientOptions = default);

new Microsoft.Azure.Cosmos.CosmosClient : string * string * Microsoft.Azure.Cosmos.CosmosClientOptions -> Microsoft.Azure.Cosmos.CosmosClient

Public Sub New (accountEndpoint As String, authKeyOrResourceToken As String, Optional clientOptions As CosmosClientOptions = Nothing)

参数

accountEndpoint: String

要使用的 cosmos 服务终结点

authKeyOrResourceToken: String

用于创建客户端的 cosmos 帐户密钥或资源令牌。

clientOptions: CosmosClientOptions

(可选) 客户端选项

示例

CosmosClient 是使用 AccountEndpoint、AccountKey 或 ResourceToken 创建的，并配置为使用“美国东部 2”区域。

using Microsoft.Azure.Cosmos;

CosmosClient cosmosClient = new CosmosClient(
            "account-endpoint-from-portal", 
            "account-key-from-portal", 
            new CosmosClientOptions()
            {
                ApplicationRegion = Regions.EastUS2,
            });

// Dispose cosmosClient at application exit

注解

返回的引用不保证凭据或连接验证，因为创建不会进行任何网络调用。

另请参阅

适用于

通过

CosmosClient 构造函数

定义

重载

CosmosClient()

适用于

CosmosClient(String, CosmosClientOptions)

参数

示例

注解

另请参阅

适用于

CosmosClient(String, AzureKeyCredential, CosmosClientOptions)

参数

示例

注解

另请参阅

适用于

CosmosClient(String, TokenCredential, CosmosClientOptions)

参数

注解

适用于

CosmosClient(String, String, CosmosClientOptions)

参数

示例

注解

另请参阅

适用于

其他资源