Share via

Restorable Sql Containers - List

  • Referenz
Service:
Cosmos DB Resource Provider
API Version:
2024-05-15

Zeigen Sie den Ereignisfeed aller Mutationen an, die für alle Azure Cosmos DB-SQL-Container in einer bestimmten Datenbank erfolgt sind. Dies ist in einem Szenario hilfreich, in dem der Container versehentlich gelöscht wurde. Für diese API ist die Berechtigung "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read" erforderlich.

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

Name In Erforderlich Typ Beschreibung
instanceId
 path True

string

Hierbei handelt es sich um die instanceId-GUID eines wiederherstellbaren Datenbankkontos.
location
 path True

string

Cosmos DB-Region mit Leerzeichen zwischen Wörtern und jedem Wort in Großbuchstaben.
subscriptionId
 path True

string

Hierbei handelt es sich um die ID des Zielabonnements.
api-version
 query True

string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.
endTime
 query

string

Wiederherstellbare Sql-Container-Ereignisfeed-Endzeit.
restorableSqlDatabaseRid
 query

string

Die Ressourcen-ID der SQL-Datenbank.
startTime
 query

string

Startzeit des Ereignisfeeds für wiederherstellbare Sql-Container.

Antworten

Name Typ Beschreibung
200 OK

RestorableSqlContainersListResult

Der Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes

CloudError

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

CosmosDBRestorableSqlContainerList

Sample Request

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

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\""
          }
        }
      }
    }
  ]
}

Definitionen

Name Beschreibung
ClientEncryptionIncludedPath

.
ClientEncryptionPolicy

Cosmos DB-Clientverschlüsselungsrichtlinie.
CloudError

Eine Fehlerantwort vom Dienst.
CompositePath
CompositePathSortOrder

Sortierreihenfolge für zusammengesetzte Pfade.
ComputedProperty

Die Definition einer berechneten Eigenschaft
ConflictResolutionMode

Gibt den Konfliktlösungsmodus an.
ConflictResolutionPolicy

Die Konfliktlösungsrichtlinie für den Container.
Container

Cosmos DB SQL-Containerressourcenobjekt
ContainerPartitionKey

Die Konfiguration des Partitionsschlüssels, der zum Partitionieren von Daten in mehrere Partitionen verwendet werden soll
CreateMode

Enumeration, um den Modus der Kontoerstellung anzugeben.
DataType

Der Datentyp, auf den das Indizierungsverhalten angewendet wird.
ErrorResponse

Fehlerantwort.
ExcludedPath
IncludedPath

Die Pfade, die in der Indizierung enthalten sind
Indexes

Die Indizes für den Pfad.
IndexingMode

Gibt den Indizierungsmodus an.
IndexingPolicy

Cosmos DB-Indizierungsrichtlinie
IndexKind

Gibt den Indextyp an.
OperationType

Enumeration, die den Vorgangstyp des Ereignisses angibt.
PartitionKind

Gibt die Art des Algorithmus an, der für die Partitionierung verwendet wird. Für MultiHash werden mehrere Partitionsschlüssel (bis zu drei maximal) für die Containererstellung unterstützt.
Resource

Die Ressource eines Azure Cosmos DB-SQL-Containerereignisses
ResourceRestoreParameters

Parameter, um die Informationen zur Wiederherstellung anzugeben.
RestorableSqlContainerGetResult

Ein Azure Cosmos DB-SQL-Containerereignis
RestorableSqlContainersListResult

Die Antwort des Auflistungsvorgangs, die die SQL-Containerereignisse und deren Eigenschaften enthält.
SpatialSpec
SpatialType

Gibt den räumlichen Typ des Indexes an.
UniqueKey

Der eindeutige Schlüssel für, der die Eindeutigkeitseinschränkung für Dokumente in der Sammlung im Azure Cosmos DB-Dienst erzwingt.
UniqueKeyPolicy

Die Richtlinienkonfiguration für eindeutige Schlüssel zum Angeben von Eindeutigkeitseinschränkungen für Dokumente in der Sammlung im Azure Cosmos DB-Dienst.

ClientEncryptionIncludedPath

.

Name Typ Beschreibung
clientEncryptionKeyId

string

Der Bezeichner des Clientverschlüsselungsschlüssels, der zum Verschlüsseln des Pfads verwendet werden soll.
encryptionAlgorithm

string

Der verschlüsselungsalgorithmus, der verwendet wird. Z. B. AEAD_AES_256_CBC_HMAC_SHA256.
encryptionType

string

Der Typ der auszuführenden Verschlüsselung. Z. B. deterministisch, randomisiert.
path

string

Pfad, der verschlüsselt werden muss.

ClientEncryptionPolicy

Cosmos DB-Clientverschlüsselungsrichtlinie.

Name Typ Beschreibung
includedPaths

ClientEncryptionIncludedPath[]

Pfade des Elements, die verschlüsselungsbedürftig sind, sowie pfadspezifische Einstellungen.
policyFormatVersion

integer

