Restorable Sql Containers - List

Referencia

Szolgáltatás:: Cosmos DB Resource Provider

API-verzió:: 2024-11-15

Egy adott adatbázis összes Azure Cosmos DB SQL-tárolóján végrehajtott összes mutáció eseménycsatornájának megjelenítése. Ez segít abban az esetben, ha a tároló véletlenül törölve lett. Ehhez az API-hoz "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read" engedély szükséges

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlContainers?api-version=2024-11-15

Opcionális paraméterekkel:

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-paraméterek

Name	In	Kötelező	Típus	Description
instanceId	path	True	string	Egy visszaállítható adatbázisfiók instanceId GUID azonosítója.
location	path	True	string	Cosmos DB-régió, szóközökkel a szavak és az egyes szavak között nagybetűvel.
subscriptionId	path	True	string	A cél-előfizetés azonosítója.
api-version	query	True	string	A művelethez használni kívánt API-verzió.
endTime	query		string	Visszaállítható SQL-tárolók eseménycsatorna befejezési ideje.
restorableSqlDatabaseRid	query		string	Az SQL-adatbázis erőforrás-azonosítója.
startTime	query		string	Visszaállítható SQL-tárolók eseménycsatorna kezdési ideje.

Válaszok

Name	Típus	Description
200 OK	RestorableSqlContainersListResult	A művelet sikeresen befejeződött.
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	A felhasználói fiók megszemélyesítése

Példák

CosmosDBRestorableSqlContainerList

Mintakérelem

HTTP

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==

Mintaválasz

Állapotkód:: 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\""
          }
        }
      }
    }
  ]
}

Definíciók

Name	Description
ClientEncryptionIncludedPath	.
ClientEncryptionPolicy	Cosmos DB ügyféltitkosítási szabályzat.
CloudError	Hibaválasz a szolgáltatástól.
CompositePath
CompositePathSortOrder	Összetett útvonalak rendezési sorrendje.
ComputedProperty	Számított tulajdonság definíciója
ConflictResolutionMode	Az ütközésfeloldási módot jelzi.
ConflictResolutionPolicy	A tároló ütközéskezelési szabályzata.
Container	Cosmos DB SQL-tárolóerőforrás-objektum
ContainerPartitionKey	Az adatok több partícióra való particionálásához használandó partíciókulcs konfigurációja
CreateMode	Szám a fióklétrehozás módjának jelzéséhez.
DataType	Az az adattípus, amelyre az indexelési viselkedés vonatkozik.
DistanceFunction	A vektorok közötti távolságszámításhoz használandó távolságfüggvény.
ErrorResponse	Hibaválasz.
ExcludedPath
IncludedPath	Az indexelésben szereplő elérési utak
Indexes	Az elérési út indexei.
IndexingMode	Az indexelési módot jelzi.
IndexingPolicy	Cosmos DB indexelési szabályzat
IndexKind	Az index típusát jelzi.
OperationType	Szám az esemény művelettípusának jelzéséhez.
PartitionKind	A particionáláshoz használt algoritmus típusát jelzi. MultiHash esetén a tároló létrehozása több partíciókulcsot (legfeljebb három) támogat
Resource	Egy Azure Cosmos DB SQL-tárolóesemény erőforrása
ResourceRestoreParameters	A visszaállítással kapcsolatos információkat jelző paraméterek.
RestorableSqlContainerGetResult	Azure Cosmos DB SQL-tárolóesemény
RestorableSqlContainersListResult	A listázási művelet válasza, amely az SQL-tárolóeseményeket és azok tulajdonságait tartalmazza.
SpatialSpec
SpatialType	Az index térbeli típusát jelzi.
UniqueKey	Az egyedi kulcs, amely egyediségi korlátozást kényszerít ki az Azure Cosmos DB szolgáltatás gyűjteményében lévő dokumentumokra.
UniqueKeyPolicy	Az Azure Cosmos DB szolgáltatás gyűjteményében lévő dokumentumok egyediségi korlátozásainak megadására szolgáló egyedi kulcsszabályzat-konfiguráció.
VectorDataType	A vektor adattípusát jelzi.
VectorEmbedding	Vektoros beágyazást jelöl. A vektorbeágyazással vektormezőt definiálhat a dokumentumokban.
VectorEmbeddingPolicy	Cosmos DB vektorbeágyazási szabályzat
VectorIndex
VectorIndexType	A vektor indextípusa. Jelenleg a flat, a diskANN és a quantizedFlat támogatott.

ClientEncryptionIncludedPath

Name	Típus	Description
clientEncryptionKeyId	string	Az elérési út titkosításához használandó ügyféltitkosítási kulcs azonosítója.
encryptionAlgorithm	string	A használandó titkosítási algoritmus. Például - AEAD_AES_256_CBC_HMAC_SHA256.
encryptionType	string	A végrehajtandó titkosítás típusa. Például - Determinisztikus, randomizált.
path	string	Titkosítandó elérési út.

