Share via

CosmosClientOptions interface

  • Referência
Pacote:
@azure/cosmos

Propriedades

aadCredentials

Token do AAD de @azure/identity Obter um objeto de credencial criando um @azure/identity objeto de credencial Usaremos seu objeto de credencial e uma URL de escopo (seu ponto de extremidade cosmos db) para autenticar solicitações no Cosmos
agent

Um agente http(s) personalizado opcional a ser usado em enironments no NodeJS Use um agente como https://github.com/TooTallNate/node-proxy-agent se você precisa se conectar ao Cosmos por meio de um proxy
connectionPolicy

Uma instância da classe ConnectionPolicy . Esse parâmetro é opcional e a connectionPolicy padrão será usada se for omitida.
consistencyLevel

Um parâmetro opcional que representa o nível de consistência. Ele pode obter qualquer valor de ConsistencyLevel.
defaultHeaders
diagnosticLevel
endpoint

O ponto de extremidade de serviço a ser usado para criar o cliente.
key

A chave mestra ou somente leitura da conta
permissionFeed

Uma matriz de objetos Permission .
resourceTokens

Um objeto que contém tokens de recursos. As chaves do objeto são IDs de recurso e os valores são os tokens de recurso.
tokenProvider

Uma função fornecida pelo usuário para resolver tokens de autorização de cabeçalho. Permite que os usuários gerem seus próprios tokens de autenticação, potencialmente usando um serviço separado
userAgentSuffix

Uma cadeia de caracteres personalizada para acrescentar ao agente de usuário do SDK padrão.

Detalhes da propriedade

aadCredentials

Token do AAD de @azure/identity Obter um objeto de credencial criando um @azure/identity objeto de credencial Usaremos seu objeto de credencial e uma URL de escopo (seu ponto de extremidade cosmos db) para autenticar solicitações no Cosmos

aadCredentials?: TokenCredential

Valor da propriedade

TokenCredential

agent

Um agente http(s) personalizado opcional a ser usado em enironments no NodeJS Use um agente como https://github.com/TooTallNate/node-proxy-agent se você precisa se conectar ao Cosmos por meio de um proxy

agent?: Agent

Valor da propriedade

Agent

connectionPolicy

Uma instância da classe ConnectionPolicy . Esse parâmetro é opcional e a connectionPolicy padrão será usada se for omitida.

connectionPolicy?: ConnectionPolicy

Valor da propriedade

ConnectionPolicy

consistencyLevel

Um parâmetro opcional que representa o nível de consistência. Ele pode obter qualquer valor de ConsistencyLevel.

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

Valor da propriedade

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

defaultHeaders 

defaultHeaders?: CosmosHeaders_2

Valor da propriedade

CosmosHeaders_2

diagnosticLevel 

diagnosticLevel?: CosmosDbDiagnosticLevel

Valor da propriedade

CosmosDbDiagnosticLevel

endpoint

O ponto de extremidade de serviço a ser usado para criar o cliente.

endpoint: string

Valor da propriedade

string

key

A chave mestra ou somente leitura da conta

key?: string

Valor da propriedade

string

permissionFeed

Uma matriz de objetos Permission .

permissionFeed?: PermissionDefinition[]

Valor da propriedade

PermissionDefinition[]

resourceTokens

Um objeto que contém tokens de recursos. As chaves do objeto são IDs de recurso e os valores são os tokens de recurso.

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

Valor da propriedade

{[resourcePath: string]: string}

tokenProvider

Uma função fornecida pelo usuário para resolver tokens de autorização de cabeçalho. Permite que os usuários gerem seus próprios tokens de autenticação, potencialmente usando um serviço separado

tokenProvider?: TokenProvider

Valor da propriedade

TokenProvider

userAgentSuffix

Uma cadeia de caracteres personalizada para acrescentar ao agente de usuário do SDK padrão.

userAgentSuffix?: string

Valor da propriedade

string