CosmosClientOptions interface
プロパティ
| aad |
|
| agent | NodeJS 環境で使用されるオプションのカスタム http エージェントプロキシ経由で Cosmos に接続する必要がある場合は、 https://github.com/TooTallNate/node-proxy-agent などのエージェントを使用します |
| client |
クライアント側の暗号化を使用する場合は、暗号化に関連する操作の暗号化ポリシーをクライアントで設定する必要があります |
| connection |
ConnectionPolicy クラス インスタンス。 このパラメーターは省略可能であり、省略した場合は既定の connectionPolicy が使用されます。 |
| connection |
接続文字列を表す省略可能なパラメーター。 データベース接続文字列は、Azure Portal にあります。 |
| consistency |
整合性レベルを表す省略可能なパラメーター。 ConsistencyLevelから任意の値を取得できます。 |
| default |
|
| diagnostic |
|
| endpoint | クライアントの作成に使用するサービス エンドポイント。 |
| http |
HTTP パイプラインによる要求の実行方法をカスタマイズするための、省略可能なカスタム |
| key | アカウント マスターキーまたは読み取りキー |
| permission |
Permission オブジェクトの配列。 |
| resource |
リソース トークンを含むオブジェクト。 オブジェクトのキーはリソース ID であり、値はリソース トークンです。 |
| throughput |
スループットバケット番号を設定するためのオプションのパラメータ。 この値は、要求レベルでオーバーライドできます詳細については、「 Cosmos DB スループットのバケット化」を参照してください。 |
| token |
ヘッダー承認トークンを解決するためのユーザー指定の関数。 ユーザーが別のサービスを使用して独自の認証トークンを生成できるようにする |
| user |
既定の SDK ユーザー エージェントに追加するカスタム文字列。 |
プロパティの詳細
aadCredentials
@azure/identity から AAD トークン @azure/identity 資格情報オブジェクトを作成して資格情報オブジェクトを取得します。その後、資格情報オブジェクトとスコープ URL (Cosmos db エンドポイント) を使用して Cosmos への要求を認証します
aadCredentials?: TokenCredential
プロパティ値
agent
NodeJS 環境で使用されるオプションのカスタム http エージェントプロキシ経由で Cosmos に接続する必要がある場合は、 https://github.com/TooTallNate/node-proxy-agent などのエージェントを使用します
agent?: Agent
プロパティ値
clientEncryptionOptions
クライアント側の暗号化を使用する場合は、暗号化に関連する操作の暗号化ポリシーをクライアントで設定する必要があります
ClientEncryptionOptions を参照してください。
clientEncryptionOptions?: ClientEncryptionOptions
プロパティ値
connectionPolicy
ConnectionPolicy クラス インスタンス。 このパラメーターは省略可能であり、省略した場合は既定の connectionPolicy が使用されます。
connectionPolicy?: ConnectionPolicy
プロパティ値
connectionString
接続文字列を表す省略可能なパラメーター。 データベース接続文字列は、Azure Portal にあります。
connectionString?: string
プロパティ値
string
consistencyLevel
整合性レベルを表す省略可能なパラメーター。 ConsistencyLevelから任意の値を取得できます。
consistencyLevel?: "Strong" | "BoundedStaleness" | "Session" | "Eventual" | "ConsistentPrefix"
プロパティ値
"Strong" | "BoundedStaleness" | "Session" | "Eventual" | "ConsistentPrefix"
defaultHeaders
defaultHeaders?: CosmosHeaders
プロパティ値
CosmosHeaders
diagnosticLevel
endpoint
クライアントの作成に使用するサービス エンドポイント。
endpoint?: string
プロパティ値
string
httpClient
HTTP パイプラインによる要求の実行方法をカスタマイズするための、省略可能なカスタム HttpClient 図形。
このインターフェイスを実装する方法の詳細については、@azure/core-rest-pipeline を参照してください。
httpClient?: HttpClient
プロパティ値
key
アカウント マスターキーまたは読み取りキー
key?: string
プロパティ値
string
permissionFeed
resourceTokens
リソース トークンを含むオブジェクト。 オブジェクトのキーはリソース ID であり、値はリソース トークンです。
resourceTokens?: {[resourcePath: string]: string}
プロパティ値
{[resourcePath: string]: string}
throughputBucket
スループットバケット番号を設定するためのオプションのパラメータ。 この値は、要求レベルでオーバーライドできます詳細については、「 Cosmos DB スループットのバケット化」を参照してください。
throughputBucket?: number
プロパティ値
number
tokenProvider
ヘッダー承認トークンを解決するためのユーザー指定の関数。 ユーザーが別のサービスを使用して独自の認証トークンを生成できるようにする
tokenProvider?: TokenProvider
プロパティ値
userAgentSuffix
既定の SDK ユーザー エージェントに追加するカスタム文字列。
userAgentSuffix?: string
プロパティ値
string