Restorable Gremlin Graphs - List

Referencia

Service:: Cosmos DB Resource Provider

API Version:: 2024-05-15

Muestra la fuente de eventos de todas las mutaciones realizadas en todos los gráficos de Gremlin de Azure Cosmos DB en una base de datos específica. Esto ayuda en un escenario en el que el contenedor se eliminó accidentalmente. Esta API requiere el permiso "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read".

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

With optional parameters:

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

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.
endTime	query		string	Hora de finalización de la fuente de eventos de Gremlin restaurable.
restorableGremlinDatabaseRid	query		string	Identificador de recurso de la base de datos de Gremlin.
startTime	query		string	Hora de inicio de la fuente de eventos de Gremlin restaurable.

Respuestas

Nombre	Tipo	Description
200 OK	RestorableGremlinGraphsListResult	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

CosmosDBRestorableGremlinGraphList

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.DocumentDB/locations/WestUS/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableGraphs?api-version=2024-05-15&restorableGremlinDatabaseRid=PD5DALigDgw=

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_graph_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="subid",
    )

    response = client.restorable_gremlin_graphs.list(
        location="WestUS",
        instance_id="98a570f2-63db-4117-91f0-366327b7b353",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/examples/CosmosDBRestorableGremlinGraphList.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/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableGraphs/79609a98-3394-41f8-911f-cfab0c075c86",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGraphs",
      "name": "79609a98-3394-41f8-911f-cfab0c075c86",
      "properties": {
        "resource": {
          "_rid": "zAyAPQAAAA==",
          "eventTimestamp": "2020-10-13T04:56:42Z",
          "ownerId": "Graph1",
          "ownerResourceId": "V18LoLrv-qA=",
          "operationType": "Create",
          "canUndelete": "invalid"
        }
      }
    },
    {
      "id": "/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableGraphs/79609a98-3394-41f8-911f-cfab0c075c86",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableGraphs",
      "name": "79609a98-3394-41f8-911f-cfab0c075c86",
      "properties": {
        "resource": {
          "_rid": "zAyAPQAAAA==",
          "eventTimestamp": "2020-10-13T04:56:42Z",
          "ownerId": "Graph1",
          "ownerResourceId": "V18LoLrv-qA=",
          "operationType": "Delete",
          "canUndelete": "notRestorable",
          "canUndeleteReason": "Individual shared database collections restore is not supported. Please restore shared database to restore its collections that share the throughput."
        }
      }
    }
  ]
}

Definiciones

Nombre	Description
CloudError	Respuesta de error del servicio.
ErrorResponse	Respuesta de error.
OperationType	Enumeración que indica el tipo de operación del evento.
Resource	Recurso de un evento de grafo de Gremlin de Azure Cosmos DB
RestorableGremlinGraphGetResult	Un evento de grafo de Gremlin de Azure Cosmos DB
RestorableGremlinGraphsListResult	La respuesta de la operación List, que contiene los eventos de grafo de Gremlin y sus propiedades.

CloudError

Respuesta de error del servicio.

Nombre	Tipo	Description
error	ErrorResponse	Respuesta de error.

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 grafo de Gremlin de Azure Cosmos DB

Nombre	Tipo	Description
_rid	string	Propiedad generada por el sistema. Identificador único.
canUndelete	string	Estado de este grafo para identificar si este grafo es restaurable en la misma cuenta.
canUndeleteReason	string	La razón por la que este grafo no se puede restaurar en la misma cuenta.
eventTimestamp	string	Hora en que se produjo este evento de grafo.
operationType	OperationType	Tipo de operación de este evento de grafo.
ownerId	string	Nombre de este grafo de Gremlin.
ownerResourceId	string	Identificador de recurso de este grafo de Gremlin.

RestorableGremlinGraphGetResult

Un evento de grafo de Gremlin de Azure Cosmos DB

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