CosmosClientOptions interface

Pacote:

@azure/cosmos

Propriedades

aadCredentials	Token do AAD de @azure/identity Obter um objeto de credencial criando um objeto de credencial @azure/identity 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 ambientes NodeJS Use um agente como https://github.com/TooTallNate/node-proxy-agent se você precisasse se conectar ao Cosmos por meio de um proxy
clientEncryptionOptions	A política de criptografia para operações que envolvem criptografia deve ser definida no cliente se estiver usando a criptografia do lado do cliente Consulte ClientEncryptionOptions
connectionPolicy	Uma instância da classe ConnectionPolicy. Esse parâmetro é opcional e a connectionPolicy padrão será usada se omitida.
connectionString	Um parâmetro opcional que representa a cadeia de conexão. Sua cadeia de conexão de banco de dados pode ser encontrada no Portal do Azure.
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.
httpClient	Uma forma de HttpClient personalizada opcional para personalizar como as solicitações são feitas pelo pipeline HTTP. Consulte @azure/core-rest-pipeline para obter detalhes sobre como implementar essa interface.
key	O mestre da conta ou a chave somente leitura
permissionFeed	Uma matriz de objetos de Permissão.
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.
throughputBucket	Um parâmetro opcional para definir o número do bucket de taxa de transferência. Esse valor pode ser substituído no nível da solicitação Para obter mais informações, visite Bucket de taxa de transferência do Cosmos DB.
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 a ser acrescentada 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 objeto de credencial @azure/identity 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 ambientes NodeJS Use um agente como https://github.com/TooTallNate/node-proxy-agent se você precisasse se conectar ao Cosmos por meio de um proxy

agent?: Agent

Valor da propriedade

Agent

clientEncryptionOptions

A política de criptografia para operações que envolvem criptografia deve ser definida no cliente se estiver usando a criptografia do lado do cliente

Consulte ClientEncryptionOptions

clientEncryptionOptions?: ClientEncryptionOptions

Valor da propriedade

ClientEncryptionOptions

connectionPolicy

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

connectionPolicy?: ConnectionPolicy

Valor da propriedade

ConnectionPolicy

connectionString

Um parâmetro opcional que representa a cadeia de conexão. Sua cadeia de conexão de banco de dados pode ser encontrada no Portal do Azure.

connectionString?: string

Valor da propriedade

string

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

Valor da propriedade

CosmosHeaders

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

httpClient

Uma forma de HttpClient personalizada opcional para personalizar como as solicitações são feitas pelo pipeline HTTP. Consulte @azure/core-rest-pipeline para obter detalhes sobre como implementar essa interface.

httpClient?: HttpClient

Valor da propriedade

HttpClient

key

O mestre da conta ou a chave somente leitura

key?: string

Valor da propriedade

string

permissionFeed

Uma matriz de objetos de Permissão.

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}

throughputBucket

Um parâmetro opcional para definir o número do bucket de taxa de transferência. Esse valor pode ser substituído no nível da solicitação Para obter mais informações, visite Bucket de taxa de transferência do Cosmos DB.

throughputBucket?: number

Valor da propriedade

number

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 a ser acrescentada ao agente de usuário do SDK padrão.

userAgentSuffix?: string

Valor da propriedade

string