Restorable Sql Containers - List
Visa händelseflödet för alla mutationer som görs på alla Azure Cosmos DB SQL-containrar under en specifik databas. Detta hjälper till i scenariot där containern togs bort av misstag. Det här API:et kräver behörigheten Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlContainers?api-version=2024-11-15
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlContainers?api-version=2024-11-15&restorableSqlDatabaseRid={restorableSqlDatabaseRid}&startTime={startTime}&endTime={endTime}
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
instance
|
path | True |
string |
InstanceId-GUID för ett återställningsbart databaskonto. |
location
|
path | True |
string |
Cosmos DB-region med blanksteg mellan ord och varje ord med versaler. |
subscription
|
path | True |
string |
ID för målprenumerationen. |
api-version
|
query | True |
string |
DEN API-version som ska användas för den här åtgärden. |
end
|
query |
string |
Återställningsbar sluttid för Sql-containrar för händelsefeed. |
|
restorable
|
query |
string |
Resurs-ID för SQL-databasen. |
|
start
|
query |
string |
Starttid för återställningsbara Sql-containrar för händelsefeed. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Åtgärden har slutförts. |
|
Other Status Codes |
Felsvar som beskriver varför åtgärden misslyckades. |
Säkerhet
azure_auth
Azure Active Directory OAuth2 Flow
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
Name | Description |
---|---|
user_impersonation | Personifiera ditt användarkonto |
Exempel
CosmosDBRestorableSqlContainerList
Exempelbegäran
GET https://management.azure.com/subscriptions/subid/providers/Microsoft.DocumentDB/locations/WestUS/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableSqlContainers?api-version=2024-11-15&restorableSqlDatabaseRid=3fu-hg==
Exempelsvar
{
"value": [
{
"id": "/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableSqlContainers/79609a98-3394-41f8-911f-cfab0c075c86",
"type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlContainers",
"name": "79609a98-3394-41f8-911f-cfab0c075c86",
"properties": {
"resource": {
"_rid": "zAyAPQAAAA==",
"eventTimestamp": "2020-10-13T04:56:42Z",
"ownerId": "Container1",
"ownerResourceId": "V18LoLrv-qA=",
"operationType": "Create",
"canUndelete": "invalid",
"container": {
"id": "Container1",
"indexingPolicy": {
"indexingMode": "consistent",
"automatic": true,
"includedPaths": [
{
"path": "/*"
},
{
"path": "/\"_ts\"/?"
}
],
"excludedPaths": [
{
"path": "/\"_etag\"/?"
}
]
},
"conflictResolutionPolicy": {
"mode": "LastWriterWins",
"conflictResolutionPath": "/_ts",
"conflictResolutionProcedure": ""
},
"_rid": "V18LoLrv-qA=",
"_self": "dbs/V18LoA==/colls/V18LoLrv-qA=/",
"_etag": "\"00003e00-0000-0700-0000-5f85338a0000\""
}
}
}
},
{
"id": "/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableSqlContainers/e85298a1-c631-4726-825e-a7ca092e9098",
"type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlContainers",
"name": "e85298a1-c631-4726-825e-a7ca092e9098",
"properties": {
"resource": {
"_rid": "PrArcgAAAA==",
"eventTimestamp": "2020-10-13T05:03:27Z",
"ownerId": "Container1",
"ownerResourceId": "V18LoLrv-qA=",
"operationType": "Replace",
"canUndelete": "invalid",
"container": {
"id": "Container1",
"indexingPolicy": {
"indexingMode": "consistent",
"automatic": true,
"includedPaths": [
{
"path": "/*"
},
{
"path": "/\"_ts\"/?"
}
],
"excludedPaths": [
{
"path": "/\"_etag\"/?"
}
]
},
"defaultTtl": 12345,
"conflictResolutionPolicy": {
"mode": "LastWriterWins",
"conflictResolutionPath": "/_ts",
"conflictResolutionProcedure": ""
},
"_rid": "V18LoLrv-qA=",
"_self": "dbs/V18LoA==/colls/V18LoLrv-qA=/",
"_etag": "\"00004400-0000-0700-0000-5f85351f0000\""
}
}
}
}
]
}
Definitioner
Name | Description |
---|---|
Client |
. |
Client |
Cosmos DB-klientkrypteringsprincip. |
Cloud |
Ett felsvar från tjänsten. |
Composite |
|
Composite |
Sorteringsordning för sammansatta sökvägar. |
Computed |
Definitionen av en beräknad egenskap |
Conflict |
Anger konfliktlösningsläget. |
Conflict |
Konfliktlösningsprincipen för containern. |
Container |
Resursobjekt för Cosmos DB SQL-container |
Container |
Konfigurationen av partitionsnyckeln som ska användas för att partitionera data i flera partitioner |
Create |
Uppräkning för att ange läget för kontoskapande. |
Data |
Den datatyp som indexeringsbeteendet tillämpas på. |
Distance |
Den avståndsfunktion som ska användas för avståndsberäkning mellan vektorer. |
Error |
Felsvar. |
Excluded |
|
Included |
Sökvägarna som ingår i indexeringen |
Indexes |
Indexen för sökvägen. |
Indexing |
Anger indexeringsläget. |
Indexing |
Cosmos DB-indexeringsprincip |
Index |
Anger typen av index. |
Operation |
Räkna upp för att ange händelsens åtgärdstyp. |
Partition |
Anger vilken typ av algoritm som används för partitionering. För MultiHash stöds flera partitionsnycklar (upp till högst tre) för containerskapande |
Resource |
Resursen för en Azure Cosmos DB SQL-containerhändelse |
Resource |
Parametrar som anger information om återställningen. |
Restorable |
En Azure Cosmos DB SQL-containerhändelse |
Restorable |
Svar på liståtgärd som innehåller SQL-containerhändelserna och deras egenskaper. |
Spatial |
|
Spatial |
Anger den rumsliga typen av index. |
Unique |
Den unika nyckeln för som framtvingar unikhetsbegränsning för dokument i samlingen i Azure Cosmos DB-tjänsten. |
Unique |
Den unika nyckelprincipkonfigurationen för att ange unika begränsningar för dokument i samlingen i Azure Cosmos DB-tjänsten. |
Vector |
Anger datatypen för vektor. |
Vector |
Representerar en vektorbäddning. En vektorbäddning används för att definiera ett vektorfält i dokumenten. |
Vector |
Inbäddningsprincip för Cosmos DB-vektor |
Vector |
|
Vector |
Indextypen för vektorn. För närvarande stöds flat, diskANN och quantizedFlat. |
ClientEncryptionIncludedPath
.
Name | Typ | Description |
---|---|---|
clientEncryptionKeyId |
string |
Identifieraren för den klientkrypteringsnyckel som ska användas för att kryptera sökvägen. |
encryptionAlgorithm |
string |
Krypteringsalgoritmen som ska användas. T.ex. - AEAD_AES_256_CBC_HMAC_SHA256. |
encryptionType |
string |
Vilken typ av kryptering som ska utföras. T.ex. deterministisk, randomiserad. |
path |
string |
Sökväg som måste krypteras. |
ClientEncryptionPolicy
Cosmos DB-klientkrypteringsprincip.
Name | Typ | Description |
---|---|---|
includedPaths |
Sökvägar för objektet som behöver kryptering tillsammans med sökvägsspecifika inställningar. |
|
policyFormatVersion |
integer |
Version av definitionen av klientkrypteringsprincipen. Versioner som stöds är 1 och 2. Version 2 stöder ID- och partitionsnyckelsökvägskryptering. |
CloudError
Ett felsvar från tjänsten.
Name | Typ | Description |
---|---|---|
error |
Felsvar. |
CompositePath
Name | Typ | Description |
---|---|---|
order |
Sorteringsordning för sammansatta sökvägar. |
|
path |
string |
Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) |
CompositePathSortOrder
Sorteringsordning för sammansatta sökvägar.
Name | Typ | Description |
---|---|---|
ascending |
string |
|
descending |
string |
ComputedProperty
Definitionen av en beräknad egenskap
Name | Typ | Description |
---|---|---|
name |
string |
Namnet på en beräknad egenskap, till exempel " cp_lowerName" |
query |
string |
Frågan som utvärderar värdet för den beräknade egenskapen, till exempel " SELECT VALUE LOWER(c.name) FROM c" |
ConflictResolutionMode
Anger konfliktlösningsläget.
Name | Typ | Description |
---|---|---|
Custom |
string |
|
LastWriterWins |
string |
ConflictResolutionPolicy
Konfliktlösningsprincipen för containern.
Name | Typ | Standardvärde | Description |
---|---|---|---|
conflictResolutionPath |
string |
Konfliktlösningssökvägen när det gäller LastWriterWins-läge. |
|
conflictResolutionProcedure |
string |
Proceduren för att lösa konflikter när det gäller anpassat läge. |
|
mode | LastWriterWins |
Anger konfliktlösningsläget. |
Container
Resursobjekt för Cosmos DB SQL-container
Name | Typ | Standardvärde | Description |
---|---|---|---|
_etag |
string |
En systemgenererad egenskap som representerar resursetaggen som krävs för optimistisk samtidighetskontroll. |
|
_rid |
string |
En systemgenererad egenskap. En unik identifierare. |
|
_self |
string |
En systemgenererad egenskap som anger containerresursens adresserbara sökväg. |
|
_ts |
number |
En systemgenererad egenskap som anger resursens senast uppdaterade tidsstämpel. |
|
analyticalStorageTtl |
integer |
TTL för analys. |
|
clientEncryptionPolicy |
Klientkrypteringsprincipen för containern. |
||
computedProperties |
Lista över beräknade egenskaper |
||
conflictResolutionPolicy |
Konfliktlösningsprincipen för containern. |
||
createMode | Default |
Uppräkning för att ange läget för att skapa resurser. |
|
defaultTtl |
integer |
Standardtid till live |
|
id |
string |
Namnet på Cosmos DB SQL-containern |
|
indexingPolicy |
Konfigurationen av indexeringsprincipen. Som standard är indexeringen automatisk för alla dokumentsökvägar i containern |
||
partitionKey |
Konfigurationen av partitionsnyckeln som ska användas för att partitionera data i flera partitioner |
||
restoreParameters |
Parametrar som anger information om återställningen |
||
uniqueKeyPolicy |
Den unika nyckelprincipkonfigurationen för att ange unika begränsningar för dokument i samlingen i Azure Cosmos DB-tjänsten. |
||
vectorEmbeddingPolicy |
Vektorinbäddningsprincipen för containern. |
ContainerPartitionKey
Konfigurationen av partitionsnyckeln som ska användas för att partitionera data i flera partitioner
Name | Typ | Standardvärde | Description |
---|---|---|---|
kind | Hash |
Anger vilken typ av algoritm som används för partitionering. För MultiHash stöds flera partitionsnycklar (upp till högst tre) för containerskapande |
|
paths |
string[] |
Lista över sökvägar som använder vilka data i containern som kan partitioneras |
|
systemKey |
boolean |
Anger om containern använder en systemgenererad partitionsnyckel |
|
version |
integer |
Anger versionen av partitionsnyckeldefinitionen |
CreateMode
Uppräkning för att ange läget för kontoskapande.
Name | Typ | Description |
---|---|---|
Default |
string |
|
Restore |
string |
DataType
Den datatyp som indexeringsbeteendet tillämpas på.
Name | Typ | Description |
---|---|---|
LineString |
string |
|
MultiPolygon |
string |
|
Number |
string |
|
Point |
string |
|
Polygon |
string |
|
String |
string |
DistanceFunction
Den avståndsfunktion som ska användas för avståndsberäkning mellan vektorer.
Name | Typ | Description |
---|---|---|
cosine |
string |
|
dotproduct |
string |
|
euclidean |
string |
ErrorResponse
Felsvar.
Name | Typ | Description |
---|---|---|
code |
string |
Felkod. |
message |
string |
Felmeddelande som anger varför åtgärden misslyckades. |
ExcludedPath
Name | Typ | Description |
---|---|---|
path |
string |
Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) |
IncludedPath
Sökvägarna som ingår i indexeringen
Name | Typ | Description |
---|---|---|
indexes |
Indexes[] |
Lista över index för den här sökvägen |
path |
string |
Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) |
Indexes
Indexen för sökvägen.
Name | Typ | Standardvärde | Description |
---|---|---|---|
dataType | String |
Den datatyp som indexeringsbeteendet tillämpas på. |
|
kind | Hash |
Anger typen av index. |
|
precision |
integer |
Indexets precision. -1 är maximal precision. |
IndexingMode
Anger indexeringsläget.
Name | Typ | Description |
---|---|---|
consistent |
string |
|
lazy |
string |
|
none |
string |
IndexingPolicy
Cosmos DB-indexeringsprincip
Name | Typ | Standardvärde | Description |
---|---|---|---|
automatic |
boolean |
Anger om indexeringsprincipen är automatisk |
|
compositeIndexes |
Lista över lista över sammansatta sökvägar |
||
excludedPaths |
Lista över sökvägar som ska undantas från indexering |
||
includedPaths |
Lista över sökvägar som ska inkluderas i indexeringen |
||
indexingMode | consistent |
Anger indexeringsläget. |
|
spatialIndexes |
Lista över rumsliga detaljer |
||
vectorIndexes |
Lista över sökvägar som ska inkluderas i vektorindexeringen |
IndexKind
Anger typen av index.
Name | Typ | Description |
---|---|---|
Hash |
string |
|
Range |
string |
|
Spatial |
string |
OperationType
Räkna upp för att ange händelsens åtgärdstyp.
Name | Typ | Description |
---|---|---|
Create |
string |
|
Delete |
string |
|
Recreate |
string |
|
Replace |
string |
|
SystemOperation |
string |
PartitionKind
Anger vilken typ av algoritm som används för partitionering. För MultiHash stöds flera partitionsnycklar (upp till högst tre) för containerskapande
Name | Typ | Description |
---|---|---|
Hash |
string |
|
MultiHash |
string |
|
Range |
string |
Resource
Resursen för en Azure Cosmos DB SQL-containerhändelse
Name | Typ | Description |
---|---|---|
_rid |
string |
En systemgenererad egenskap. En unik identifierare. |
canUndelete |
string |
Ett tillstånd för den här containern för att identifiera om den här containern kan återställas i samma konto. |
canUndeleteReason |
string |
Anledningen till att den här containern inte kan återställas i samma konto. |
container |
Resursobjekt för Cosmos DB SQL-container |
|
eventTimestamp |
string |
När den här containerhändelsen inträffade. |
operationType |
Åtgärdstypen för den här containerhändelsen. |
|
ownerId |
string |
Namnet på den här SQL-containern. |
ownerResourceId |
string |
Resurs-ID för den här SQL-containern. |
ResourceRestoreParameters
Parametrar som anger information om återställningen.
Name | Typ | Description |
---|---|---|
restoreSource |
string |
ID:t för det återställningsbara databaskonto som återställningen måste initieras från. Till exempel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
restoreTimestampInUtc |
string |
Tid då kontot måste återställas (ISO-8601-format). |
restoreWithTtlDisabled |
boolean |
Anger om det återställda kontot kommer att ha time-To-Live inaktiverat vid lyckad återställning. |
RestorableSqlContainerGetResult
En Azure Cosmos DB SQL-containerhändelse
Name | Typ | Description |
---|---|---|
id |
string |
Den unika resursidentifieraren för ARM-resursen. |
name |
string |
Namnet på ARM-resursen. |
properties.resource |
Resursen för en Azure Cosmos DB SQL-containerhändelse |
|
type |
string |
Typen av Azure-resurs. |
RestorableSqlContainersListResult
Svar på liståtgärd som innehåller SQL-containerhändelserna och deras egenskaper.
Name | Typ | Description |
---|---|---|
value |
Lista över SQL-containerhändelser och deras egenskaper. |
SpatialSpec
Name | Typ | Description |
---|---|---|
path |
string |
Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slut med jokertecken (/sökväg/*) |
types |
Lista över sökvägens rumsliga typ |
SpatialType
Anger den rumsliga typen av index.
Name | Typ | Description |
---|---|---|
LineString |
string |
|
MultiPolygon |
string |
|
Point |
string |
|
Polygon |
string |
UniqueKey
Den unika nyckeln för som framtvingar unikhetsbegränsning för dokument i samlingen i Azure Cosmos DB-tjänsten.
Name | Typ | Description |
---|---|---|
paths |
string[] |
Listan över sökvägar måste vara unik för varje dokument i Azure Cosmos DB-tjänsten |
UniqueKeyPolicy
Den unika nyckelprincipkonfigurationen för att ange unika begränsningar för dokument i samlingen i Azure Cosmos DB-tjänsten.
Name | Typ | Description |
---|---|---|
uniqueKeys |
Lista över unika nycklar på som framtvingar unikhetsbegränsning för dokument i samlingen i Azure Cosmos DB-tjänsten. |
VectorDataType
Anger datatypen för vektor.
Name | Typ | Description |
---|---|---|
float32 |
string |
|
int8 |
string |
|
uint8 |
string |
VectorEmbedding
Representerar en vektorbäddning. En vektorbäddning används för att definiera ett vektorfält i dokumenten.
Name | Typ | Description |
---|---|---|
dataType |
Anger datatypen för vektor. |
|
dimensions |
integer |
Antalet dimensioner i vektorn. |
distanceFunction |
Den avståndsfunktion som ska användas för avståndsberäkning mellan vektorer. |
|
path |
string |
Sökvägen till vektorfältet i dokumentet. |
VectorEmbeddingPolicy
Inbäddningsprincip för Cosmos DB-vektor
Name | Typ | Description |
---|---|---|
vectorEmbeddings |
Lista över vektorbäddningar |
VectorIndex
Name | Typ | Description |
---|---|---|
path |
string |
Sökvägen till vektorfältet i dokumentet. |
type |
Indextypen för vektorn. För närvarande stöds flat, diskANN och quantizedFlat. |
VectorIndexType
Indextypen för vektorn. För närvarande stöds flat, diskANN och quantizedFlat.
Name | Typ | Description |
---|---|---|
diskANN |
string |
|
flat |
string |
|
quantizedFlat |
string |