你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Restorable Sql Databases - List

服务:

Cosmos DB Resource Provider

API 版本:

2024-11-15

显示在可还原帐户下的所有 Azure Cosmos DB SQL 数据库上完成的所有突变的事件源。 这有助于在意外删除数据库以获取删除时间的情况下。 此 API 需要“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

URI 参数

名称	在	必需	类型	说明
instanceId	path	True	string	可还原数据库帐户的 instanceId GUID。
location	path	True	string	Cosmos DB 区域，单词和每个单词的大小写之间的空格。
subscriptionId	path	True	string	目标订阅的 ID。
api-version	query	True	string	用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	RestorableSqlDatabasesListResult	操作已成功完成。
Other Status Codes	CloudError	描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

CosmosDBRestorableSqlDatabaseList

示例请求

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

示例响应

状态代码:

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

定义

名称	说明
CloudError	服务的错误响应。
CreateMode	枚举以指示帐户创建模式。
Database	Cosmos DB SQL 数据库资源对象
ErrorResponse	错误响应。
OperationType	枚举以指示事件的操作类型。
Resource	Azure Cosmos DB SQL 数据库事件的资源
ResourceRestoreParameters	用于指示还原信息的参数。
RestorableSqlDatabaseGetResult	Azure Cosmos DB SQL 数据库事件
RestorableSqlDatabasesListResult	包含 SQL 数据库事件及其属性的列表操作响应。

CloudError

服务的错误响应。

名称	类型	说明
error	ErrorResponse	错误响应。

CreateMode

枚举以指示帐户创建模式。

名称	类型	说明
Default	string
Restore	string

Database

Cosmos DB SQL 数据库资源对象

名称	类型	默认值	说明
_colls	string		一个系统生成的属性，该属性指定集合资源的可寻址路径。
_etag	string		表示乐观并发控制所需的资源 etag 的系统生成属性。
_rid	string		系统生成的属性。 唯一标识符。
_self	string		一个系统生成的属性，指定数据库资源的可寻址路径。
_ts	number		一个系统生成的属性，该属性表示资源的上次更新时间戳。
_users	string		一个系统生成的属性，指定用户资源的可寻址路径。
createMode	CreateMode	Default	用于指示资源创建模式的枚举。
id	string		Cosmos DB SQL 数据库的名称
restoreParameters	ResourceRestoreParameters		指示有关还原的信息的参数

ErrorResponse

错误响应。

名称	类型	说明
code	string	错误代码。
message	string	指示操作失败的原因的错误消息。

OperationType

枚举以指示事件的操作类型。

名称	类型	说明
Create	string
Delete	string
Recreate	string
Replace	string
SystemOperation	string

Resource

Azure Cosmos DB SQL 数据库事件的资源

名称	类型	说明
_rid	string	系统生成的属性。 唯一标识符。
canUndelete	string	此数据库的状态，用于确定此数据库是否在同一帐户中可还原。
canUndeleteReason	string	无法在同一帐户中还原此数据库的原因。
database	Database	Cosmos DB SQL 数据库资源对象
eventTimestamp	string	发生此数据库事件的时间。
operationType	OperationType	此数据库事件的操作类型。
ownerId	string	SQL 数据库的名称。
ownerResourceId	string	SQL 数据库的资源 ID。

ResourceRestoreParameters

用于指示还原信息的参数。

名称	类型	说明
restoreSource	string	必须从中启动还原的可还原数据库帐户的 ID。 例如：/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string	帐户必须还原到的时间（ISO-8601 格式）。
restoreWithTtlDisabled	boolean	指定还原的帐户是否在成功还原时禁用时间To-Live。

RestorableSqlDatabaseGetResult

Azure Cosmos DB SQL 数据库事件

名称	类型	说明
id	string	ARM 资源的唯一资源标识符。
name	string	ARM 资源的名称。
properties.resource	Resource	Azure Cosmos DB SQL 数据库事件的资源
type	string	Azure 资源的类型。

RestorableSqlDatabasesListResult

包含 SQL 数据库事件及其属性的列表操作响应。

名称	类型	说明
value	RestorableSqlDatabaseGetResult[]	SQL 数据库事件及其属性的列表。