Restorable Mongodb Collections - List

Referência

Serviço:: Cosmos DB Resource Provider

Versão da API:: 2024-11-15

Mostrar o feed de eventos de todas as mutações feitas em todas as coleções MongoDB do Azure Cosmos DB em um banco de dados específico. Isso ajuda no cenário em que o contêiner foi excluído acidentalmente. Esta API requer a permissão 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read'

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

Com parâmetros opcionais:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
instanceId	path	True	string	O GUID instanceId de uma conta de banco de dados restaurável.
location	path	True	string	Região do Cosmos DB, com espaços entre palavras e cada palavra em maiúsculas.
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.
endTime	query		string	Hora de término do feed de eventos de coleções MongoDB restauráveis.
restorableMongodbDatabaseRid	query		string	O ID do recurso do banco de dados MongoDB.
startTime	query		string	Hora de início do feed de eventos de coleções MongoDB restauráveis.

Respostas

Name	Tipo	Description
200 OK	RestorableMongodbCollectionsListResult	A operação foi concluída com êxito.
Other Status Codes	CloudError	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	Personificar a sua conta de utilizador

Exemplos

CosmosDBRestorableMongodbCollectionList

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

{
  "value": [
    {
      "id": "/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableMongodbCollections/79609a98-3394-41f8-911f-cfab0c075c86",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableMongodbCollections",
      "name": "79609a98-3394-41f8-911f-cfab0c075c86",
      "properties": {
        "resource": {
          "_rid": "zAyAPQAAAA==",
          "eventTimestamp": "2020-10-13T04:56:42Z",
          "ownerId": "Collection1",
          "ownerResourceId": "V18LoLrv-qA=",
          "operationType": "Create",
          "canUndelete": "invalid"
        }
      }
    },
    {
      "id": "/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableMongodbCollections/79609a98-3394-41f8-911f-cfab0c075c86",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableMongodbCollections",
      "name": "79609a98-3394-41f8-911f-cfab0c075c86",
      "properties": {
        "resource": {
          "_rid": "zAyAPQAAAA==",
          "eventTimestamp": "2020-10-13T04:56:42Z",
          "ownerId": "Collection1",
          "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."
        }
      }
    }
  ]
}

Definições

Name	Description
CloudError	Uma resposta de erro do serviço.
ErrorResponse	Resposta de erro.
OperationType	Enum para indicar o tipo de operação do evento.
Resource	O recurso de um evento de coleção MongoDB do Azure Cosmos DB
RestorableMongodbCollectionGetResult	Um evento de coleção MongoDB do Azure Cosmos DB
RestorableMongodbCollectionsListResult	A resposta da operação List, que contém os eventos da coleção MongoDB e suas propriedades.

CloudError

Uma resposta de erro do serviço.

Name	Tipo	Description
error	ErrorResponse	Resposta de erro.

ErrorResponse

Resposta de erro.

Name	Tipo	Description
code	string	Código de erro.
message	string	Mensagem de erro indicando por que a operação falhou.

OperationType

Enum para indicar o tipo de operação do evento.

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

Resource

O recurso de um evento de coleção MongoDB do Azure Cosmos DB

Name	Tipo	Description
_rid	string	Uma propriedade gerada pelo sistema. Um identificador único.
canUndelete	string	Um estado dessa coleção para identificar se esse contêiner é restaurável na mesma conta.
canUndeleteReason	string	A razão pela qual esta coleção não pode ser restaurada na mesma conta.
eventTimestamp	string	O momento em que esse evento de coleta aconteceu.
operationType	OperationType	O tipo de operação deste evento de coleção.
ownerId	string	O nome desta coleção MongoDB.
ownerResourceId	string	O ID do recurso desta coleção MongoDB.

RestorableMongodbCollectionGetResult

Um evento de coleção MongoDB do Azure Cosmos DB

Name	Tipo	Description
id	string	O identificador de recurso exclusivo do recurso ARM.
name	string	O nome do recurso ARM.
properties.resource	Resource	O recurso de um evento de coleção MongoDB do Azure Cosmos DB
type	string	O tipo de recurso do Azure.