CosmosClientOptions interface

Paket:

@azure/cosmos

Özellikler

aadCredentials	Kimlik bilgisi nesnesi oluşturarak @azure/identity kimlik bilgisi nesnesi alma öğesinden @azure/identity AAD belirteci Daha sonra Cosmos'a yönelik isteklerin kimliğini doğrulamak için kimlik bilgisi nesnenizi ve kapsam URL'nizi (cosmos db uç noktanız) kullanırız
agent	NodeJS enironments'ta kullanılacak isteğe bağlı özel http(ler) Aracısı Ara sunucu aracılığıyla Cosmos'a bağlanmanız gerektiği gibi https://github.com/TooTallNate/node-proxy-agent bir aracı kullanın
connectionPolicy	ConnectionPolicy sınıfının bir örneği. Bu parametre isteğe bağlıdır ve atlanırsa varsayılan connectionPolicy kullanılır.
consistencyLevel	Tutarlılık düzeyini temsil eden isteğe bağlı bir parametre. ConsistencyLevel'den herhangi bir değeri alabilir.
defaultHeaders
diagnosticLevel
endpoint	İstemciyi oluşturmak için kullanılacak hizmet uç noktası.
key	Hesap yöneticisi veya salt okunur anahtar
permissionFeed	İzin nesneleri dizisi.
resourceTokens	Kaynak belirteçleri içeren bir nesne. Nesnenin anahtarları kaynak kimlikleri, değerler ise kaynak belirteçleridir.
tokenProvider	Üst bilgi yetkilendirme belirteçlerini çözümlemek için kullanıcı tarafından sağlanan işlev. Kullanıcıların ayrı bir hizmet kullanarak kendi kimlik doğrulama belirteçlerini oluşturmasına olanak tanır
userAgentSuffix	Varsayılan SDK kullanıcı aracısına eklenecek özel bir dize.

Özellik Ayrıntıları

aadCredentials

Kimlik bilgisi nesnesi oluşturarak @azure/identity kimlik bilgisi nesnesi alma öğesinden @azure/identity AAD belirteci Daha sonra Cosmos'a yönelik isteklerin kimliğini doğrulamak için kimlik bilgisi nesnenizi ve kapsam URL'nizi (cosmos db uç noktanız) kullanırız

aadCredentials?: TokenCredential

Özellik Değeri

TokenCredential

agent

NodeJS enironments'ta kullanılacak isteğe bağlı özel http(ler) Aracısı Ara sunucu aracılığıyla Cosmos'a bağlanmanız gerektiği gibi https://github.com/TooTallNate/node-proxy-agent bir aracı kullanın

agent?: Agent

Özellik Değeri

Agent

connectionPolicy

ConnectionPolicy sınıfının bir örneği. Bu parametre isteğe bağlıdır ve atlanırsa varsayılan connectionPolicy kullanılır.

connectionPolicy?: ConnectionPolicy

Özellik Değeri

ConnectionPolicy

consistencyLevel

Tutarlılık düzeyini temsil eden isteğe bağlı bir parametre. ConsistencyLevel'den herhangi bir değeri alabilir.

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

Özellik Değeri

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

defaultHeaders

defaultHeaders?: CosmosHeaders_2

Özellik Değeri

CosmosHeaders_2

diagnosticLevel

diagnosticLevel?: CosmosDbDiagnosticLevel

Özellik Değeri

CosmosDbDiagnosticLevel

endpoint

İstemciyi oluşturmak için kullanılacak hizmet uç noktası.

endpoint: string

Özellik Değeri

string

key

Hesap yöneticisi veya salt okunur anahtar

key?: string

Özellik Değeri

string

permissionFeed

İzin nesneleri dizisi.

permissionFeed?: PermissionDefinition[]

Özellik Değeri

PermissionDefinition[]

resourceTokens

Kaynak belirteçleri içeren bir nesne. Nesnenin anahtarları kaynak kimlikleri, değerler ise kaynak belirteçleridir.

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

Özellik Değeri

{[resourcePath: string]: string}

tokenProvider

Üst bilgi yetkilendirme belirteçlerini çözümlemek için kullanıcı tarafından sağlanan işlev. Kullanıcıların ayrı bir hizmet kullanarak kendi kimlik doğrulama belirteçlerini oluşturmasına olanak tanır

tokenProvider?: TokenProvider

Özellik Değeri

TokenProvider

userAgentSuffix

Varsayılan SDK kullanıcı aracısına eklenecek özel bir dize.

userAgentSuffix?: string

Özellik Değeri

string