CosmosClientOptions interface

Pacchetto:

@azure/cosmos

Proprietà

aadCredentials	Token AAD da @azure/identity Ottenere un oggetto credenziale creando un oggetto credenziali @azure/identity Verrà quindi usato l'oggetto credenziali e un URL di ambito (l'endpoint cosmos db) per autenticare le richieste a Cosmos
agent	Un agente http(s) personalizzato opzionale da utilizzare negli ambienti NodeJS Utilizzare un agente, ad esempio https://github.com/TooTallNate/node-proxy-agent se è necessario connettersi a Cosmos tramite un proxy
clientEncryptionOptions	I criteri di crittografia per le operazioni che coinvolgono la crittografia devono essere impostati sul client se si utilizza la crittografia lato client Vedere ClientEncryptionOptions
connectionPolicy	Istanza di classe ConnectionPolicy. Questo parametro è facoltativo e la proprietà connectionPolicy predefinita verrà usata se omessa.
connectionString	Parametro facoltativo che rappresenta la stringa di connessione. La stringa di connessione al database è disponibile nel portale di Azure.
consistencyLevel	Parametro facoltativo che rappresenta il livello di coerenza. Può accettare qualsiasi valore da ConsistencyLevel.
defaultHeaders
diagnosticLevel
endpoint	Endpoint del servizio da usare per creare il client.
httpClient	Forma facoltativa di HttpClient personalizzata per personalizzare il modo in cui le richieste vengono effettuate dalla pipeline HTTP. Per informazioni dettagliate su come implementare questa interfaccia, vedere @azure/core-rest-pipeline.
key	Chiave master o readonly dell'account
permissionFeed	Matrice di oggetti Permission.
resourceTokens	Oggetto che contiene token di risorse. Le chiavi per l'oggetto sono ID risorsa e i valori sono i token di risorsa.
throughputBucket	Parametro facoltativo per impostare il numero di bucket di velocità effettiva. Questo valore può essere sottoposto a override a livello di richiesta Per altre informazioni, vedere Bucket della velocità effettiva di Cosmos DB.
tokenProvider	Funzione fornita dall'utente per la risoluzione dei token di autorizzazione dell'intestazione. Consente agli utenti di generare i propri token di autenticazione, potenzialmente usando un servizio separato
userAgentSuffix	Stringa personalizzata da aggiungere all'agente utente SDK predefinito.

Dettagli proprietà

aadCredentials

Token AAD da @azure/identity Ottenere un oggetto credenziale creando un oggetto credenziali @azure/identity Verrà quindi usato l'oggetto credenziali e un URL di ambito (l'endpoint cosmos db) per autenticare le richieste a Cosmos

aadCredentials?: TokenCredential

Valore della proprietà

TokenCredential

agent

Un agente http(s) personalizzato opzionale da utilizzare negli ambienti NodeJS Utilizzare un agente, ad esempio https://github.com/TooTallNate/node-proxy-agent se è necessario connettersi a Cosmos tramite un proxy

agent?: Agent

Valore della proprietà

Agent

clientEncryptionOptions

I criteri di crittografia per le operazioni che coinvolgono la crittografia devono essere impostati sul client se si utilizza la crittografia lato client

Vedere ClientEncryptionOptions

clientEncryptionOptions?: ClientEncryptionOptions

Valore della proprietà

ClientEncryptionOptions

connectionPolicy

Istanza di classe ConnectionPolicy. Questo parametro è facoltativo e la proprietà connectionPolicy predefinita verrà usata se omessa.

connectionPolicy?: ConnectionPolicy

Valore della proprietà

ConnectionPolicy

connectionString

Parametro facoltativo che rappresenta la stringa di connessione. La stringa di connessione al database è disponibile nel portale di Azure.

connectionString?: string

Valore della proprietà

string

consistencyLevel

Parametro facoltativo che rappresenta il livello di coerenza. Può accettare qualsiasi valore da ConsistencyLevel.

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

Valore della proprietà

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

defaultHeaders

defaultHeaders?: CosmosHeaders

Valore della proprietà

CosmosHeaders

diagnosticLevel

diagnosticLevel?: CosmosDbDiagnosticLevel

Valore della proprietà

CosmosDbDiagnosticLevel

endpoint

Endpoint del servizio da usare per creare il client.

endpoint?: string

Valore della proprietà

string

httpClient

Forma facoltativa di HttpClient personalizzata per personalizzare il modo in cui le richieste vengono effettuate dalla pipeline HTTP. Per informazioni dettagliate su come implementare questa interfaccia, vedere @azure/core-rest-pipeline.

httpClient?: HttpClient

Valore della proprietà

HttpClient

key

Chiave master o readonly dell'account

key?: string

Valore della proprietà

string

permissionFeed

Matrice di oggetti Permission.

permissionFeed?: PermissionDefinition[]

Valore della proprietà

PermissionDefinition[]

resourceTokens

Oggetto che contiene token di risorse. Le chiavi per l'oggetto sono ID risorsa e i valori sono i token di risorsa.

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

Valore della proprietà

{[resourcePath: string]: string}

throughputBucket

Parametro facoltativo per impostare il numero di bucket di velocità effettiva. Questo valore può essere sottoposto a override a livello di richiesta Per altre informazioni, vedere Bucket della velocità effettiva di Cosmos DB.

throughputBucket?: number

Valore della proprietà

number

tokenProvider

Funzione fornita dall'utente per la risoluzione dei token di autorizzazione dell'intestazione. Consente agli utenti di generare i propri token di autenticazione, potenzialmente usando un servizio separato

tokenProvider?: TokenProvider

Valore della proprietà

TokenProvider

userAgentSuffix

Stringa personalizzata da aggiungere all'agente utente SDK predefinito.

userAgentSuffix?: string

Valore della proprietà

string