Share via

Restorable Sql Databases - 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-Datenbanken unter dem wiederherstellbaren Konto erfolgt sind. Dies ist in einem Szenario hilfreich, in dem die Datenbank versehentlich gelöscht wurde, um den Löschzeitpunkt zu ermitteln. 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}/restorableSqlDatabases?api-version=2024-05-15

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.

Antworten

Name Typ Beschreibung
200 OK

RestorableSqlDatabasesListResult

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

CosmosDBRestorableSqlDatabaseList

Sample Request

GET https://management.azure.com/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/WestUS/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableSqlDatabases?api-version=2024-05-15

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/36f09704-6be3-4f33-aa05-17b73e504c75/restorableSqlDatabases/59c21367-b98b-4a8e-abb7-b6f46600decc",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlDatabases",
      "name": "59c21367-b98b-4a8e-abb7-b6f46600decc",
      "properties": {
        "resource": {
          "_rid": "DLB14gAAAA==",
          "eventTimestamp": "2020-09-02T19:45:03Z",
          "ownerId": "Database1",
          "ownerResourceId": "3fu-hg==",
          "operationType": "Create",
          "canUndelete": "invalid",
          "database": {
            "id": "Database1",
            "_rid": "3fu-hg==",
            "_self": "dbs/3fu-hg==/",
            "_etag": "\"0000c20a-0000-0700-0000-5f4ff63f0000\"",
            "_colls": "colls/",
            "_users": "users/"
          }
        }
      }
    },
    {
      "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableSqlDatabases/8456cb17-cdb0-4c6a-8db8-d0ff3f886257",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlDatabases",
      "name": "8456cb17-cdb0-4c6a-8db8-d0ff3f886257",
      "properties": {
        "resource": {
          "_rid": "ESXNLAAAAA==",
          "eventTimestamp": "2020-09-02T19:53:42Z",
          "ownerId": "Database1",
          "ownerResourceId": "3fu-hg==",
          "database": {
            "id": "Database1",
            "_rid": "3fu-hg==",
            "_self": "dbs/3fu-hg==/",
            "_etag": "\"0000c20a-0000-0700-0000-5f4ff63f0000\"",
            "_colls": "colls/",
            "_users": "users/",
            "_ts": 1599075903
          },
          "operationType": "Delete",
          "canUndelete": "notRestorable",
          "canUndeleteReason": "Database already exists. Only deleted resources can be restored within same account."
        }
      }
    },
    {
      "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableSqlDatabases/2c07991b-9c7c-4e85-be68-b18c1f2ff326",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlDatabases",
      "name": "2c07991b-9c7c-4e85-be68-b18c1f2ff326",
      "properties": {
        "resource": {
          "_rid": "aXFqUQAAAA==",
          "eventTimestamp": "2020-09-02T19:53:15Z",
          "ownerId": "Database2",
          "ownerResourceId": "0SziSg==",
          "database": {
            "id": "Database2",
            "_rid": "0SziSg==",
            "_self": "dbs/0SziSg==/",
            "_etag": "\"0000ca0a-0000-0700-0000-5f4ff82b0000\"",
            "_colls": "colls/",
            "_users": "users/"
          },
          "operationType": "Create",
          "canUndelete": "invalid"
        }
      }
    }
  ]
}

Definitionen

Name Beschreibung
CloudError

Eine Fehlerantwort vom Dienst.
CreateMode

Enumeration, um den Modus der Kontoerstellung anzugeben.
Database

Cosmos DB SQL-Datenbankressourcenobjekt
ErrorResponse

Fehlerantwort.
OperationType

Enumeration, die den Vorgangstyp des Ereignisses angibt.
Resource

Die Ressource eines Azure Cosmos DB-SQL-Datenbankereignisses
ResourceRestoreParameters

Parameter, um die Informationen zur Wiederherstellung anzugeben.
RestorableSqlDatabaseGetResult

Ein Azure Cosmos DB-SQL-Datenbankereignis
RestorableSqlDatabasesListResult

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

CloudError

Eine Fehlerantwort vom Dienst.

Name Typ Beschreibung
error

ErrorResponse

Fehlerantwort.

CreateMode

Enumeration, um den Modus der Kontoerstellung anzugeben.

Name Typ Beschreibung
Default

string

Restore

string

Database

Cosmos DB SQL-Datenbankressourcenobjekt

Name Typ Standardwert Beschreibung
_colls

string

Eine vom System generierte Eigenschaft, die den adressierbaren Pfad der Auflistungsressource angibt.
_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 Datenbankressource angibt.
_ts

number

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

string

Eine vom System generierte Eigenschaft, die den adressierbaren Pfad der Benutzerressource angibt.
createMode

CreateMode

Default

Enumeration, um den Modus der Ressourcenerstellung anzugeben.
id

string

Name der Cosmos DB SQL-Datenbank
restoreParameters

ResourceRestoreParameters

Parameter zum Angeben der Informationen zur Wiederherstellung

ErrorResponse

Fehlerantwort.

Name Typ Beschreibung
code

string

Fehlercode
message

string

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

OperationType

Enumeration, die den Vorgangstyp des Ereignisses angibt.

Name Typ Beschreibung
Create

string

Delete

string

Recreate

string

Replace

string

SystemOperation

string

Resource

Die Ressource eines Azure Cosmos DB-SQL-Datenbankereignisses

Name Typ Beschreibung
_rid

string

Eine vom System generierte Eigenschaft. Einen eindeutigen Bezeichner.
canUndelete

string

Ein Zustand dieser Datenbank, um zu ermitteln, ob diese Datenbank in demselben Konto wiederhergestellt werden kann.
canUndeleteReason

string

Der Grund, warum diese Datenbank nicht im selben Konto wiederhergestellt werden kann.
database

Database

Cosmos DB SQL-Datenbankressourcenobjekt
eventTimestamp

string

Der Zeitpunkt, zu dem dieses Datenbankereignis aufgetreten ist.
operationType

OperationType

Der Vorgangstyp dieses Datenbankereignisses.
ownerId

string

Der Name der SQL-Datenbank
ownerResourceId

string

Die Ressourcen-ID der SQL-Datenbank.

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).

RestorableSqlDatabaseGetResult

Ein Azure Cosmos DB-SQL-Datenbankereignis

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-Datenbankereignisses
type

string

Der Typ der Azure-Ressource.

RestorableSqlDatabasesListResult

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

Name Typ Beschreibung
value

RestorableSqlDatabaseGetResult[]

Liste der SQL-Datenbankereignisse und deren Eigenschaften.