Restorable Sql Containers - List

Service:

Cosmos DB Resource Provider

API Version:

2024-05-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ót véletlenül törölték. 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-05-15

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlContainers?api-version=2024-05-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ó, a szavak és az egyes szavak közötti szóközök nagybetűvel.
subscriptionId	path	True	string	A cél-előfizetés azonosítója.
api-version	query	True	string	A művelethez használandó 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 időpontja.

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 a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Példák

CosmosDBRestorableSqlContainerList

Sample Request

HTTP

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.cosmosdb import CosmosDBManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdb
# USAGE
    python cosmos_db_restorable_sql_container_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CosmosDBManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.restorable_sql_containers.list(
        location="WestUS",
        instance_id="98a570f2-63db-4117-91f0-366327b7b353",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/examples/CosmosDBRestorableSqlContainerList.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

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 elérési utak 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ésfeloldási szabályzata.
Container	Cosmos DB SQL-tároló erőforrás-objektuma
ContainerPartitionKey	Az adatok több partícióra való particionálásához használandó partíciókulcs konfigurációja
CreateMode	Enumerálás a fióklétrehozás módjának jelzésére.
DataType	Az adattípus, amelyre az indexelési viselkedés vonatkozik.
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	Enumerálás az esemény művelettípusának jelzéséhez.
PartitionKind	A particionáláshoz használt algoritmus típusát jelzi. A MultiHash esetében 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 tartalmazza az SQL-tárolóeseményeket és azok tulajdonságait.
SpatialSpec
SpatialType	Az index térbeli típusát jelzi.
UniqueKey	Az egyedi kulcs, amely egyediségi korlátozást kényszerít ki a gyűjteményben lévő dokumentumokra az Azure Cosmos DB szolgáltatásban.
UniqueKeyPolicy	Az Azure Cosmos DB szolgáltatás gyűjteményében található dokumentumok egyediségi korlátozásainak megadására szolgáló egyedi kulcsszabályzat-konfiguráció.

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álni fog 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 elérési utakra vonatkozó 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- es verzió támogatja az azonosító- és partíciókulcsok elérési útjának 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 elérési utak rendezési sorrendje.
path	string	Az az elérési út, amelyre az indexelési viselkedés vonatkozik. Az indexelési útvonalak általában gyökérrel kezdődnek, és helyettesítő karakterrel (/elérési út/*) végződnek.

CompositePathSortOrder

Összetett elérési utak 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ésfeloldá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 feloldásának eljárása egyéni mód esetén.
mode	ConflictResolutionMode	LastWriterWins	Az ütközésfeloldási módot jelzi.

Container

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

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áscímkét jelöli.
_rid	string		Rendszer által létrehozott tulajdonság. Egy egyedi azonosító.
_self	string		Egy rendszer által létrehozott tulajdonság, amely meghatározza a tárolóerőforrás címzhető 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ésfeloldási szabályzata.
createMode	CreateMode	Default	Enumerálás az erőforrás-létrehozás módjának jelzésére.
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 automatikusan történik a tárolóban lévő ö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 található dokumentumok egyediségi korlátozásainak megadására szolgáló egyedi kulcsszabályzat-konfiguráció.

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. A MultiHash esetében a tároló létrehozása több partíciókulcsot (legfeljebb három) támogat
paths	string[]		Azon elérési utak listája, amelyeken belül a tárolóban lévő adatok particionálhatók
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ó verzióját jelzi

CreateMode

Enumerálás a fióklétrehozás módjának jelzésére.

Name	Típus	Description
Default	string
Restore	string

DataType

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

ErrorResponse

Hibaválasz.

Name	Típus	Description
code	string	Hibakód.
message	string	Hibaüzenet, amely jelzi, hogy a művelet miért hiúsult meg.

ExcludedPath

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

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 indexelési útvonalak általában gyökérrel kezdődnek, és helyettesítő karakterrel (/elérési út/*) végződnek.

Indexes

Az elérési út indexei.

Name	Típus	Alapértelmezett érték	Description
dataType	DataType	String	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út-lista
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 jellemzők listája

IndexKind

Az index típusát jelzi.

Name	Típus	Description
Hash	string
Range	string
Spatial	string

OperationType

Enumerálás 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. A MultiHash esetében 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. Egy egyedi azonosító.
canUndelete	string	A tároló állapota annak megállapításához, 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-objektuma
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	Az SQL-tároló 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 ideje (ISO-8601 formátum).

RestorableSqlContainerGetResult

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

Name	Típus	Description
id	string	Az ARM-erőforrás egyedi erőforrás-azonosí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.

RestorableSqlContainersListResult

A listázási művelet válasza, amely tartalmazza az SQL-tárolóeseményeket és azok tulajdonságait.

Name	Típus	Description
value	RestorableSqlContainerGetResult[]	Az SQL-tárolóesemények és tulajdonságaik listája.

SpatialSpec

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

SpatialType

Az index térbeli típusát jelzi.

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

UniqueKey

Az egyedi kulcs, amely egyediségi korlátozást kényszerít ki a gyűjteményben lévő dokumentumokra az Azure Cosmos DB szolgáltatásban.

Name	Típus	Description
paths	string[]	Az elérési utak listájának egyedinek kell lennie az Azure Cosmos DB szolgáltatás minden dokumentumához

UniqueKeyPolicy

Az Azure Cosmos DB szolgáltatás gyűjteményében található dokumentumok egyediségi korlátozásainak megadására szolgáló egyedi kulcsszabályzat-konfiguráció.

Name	Típus	Description
uniqueKeys	UniqueKey[]	Azon egyedi kulcsok listája, amelyek egyediségi korlátozást kényszerítenek ki a gyűjteményben lévő dokumentumokra az Azure Cosmos DB szolgáltatásban.