Restorable Gremlin Resources - List

Reference

Service:: Cosmos DB Resource Provider

API Version:: 2024-11-15

Return a list of gremlin database and graphs combo that exist on the account at the given timestamp and location. This helps in scenarios to validate what resources exist at given timestamp and location. This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission.

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

With optional parameters:

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 Parameters

Name	In	Required	Type	Description
instanceId	path	True	string	The instanceId GUID of a restorable database account.
location	path	True	string	Cosmos DB region, with spaces between words and each word capitalized.
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.
restoreLocation	query		string	The location where the restorable resources are located.
restoreTimestampInUtc	query		string	The timestamp when the restorable resources existed.

Responses

Name	Type	Description
200 OK	RestorableGremlinResourcesListResult	The operation completed successfully.
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	Impersonate your user account

Examples

CosmosDBRestorableGremlinResourceList

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/restorableGremlinResources?api-version=2024-11-15&restoreLocation=WestUS&restoreTimestampInUtc=06/01/2022 4:56

Sample response

Status code:: 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": []
    }
  ]
}

Definitions

Name	Description
CloudError	An error response from the service.
ErrorResponse	Error Response.
RestorableGremlinResourcesGetResult	Specific Databases to restore.
RestorableGremlinResourcesListResult	The List operation response, that contains the restorable Gremlin resources.

CloudError

An error response from the service.

Name	Type	Description
error	ErrorResponse	Error Response.

ErrorResponse

Error Response.

Name	Type	Description
code	string	Error code.
message	string	Error message indicating why the operation failed.

RestorableGremlinResourcesGetResult

Specific Databases to restore.

Name	Type	Description
databaseName	string	The name of the gremlin database available for restore.
graphNames	string[]	The names of the graphs available for restore.
id	string	The unique resource identifier of the ARM resource.
name	string	The name of the ARM resource.
type	string	The type of Azure resource.