CosmosClientOptions interface
Eigenschappen
aad |
AAD-token van |
agent | Een optionele aangepaste http(s)-agent die moet worden gebruikt in NodeJS-omgevingen Gebruik een agent, bijvoorbeeld https://github.com/TooTallNate/node-proxy-agent als u via een proxy verbinding moet maken met Cosmos |
client |
Versleutelingsbeleid voor bewerkingen met versleuteling moet worden ingesteld op de client als versleuteling aan de clientzijde wordt gebruikt |
connection |
Een exemplaar van ConnectionPolicy--klasse. Deze parameter is optioneel en de standaard connectionPolicy wordt gebruikt als u deze weglaat. |
connection |
Een optionele parameter die de verbindingsreeks vertegenwoordigt. De verbindingsreeks van uw database is te vinden in de Azure Portal. |
consistency |
Een optionele parameter die het consistentieniveau vertegenwoordigt. Het kan elke waarde van ConsistencyLevel. |
default |
|
diagnostic |
|
endpoint | Het service-eindpunt dat moet worden gebruikt om de client te maken. |
http |
Een optionele aangepaste |
key | De accounthoofd- of leessleutel |
permission |
Een matrix van Permission-objecten. |
resource |
Een object dat resourcestokens bevat. Sleutels voor het object zijn resource-id's en waarden zijn de resourcetokens. |
throughput |
Een optionele parameter om het aantal doorvoerbakken in te stellen. Deze waarde kan worden overschreven op aanvraagniveau Ga voor meer informatie naar Cosmos DB-doorvoer Bucketing. |
token |
Een door de gebruiker opgegeven functie voor het omzetten van headerautorisatietokens. Hiermee kunnen gebruikers hun eigen verificatietokens genereren, mogelijk met behulp van een afzonderlijke service |
user |
Een aangepaste tekenreeks die moet worden toegevoegd aan de standaard-SDK-gebruikersagent. |
Eigenschapdetails
aadCredentials
AAD-token van @azure/identity
Een referentieobject verkrijgen door een @azure/identity
referentieobject te maken. Vervolgens gebruiken we uw referentieobject en een bereik-URL (uw cosmos db-eindpunt) om aanvragen voor Cosmos te verifiëren
aadCredentials?: TokenCredential
Waarde van eigenschap
agent
Een optionele aangepaste http(s)-agent die moet worden gebruikt in NodeJS-omgevingen Gebruik een agent, bijvoorbeeld https://github.com/TooTallNate/node-proxy-agent als u via een proxy verbinding moet maken met Cosmos
agent?: Agent
Waarde van eigenschap
clientEncryptionOptions
Versleutelingsbeleid voor bewerkingen met versleuteling moet worden ingesteld op de client als versleuteling aan de clientzijde wordt gebruikt
clientEncryptionOptions?: ClientEncryptionOptions
Waarde van eigenschap
connectionPolicy
Een exemplaar van ConnectionPolicy--klasse. Deze parameter is optioneel en de standaard connectionPolicy wordt gebruikt als u deze weglaat.
connectionPolicy?: ConnectionPolicy
Waarde van eigenschap
connectionString
Een optionele parameter die de verbindingsreeks vertegenwoordigt. De verbindingsreeks van uw database is te vinden in de Azure Portal.
connectionString?: string
Waarde van eigenschap
string
consistencyLevel
Een optionele parameter die het consistentieniveau vertegenwoordigt. Het kan elke waarde van ConsistencyLevel.
consistencyLevel?: "Strong" | "BoundedStaleness" | "Session" | "Eventual" | "ConsistentPrefix"
Waarde van eigenschap
"Strong" | "BoundedStaleness" | "Session" | "Eventual" | "ConsistentPrefix"
defaultHeaders
defaultHeaders?: CosmosHeaders
Waarde van eigenschap
CosmosHeaders
diagnosticLevel
endpoint
Het service-eindpunt dat moet worden gebruikt om de client te maken.
endpoint?: string
Waarde van eigenschap
string
httpClient
Een optionele aangepaste HttpClient
shape om aan te passen hoe aanvragen worden gedaan door de HTTP-pijplijn.
Zie @azure/core-rest-pipeline
voor meer informatie over het implementeren van deze interface.
httpClient?: HttpClient
Waarde van eigenschap
key
De accounthoofd- of leessleutel
key?: string
Waarde van eigenschap
string
permissionFeed
resourceTokens
Een object dat resourcestokens bevat. Sleutels voor het object zijn resource-id's en waarden zijn de resourcetokens.
resourceTokens?: {[resourcePath: string]: string}
Waarde van eigenschap
{[resourcePath: string]: string}
throughputBucket
Een optionele parameter om het aantal doorvoerbakken in te stellen. Deze waarde kan worden overschreven op aanvraagniveau Ga voor meer informatie naar Cosmos DB-doorvoer Bucketing.
throughputBucket?: number
Waarde van eigenschap
number
tokenProvider
Een door de gebruiker opgegeven functie voor het omzetten van headerautorisatietokens. Hiermee kunnen gebruikers hun eigen verificatietokens genereren, mogelijk met behulp van een afzonderlijke service
tokenProvider?: TokenProvider
Waarde van eigenschap
userAgentSuffix
Een aangepaste tekenreeks die moet worden toegevoegd aan de standaard-SDK-gebruikersagent.
userAgentSuffix?: string
Waarde van eigenschap
string