Compartir a través de

CosmosClientOptions interface

  • Referencia
Paquete:
@azure/cosmos

Propiedades

aadCredentials

Token de AAD de @azure/identity Obtener un objeto de credencial mediante la creación de un objeto de credencial de @azure/identity Usaremos el objeto de credencial y una dirección URL de ámbito (el punto de conexión de Cosmos db) para autenticar las solicitudes en Cosmos.
agent

Un agente http(s) personalizado opcional que se usará en los entornos de NodeJS Use un agente como https://github.com/TooTallNate/node-proxy-agent si necesita conectarse a Cosmos a través de un proxy
connectionPolicy

Instancia de clase de ConnectionPolicy. Este parámetro es opcional y se usará connectionPolicy predeterminado si se omite.
consistencyLevel

Parámetro opcional que representa el nivel de coherencia. Puede tomar cualquier valor de ConsistencyLevel.
defaultHeaders
diagnosticLevel
endpoint

Punto de conexión de servicio que se va a usar para crear el cliente.
httpClient

Una forma de HttpClient personalizada opcional para personalizar cómo realizan las solicitudes la canalización HTTP. Consulte @azure/core-rest-pipeline para obtener más información sobre cómo implementar esta interfaz.
key

Clave maestra o de solo lectura de la cuenta
permissionFeed

Matriz de objetos Permission.
resourceTokens

Objeto que contiene tokens de recursos. Las claves del objeto son identificadores de recurso y los valores son los tokens de recursos.
tokenProvider

Función proporcionada por el usuario para resolver tokens de autorización de encabezado. Permite a los usuarios generar sus propios tokens de autenticación, posiblemente mediante un servicio independiente.
userAgentSuffix

Cadena personalizada que se va a anexar al agente de usuario del SDK predeterminado.

Detalles de las propiedades

aadCredentials

Token de AAD de @azure/identity Obtener un objeto de credencial mediante la creación de un objeto de credencial de @azure/identity Usaremos el objeto de credencial y una dirección URL de ámbito (el punto de conexión de Cosmos db) para autenticar las solicitudes en Cosmos.

aadCredentials?: TokenCredential

Valor de propiedad

TokenCredential

agent

Un agente http(s) personalizado opcional que se usará en los entornos de NodeJS Use un agente como https://github.com/TooTallNate/node-proxy-agent si necesita conectarse a Cosmos a través de un proxy

agent?: Agent

Valor de propiedad

Agent

connectionPolicy

Instancia de clase de ConnectionPolicy. Este parámetro es opcional y se usará connectionPolicy predeterminado si se omite.

connectionPolicy?: ConnectionPolicy

Valor de propiedad

ConnectionPolicy

consistencyLevel

Parámetro opcional que representa el nivel de coherencia. Puede tomar cualquier valor de ConsistencyLevel.

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

Valor de propiedad

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

defaultHeaders 

defaultHeaders?: CosmosHeaders_2

Valor de propiedad

CosmosHeaders_2

diagnosticLevel 

diagnosticLevel?: CosmosDbDiagnosticLevel

Valor de propiedad

CosmosDbDiagnosticLevel

endpoint

Punto de conexión de servicio que se va a usar para crear el cliente.

endpoint: string

Valor de propiedad

string

httpClient

Una forma de HttpClient personalizada opcional para personalizar cómo realizan las solicitudes la canalización HTTP. Consulte @azure/core-rest-pipeline para obtener más información sobre cómo implementar esta interfaz.

httpClient?: HttpClient

Valor de propiedad

HttpClient

key

Clave maestra o de solo lectura de la cuenta

key?: string

Valor de propiedad

string

permissionFeed

Matriz de objetos Permission.

permissionFeed?: PermissionDefinition[]

Valor de propiedad

PermissionDefinition[]

resourceTokens

Objeto que contiene tokens de recursos. Las claves del objeto son identificadores de recurso y los valores son los tokens de recursos.

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

Valor de propiedad

{[resourcePath: string]: string}

tokenProvider

Función proporcionada por el usuario para resolver tokens de autorización de encabezado. Permite a los usuarios generar sus propios tokens de autenticación, posiblemente mediante un servicio independiente.

tokenProvider?: TokenProvider

Valor de propiedad

TokenProvider

userAgentSuffix

Cadena personalizada que se va a anexar al agente de usuario del SDK predeterminado.

userAgentSuffix?: string

Valor de propiedad

string