CosmosClientOptions interface

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

aadCredentials?: TokenCredential

プロパティ値

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

agent?: Agent

プロパティ値

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

connectionPolicy?: ConnectionPolicy

プロパティ値

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

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

プロパティ値

defaultHeaders?: CosmosHeaders_2

プロパティ値

diagnosticLevel?: CosmosDbDiagnosticLevel

プロパティ値

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

endpoint: string

プロパティ値

HTTP パイプラインによる要求の実行方法をカスタマイズするための、省略可能なカスタム HttpClient 図形。 このインターフェイスを実装する方法の詳細については、@azure/core-rest-pipeline を参照してください。

httpClient?: HttpClient

プロパティ値

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

key?: string

プロパティ値

Permission オブジェクトの配列。

permissionFeed?: PermissionDefinition[]

プロパティ値

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

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

プロパティ値

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

tokenProvider?: TokenProvider

プロパティ値

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

userAgentSuffix?: string

プロパティ値