CosmosClientOptions interface

Paket:

@azure/cosmos

Özellikler

aadCredentials	@azure/identity AAD belirteci @azure/identity kimlik bilgisi nesnesi oluşturarak kimlik bilgisi nesnesi alma Daha sonra Cosmos'a yönelik isteklerin kimliğini doğrulamak için kimlik bilgileri nesnenizi ve kapsam URL'nizi (cosmos db uç noktanız) kullanacağız
agent	NodeJS ortamlarında kullanılacak isteğe bağlı bir özel http(s) Aracısı Cosmos'a bir proxy aracılığıyla bağlanmanız gerekiyorsa gibi bir aracı https://github.com/TooTallNate/node-proxy-agent kullanın
clientEncryptionOptions	İstemci tarafı şifreleme kullanılıyorsa, şifreleme içeren işlemler için şifreleme ilkesi istemcide ayarlanmalıdır ClientEncryptionOptions'a bakı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.
connectionString	Bağlantı dizesini temsil eden isteğe bağlı bir parametre. Veritabanı bağlantı dizeniz Azure Portal'da bulunabilir.
consistencyLevel	Tutarlılık düzeyini temsil eden isteğe bağlı bir parametre. ConsistencyLevelherhangi bir değeri alabilir.
defaultHeaders
diagnosticLevel
endpoint	İstemciyi oluşturmak için kullanılacak hizmet uç noktası.
httpClient	İSTEKlerin HTTP işlem hattı tarafından nasıl yapıldığını özelleştirmek için isteğe bağlı bir özel HttpClient şekli. Bu arabirimi uygulama hakkında ayrıntılı bilgi için bkz. @azure/core-rest-pipeline.
key	Hesap yöneticisi veya salt okunur anahtar
permissionFeed	İzin nesneleri dizisi.
resourceTokens	Kaynak belirteçlerini içeren bir nesne. Nesnenin anahtarları kaynak kimlikleri, değerler ise kaynak belirteçleridir.
throughputBucket	Aktarım hızı demeti numarasını ayarlamak için isteğe bağlı bir parametre. Bu değer istek düzeyinde geçersiz kılınabilir Daha fazla bilgi için Cosmos DB aktarım hızı demetleme sayfasını ziyaret edin.
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 dize.

Özellik Ayrıntıları

aadCredentials

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

aadCredentials?: TokenCredential

Özellik Değeri

TokenCredential

agent

NodeJS ortamlarında kullanılacak isteğe bağlı bir özel http(s) Aracısı Cosmos'a bir proxy aracılığıyla bağlanmanız gerekiyorsa gibi bir aracı https://github.com/TooTallNate/node-proxy-agent kullanın

agent?: Agent

Özellik Değeri

Agent

clientEncryptionOptions

İstemci tarafı şifreleme kullanılıyorsa, şifreleme içeren işlemler için şifreleme ilkesi istemcide ayarlanmalıdır

ClientEncryptionOptions'a bakın

clientEncryptionOptions?: ClientEncryptionOptions

Özellik Değeri

ClientEncryptionOptions

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

connectionString

Bağlantı dizesini temsil eden isteğe bağlı bir parametre. Veritabanı bağlantı dizeniz Azure Portal'da bulunabilir.

connectionString?: string

Özellik Değeri

string

consistencyLevel

Tutarlılık düzeyini temsil eden isteğe bağlı bir parametre. ConsistencyLevelherhangi bir değeri alabilir.

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

Özellik Değeri

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

defaultHeaders

defaultHeaders?: CosmosHeaders

Özellik Değeri

CosmosHeaders

diagnosticLevel

diagnosticLevel?: CosmosDbDiagnosticLevel

Özellik Değeri

CosmosDbDiagnosticLevel

endpoint

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

endpoint?: string

Özellik Değeri

string

httpClient

İSTEKlerin HTTP işlem hattı tarafından nasıl yapıldığını özelleştirmek için isteğe bağlı bir özel HttpClient şekli. Bu arabirimi uygulama hakkında ayrıntılı bilgi için bkz. @azure/core-rest-pipeline.

httpClient?: HttpClient

Özellik Değeri

HttpClient

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çlerini içeren bir nesne. Nesnenin anahtarları kaynak kimlikleri, değerler ise kaynak belirteçleridir.

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

Özellik Değeri

{[resourcePath: string]: string}

throughputBucket

Aktarım hızı demeti numarasını ayarlamak için isteğe bağlı bir parametre. Bu değer istek düzeyinde geçersiz kılınabilir Daha fazla bilgi için Cosmos DB aktarım hızı demetleme sayfasını ziyaret edin.

throughputBucket?: number

Özellik Değeri

number

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 dize.

userAgentSuffix?: string

Özellik Değeri

string