CosmosClientOptions interface
Egenskaper
| aad |
AAD-token från |
| agent | En valfri anpassad http-agent som ska användas i NodeJS-enronment Använd en agent, till exempel https://github.com/TooTallNate/node-proxy-agent om du behöver ansluta till Cosmos via en proxyserver |
| connection |
En instans av klassen ConnectionPolicy. Den här parametern är valfri och standardanslutningpolicyn används om den utelämnas. |
| consistency |
En valfri parameter som representerar konsekvensnivån. Det kan ta valfritt värde från ConsistencyLevel. |
| default |
|
| diagnostic |
|
| endpoint | Tjänstslutpunkten som ska användas för att skapa klienten. |
| http |
En valfri anpassad |
| key | Kontohuvudnyckeln eller skrivskyddad nyckel |
| permission |
En matris med behörighet objekt. |
| resource |
Ett objekt som innehåller resurstoken. Nycklar för objektet är resurs-ID:er och värden är resurstoken. |
| token |
En användarangiven funktion för att matcha auktoriseringstoken för huvuden. Tillåter användare att generera sina egna autentiseringstoken, eventuellt med hjälp av en separat tjänst |
| user |
En anpassad sträng som ska läggas till i standard-SDK-användaragenten. |
Egenskapsinformation
aadCredentials
AAD-token från @azure/identity Hämta ett autentiseringsobjekt genom att skapa ett @azure/identity autentiseringsobjekt Vi använder sedan ditt autentiseringsobjekt och en omfångs-URL (cosmos db-slutpunkten) för att autentisera begäranden till Cosmos
aadCredentials?: TokenCredentialEgenskapsvärde
agent
En valfri anpassad http-agent som ska användas i NodeJS-enronment Använd en agent, till exempel https://github.com/TooTallNate/node-proxy-agent om du behöver ansluta till Cosmos via en proxyserver
agent?: AgentEgenskapsvärde
connectionPolicy
En instans av klassen ConnectionPolicy. Den här parametern är valfri och standardanslutningpolicyn används om den utelämnas.
connectionPolicy?: ConnectionPolicyEgenskapsvärde
consistencyLevel
En valfri parameter som representerar konsekvensnivån. Det kan ta valfritt värde från ConsistencyLevel.
consistencyLevel?: "Strong" | "BoundedStaleness" | "Session" | "Eventual" | "ConsistentPrefix"Egenskapsvärde
"Strong" | "BoundedStaleness" | "Session" | "Eventual" | "ConsistentPrefix"
defaultHeaders
defaultHeaders?: CosmosHeaders_2Egenskapsvärde
CosmosHeaders_2
diagnosticLevel
endpoint
Tjänstslutpunkten som ska användas för att skapa klienten.
endpoint: stringEgenskapsvärde
string
httpClient
En valfri anpassad HttpClient form för att anpassa hur begäranden görs av HTTP-pipelinen.
Mer information om hur du implementerar det här gränssnittet finns i @azure/core-rest-pipeline.
httpClient?: HttpClientEgenskapsvärde
key
Kontohuvudnyckeln eller skrivskyddad nyckel
key?: stringEgenskapsvärde
string
permissionFeed
resourceTokens
Ett objekt som innehåller resurstoken. Nycklar för objektet är resurs-ID:er och värden är resurstoken.
resourceTokens?: {[resourcePath: string]: string}Egenskapsvärde
{[resourcePath: string]: string}
tokenProvider
En användarangiven funktion för att matcha auktoriseringstoken för huvuden. Tillåter användare att generera sina egna autentiseringstoken, eventuellt med hjälp av en separat tjänst
tokenProvider?: TokenProviderEgenskapsvärde
userAgentSuffix
En anpassad sträng som ska läggas till i standard-SDK-användaragenten.
userAgentSuffix?: stringEgenskapsvärde
string