Restorable Sql Databases - List

Dienst:: Cosmos DB Resource Provider

API-Version:: 2025-10-15

Zeigen Sie den Ereignisfeed aller Mutationen an, die für alle Azure Cosmos DB SQL-Datenbanken unter dem wiederherstellbaren Konto vorgenommen wurden. Dies ist hilfreich in Szenarien, in denen die Datenbank versehentlich gelöscht wurde, um die Löschzeit zu erhalten. 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=2025-10-15

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
instanceId	path	True	string	Die instanceId-GUID eines wiederherstellbaren Datenbankkontos.
location	path	True	string	Cosmos DB-Region, mit Leerzeichen zwischen den Wörtern und jedem Wort in Großbuchstaben.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	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, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

CosmosDBRestorableSqlDatabaseList

Beispielanforderung

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=2025-10-15

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_database_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="2296c272-5d55-40d9-bc05-4d56dc2d7588",
    )

    response = client.restorable_sql_databases.list(
        location="WestUS",
        instance_id="d9b26648-2f53-4541-b3d8-3044f4f9810d",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/DocumentDB/stable/2025-10-15/examples/CosmosDBRestorableSqlDatabaseList.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

package armcosmos_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmos/armcosmos/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/8b53f9cfc1fdb24dbfa28e311d3be4c645169297/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/DocumentDB/stable/2025-10-15/examples/CosmosDBRestorableSqlDatabaseList.json
func ExampleRestorableSQLDatabasesClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcosmos.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewRestorableSQLDatabasesClient().NewListPager("WestUS", "d9b26648-2f53-4541-b3d8-3044f4f9810d", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.RestorableSQLDatabasesListResult = armcosmos.RestorableSQLDatabasesListResult{
		// 	Value: []*armcosmos.RestorableSQLDatabaseGetResult{
		// 		{
		// 			Name: to.Ptr("59c21367-b98b-4a8e-abb7-b6f46600decc"),
		// 			Type: to.Ptr("Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlDatabases"),
		// 			ID: to.Ptr("/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/36f09704-6be3-4f33-aa05-17b73e504c75/restorableSqlDatabases/59c21367-b98b-4a8e-abb7-b6f46600decc"),
		// 			Properties: &armcosmos.RestorableSQLDatabaseProperties{
		// 				Resource: &armcosmos.RestorableSQLDatabasePropertiesResource{
		// 					Rid: to.Ptr("DLB14gAAAA=="),
		// 					CanUndelete: to.Ptr("invalid"),
		// 					Database: &armcosmos.RestorableSQLDatabasePropertiesResourceDatabase{
		// 						Etag: to.Ptr("\"0000c20a-0000-0700-0000-5f4ff63f0000\""),
		// 						Rid: to.Ptr("3fu-hg=="),
		// 						ID: to.Ptr("Database1"),
		// 						Colls: to.Ptr("colls/"),
		// 						Self: to.Ptr("dbs/3fu-hg==/"),
		// 						Users: to.Ptr("users/"),
		// 					},
		// 					EventTimestamp: to.Ptr("2020-09-02T19:45:03Z"),
		// 					OperationType: to.Ptr(armcosmos.OperationTypeCreate),
		// 					OwnerID: to.Ptr("Database1"),
		// 					OwnerResourceID: to.Ptr("3fu-hg=="),
		// 				},
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("8456cb17-cdb0-4c6a-8db8-d0ff3f886257"),
		// 			Type: to.Ptr("Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlDatabases"),
		// 			ID: to.Ptr("/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableSqlDatabases/8456cb17-cdb0-4c6a-8db8-d0ff3f886257"),
		// 			Properties: &armcosmos.RestorableSQLDatabaseProperties{
		// 				Resource: &armcosmos.RestorableSQLDatabasePropertiesResource{
		// 					Rid: to.Ptr("ESXNLAAAAA=="),
		// 					CanUndelete: to.Ptr("notRestorable"),
		// 					CanUndeleteReason: to.Ptr("Database already exists. Only deleted resources can be restored within same account."),
		// 					Database: &armcosmos.RestorableSQLDatabasePropertiesResourceDatabase{
		// 						Etag: to.Ptr("\"0000c20a-0000-0700-0000-5f4ff63f0000\""),
		// 						Rid: to.Ptr("3fu-hg=="),
		// 						Ts: to.Ptr[float32](1599075903),
		// 						ID: to.Ptr("Database1"),
		// 						Colls: to.Ptr("colls/"),
		// 						Self: to.Ptr("dbs/3fu-hg==/"),
		// 						Users: to.Ptr("users/"),
		// 					},
		// 					EventTimestamp: to.Ptr("2020-09-02T19:53:42Z"),
		// 					OperationType: to.Ptr(armcosmos.OperationTypeDelete),
		// 					OwnerID: to.Ptr("Database1"),
		// 					OwnerResourceID: to.Ptr("3fu-hg=="),
		// 				},
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("2c07991b-9c7c-4e85-be68-b18c1f2ff326"),
		// 			Type: to.Ptr("Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlDatabases"),
		// 			ID: to.Ptr("/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableSqlDatabases/2c07991b-9c7c-4e85-be68-b18c1f2ff326"),
		// 			Properties: &armcosmos.RestorableSQLDatabaseProperties{
		// 				Resource: &armcosmos.RestorableSQLDatabasePropertiesResource{
		// 					Rid: to.Ptr("aXFqUQAAAA=="),
		// 					CanUndelete: to.Ptr("invalid"),
		// 					Database: &armcosmos.RestorableSQLDatabasePropertiesResourceDatabase{
		// 						Etag: to.Ptr("\"0000ca0a-0000-0700-0000-5f4ff82b0000\""),
		// 						Rid: to.Ptr("0SziSg=="),
		// 						ID: to.Ptr("Database2"),
		// 						Colls: to.Ptr("colls/"),
		// 						Self: to.Ptr("dbs/0SziSg==/"),
		// 						Users: to.Ptr("users/"),
		// 					},
		// 					EventTimestamp: to.Ptr("2020-09-02T19:53:15Z"),
		// 					OperationType: to.Ptr(armcosmos.OperationTypeCreate),
		// 					OwnerID: to.Ptr("Database2"),
		// 					OwnerResourceID: to.Ptr("0SziSg=="),
		// 				},
		// 			},
		// 	}},
		// }
	}
}

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

const { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Show the event feed of all mutations done on all the Azure Cosmos DB SQL databases under the restorable account.  This helps in scenario where database was accidentally deleted to get the deletion time.  This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission
 *
 * @summary Show the event feed of all mutations done on all the Azure Cosmos DB SQL databases under the restorable account.  This helps in scenario where database was accidentally deleted to get the deletion time.  This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/DocumentDB/stable/2025-10-15/examples/CosmosDBRestorableSqlDatabaseList.json
 */
async function cosmosDbRestorableSqlDatabaseList() {
  const subscriptionId =
    process.env["COSMOSDB_SUBSCRIPTION_ID"] || "2296c272-5d55-40d9-bc05-4d56dc2d7588";
  const location = "WestUS";
  const instanceId = "d9b26648-2f53-4541-b3d8-3044f4f9810d";
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.restorableSqlDatabases.list(location, instanceId)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.CosmosDB.Models;
using Azure.ResourceManager.CosmosDB;

// Generated from example definition: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/DocumentDB/stable/2025-10-15/examples/CosmosDBRestorableSqlDatabaseList.json
// this example is just showing the usage of "RestorableSqlDatabases_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this RestorableCosmosDBAccountResource created on azure
// for more information of creating RestorableCosmosDBAccountResource, please refer to the document of RestorableCosmosDBAccountResource
string subscriptionId = "2296c272-5d55-40d9-bc05-4d56dc2d7588";
AzureLocation location = new AzureLocation("WestUS");
Guid instanceId = Guid.Parse("d9b26648-2f53-4541-b3d8-3044f4f9810d");
ResourceIdentifier restorableCosmosDBAccountResourceId = RestorableCosmosDBAccountResource.CreateResourceIdentifier(subscriptionId, location, instanceId);
RestorableCosmosDBAccountResource restorableCosmosDBAccount = client.GetRestorableCosmosDBAccountResource(restorableCosmosDBAccountResourceId);

// invoke the operation and iterate over the result
await foreach (RestorableSqlDatabase item in restorableCosmosDBAccount.GetRestorableSqlDatabasesAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

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

Beispiel für eine Antwort

Statuscode:: 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 des Diensts.
CreateMode	Aufzählung, um den Modus der Kontoerstellung anzugeben.
Database	Cosmos DB SQL-Datenbankressourcenobjekt
ErrorResponse	Fehlerantwort.
OperationType	Enum, um den Vorgangstyp des Ereignisses anzugeben.
Resource	Die Ressource eines Azure Cosmos DB SQL-Datenbankereignisses
ResourceRestoreParameters	Parameter, die die Informationen zur Wiederherstellung angeben sollen.
RestorableSqlDatabaseGetResult	Ein Azure Cosmos DB-SQL-Datenbankereignis
RestorableSqlDatabasesListResult	Die Antwort auf den List-Vorgang, die die SQL-Datenbankereignisse und deren Eigenschaften enthält.

CloudError

Objekt

Eine Fehlerantwort des Diensts.

Name	Typ	Beschreibung
error	ErrorResponse	Fehlerantwort.

CreateMode

Enumeration

Aufzählung, um den Modus der Kontoerstellung anzugeben.

Wert	Beschreibung
Default
Restore

Database

Objekt

Cosmos DB SQL-Datenbankressourcenobjekt

Name	Typ	Standardwert	Beschreibung
_colls	string		Eine vom System generierte Eigenschaft, die den adressierbaren Pfad der Sammlungsressource 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. Eine eindeutige Kennung.
_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	Aufzählung, um den Modus der Ressourcenerstellung anzugeben.
id	string		Name der Cosmos DB SQL-Datenbank
restoreParameters	ResourceRestoreParameters		Parameter, die die Informationen zur Wiederherstellung angeben sollen

ErrorResponse

Objekt

Fehlerantwort.

Name	Typ	Beschreibung
code	string	Fehlercode.
message	string	Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

OperationType

Enumeration

Enum, um den Vorgangstyp des Ereignisses anzugeben.

Wert	Beschreibung
Create
Replace
Delete
Recreate
SystemOperation

Resource

Objekt

Die Ressource eines Azure Cosmos DB SQL-Datenbankereignisses

Name	Typ	Beschreibung
_rid	string	Eine vom System generierte Eigenschaft. Eine eindeutige Kennung.
canUndelete	string	Ein Status dieser Datenbank, um zu ermitteln, ob diese Datenbank im selben 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

Objekt

Parameter, die die Informationen zur Wiederherstellung angeben sollen.

Name	Typ	Beschreibung
restoreSource	string	Die ID des wiederherstellbaren Datenbankkontos, von dem die Wiederherstellung initiiert werden muss. Beispiel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string (date-time)	Zeit, zu der das Konto wiederhergestellt werden muss (ISO-8601-Format).
restoreWithTtlDisabled	boolean	Gibt an, ob das wiederhergestellte Konto zeit-To-Live bei der erfolgreichen Wiederherstellung deaktiviert ist.

RestorableSqlDatabaseGetResult

Objekt

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.