Version der Definition der Clientverschlüsselungsrichtlinie. Unterstützte Versionen sind 1 und 2. Version 2 unterstützt die Pfadverschlüsselung für ID und Partitionsschlüssel.

CloudError

Eine Fehlerantwort vom Dienst.

Name Typ Beschreibung
error

ErrorResponse

Fehlerantwort.

CompositePath

Name Typ Beschreibung
order

CompositePathSortOrder

Sortierreihenfolge für zusammengesetzte Pfade.
path

string

Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Platzhalter (/path/*)

CompositePathSortOrder

Sortierreihenfolge für zusammengesetzte Pfade.

Name Typ Beschreibung
ascending

string

descending

string

ComputedProperty

Die Definition einer berechneten Eigenschaft

Name Typ Beschreibung
name

string

Der Name einer berechneten Eigenschaft, z. B. "cp_lowerName"
query

string

Die Abfrage, die den Wert für die berechnete Eigenschaft auswertet, z. B. "SELECT VALUE LOWER(c.name) FROM c"

ConflictResolutionMode

Gibt den Konfliktlösungsmodus an.

Name Typ Beschreibung
Custom

string

LastWriterWins

string

ConflictResolutionPolicy

Die Konfliktlösungsrichtlinie für den Container.

Name Typ Standardwert Beschreibung
conflictResolutionPath

string

Der Konfliktlösungspfad im Fall des LastWriterWins-Modus.
conflictResolutionProcedure

string

Das Verfahren zum Auflösen von Konflikten im Fall des benutzerdefinierten Modus.
mode

ConflictResolutionMode

LastWriterWins

Gibt den Konfliktlösungsmodus an.

Container

Cosmos DB SQL-Containerressourcenobjekt

Name Typ Standardwert Beschreibung
_etag

string

Eine vom System generierte Eigenschaft, die das Ressourcen-Etag darstellt, das für die Steuerung der optimistischen Parallelität erforderlich ist.
_rid

string

Eine vom System generierte Eigenschaft. Einen eindeutigen Bezeichner.
_self

string

Eine vom System generierte Eigenschaft, die den adressierbaren Pfad der Containerressource angibt.
_ts

number

Eine vom System generierte Eigenschaft, die den zuletzt aktualisierten Zeitstempel der Ressource angibt.
analyticalStorageTtl

integer

Analytische TTL.
clientEncryptionPolicy

ClientEncryptionPolicy

Die Clientverschlüsselungsrichtlinie für den Container.
computedProperties

ComputedProperty[]

Liste der berechneten Eigenschaften
conflictResolutionPolicy

ConflictResolutionPolicy

Die Konfliktlösungsrichtlinie für den Container.
createMode

CreateMode

Default

Enumeration, um den Modus der Ressourcenerstellung anzugeben.
defaultTtl

integer

Standardzeit
id

string

Name des Cosmos DB SQL-Containers
indexingPolicy

IndexingPolicy

Die Konfiguration der Indizierungsrichtlinie. Standardmäßig erfolgt die Indizierung für alle Dokumentpfade im Container automatisch.
partitionKey

ContainerPartitionKey

Die Konfiguration des Partitionsschlüssels, der zum Partitionieren von Daten in mehrere Partitionen verwendet werden soll
restoreParameters

ResourceRestoreParameters

Parameter zum Angeben der Informationen zur Wiederherstellung
uniqueKeyPolicy

UniqueKeyPolicy

Die Richtlinienkonfiguration für eindeutige Schlüssel zum Angeben von Eindeutigkeitseinschränkungen für Dokumente in der Sammlung im Azure Cosmos DB-Dienst.

ContainerPartitionKey

Die Konfiguration des Partitionsschlüssels, der zum Partitionieren von Daten in mehrere Partitionen verwendet werden soll

Name Typ Standardwert Beschreibung
kind

PartitionKind

Hash

Gibt die Art des Algorithmus an, der für die Partitionierung verwendet wird. Für MultiHash werden mehrere Partitionsschlüssel (bis zu drei maximal) für die Containererstellung unterstützt.
paths

string[]

Liste der Pfade, mit denen Daten innerhalb des Containers partitioniert werden können
systemKey

boolean

Gibt an, ob der Container einen vom System generierten Partitionsschlüssel verwendet.
version

integer

Gibt die Version der Partitionsschlüsseldefinition an.

CreateMode

Enumeration, um den Modus der Kontoerstellung anzugeben.

Name Typ Beschreibung
Default

string

Restore

string

DataType

Der Datentyp, auf den das Indizierungsverhalten angewendet wird.

Name Typ Beschreibung
LineString

string

MultiPolygon

string

Number

string

Point

string

Polygon

string

String

string

ErrorResponse

Fehlerantwort.

Name Typ Beschreibung
code

string

Fehlercode
message

string

Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

ExcludedPath

Name Typ Beschreibung
path

string

Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Platzhalter (/path/*)

IncludedPath

Die Pfade, die in der Indizierung enthalten sind

Name Typ Beschreibung
indexes

Indexes[]

Liste der Indizes für diesen Pfad
path

string

Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Platzhalter (/path/*)

Indexes

Die Indizes für den Pfad.

Name Typ Standardwert Beschreibung
dataType

DataType

String

Der Datentyp, auf den das Indizierungsverhalten angewendet wird.
kind

IndexKind

Hash

Gibt den Indextyp an.
precision

integer

Die Genauigkeit des Indexes. -1 ist maximale Genauigkeit.

IndexingMode

Gibt den Indizierungsmodus an.

Name Typ Beschreibung
consistent

string

lazy

string

none

string

IndexingPolicy

Cosmos DB-Indizierungsrichtlinie

Name Typ Standardwert Beschreibung
automatic

boolean

Gibt an, ob die Indizierungsrichtlinie automatisch ist.
compositeIndexes

CompositePath[]

Liste der zusammengesetzten Pfadliste
excludedPaths

ExcludedPath[]

Liste der Pfade, die von der Indizierung ausgeschlossen werden sollen
includedPaths

IncludedPath[]

Liste der Pfade, die in die Indizierung einbezogen werden sollen
indexingMode

IndexingMode

consistent

Gibt den Indizierungsmodus an.
spatialIndexes

SpatialSpec[]

Liste der räumlichen Besonderheiten

IndexKind

Gibt den Indextyp an.

Name Typ Beschreibung
Hash

string

Range

string

Spatial

string

OperationType

Enumeration, die den Vorgangstyp des Ereignisses angibt.

Name Typ Beschreibung
Create

string

Delete

string

Recreate

string

Replace

string

SystemOperation

string

PartitionKind

Gibt die Art des Algorithmus an, der für die Partitionierung verwendet wird. Für MultiHash werden mehrere Partitionsschlüssel (bis zu drei maximal) für die Containererstellung unterstützt.

Name Typ Beschreibung
Hash

string

MultiHash

string

Range

string

Resource

Die Ressource eines Azure Cosmos DB-SQL-Containerereignisses

Name Typ Beschreibung
_rid

string

Eine vom System generierte Eigenschaft. Einen eindeutigen Bezeichner.
canUndelete

string

Ein Zustand dieses Containers, um zu ermitteln, ob dieser Container im selben Konto wiederhergestellt werden kann.
canUndeleteReason

string

Der Grund, warum dieser Container nicht im selben Konto wiederhergestellt werden kann.
container

Container

Cosmos DB SQL-Containerressourcenobjekt
eventTimestamp

string

Der Zeitpunkt, zu dem dieses Containerereignis aufgetreten ist.
operationType

OperationType

Der Vorgangstyp dieses Containerereignisses.
ownerId

string

Der Name dieses SQL-Containers.
ownerResourceId

string

Die Ressourcen-ID dieses SQL-Containers.

ResourceRestoreParameters

Parameter, um die Informationen zur Wiederherstellung anzugeben.

Name Typ Beschreibung
restoreSource

string

Die ID des wiederherstellbaren Datenbankkontos, von dem aus die Wiederherstellung initiiert werden muss. Beispiel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc

string

Zeit, zu der das Konto wiederhergestellt werden muss (ISO-8601-Format).

RestorableSqlContainerGetResult

Ein Azure Cosmos DB-SQL-Containerereignis

Name Typ Beschreibung
id

string

Der eindeutige Ressourcenbezeichner der ARM-Ressource.
name

string

Der Name der ARM-Ressource.
properties.resource

Resource

Die Ressource eines Azure Cosmos DB-SQL-Containerereignisses
type

string

Der Typ der Azure-Ressource.

RestorableSqlContainersListResult

Die Antwort des Auflistungsvorgangs, die die SQL-Containerereignisse und deren Eigenschaften enthält.

Name Typ Beschreibung
value

RestorableSqlContainerGetResult[]

Liste der SQL-Containerereignisse und deren Eigenschaften.

SpatialSpec

Name Typ Beschreibung
path

string

Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Platzhalter (/path/*)
types

SpatialType[]

Liste des räumlichen Pfadtyps

SpatialType

Gibt den räumlichen Typ des Indexes an.

Name Typ Beschreibung
LineString

string

MultiPolygon

string

Point

string

Polygon

string

UniqueKey

Der eindeutige Schlüssel für, der die Eindeutigkeitseinschränkung für Dokumente in der Sammlung im Azure Cosmos DB-Dienst erzwingt.

Name Typ Beschreibung
paths

string[]

Die Liste der Pfade muss für jedes Dokument im Azure Cosmos DB-Dienst eindeutig sein.

UniqueKeyPolicy

Die Richtlinienkonfiguration für eindeutige Schlüssel zum Angeben von Eindeutigkeitseinschränkungen für Dokumente in der Sammlung im Azure Cosmos DB-Dienst.

Name Typ Beschreibung
uniqueKeys

UniqueKey[]

Liste der eindeutigen Schlüssel für, die die Eindeutigkeitseinschränkungen für Dokumente in der Sammlung im Azure Cosmos DB-Dienst erzwingen.