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

Restorable Gremlin Resources - List

参考

服务:: Cosmos DB Resource Provider

API 版本:: 2024-11-15

返回给定时间戳和位置的帐户上存在的 gremlin 数据库和图形组合的列表。这有助于在方案中验证给定时间戳和位置存在的资源。此 API 需要“Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read”权限。

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

具有可选参数:

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

URI 参数

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

响应

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

CosmosDBRestorableGremlinResourceList

GET https://management.azure.com/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/WestUS/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableGremlinResources?api-version=2024-11-15&restoreLocation=WestUS&restoreTimestampInUtc=06/01/2022 4:56

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_gremlin_resource_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_gremlin_resources.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/CosmosDBRestorableGremlinResourceList.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/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableGremlinResources/Database1",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGremlinResources",
      "name": "Database1",
      "databaseName": "Database1",
      "graphNames": [
        "Graph1"
      ]
    },
    {
      "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableGremlinResources/Database2",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGremlinResources",
      "name": "Database2",
      "databaseName": "Database2",
      "graphNames": [
        "Graph1",
        "Graph2"
      ]
    },
    {
      "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableGremlinResources/Database3",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGremlinResources",
      "name": "Database3",
      "databaseName": "Database3",
      "graphNames": []
    }
  ]
}

定义

名称	说明
CloudError	服务的错误响应。
ErrorResponse	错误响应。
RestorableGremlinResourcesGetResult	要还原的特定数据库。
RestorableGremlinResourcesListResult	包含可还原 Gremlin 资源的 List 操作响应。

CloudError

服务的错误响应。

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

ErrorResponse

错误响应。

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

RestorableGremlinResourcesGetResult

要还原的特定数据库。

名称	类型	说明
databaseName	string	可用于还原的 gremlin 数据库的名称。
graphNames	string[]	可用于还原的图形的名称。
id	string	ARM 资源的唯一资源标识符。
name	string	ARM 资源的名称。
type	string	Azure 资源的类型。