Restorable Sql Containers - List

Tjänst:: Cosmos DB Resource Provider

API-version:: 2025-04-15

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=2025-04-15

Med valfria parametrar:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlContainers?api-version=2025-04-15&restorableSqlDatabaseRid={restorableSqlDatabaseRid}&startTime={startTime}&endTime={endTime}

URI-parametrar

Name	I	Obligatorisk	Typ	Description
instanceId	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.
subscriptionId	path	True	string minLength: 1	ID för målprenumerationen.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.
endTime	query		string	Återställningsbar sluttid för Sql-containrar för händelsefeed.
restorableSqlDatabaseRid	query		string	Resurs-ID för SQL-databasen.
startTime	query		string	Starttid för återställningsbara Sql-containrar för händelsefeed.

Svar

Name	Typ	Description
200 OK	RestorableSqlContainersListResult	Åtgärden har slutförts.
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

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

HTTP

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.DocumentDB/locations/WestUS/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableSqlContainers?api-version=2025-04-15&restorableSqlDatabaseRid=3fu-hg==

Exempelsvar

Statuskod:: 200

{
  "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
ClientEncryptionIncludedPath	.
ClientEncryptionPolicy	Cosmos DB-klientkrypteringsprincip.
CloudError	Ett felsvar från tjänsten.
CompositePath
CompositePathSortOrder	Sorteringsordning för sammansatta sökvägar.
ComputedProperty	Definitionen av en beräknad egenskap
ConflictResolutionMode	Anger konfliktlösningsläget.
ConflictResolutionPolicy	Konfliktlösningsprincipen för containern.
Container	Resursobjekt för Cosmos DB SQL-container
ContainerPartitionKey	Konfigurationen av partitionsnyckeln som ska användas för att partitionera data i flera partitioner
CreateMode	Uppräkning för att ange läget för kontoskapande.
DataType	Den datatyp som indexeringsbeteendet tillämpas på.
DistanceFunction	Den avståndsfunktion som ska användas för avståndsberäkning mellan vektorer.
ErrorResponse	Felsvar.
ExcludedPath
FullTextPath	Representerar specifikationen för fullständig textsökväg.
FullTextPolicy	Fulltextprincip för Cosmos DB
IncludedPath	Sökvägarna som ingår i indexeringen
Indexes	Indexen för sökvägen.
IndexingMode	Anger indexeringsläget.
IndexingPolicy	Cosmos DB-indexeringsprincip
IndexKind	Anger typen av index.
OperationType	Räkna upp för att ange händelsens åtgärdstyp.
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
Resource	Resursen för en Azure Cosmos DB SQL-containerhändelse
ResourceRestoreParameters	Parametrar som anger information om återställningen.
RestorableSqlContainerGetResult	En Azure Cosmos DB SQL-containerhändelse
RestorableSqlContainersListResult	Svar på liståtgärd som innehåller SQL-containerhändelserna och deras egenskaper.
SpatialSpec
SpatialType	Anger den rumsliga typen av index.
UniqueKey	Den unika nyckeln för som framtvingar unikhetsbegränsning för dokument i samlingen 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.
VectorDataType	Anger datatypen för vektor.
VectorEmbedding	Representerar en vektorbäddning. En vektorbäddning används för att definiera ett vektorfält i dokumenten.
VectorEmbeddingPolicy	Inbäddningsprincip för Cosmos DB-vektor
VectorIndex
VectorIndexType	Indextypen för vektorn. För närvarande stöds flat, diskANN och quantizedFlat.

ClientEncryptionIncludedPath

Objekt

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

Objekt

Cosmos DB-klientkrypteringsprincip.

Name	Typ	Description
includedPaths	ClientEncryptionIncludedPath[]	Sökvägar för objektet som behöver kryptering tillsammans med sökvägsspecifika inställningar.
policyFormatVersion	integer (int32) minimum: 1 maximum: 2	Version av definitionen av klientkrypteringsprincipen. Versioner som stöds är 1 och 2. Version 2 stöder ID- och partitionsnyckelsökvägskryptering.

CloudError

Objekt

Ett felsvar från tjänsten.

Name	Typ	Description
error	ErrorResponse	Felsvar.

CompositePath

Objekt

Name	Typ	Description
order	CompositePathSortOrder	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

Uppräkning

Sorteringsordning för sammansatta sökvägar.

Värde	Description
ascending
descending

ComputedProperty

Objekt

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

Uppräkning

Anger konfliktlösningsläget.

Värde	Description
LastWriterWins
Custom

ConflictResolutionPolicy

Objekt

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	ConflictResolutionMode	LastWriterWins	Anger konfliktlösningsläget.

Container

Objekt

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 (int64)		TTL för analys.
clientEncryptionPolicy	ClientEncryptionPolicy		Klientkrypteringsprincipen för containern.
computedProperties	ComputedProperty[]		Lista över beräknade egenskaper
conflictResolutionPolicy	ConflictResolutionPolicy		Konfliktlösningsprincipen för containern.
createMode	CreateMode	Default	Uppräkning för att ange läget för att skapa resurser.
defaultTtl	integer		Standardtid till live
fullTextPolicy	FullTextPolicy		FullText-principen för containern.
id	string		Namnet på Cosmos DB SQL-containern
indexingPolicy	IndexingPolicy		Konfigurationen av indexeringsprincipen. Som standard är indexeringen automatisk för alla dokumentsökvägar i containern
partitionKey	ContainerPartitionKey		Konfigurationen av partitionsnyckeln som ska användas för att partitionera data i flera partitioner
restoreParameters	ResourceRestoreParameters		Parametrar som anger information om återställningen
uniqueKeyPolicy	UniqueKeyPolicy		Den unika nyckelprincipkonfigurationen för att ange unika begränsningar för dokument i samlingen i Azure Cosmos DB-tjänsten.
vectorEmbeddingPolicy	VectorEmbeddingPolicy		Vektorinbäddningsprincipen för containern.

ContainerPartitionKey

Objekt

Konfigurationen av partitionsnyckeln som ska användas för att partitionera data i flera partitioner

Name	Typ	Standardvärde	Description
kind	PartitionKind	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 (int32) minimum: 1 maximum: 2		Anger versionen av partitionsnyckeldefinitionen

CreateMode

Uppräkning

Uppräkning för att ange läget för kontoskapande.

Värde	Description
Default
Restore

DataType

Uppräkning

Den datatyp som indexeringsbeteendet tillämpas på.

Värde	Description
String
Number
Point
Polygon
LineString
MultiPolygon

DistanceFunction

Uppräkning

Den avståndsfunktion som ska användas för avståndsberäkning mellan vektorer.

Värde	Description
euclidean
cosine
dotproduct

ErrorResponse

Objekt

Felsvar.

Name	Typ	Description
code	string	Felkod.
message	string	Felmeddelande som anger varför åtgärden misslyckades.

ExcludedPath

Objekt

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/*)

FullTextPath

Objekt

Representerar specifikationen för fullständig textsökväg.

Name	Typ	Description
language	string	Språket i det fullständiga textfältet i dokumentet.
path	string	Sökvägen till det fullständiga textfältet i dokumentet.

FullTextPolicy

Objekt

Fulltextprincip för Cosmos DB

Name	Typ	Description
defaultLanguage	string	Standardspråket för en fulltextsökväg.
fullTextPaths	FullTextPath[]	Lista över sökvägar i fulltext

IncludedPath

Objekt

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

Objekt

Indexen för sökvägen.

Name	Typ	Standardvärde	Description
dataType	DataType	String	Den datatyp som indexeringsbeteendet tillämpas på.
kind	IndexKind	Hash	Anger typen av index.
precision	integer		Indexets precision. -1 är maximal precision.

IndexingMode

Uppräkning

Anger indexeringsläget.

Värde	Description
consistent
lazy
none

IndexingPolicy

Objekt

Cosmos DB-indexeringsprincip

Name	Typ	Standardvärde	Description
automatic	boolean		Anger om indexeringsprincipen är automatisk
compositeIndexes	CompositePath[]		Lista över lista över sammansatta sökvägar
excludedPaths	ExcludedPath[]		Lista över sökvägar som ska undantas från indexering
includedPaths	IncludedPath[]		Lista över sökvägar som ska inkluderas i indexeringen
indexingMode	IndexingMode	consistent	Anger indexeringsläget.
spatialIndexes	SpatialSpec[]		Lista över rumsliga detaljer
vectorIndexes	VectorIndex[]		Lista över sökvägar som ska inkluderas i vektorindexeringen

IndexKind

Uppräkning

Anger typen av index.

Värde	Description
Hash
Range
Spatial

OperationType

Uppräkning

Räkna upp för att ange händelsens åtgärdstyp.

Värde	Description
Create
Replace
Delete
Recreate
SystemOperation

PartitionKind

Uppräkning

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

Värde	Description
Hash
Range
MultiHash

Resource

Objekt

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	Container	Resursobjekt för Cosmos DB SQL-container
eventTimestamp	string	När den här containerhändelsen inträffade.
operationType	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

Objekt

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 (date-time)	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

Objekt

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	Resource	Resursen för en Azure Cosmos DB SQL-containerhändelse
type	string	Typen av Azure-resurs.