CosmosClientOptions interface

Pacote:

@azure/cosmos

Propriedades

aadCredentials	Token AAD do @azure/identity Obter um objeto de credencial criando um objeto de credencial @azure/identity Em seguida, usaremos seu objeto de credencial e uma URL de escopo (seu ponto de extremidade cosmos db) para autenticar solicitações para o Cosmos
agent	Um agente http(s) personalizado opcional para ser usado em ambientes NodeJS Use um agente, como https://github.com/TooTallNate/node-proxy-agent se você precisar 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 criptografia do lado do cliente Consulte ClientEncryptionOptions
connectionPolicy	Uma instância de ConnectionPolicy classe. Este parâmetro é opcional e o padrão connectionPolicy será usado se omitido.
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 tomar qualquer valor de ConsistencyLevel.
defaultHeaders
diagnosticLevel
endpoint	O ponto de extremidade do 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	A chave mestre de conta ou somente leitura
permissionFeed	Uma matriz de Permission objetos.
resourceTokens	Um objeto que contém tokens de recursos. As chaves para o 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 Bucketing 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 para acrescentar ao agente de usuário padrão do SDK.

Detalhes de Propriedade

aadCredentials

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

aadCredentials?: TokenCredential

Valor de Propriedade

TokenCredential

agent

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

agent?: Agent

Valor de Propriedade

Agent

clientEncryptionOptions

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

Consulte ClientEncryptionOptions

clientEncryptionOptions?: ClientEncryptionOptions

Valor de Propriedade

ClientEncryptionOptions

connectionPolicy

Uma instância de ConnectionPolicy classe. Este parâmetro é opcional e o padrão connectionPolicy será usado se omitido.

connectionPolicy?: ConnectionPolicy

Valor de 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 de Propriedade

string

consistencyLevel

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

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

Valor de Propriedade

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

defaultHeaders

defaultHeaders?: CosmosHeaders

Valor de Propriedade

CosmosHeaders

diagnosticLevel

diagnosticLevel?: CosmosDbDiagnosticLevel

Valor de Propriedade

CosmosDbDiagnosticLevel

endpoint

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

endpoint?: string

Valor de 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 de Propriedade

HttpClient

key

A chave mestre de conta ou somente leitura

key?: string

Valor de Propriedade

string

permissionFeed

Uma matriz de Permission objetos.

permissionFeed?: PermissionDefinition[]

Valor de Propriedade

PermissionDefinition[]

resourceTokens

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

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

Valor de 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 Bucketing de taxa de transferência do Cosmos DB.

throughputBucket?: number

Valor de 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 de Propriedade

TokenProvider

userAgentSuffix

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

userAgentSuffix?: string

Valor de Propriedade

string