@azure/cosmos package

Klassen

AbortError	Deze fout treedt op wanneer een asynchrone bewerking is afgebroken. Controleer op deze fout door te name testen of de eigenschap name van de fout overeenkomt met "AbortError". Voorbeeld const controller = new AbortController(); controller.abort(); try { doAsyncWork(controller.signal) } catch (e) { if (e.name === 'AbortError') { // handle abort error here. } }
ChangeFeedIterator	Biedt iterator voor wijzigingenfeed. Gebruik Items.changeFeed() om een exemplaar van de iterator op te halen.
ChangeFeedIteratorResponse	Eén antwoordpagina van de Azure Cosmos DB-wijzigingenfeed
ChangeFeedResponse	Eén antwoordpagina van de Azure Cosmos DB-wijzigingenfeed
ChangeFeedStartFrom	Basisklasse voor het starten van een ChangeFeedIterator.
ClientSideMetrics
Conflict	Gebruik om een bepaalde conflict op id te lezen of te verwijderen. Zie Conflicten om alle conflicten op te vragen of te lezen.
ConflictResponse
Conflicts	Gebruik om alle conflicten op te vragen of te lezen. Zie Conflict om een bepaald conflict op id te lezen of te verwijderen.
Container	Bewerkingen voor het lezen, vervangen of verwijderen van een specifieke, bestaande container op id. Zie Containers voor het maken van nieuwe containers en het lezen/opvragen van alle containers; gebruik .containers. Opmerking: al deze bewerkingen voeren aanroepen uit tegen een vast budget. U moet uw systeem zo ontwerpen dat deze aanroepen sublineair worden geschaald met uw toepassing. Roep container(id).read() bijvoorbeeld niet aan voor elke aanroep item.read() om ervoor te zorgen dat de container bestaat. Doe dit eenmaal bij het opstarten van de toepassing.
ContainerResponse	Antwoordobject voor containerbewerkingen
Containers	Bewerkingen voor het maken van nieuwe containers en het lezen/opvragen van alle containers Zie Container voor het lezen, vervangen of verwijderen van een bestaande container. gebruik .container(id). Opmerking: al deze bewerkingen voeren aanroepen uit tegen een vast budget. U moet uw systeem zo ontwerpen dat deze aanroepen sublineair worden geschaald met uw toepassing. Roep containers.readAll() bijvoorbeeld niet aan voor elke aanroep item.read() om ervoor te zorgen dat de container bestaat. Doe dit eenmaal bij het opstarten van de toepassing.
CosmosClient	Biedt een logische weergave aan de clientzijde van het Azure Cosmos DB-databaseaccount. Deze client wordt gebruikt voor het configureren en uitvoeren van aanvragen in de Azure Cosmos DB-databaseservice. Voorbeeld Een client instantiëren en een nieuwe database maken const client = new CosmosClient({endpoint: "<URL HERE>", auth: {masterKey: "<KEY HERE>"}}); await client.databases.create({id: "<datbase name here>"}); Voorbeeld Een client instantiëren met aangepast verbindingsbeleid const connectionPolicy = new ConnectionPolicy(); connectionPolicy.RequestTimeout = 10000; const client = new CosmosClient({ endpoint: "<URL HERE>", auth: {masterKey: "<KEY HERE>"}, connectionPolicy });
CosmosDiagnostics	Dit is een Cosmos Diagnostic-type dat verzamelde diagnostische gegevens bevat tijdens een clientbewerking. Ie. Item.read(), Container.create(). Het heeft drie leden : clientSideRequestStatistics lid bevat geaggregeerde diagnostische gegevens, waaronder - zoekacties voor metagegevens. Hier worden alle serveraanvragen, met uitzondering van de uiteindelijke beoogde resource, beschouwd als aanroepen van metagegevens. Dat wil zeggen voor item.read(id), als de client een server aanroep doet om eindpunten te detecteren, wordt deze beschouwd als aanroep van metagegevens. Pogingen eindpunten die zijn gecontacteerd. nettoladingstatistieken van aanvragen en antwoorden. gatewayStatistics: informatie die overeenkomt met de hoofdbewerking. Tijdens Item.read() kan de client bijvoorbeeld veel bewerkingen uitvoeren, zoals het opzoeken van metagegevens, enzovoort, maar gatewayStatistics vertegenwoordigt de diagnostische gegevens voor de werkelijke leesbewerking. diagnosticNode : is een structuur die lijkt op een structuur die gedetailleerde diagnostische gegevens vastlegt. Deze is standaard uitgeschakeld en is alleen bedoeld om te worden gebruikt voor foutopsporing in niet-productieomgevingen. Het soort details dat is vastgelegd in diagnosticNode wordt beheerd door CosmosDbDiagnosticLevel. CosmosDbDiagnosticLevel.info: is de standaardwaarde. Op dit niveau worden alleen clientSideRequestStatistics vastgelegd. Is bedoeld voor productieomgevingen. CosmosDbDiagnosticLevel.debug : legt diagnosticNode en clientConfig vast. Er worden geen nettoladingen van aanvragen en antwoorden vastgelegd. Is niet bedoeld om te worden gebruikt in een productieomgeving. CosmosDbDiagnosticLevel.debug-onveilig: naast gegevens die zijn vastgelegd in CosmosDbDiagnosticLevel.debug, worden ook nettoladingen van aanvragen en antwoorden vastgelegd. Is niet bedoeld om te worden gebruikt in een productieomgeving. clientConfig: legt informatie vast met betrekking tot de configuratie van de client tijdens de initialisatie.
Database	Bewerkingen voor het lezen of verwijderen van een bestaande database. Zie Databases voor het maken van nieuwe databases en het lezen/opvragen van alle databases. gebruik client.databases. Opmerking: al deze bewerkingen voeren aanroepen uit tegen een vast budget. U moet uw systeem zo ontwerpen dat deze aanroepen sublineair worden geschaald met uw toepassing. Roep database.read() bijvoorbeeld niet aan voor elke aanroep item.read() om ervoor te zorgen dat de database bestaat. Doe dit eenmaal bij het opstarten van de toepassing.
DatabaseAccount	Vertegenwoordigt een DatabaseAccount in de Azure Cosmos DB-databaseservice.
DatabaseResponse	Antwoordobject voor databasebewerkingen
Databases	Bewerkingen voor het maken van nieuwe databases en het lezen/opvragen van alle databases Zie Database voor het lezen of verwijderen van een bestaande database; gebruik client.database(id). Opmerking: al deze bewerkingen voeren aanroepen uit tegen een vast budget. U moet uw systeem zo ontwerpen dat deze aanroepen sublineair worden geschaald met uw toepassing. Roep databases.readAll() bijvoorbeeld niet aan voor elke aanroep item.read() om ervoor te zorgen dat de database bestaat. Doe dit eenmaal bij het opstarten van de toepassing.
ErrorResponse
FeedRange	Hiermee geeft u een feedbereik voor de wijzigingsfeed op.
FeedResponse
Item	Wordt gebruikt om bewerkingen uit te voeren op een specifiek item. Zie Items voor bewerkingen op alle items; zie container.items.
ItemResponse
Items	Bewerkingen voor het maken van nieuwe items en het lezen/opvragen van alle items Zie Item voor het lezen, vervangen of verwijderen van een bestaande container. gebruik .item(id).
Offer	Gebruik om een bestaande aanbieding te lezen of te vervangen door id. Zie Aanbiedingen om alle aanbiedingen op te vragen of te lezen.
OfferResponse
Offers	Gebruik om een query uit te voeren of alle aanbiedingen te lezen. Zie Aanbieding om een bestaande aanbieding te lezen of te vervangen door id.
PartitionKeyBuilder	Builder-klasse voor het bouwen van PartitionKey.
Permission	Gebruik om een bepaalde machtiging op id te lezen, te vervangen of te verwijderen. Zie Machtigingen voor het maken, upserten, opvragen of lezen van alle machtigingen.
PermissionResponse
Permissions	Gebruik om alle machtigingen te maken, te vervangen, op te vragen en te lezen. Zie Machtiging voor het lezen, vervangen of verwijderen van een specifieke machtiging op id.
QueryIterator	Vertegenwoordigt een QueryIterator-object, een implementatie van feed- of queryantwoorden die doorkruising en herhalen van het antwoord in de Azure Cosmos DB-databaseservice mogelijk maakt.
QueryMetrics
QueryPreparationTimes
ResourceResponse
RestError	Een aangepast fouttype voor mislukte pijplijnaanvragen.
RuntimeExecutionTimes
SasTokenProperties
Scripts
StoredProcedure	Bewerkingen voor het lezen, vervangen, verwijderen of uitvoeren van een specifieke, bestaande opgeslagen procedure op id. Voor bewerkingen voor het maken, lezen van alle of query's op opgeslagen procedures,
StoredProcedureResponse
StoredProcedures	Bewerkingen voor het maken, upserten of lezen/opvragen van alle opgeslagen procedures. Zie voor bewerkingen voor het lezen, vervangen, verwijderen of uitvoeren van een specifieke, bestaande opgeslagen procedure op id container.storedProcedure().
TimeoutError
Trigger	Bewerkingen voor het lezen, vervangen of verwijderen van een trigger. Gebruik container.triggers dit om alles te maken, te upsert, op te vragen of te lezen.
TriggerResponse
Triggers	Bewerkingen voor het maken, uitvoeren van upsert, query's uitvoeren en alle triggers lezen. Gebruik container.triggers om een trigger te lezen, te vervangen of te verwijderen.
User	Wordt gebruikt om gebruikers te lezen, te vervangen en te verwijderen. Daarnaast hebt u toegang tot de machtigingen voor een bepaalde gebruiker via user.permission en user.permissions. Zie Gebruikers om alles te maken, upsert, op te vragen of te lezen.
UserDefinedFunction	Wordt gebruikt voor het lezen, vervangen of verwijderen van een opgegeven door de gebruiker geweigerde functie op id. Zie UserDefinedFunction om alle door de gebruiker gedefinieerde functies te maken, upsert, query's uit te voeren en te lezen.
UserDefinedFunctionResponse
UserDefinedFunctions	Wordt gebruikt om alle door de gebruiker gedefinieerde functies te maken, upsert, op te vragen of te lezen. Zie UserDefinedFunction om een bepaalde door de gebruiker gedefinieerde functie op id te lezen, te vervangen of te verwijderen.
UserResponse
Users	Wordt gebruikt om alle gebruikers te maken, upsert, op te vragen en te lezen. Zie Gebruiker om een specifieke gebruiker te lezen, te vervangen of te verwijderen op id.

Interfaces

@azure/cosmos.Index

Agent
BulkOptions	Opties-object dat wordt gebruikt om bulkuitvoering te wijzigen. continueOnError (standaardwaarde: false) - Wordt de bulkuitvoering voortgezet wanneer een bewerking mislukt ** OPMERKING DIT WORDT STANDAARD INGESTELD OP TRUE IN de 4.0 RELEASE
ChangeFeedIteratorOptions	Hiermee geeft u opties voor de wijzigingenfeed op Als geen van deze opties is ingesteld, worden de wijzigingen vanaf nu voor de hele container gelezen.
ChangeFeedOptions	Hiermee geeft u opties voor de wijzigingenfeed op Sommige van deze opties bepalen waar en wanneer u wilt beginnen met lezen vanuit de wijzigingenfeed. De volgorde van prioriteit is: Voortzetting startTime startFromBeginning Als geen van deze opties is ingesteld, worden wijzigingen vanaf de eerste ChangeFeedIterator.fetchNext() aanroep gelezen.
ChangeFeedPullModelIterator	Gebruik Items.getChangeFeedIterator() om een iterator te retourneren die alle wijzigingen voor een partitiesleutel, feedbereik of een hele container kan herhalen.
ConflictDefinition
ConflictResolutionPolicy	Vertegenwoordigt de configuratie van het conflictoplossingsbeleid voor het opgeven van het oplossen van conflicten in het geval schrijfbewerkingen uit verschillende regio's leiden tot conflicten in documenten in de verzameling in de Azure Cosmos DB-service.
ConnectionPolicy	Vertegenwoordigt het verbindingsbeleid dat is gekoppeld aan een CosmosClient in de Azure Cosmos DB-databaseservice.
ContainerDefinition
ContainerRequest
CosmosClientOptions
CosmosHeaders
CreateOperationInput
DatabaseDefinition
DatabaseRequest
DeleteOperationInput
DiagnosticNode	Vertegenwoordigt een structuur die lijkt op een structuur, voor het vastleggen van diagnostische gegevens.
ErrorBody
FailedRequestAttemptDiagnostic	Dit type legt diagnostische informatie vast met betrekking tot een mislukte aanvraag voor de server-API.
FeedOptions	De feedopties en querymethoden.
GroupByAliasToAggregateType
IndexedPath
IndexingPolicy
ItemDefinition	Items in Cosmos DB zijn gewoon JSON-objecten. Met de meeste itembewerkingen kunt u uw eigen type opgeven dat de zeer eenvoudige ItemDefinition uitbreidt. U kunt geen gereserveerde sleutels gebruiken. U kunt de lijst met gereserveerde sleutels zien in <xref:ItemBody>
JSONArray
JSONObject
Location	Wordt gebruikt om de locaties op te geven die beschikbaar zijn, lezen is index 1 en schrijven is index 0.
MetadataLookUpDiagnostic	Dit type bevat diagnostische informatie met betrekking tot één aanvraag voor metagegevens naar de server.
OfferDefinition
OperationBase
OperationResponse
PartitionKeyDefinition
PartitionKeyRangePropertiesNames
PatchOperationInput
PermissionBody
PermissionDefinition
ReadOperationInput
ReplaceOperationInput
RequestOptions	Opties die kunnen worden opgegeven voor een aangevraagde die is uitgegeven aan de Azure Cosmos DB-servers.=
Resource
RetryOptions	Vertegenwoordigt het beleid voor opnieuw proberen dat is gekoppeld aan beperkte aanvragen in de Azure Cosmos DB-databaseservice.
SharedOptions	Opties die kunnen worden opgegeven voor een aangevraagde die is uitgegeven aan de Azure Cosmos DB-servers.=
SpatialIndex
SqlParameter	Vertegenwoordigt een parameter in een SQL-query met parameters, opgegeven in SqlQuerySpec
SqlQuerySpec	Vertegenwoordigt een SQL-query in de Azure Cosmos DB-service. Query's met invoer moeten worden geparameteriseerd om bescherming te bieden tegen SQL-injectie. Voorbeeld Sql-query met parameters const query: SqlQuerySpec = { query: "SELECT * FROM Families f where f.lastName = @lastName", parameters: [ {name: "@lastName", value: "Wakefield"} ] };
StoredProcedureDefinition
TriggerDefinition
UniqueKey	Interface voor één unieke sleutel die is doorgegeven als onderdeel van UniqueKeyPolicy
UniqueKeyPolicy	Interface voor het instellen van unieke sleutels bij het maken van een container
UpsertOperationInput
UserDefinedFunctionDefinition
UserDefinition

Type-aliassen

AggregateType
BulkOperationResponse
BulkPatchOperation
ClientConfigDiagnostic	Dit type bevat informatie met betrekking tot initialisatie van CosmosClient
ClientSideRequestStatistics	Dit is een verzamelingstype voor alle diagnostische gegevens aan de clientzijde.
CreateOperation
DeleteOperation
ExistingKeyOperation
GatewayStatistics
GroupByExpressions
JSONValue
MetadataLookUpDiagnostics	Dit type bevat diagnostische informatie met betrekking tot alle metagegevensaanvragen naar de server tijdens een CosmosDB-clientbewerking.
NonePartitionKeyType	Het geretourneerde object vertegenwoordigt een partitiesleutelwaarde waarmee u items kunt maken en openen zonder een waarde voor partitiesleutel
NullPartitionKeyType	Het geretourneerde object vertegenwoordigt een partitiesleutelwaarde waarmee items met een null-waarde voor de partitiesleutel kunnen worden gemaakt en geopend.
Operation
OperationInput
OperationWithItem
PartitionKey	PartitionKey van een container.
PatchOperation
PatchRequestBody
PrimitivePartitionKeyValue	Een primitieve partitiesleutelwaarde.
ReadOperation
RemoveOperation
ReplaceOperation
RetryDiagnostics	Dit type legt diagnostische gegevens vast met betrekking tot nieuwe pogingen tijdens een CosmosDB-clientbewerking.
TokenProvider
UpsertOperation

Enums

ConflictResolutionMode
ConnectionMode	Bepaalt het verbindingsgedrag van de CosmosClient. Houd er rekening mee dat we momenteel alleen de gatewaymodus ondersteunen.
ConsistencyLevel	Vertegenwoordigt de consistentieniveaus die worden ondersteund voor Azure Cosmos DB-clientbewerkingen. Het aangevraagde ConsistencyLevel moet overeenkomen of zwakker zijn dan het ingerichte voor het databaseaccount. Consistentieniveaus. Consistentieniveaus op volgorde van sterkte zijn Strong, BoundedStaleness, Session, Consistent Voorvoegsel en Uiteindelijk. Zie https://aka.ms/cosmos-consistency voor meer gedetailleerde documentatie over consistentieniveaus.
CosmosDbDiagnosticLevel	Diagnostisch niveau van Cosmos DB
DataType	Definieert een doelgegevenstype van een indexpadspecificatie in de Azure Cosmos DB-service.
GeospatialType
IndexKind	Hiermee geeft u de ondersteunde indextypen op.
IndexingMode	Hiermee geeft u de ondersteunde indexeringsmodi op.
MetadataLookUpType	Dit is een opsomming voor type metagegevenszoekacties mogelijk.
PartitionKeyDefinitionVersion	PartitionKey-definitieversie
PartitionKeyKind	Type PartitionKey, bijvoorbeeld Hash, MultiHash
PermissionMode	Opsomming voor waarden voor machtigingsmodus.
PriorityLevel	Vertegenwoordigt prioriteitsniveau dat is gekoppeld aan elke Azure Cosmos DB-clientaanvragen. Aanvragen met lage prioriteit worden altijd beperkt vóór aanvragen met hoge prioriteit. Standaard worden alle aanvragen beschouwd als aanvragen met hoge prioriteit. Zie https://aka.ms/CosmosDB/PriorityBasedExecution voor meer gedetailleerde documentatie over beperking op basis van prioriteit.
SpatialType
TriggerOperation	Opsomming voor waarden voor triggerbewerkingen. hiermee geeft u de bewerkingen op waarop een trigger moet worden uitgevoerd.
TriggerType	Opsomming voor triggertypewaarden. Hiermee geeft u het type van de trigger op.
UserDefinedFunctionType	Opsomming voor udf-typewaarden. Hiermee geeft u de typen door de gebruiker gedefinieerde functies op.

Functies

createAuthorizationSasToken(string, SasTokenProperties)

Experimenteel intern genereert alleen de nettolading die de machtigingsconfiguratie voor het SAS-token vertegenwoordigt.

Functiedetails

createAuthorizationSasToken(string, SasTokenProperties)

Experimenteel intern genereert alleen de nettolading die de machtigingsconfiguratie voor het SAS-token vertegenwoordigt.

function createAuthorizationSasToken(masterKey: string, sasTokenProperties: SasTokenProperties): Promise<string>

Parameters

masterKey

string

sasTokenProperties

SasTokenProperties

Retouren

Promise<string>