Restorable Sql Databases - List

Service:

Cosmos DB Resource Provider

API Version:

2024-05-15

Muestre la fuente de eventos de todas las mutaciones realizadas en todas las instancias de SQL Database de Azure Cosmos DB en la cuenta restaurable. Esto ayuda en el escenario en el que la base de datos se elimina accidentalmente para obtener el tiempo de eliminación. Esta API requiere el permiso "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read".

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
instanceId	path	True	string	GUID instanceId de una cuenta de base de datos restaurable.
location	path	True	string	Región de Cosmos DB, con espacios entre palabras y cada palabra en mayúsculas.
subscriptionId	path	True	string	Identificador de la suscripción de destino.
api-version	query	True	string	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	RestorableSqlDatabasesListResult	La operación se ha completado correctamente.
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	Suplantación de su cuenta de usuario

Ejemplos

CosmosDBRestorableSqlDatabaseList

Sample Request

HTTP

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

Python

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

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

Definiciones

Nombre	Description
CloudError	Respuesta de error del servicio.
CreateMode	Enumeración para indicar el modo de creación de la cuenta.
Database	Objeto de recurso de base de datos SQL de Cosmos DB
ErrorResponse	Respuesta de error.
OperationType	Enumeración que indica el tipo de operación del evento.
Resource	Recurso de un evento de instancia de SQL Database de Azure Cosmos DB.
ResourceRestoreParameters	Parámetros para indicar la información sobre la restauración.
RestorableSqlDatabaseGetResult	Evento de instancia de SQL Database de Azure Cosmos DB.
RestorableSqlDatabasesListResult	Respuesta de la operación de lista, que contiene los eventos de la instancia de SQL Database y sus propiedades.

CloudError

Respuesta de error del servicio.

Nombre	Tipo	Description
error	ErrorResponse	Respuesta de error.

CreateMode

Enumeración para indicar el modo de creación de la cuenta.

Nombre	Tipo	Description
Default	string
Restore	string

Database

Objeto de recurso de base de datos SQL de Cosmos DB

Nombre	Tipo	Valor predeterminado	Description
_colls	string		Propiedad generada por el sistema que especificó la ruta de acceso direccionable del recurso de colecciones.
_etag	string		Propiedad generada por el sistema que representa la etag de recursos necesaria para el control de simultaneidad optimista.
_rid	string		Propiedad generada por el sistema. Identificador único.
_self	string		Propiedad generada por el sistema que especifica la ruta de acceso direccionable del recurso de base de datos.
_ts	number		Propiedad generada por el sistema que indica la última marca de tiempo actualizada del recurso.
_users	string		Propiedad generada por el sistema que especifica la ruta de acceso direccionable del recurso de usuarios.
createMode	CreateMode	Default	Enumeración para indicar el modo de creación de recursos.
id	string		Nombre de la base de datos SQL de Cosmos DB
restoreParameters	ResourceRestoreParameters		Parámetros para indicar la información sobre la restauración

ErrorResponse

Respuesta de error.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Mensaje de error que indica por qué se produjo un error en la operación.

OperationType

Enumeración que indica el tipo de operación del evento.

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

Resource

Recurso de un evento de instancia de SQL Database de Azure Cosmos DB.

Nombre	Tipo	Description
_rid	string	Propiedad generada por el sistema. Identificador único.
canUndelete	string	Estado de esta base de datos para identificar si esta base de datos se puede restaurar en la misma cuenta.
canUndeleteReason	string	Motivo por el que esta base de datos no se puede restaurar en la misma cuenta.
database	Database	Objeto de recurso de base de datos SQL de Cosmos DB
eventTimestamp	string	Hora en la que se produjo este evento de base de datos.
operationType	OperationType	Tipo de operación de este evento de base de datos.
ownerId	string	Nombre de la base de datos SQL.
ownerResourceId	string	Identificador de recurso de la instancia de SQL Database.

ResourceRestoreParameters

Parámetros para indicar la información sobre la restauración.

Nombre	Tipo	Description
restoreSource	string	Identificador de la cuenta de base de datos restaurable desde la que se debe iniciar la restauración. Por ejemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string	Hora a la que se debe restaurar la cuenta (formato ISO-8601).

RestorableSqlDatabaseGetResult

Evento de instancia de SQL Database de Azure Cosmos DB.

Nombre	Tipo	Description
id	string	Identificador de recurso único del recurso de ARM.
name	string	Nombre del recurso de ARM.
properties.resource	Resource	Recurso de un evento de instancia de SQL Database de Azure Cosmos DB.
type	string	Tipo de recurso de Azure.

RestorableSqlDatabasesListResult

Respuesta de la operación de lista, que contiene los eventos de la instancia de SQL Database y sus propiedades.

Nombre	Tipo	Description
value	RestorableSqlDatabaseGetResult[]	Lista de eventos de base de datos SQL y sus propiedades.