CosmosClientOptions interface

パッケージ:

@azure/cosmos

プロパティ

aadCredentials	[資格情報オブジェクトを作成して資格情報オブジェクトを@azure/identity取得する] から @azure/identity AAD トークンを取得します。次に、資格情報オブジェクトとスコープ URL (cosmos db エンドポイント) を使用して Cosmos への要求を認証します
agent	NodeJS enironments で使用するオプションのカスタム http(s) エージェント プロキシ経由で Cosmos に接続する必要がある場合など https://github.com/TooTallNate/node-proxy-agent 、エージェントを使用します
connectionPolicy	ConnectionPolicy クラスのインスタンス。 このパラメーターは省略可能であり、省略した場合は既定の connectionPolicy が使用されます。
consistencyLevel	整合性レベルを表す省略可能なパラメーター。 ConsistencyLevel から任意の値を受け取ることができます。
defaultHeaders
diagnosticLevel
endpoint	クライアントの作成に使用するサービス エンドポイント。
key	アカウント マスターまたは読み取り専用キー
permissionFeed	Permission オブジェクトの配列。
resourceTokens	リソース トークンを含む オブジェクト。 オブジェクトのキーはリソース ID であり、値はリソース トークンです。
tokenProvider	ヘッダー承認トークンを解決するためのユーザー指定の関数。 ユーザーが独自の認証トークンを生成できるようにします。別のサービスを使用する可能性があります
userAgentSuffix	既定の SDK ユーザー エージェントに追加するカスタム文字列。

プロパティの詳細

aadCredentials

[資格情報オブジェクトを作成して資格情報オブジェクトを@azure/identity取得する] から @azure/identity AAD トークンを取得します。次に、資格情報オブジェクトとスコープ URL (cosmos db エンドポイント) を使用して Cosmos への要求を認証します

aadCredentials?: TokenCredential

プロパティ値

TokenCredential

agent

NodeJS enironments で使用するオプションのカスタム http(s) エージェント プロキシ経由で Cosmos に接続する必要がある場合など https://github.com/TooTallNate/node-proxy-agent 、エージェントを使用します

agent?: Agent

プロパティ値

Agent

connectionPolicy

ConnectionPolicy クラスのインスタンス。 このパラメーターは省略可能であり、省略した場合は既定の connectionPolicy が使用されます。

connectionPolicy?: ConnectionPolicy

プロパティ値

ConnectionPolicy

consistencyLevel

整合性レベルを表す省略可能なパラメーター。 ConsistencyLevel から任意の値を受け取ることができます。

consistencyLevel?: "Strong" | "BoundedStaleness" | "Session" | "Eventual" | "ConsistentPrefix"

プロパティ値

"Strong" | "BoundedStaleness" | "Session" | "Eventual" | "ConsistentPrefix"

defaultHeaders

defaultHeaders?: CosmosHeaders_2

プロパティ値

CosmosHeaders_2

diagnosticLevel

diagnosticLevel?: CosmosDbDiagnosticLevel

プロパティ値

CosmosDbDiagnosticLevel

endpoint

クライアントの作成に使用するサービス エンドポイント。

endpoint: string

プロパティ値

string

key

アカウント マスターまたは読み取り専用キー

key?: string

プロパティ値

string

permissionFeed

Permission オブジェクトの配列。

permissionFeed?: PermissionDefinition[]

プロパティ値

PermissionDefinition[]

resourceTokens

リソース トークンを含む オブジェクト。 オブジェクトのキーはリソース ID であり、値はリソース トークンです。

resourceTokens?: {[resourcePath: string]: string}

プロパティ値

{[resourcePath: string]: string}

tokenProvider

ヘッダー承認トークンを解決するためのユーザー指定の関数。 ユーザーが独自の認証トークンを生成できるようにします。別のサービスを使用する可能性があります

tokenProvider?: TokenProvider

プロパティ値

TokenProvider

userAgentSuffix

既定の SDK ユーザー エージェントに追加するカスタム文字列。

userAgentSuffix?: string

プロパティ値

string