Restorable Sql Databases - List

Referência

Serviço:: Cosmos DB Resource Provider

Versão da API:: 2024-11-15

Mostrar o feed de eventos de todas as mutações feitas em todos os bancos de dados SQL do Azure Cosmos DB na conta restaurável. Isso ajuda no cenário em que o banco de dados foi excluído acidentalmente para obter o tempo de exclusão. Essa API requer a permissão 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read'

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
instanceId	path	True	string	O GUID instanceId de uma conta de banco de dados restaurável.
location	path	True	string	Região do Cosmos DB, com espaços entre palavras e cada palavra maiúscula.
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	RestorableSqlDatabasesListResult	A operação foi concluída com êxito.
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	Representar sua conta de usuário

Exemplos

CosmosDBRestorableSqlDatabaseList

Solicitação de exemplo

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-11-15


/**
 * Samples for RestorableSqlDatabases List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/
     * CosmosDBRestorableSqlDatabaseList.json
     */
    /**
     * Sample code: CosmosDBRestorableSqlDatabaseList.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBRestorableSqlDatabaseList(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getRestorableSqlDatabases().list("WestUS",
            "d9b26648-2f53-4541-b3d8-3044f4f9810d", com.azure.core.util.Context.NONE);
    }
}

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

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/stable/2024-11-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/ded6306d00ae294c24211e5069c1f56b15ba8ef5/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-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");

/**
 * 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/stable/2024-11-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 (let 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

Resposta de exemplo

Código de status:: 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"
        }
      }
    }
  ]
}

Definições

Nome	Description
CloudError	Uma resposta de erro do serviço.
CreateMode	Enumerar para indicar o modo de criação da conta.
Database	Objeto de recurso do banco de dados SQL do Cosmos DB
ErrorResponse	Resposta de erro.
OperationType	Enumerar para indicar o tipo de operação do evento.
Resource	O recurso de um evento de banco de dados SQL do Azure Cosmos DB
ResourceRestoreParameters	Parâmetros para indicar as informações sobre a restauração.
RestorableSqlDatabaseGetResult	Um evento do banco de dados SQL do Azure Cosmos DB
RestorableSqlDatabasesListResult	A resposta da operação Lista, que contém os eventos do banco de dados SQL e suas propriedades.

CloudError

Uma resposta de erro do serviço.

Nome	Tipo	Description
error	ErrorResponse	Resposta de erro.

CreateMode

Enumerar para indicar o modo de criação da conta.

Nome	Tipo	Description
Default	string
Restore	string

Database

Objeto de recurso do banco de dados SQL do Cosmos DB

Nome	Tipo	Valor padrão	Description
_colls	string		Uma propriedade gerada pelo sistema que especificou o caminho endereçável do recurso de coleções.
_etag	string		Uma propriedade gerada pelo sistema que representa a etag de recurso necessária para o controle de simultaneidade otimista.
_rid	string		Uma propriedade gerada pelo sistema. Um identificador exclusivo.
_self	string		Uma propriedade gerada pelo sistema que especifica o caminho endereçável do recurso de banco de dados.
_ts	number		Uma propriedade gerada pelo sistema que indica o último carimbo de data/hora atualizado do recurso.
_users	string		Uma propriedade gerada pelo sistema que especifica o caminho endereçável do recurso de usuários.
createMode	CreateMode	Default	Enumerar para indicar o modo de criação de recursos.
id	string		Nome do banco de dados SQL do Cosmos DB
restoreParameters	ResourceRestoreParameters		Parâmetros para indicar as informações sobre a restauração

ErrorResponse

Resposta de erro.

Nome	Tipo	Description
code	string	Código de erro.
message	string	Mensagem de erro indicando por que a operação falhou.

OperationType

Enumerar para indicar o tipo de operação do evento.

Nome	Tipo	Description
Create	string
Delete	string
Recreate	string
Replace	string
SystemOperation	string

Resource

O recurso de um evento de banco de dados SQL do Azure Cosmos DB

Nome	Tipo	Description
_rid	string	Uma propriedade gerada pelo sistema. Um identificador exclusivo.
canUndelete	string	Um estado desse banco de dados para identificar se esse banco de dados é restaurável na mesma conta.
canUndeleteReason	string	O motivo pelo qual esse banco de dados não pode ser restaurado na mesma conta.
database	Database	Objeto de recurso do banco de dados SQL do Cosmos DB
eventTimestamp	string	A hora em que esse evento de banco de dados aconteceu.
operationType	OperationType	O tipo de operação desse evento de banco de dados.
ownerId	string	O nome do banco de dados SQL.
ownerResourceId	string	A ID do recurso do banco de dados SQL.

ResourceRestoreParameters

Parâmetros para indicar as informações sobre a restauração.

Nome	Tipo	Description
restoreSource	string	A ID da conta de banco de dados restaurável da qual a restauração deve ser iniciada. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string	Tempo para o qual a conta precisa ser restaurada (formato ISO-8601).
restoreWithTtlDisabled	boolean	Especifica se a conta restaurada terá o TempoTo-Live desabilitado após a restauração bem-sucedida.

RestorableSqlDatabaseGetResult

Um evento do banco de dados SQL do Azure Cosmos DB

Nome	Tipo	Description
id	string	O identificador de recurso exclusivo do recurso do ARM.
name	string	O nome do recurso do ARM.
properties.resource	Resource	O recurso de um evento de banco de dados SQL do Azure Cosmos DB
type	string	O tipo de recurso do Azure.