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

CosmosClient.CreateAndInitializeAsync 方法

定义

命名空间:

Microsoft.Azure.Cosmos

程序集:

Microsoft.Azure.Cosmos.Client.dll

包:

Microsoft.Azure.Cosmos v3.36.0

重载

CreateAndInitializeAsync(String, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)	使用帐户终结点 URI 字符串和 TokenCredential 创建新的 CosmosClient。 此外，它还使用提供的容器初始化客户端，即 SDK 在首次调用服务之前预热缓存和连接。 使用它在应用程序启动时获得较低的延迟。 CosmosClient 是线程安全的。 建议在应用程序的生命周期内维护 CosmosClient 的单个实例，从而实现高效的连接管理和性能。 请参阅 性能指南。
CreateAndInitializeAsync(String, AzureKeyCredential, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)	使用帐户终结点 URI 字符串和 AzureKeyCredential 创建新的 CosmosClient。 AzureKeyCredential 允许在 CosmosClient 仍在使用时更改/更新 master-key/ResourceToken。 此外，它还使用提供的容器初始化客户端，即 SDK 在首次调用服务之前预热缓存和连接。 使用它在应用程序启动时获得较低的延迟。 CosmosClient 是线程安全的。 建议在应用程序的生命周期内维护 CosmosClient 的单个实例，从而实现高效的连接管理和性能。 请参阅 性能指南。
CreateAndInitializeAsync(String, TokenCredential, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)	使用帐户终结点 URI 字符串和 TokenCredential 创建新的 CosmosClient。 此外，它还使用提供的容器初始化客户端，即 SDK 在首次调用服务之前预热缓存和连接。 使用它在应用程序启动时获得较低的延迟。 CosmosClient 是线程安全的。 建议在应用程序的生命周期内维护 CosmosClient 的单个实例，从而实现高效的连接管理和性能。 请参阅 性能指南。
CreateAndInitializeAsync(String, String, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)	使用帐户终结点 URI 字符串和 TokenCredential 创建新的 CosmosClient。 此外，它还使用提供的容器初始化客户端，即 SDK 在首次调用服务之前预热缓存和连接。 使用它在应用程序启动时获得较低的延迟。 CosmosClient 是线程安全的。 建议在应用程序的生命周期内维护 CosmosClient 的单个实例，从而实现高效的连接管理和性能。 请参阅 性能指南。

CreateAndInitializeAsync(String, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)

使用帐户终结点 URI 字符串和 TokenCredential 创建新的 CosmosClient。 此外，它还使用提供的容器初始化客户端，即 SDK 在首次调用服务之前预热缓存和连接。 使用它在应用程序启动时获得较低的延迟。 CosmosClient 是线程安全的。 建议在应用程序的生命周期内维护 CosmosClient 的单个实例，从而实现高效的连接管理和性能。 请参阅 性能指南。

public static System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.CosmosClient> CreateAndInitializeAsync (string connectionString, System.Collections.Generic.IReadOnlyList<(string databaseId, string containerId)> containers, Microsoft.Azure.Cosmos.CosmosClientOptions cosmosClientOptions = default, System.Threading.CancellationToken cancellationToken = default);

static member CreateAndInitializeAsync : string * System.Collections.Generic.IReadOnlyList<ValueTuple<string, string>> * Microsoft.Azure.Cosmos.CosmosClientOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.CosmosClient>

Public Shared Function CreateAndInitializeAsync (connectionString As String, containers As IReadOnlyList(Of ValueTuple(Of String, String)), Optional cosmosClientOptions As CosmosClientOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of CosmosClient)

参数

connectionString

String

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

containers

IReadOnlyList<ValueTuple<String,String>>

要初始化的容器由其数据库名称和容器名称标识。

cosmosClientOptions

CosmosClientOptions

(可选) 客户端选项

cancellationToken

CancellationToken

(可选) 取消令牌

返回

Task<CosmosClient>

CosmosClient 对象。

示例

使用 ConnectionString 创建 CosmosClient，并初始化帐户中的 2 个容器

using Microsoft.Azure.Cosmos;
List<(string, string)> containersToInitialize = new List<(string, string)>
{ ("DatabaseName1", "ContainerName1"), ("DatabaseName2", "ContainerName2") };

CosmosClient cosmosClient = await CosmosClient.CreateAndInitializeAsync("connection-string-from-portal",
                                                                        containersToInitialize)

// Dispose cosmosClient at application exit

CreateAndInitializeAsync(String, AzureKeyCredential, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)

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

此外，它还使用提供的容器初始化客户端，即 SDK 在首次调用服务之前预热缓存和连接。 使用它在应用程序启动时获得较低的延迟。 CosmosClient 是线程安全的。 建议在应用程序的生命周期内维护 CosmosClient 的单个实例，从而实现高效的连接管理和性能。 请参阅 性能指南。

public static System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.CosmosClient> CreateAndInitializeAsync (string accountEndpoint, Azure.AzureKeyCredential authKeyOrResourceTokenCredential, System.Collections.Generic.IReadOnlyList<(string databaseId, string containerId)> containers, Microsoft.Azure.Cosmos.CosmosClientOptions cosmosClientOptions = default, System.Threading.CancellationToken cancellationToken = default);

static member CreateAndInitializeAsync : string * Azure.AzureKeyCredential * System.Collections.Generic.IReadOnlyList<ValueTuple<string, string>> * Microsoft.Azure.Cosmos.CosmosClientOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.CosmosClient>

