Restorable Sql Databases - List

  • Riferimento
Service:
Cosmos DB Resource Provider
API Version:
2023-11-15

Visualizzare il feed di eventi di tutte le mutazioni eseguite in tutti i database SQL di Azure Cosmos DB nell'account ripristinabile. Ciò consente di ottenere il tempo di eliminazione accidentale del database in uno scenario in cui il database è stato eliminato accidentalmente. Questa API richiede l'autorizzazione 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read'

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
instanceId
 path True

string

GUID instanceId di un account di database ripristinabile.
location
 path True

string

Area di Cosmos DB, con spazi tra parole e ogni parola maiuscola.
subscriptionId
 path True

string

ID della sottoscrizione di destinazione.
api-version
 query True

string

Versione dell'API da usare per questa operazione.

Risposte

Nome Tipo Descrizione
200 OK

RestorableSqlDatabasesListResult

Operazione riuscita.
Other Status Codes

CloudError

Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome Descrizione
user_impersonation Rappresentare l'account utente

Esempio

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=2023-11-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"
        }
      }
    }
  ]
}

Definizioni

Nome Descrizione
CloudError

Risposta di errore dal servizio.
CreateMode

Enumerazione per indicare la modalità di creazione dell'account.
Database

Oggetto risorsa del database SQL di Cosmos DB
ErrorResponse

Risposta errore.
OperationType

Enumerazione per indicare il tipo di operazione dell'evento.
Resource

Risorsa di un evento di database SQL di Azure Cosmos DB
ResourceRestoreParameters

Parametri per indicare le informazioni sul ripristino.
RestorableSqlDatabaseGetResult

Evento di database SQL di Azure Cosmos DB
RestorableSqlDatabasesListResult

Risposta dell'operazione Elenco contenente gli eventi del database SQL e le relative proprietà.

CloudError

Risposta di errore dal servizio.

Nome Tipo Descrizione
error

ErrorResponse

Risposta errore.

CreateMode

Enumerazione per indicare la modalità di creazione dell'account.

Nome Tipo Descrizione
Default

string

Restore

string

Database

Oggetto risorsa del database SQL di Cosmos DB

Nome Tipo Valore predefinito Descrizione
_colls

string

Proprietà generata dal sistema che ha specificato il percorso indirizzabile della risorsa delle raccolte.
_etag

string

Proprietà generata dal sistema che rappresenta l'etag della risorsa necessaria per il controllo di concorrenza ottimistica.
_rid

string

Proprietà generata dal sistema. Identificatore univoco.
_self

string

Proprietà generata dal sistema che specifica il percorso indirizzabile della risorsa di database.
_ts

number

Proprietà generata dal sistema che indica l'ultimo timestamp aggiornato della risorsa.
_users

string

Proprietà generata dal sistema che specifica il percorso indirizzabile della risorsa utenti.
createMode

CreateMode

Default

Enumerazione per indicare la modalità di creazione delle risorse.
id

string

Nome del database SQL di Cosmos DB
restoreParameters

ResourceRestoreParameters

Parametri per indicare le informazioni sul ripristino

ErrorResponse

Risposta errore.

Nome Tipo Descrizione
code

string

Codice di errore.
message

string

Messaggio di errore che indica perché l'operazione non è riuscita.

OperationType

Enumerazione per indicare il tipo di operazione dell'evento.

Nome Tipo Descrizione
Create

string

Delete

string

Recreate

string

Replace

string

SystemOperation

string

Resource

Risorsa di un evento di database SQL di Azure Cosmos DB

Nome Tipo Descrizione
_rid

string

Proprietà generata dal sistema. Identificatore univoco.
canUndelete

string

Stato di questo database per identificare se questo database è ripristinabile nello stesso account.
canUndeleteReason

string

Motivo per cui questo database non può essere ripristinato nello stesso account.
database

Database

Oggetto risorsa del database SQL di Cosmos DB
eventTimestamp

string

Ora in cui si è verificato questo evento di database.
operationType

OperationType

Tipo di operazione di questo evento di database.
ownerId

string

Nome del database SQL.
ownerResourceId

string

ID risorsa del database SQL.

ResourceRestoreParameters

Parametri per indicare le informazioni sul ripristino.

Nome Tipo Descrizione
restoreSource

string

ID dell'account del database ripristinabile da cui deve essere avviato il ripristino. Ad esempio: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc

string

Ora in cui l'account deve essere ripristinato (formato ISO-8601).

RestorableSqlDatabaseGetResult

Evento di database SQL di Azure Cosmos DB

Nome Tipo Descrizione
id

string

Identificatore di risorsa univoco della risorsa ARM.
name

string

Nome della risorsa ARM.
properties.resource

Resource

Risorsa di un evento di database SQL di Azure Cosmos DB
type

string

Tipo di risorsa di Azure.

RestorableSqlDatabasesListResult

Risposta dell'operazione Elenco contenente gli eventi del database SQL e le relative proprietà.

Nome Tipo Descrizione
value

RestorableSqlDatabaseGetResult[]

Elenco degli eventi del database SQL e delle relative proprietà.