CosmosClient コンストラクター
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
| CosmosClient() |
モック テストに使用する新しい CosmosClient を作成する |
| CosmosClient(String, CosmosClientOptions) |
接続文字列を使用して新しい CosmosClient を作成します。 CosmosClient はスレッド セーフです。 アプリケーションの有効期間ごとに CosmosClient の 1 つのインスタンスを維持することをお勧めします。これにより、効率的な接続管理とパフォーマンスが可能になります。 パフォーマンス ガイドを参照してください。 |
| CosmosClient(String, AzureKeyCredential, CosmosClientOptions) |
アカウント エンドポイント URI 文字列と AzureKeyCredential を使用して、新しい CosmosClient を作成します。 AzureKeyCredential を使用すると、CosmosClient がまだ使用されている間に master-key/ResourceToken を変更/更新できます。 CosmosClient はスレッド セーフです。 アプリケーションの有効期間ごとに CosmosClient の 1 つのインスタンスを維持することをお勧めします。これにより、効率的な接続管理とパフォーマンスが可能になります。 パフォーマンス ガイドを参照してください。 |
| CosmosClient(String, TokenCredential, CosmosClientOptions) |
アカウント エンドポイント URI 文字列と TokenCredential を使用して、新しい CosmosClient を作成します。 CosmosClient はスレッド セーフです。 アプリケーションの有効期間ごとに CosmosClient の 1 つのインスタンスを維持することをお勧めします。これにより、効率的な接続管理とパフォーマンスが可能になります。 パフォーマンス ガイドを参照してください。 |
| CosmosClient(String, String, CosmosClientOptions) |
アカウント エンドポイント URI 文字列とアカウント キーを使用して、新しい CosmosClient を作成します。 CosmosClient はスレッド セーフです。 アプリケーションの有効期間ごとに CosmosClient の 1 つのインスタンスを維持することをお勧めします。これにより、効率的な接続管理とパフォーマンスが可能になります。 パフォーマンス ガイドを参照してください。 |
CosmosClient()
モック テストに使用する新しい CosmosClient を作成する
protected CosmosClient ();Protected Sub New ()適用対象
CosmosClient(String, CosmosClientOptions)
接続文字列を使用して新しい CosmosClient を作成します。
CosmosClient はスレッド セーフです。 アプリケーションの有効期間ごとに CosmosClient の 1 つのインスタンスを維持することをお勧めします。これにより、効率的な接続管理とパフォーマンスが可能になります。 パフォーマンス ガイドを参照してください。
public CosmosClient (string connectionString, Microsoft.Azure.Cosmos.CosmosClientOptions clientOptions = default);new Microsoft.Azure.Cosmos.CosmosClient : string * Microsoft.Azure.Cosmos.CosmosClientOptions -> Microsoft.Azure.Cosmos.CosmosClientPublic 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 の 1 つのインスタンスを維持することをお勧めします。これにより、効率的な接続管理とパフォーマンスが可能になります。 パフォーマンス ガイドを参照してください。
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.CosmosClientPublic 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 の 1 つのインスタンスを維持することをお勧めします。これにより、効率的な接続管理とパフォーマンスが可能になります。 パフォーマンス ガイドを参照してください。
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.CosmosClientPublic 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 の 1 つのインスタンスを維持することをお勧めします。これにより、効率的な接続管理とパフォーマンスが可能になります。 パフォーマンス ガイドを参照してください。
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.CosmosClientPublic 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
注釈
返された参照では、作成ではネットワーク呼び出しが行われないため、資格情報や接続の検証は保証されません。
こちらもご覧ください
適用対象
Azure SDK for .NET
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示