Public Shared Function CreateAndInitializeAsync (accountEndpoint As String, authKeyOrResourceTokenCredential As AzureKeyCredential, containers As IReadOnlyList(Of ValueTuple(Of String, String)), Optional cosmosClientOptions As CosmosClientOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of CosmosClient)

参数

accountEndpoint

String

要使用的 cosmos 服务终结点

authKeyOrResourceTokenCredential

AzureKeyCredential

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

containers

IReadOnlyList<ValueTuple<String,String>>

要初始化的容器由其数据库名称和容器名称标识。

cosmosClientOptions

CosmosClientOptions

(可选) 客户端选项

cancellationToken

CancellationToken

(可选) 取消令牌

返回

Task<CosmosClient>

CosmosClient 对象。

示例

使用 AccountEndpoint、AccountKey 或 ResourceToken 创建 CosmosClient，并初始化帐户中的 2 个容器

using Microsoft.Azure.Cosmos;
List<(string, string)> containersToInitialize = new List<(string, string)>
{ ("DatabaseName1", "ContainerName1"), ("DatabaseName2", "ContainerName2") };

AzureKeyCredential keyCredential = new AzureKeyCredential("account-master-key/ResourceToken");
CosmosClient cosmosClient = await CosmosClient.CreateAndInitializeAsync("account-endpoint-from-portal", 
                                                                        keyCredential,
                                                                        containersToInitialize)

....

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

// Dispose cosmosClient at application exit

注解

AzureKeyCredential 允许更改/更新 master-key/ResourceToken whle CosmosClient 仍在使用中。

CreateAndInitializeAsync(String, TokenCredential, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)

使用帐户终结点 URI 字符串和 TokenCredential 创建新的 CosmosClient。 此外，它还使用提供的容器初始化客户端，即 SDK 在首次调用服务之前预热缓存和连接。 使用它在应用程序启动时获得较低的延迟。 CosmosClient 是线程安全的。 建议在应用程序的生命周期内维护 CosmosClient 的单个实例，从而实现高效的连接管理和性能。 请参阅 性能指南。

public static System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.CosmosClient> CreateAndInitializeAsync (string accountEndpoint, Azure.Core.TokenCredential tokenCredential, System.Collections.Generic.IReadOnlyList<(string databaseId, string containerId)> containers, Microsoft.Azure.Cosmos.CosmosClientOptions cosmosClientOptions = default, System.Threading.CancellationToken cancellationToken = default);

static member CreateAndInitializeAsync : string * Azure.Core.TokenCredential * System.Collections.Generic.IReadOnlyList<ValueTuple<string, string>> * Microsoft.Azure.Cosmos.CosmosClientOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.CosmosClient>

Public Shared Function CreateAndInitializeAsync (accountEndpoint As String, tokenCredential As TokenCredential, containers As IReadOnlyList(Of ValueTuple(Of String, String)), Optional cosmosClientOptions As CosmosClientOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of CosmosClient)

参数

accountEndpoint

String

要使用的 cosmos 服务终结点。

tokenCredential

TokenCredential

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

containers

IReadOnlyList<ValueTuple<String,String>>

要初始化的容器由其数据库名称和容器名称标识。

cosmosClientOptions

CosmosClientOptions

(可选) 客户端选项

cancellationToken

CancellationToken

(可选) 取消令牌

返回

Task<CosmosClient>

CosmosClient 对象。

CreateAndInitializeAsync(String, String, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)

使用帐户终结点 URI 字符串和 TokenCredential 创建新的 CosmosClient。 此外，它还使用提供的容器初始化客户端，即 SDK 在首次调用服务之前预热缓存和连接。 使用它在应用程序启动时获得较低的延迟。 CosmosClient 是线程安全的。 建议在应用程序的生存期内维护 CosmosClient 的单个实例，从而实现高效的连接管理和性能。 请参阅 性能指南。

public static System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.CosmosClient> CreateAndInitializeAsync (string accountEndpoint, string authKeyOrResourceToken, System.Collections.Generic.IReadOnlyList<(string databaseId, string containerId)> containers, Microsoft.Azure.Cosmos.CosmosClientOptions cosmosClientOptions = default, System.Threading.CancellationToken cancellationToken = default);

static member CreateAndInitializeAsync : string * string * System.Collections.Generic.IReadOnlyList<ValueTuple<string, string>> * Microsoft.Azure.Cosmos.CosmosClientOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.CosmosClient>

Public Shared Function CreateAndInitializeAsync (accountEndpoint As String, authKeyOrResourceToken As String, containers As IReadOnlyList(Of ValueTuple(Of String, String)), Optional cosmosClientOptions As CosmosClientOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of CosmosClient)

参数

accountEndpoint

String

要使用的 cosmos 服务终结点

authKeyOrResourceToken

String

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

containers

IReadOnlyList<ValueTuple<String,String>>

要初始化的容器由其数据库名称和容器名称标识。

cosmosClientOptions

CosmosClientOptions

(可选) 客户端选项

cancellationToken

CancellationToken

(可选) 取消令牌

返回

Task<CosmosClient>

CosmosClient 对象。

示例

使用 AccountEndpoint、AccountKey 或 ResourceToken 创建 CosmosClient，并初始化帐户中的 2 个容器

using Microsoft.Azure.Cosmos;
List<(string, string)> containersToInitialize = new List<(string, string)>
{ ("DatabaseName1", "ContainerName1"), ("DatabaseName2", "ContainerName2") };

CosmosClient cosmosClient = await CosmosClient.CreateAndInitializeAsync("account-endpoint-from-portal", 
                                                                        "account-key-from-portal",
                                                                        containersToInitialize)

// Dispose cosmosClient at application exit

注解

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