ClientEncryptionPolicy

Cosmos DB ügyféltitkosítási szabályzat.

Name	Típus	Description
includedPaths	ClientEncryptionIncludedPath[]	A titkosítást igénylő elem elérési útjai, valamint az útvonalspecifikus beállítások.
policyFormatVersion	integer	Az ügyféltitkosítási szabályzat definíciójának verziója. A támogatott verziók: 1 és 2. A 2. verzió támogatja az azonosító- és partíciókulcs-elérési út titkosítását.

CloudError

Hibaválasz a szolgáltatástól.

Name	Típus	Description
error	ErrorResponse	Hibaválasz.

CompositePath

Name	Típus	Description
order	CompositePathSortOrder	Összetett útvonalak rendezési sorrendje.
path	string	Az az elérési út, amelyre az indexelési viselkedés vonatkozik. Az index elérési útjai általában gyökérrel kezdődnek, és helyettesítő karakterrel végződnek (/elérési út/*)

CompositePathSortOrder

Összetett útvonalak rendezési sorrendje.

Name	Típus	Description
ascending	string
descending	string

ComputedProperty

Számított tulajdonság definíciója

Name	Típus	Description
name	string	Egy számított tulajdonság neve, például : "cp_lowerName"
query	string	A számított tulajdonság értékét kiértékelő lekérdezés, például : "SELECT VALUE LOWER(c.name) FROM c"

ConflictResolutionMode

Az ütközésfeloldási módot jelzi.

Name	Típus	Description
Custom	string
LastWriterWins	string

ConflictResolutionPolicy

A tároló ütközéskezelési szabályzata.

Name	Típus	Alapértelmezett érték	Description
conflictResolutionPath	string		A LastWriterWins mód esetén az ütközésfeloldási útvonal.
conflictResolutionProcedure	string		Az ütközések egyéni mód esetén történő feloldásának eljárása.
mode	ConflictResolutionMode	LastWriterWins	Az ütközésfeloldási módot jelzi.

Container

Cosmos DB SQL-tárolóerőforrás-objektum

Name	Típus	Alapértelmezett érték	Description
_etag	string		Egy rendszer által létrehozott tulajdonság, amely az optimista egyidejűség-vezérléshez szükséges erőforrás-etagot jelöli.
_rid	string		Rendszer által létrehozott tulajdonság. Egyedi azonosító.
_self	string		Egy rendszer által létrehozott tulajdonság, amely meghatározza a tárolóerőforrás címezhető elérési útját.
_ts	number		Egy rendszer által létrehozott tulajdonság, amely az erőforrás utolsó frissített időbélyegét jelöli.
analyticalStorageTtl	integer		Elemzési TTL.
clientEncryptionPolicy	ClientEncryptionPolicy		A tároló ügyféltitkosítási szabályzata.
computedProperties	ComputedProperty[]		Számított tulajdonságok listája
conflictResolutionPolicy	ConflictResolutionPolicy		A tároló ütközéskezelési szabályzata.
createMode	CreateMode	Default	Szám az erőforrás-létrehozás módjának jelzéséhez.
defaultTtl	integer		Alapértelmezett élettartam
id	string		A Cosmos DB SQL-tároló neve
indexingPolicy	IndexingPolicy		Az indexelési szabályzat konfigurációja. Alapértelmezés szerint az indexelés automatikus a tárolón belüli összes dokumentumútvonal esetében
partitionKey	ContainerPartitionKey		Az adatok több partícióra való particionálásához használandó partíciókulcs konfigurációja
restoreParameters	ResourceRestoreParameters		A visszaállítással kapcsolatos információkat jelző paraméterek
uniqueKeyPolicy	UniqueKeyPolicy		Az Azure Cosmos DB szolgáltatás gyűjteményében lévő dokumentumok egyediségi korlátozásainak megadására szolgáló egyedi kulcsszabályzat-konfiguráció.
vectorEmbeddingPolicy	VectorEmbeddingPolicy		A tároló vektoros beágyazási szabályzata.

ContainerPartitionKey

Az adatok több partícióra való particionálásához használandó partíciókulcs konfigurációja

Name	Típus	Alapértelmezett érték	Description
kind	PartitionKind	Hash	A particionáláshoz használt algoritmus típusát jelzi. MultiHash esetén a tároló létrehozása több partíciókulcsot (legfeljebb három) támogat
paths	string[]		A tárolón belüli adatok particionálására szolgáló elérési utak listája
systemKey	boolean		Azt jelzi, hogy a tároló rendszer által létrehozott partíciókulcsot használ-e
version	integer		A partíciókulcs definíciójának verzióját jelzi

CreateMode

Szám a fióklétrehozás módjának jelzéséhez.

Name	Típus	Description
Default	string
Restore	string

DataType

Az az adattípus, amelyre az indexelési viselkedés vonatkozik.

Name	Típus	Description
LineString	string
MultiPolygon	string
Number	string
Point	string
Polygon	string
String	string

DistanceFunction

A vektorok közötti távolságszámításhoz használandó távolságfüggvény.

Name	Típus	Description
cosine	string
dotproduct	string
euclidean	string

ErrorResponse

Hibaválasz.

Name	Típus	Description
code	string	Hibakód.
message	string	A művelet sikertelen voltát jelző hibaüzenet.

ExcludedPath

Name	Típus	Description
path	string	Az az elérési út, amelyre az indexelési viselkedés vonatkozik. Az index elérési útjai általában gyökérrel kezdődnek, és helyettesítő karakterrel végződnek (/elérési út/*)

IncludedPath

Az indexelésben szereplő elérési utak

Name	Típus	Description
indexes	Indexes[]	Az elérési út indexeinek listája
path	string	Az az elérési út, amelyre az indexelési viselkedés vonatkozik. Az index elérési útjai általában gyökérrel kezdődnek, és helyettesítő karakterrel végződnek (/elérési út/*)

Indexes

Az elérési út indexei.

Name	Típus	Alapértelmezett érték	Description
dataType	DataType	String	Az az adattípus, amelyre az indexelési viselkedés vonatkozik.
kind	IndexKind	Hash	Az index típusát jelzi.
precision	integer		Az index pontossága. A -1 a maximális pontosság.

IndexingMode

Az indexelési módot jelzi.

Name	Típus	Description
consistent	string
lazy	string
none	string

IndexingPolicy

Cosmos DB indexelési szabályzat

Name	Típus	Alapértelmezett érték	Description
automatic	boolean		Azt jelzi, hogy az indexelési szabályzat automatikus-e
compositeIndexes	CompositePath[]		Összetett elérési utak listája
excludedPaths	ExcludedPath[]		Az indexelésből kizárandó elérési utak listája
includedPaths	IncludedPath[]		Az indexelésbe belefoglalandó elérési utak listája
indexingMode	IndexingMode	consistent	Az indexelési módot jelzi.
spatialIndexes	SpatialSpec[]		Térbeli sajátosságok listája
vectorIndexes	VectorIndex[]		A vektorindexelésbe belefoglalandó elérési utak listája

IndexKind

Az index típusát jelzi.

Name	Típus	Description
Hash	string
Range	string
Spatial	string

OperationType

Szám az esemény művelettípusának jelzéséhez.

Name	Típus	Description
Create	string
Delete	string
Recreate	string
Replace	string
SystemOperation	string

PartitionKind

A particionáláshoz használt algoritmus típusát jelzi. MultiHash esetén a tároló létrehozása több partíciókulcsot (legfeljebb három) támogat

Name	Típus	Description
Hash	string
MultiHash	string
Range	string

Resource

Egy Azure Cosmos DB SQL-tárolóesemény erőforrása

Name	Típus	Description
_rid	string	Rendszer által létrehozott tulajdonság. Egyedi azonosító.
canUndelete	string	A tároló állapota annak megállapítására, hogy a tároló visszaállítható-e ugyanabban a fiókban.
canUndeleteReason	string	Ez az oka annak, hogy ez a tároló nem állítható vissza ugyanabban a fiókban.
container	Container	Cosmos DB SQL-tárolóerőforrás-objektum
eventTimestamp	string	A tárolóesemény bekövetkezésének dátuma.
operationType	OperationType	A tárolóesemény művelettípusa.
ownerId	string	Ennek az SQL-tárolónak a neve.
ownerResourceId	string	Az SQL-tároló erőforrás-azonosítója.

ResourceRestoreParameters

A visszaállítással kapcsolatos információkat jelző paraméterek.

Name	Típus	Description
restoreSource	string	Annak a visszaállítható adatbázisfióknak az azonosítója, amelyből a visszaállítást el kell indítani. Például: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string	A fiók visszaállításának időpontja (ISO-8601 formátum).
restoreWithTtlDisabled	boolean	Megadja, hogy a visszaállított fiókban le lesz-e tiltva az idő–To-Live a sikeres visszaállításkor.

RestorableSqlContainerGetResult

Azure Cosmos DB SQL-tárolóesemény

Name	Típus	Description
id	string	Az ARM-erőforrás egyedi erőforrásazonosítója.
name	string	Az ARM-erőforrás neve.
properties.resource	Resource	Egy Azure Cosmos DB SQL-tárolóesemény erőforrása
type	string	Az Azure-erőforrás típusa.