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 do 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. Essa 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 de URI

Nome	Em	Obrigató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 maiúscula.
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 do MongoDB restaurável.
restorableMongodbDatabaseRid	query		string	A ID do recurso do banco de dados do MongoDB.
startTime	query		string	Hora de início do feed de eventos de coleções do MongoDB restaurável.

Respostas

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

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Escopos

Nome	Description
user_impersonation	Representar sua conta de usuário

Exemplos

CosmosDBRestorableMongodbCollectionList

Solicitação de exemplo

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=


/**
 * Samples for RestorableMongodbCollections List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/
     * CosmosDBRestorableMongodbCollectionList.json
     */
    /**
     * Sample code: CosmosDBRestorableMongodbCollectionList.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBRestorableMongodbCollectionList(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getRestorableMongodbCollections().list("WestUS",
            "98a570f2-63db-4117-91f0-366327b7b353", "PD5DALigDgw=", null, null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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_mongodb_collection_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_mongodb_collections.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-11-15/examples/CosmosDBRestorableMongodbCollectionList.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

package armcosmos_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmos/armcosmos/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ded6306d00ae294c24211e5069c1f56b15ba8ef5/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/CosmosDBRestorableMongodbCollectionList.json
func ExampleRestorableMongodbCollectionsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcosmos.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewRestorableMongodbCollectionsClient().NewListPager("WestUS", "98a570f2-63db-4117-91f0-366327b7b353", &armcosmos.RestorableMongodbCollectionsClientListOptions{RestorableMongodbDatabaseRid: to.Ptr("PD5DALigDgw="),
		StartTime: nil,
		EndTime:   nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.RestorableMongodbCollectionsListResult = armcosmos.RestorableMongodbCollectionsListResult{
		// 	Value: []*armcosmos.RestorableMongodbCollectionGetResult{
		// 		{
		// 			Name: to.Ptr("79609a98-3394-41f8-911f-cfab0c075c86"),
		// 			Type: to.Ptr("Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableMongodbCollections"),
		// 			ID: to.Ptr("/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableMongodbCollections/79609a98-3394-41f8-911f-cfab0c075c86"),
		// 			Properties: &armcosmos.RestorableMongodbCollectionProperties{
		// 				Resource: &armcosmos.RestorableMongodbCollectionPropertiesResource{
		// 					Rid: to.Ptr("zAyAPQAAAA=="),
		// 					CanUndelete: to.Ptr("invalid"),
		// 					EventTimestamp: to.Ptr("2020-10-13T04:56:42Z"),
		// 					OperationType: to.Ptr(armcosmos.OperationTypeCreate),
		// 					OwnerID: to.Ptr("Collection1"),
		// 					OwnerResourceID: to.Ptr("V18LoLrv-qA="),
		// 				},
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("79609a98-3394-41f8-911f-cfab0c075c86"),
		// 			Type: to.Ptr("Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableMongodbCollections"),
		// 			ID: to.Ptr("/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableMongodbCollections/79609a98-3394-41f8-911f-cfab0c075c86"),
		// 			Properties: &armcosmos.RestorableMongodbCollectionProperties{
		// 				Resource: &armcosmos.RestorableMongodbCollectionPropertiesResource{
		// 					Rid: to.Ptr("zAyAPQAAAA=="),
		// 					CanUndelete: to.Ptr("notRestorable"),
		// 					CanUndeleteReason: to.Ptr("Individual shared database collections restore is not supported. Please restore shared database to restore its collections that share the throughput."),
		// 					EventTimestamp: to.Ptr("2020-10-13T04:56:42Z"),
		// 					OperationType: to.Ptr(armcosmos.OperationTypeDelete),
		// 					OwnerID: to.Ptr("Collection1"),
		// 					OwnerResourceID: to.Ptr("V18LoLrv-qA="),
		// 				},
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Show the event feed of all mutations done on all the Azure Cosmos DB MongoDB collections under a specific database.  This helps in scenario where container was accidentally deleted.  This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission
 *
 * @summary Show the event feed of all mutations done on all the Azure Cosmos DB MongoDB collections under a specific database.  This helps in scenario where container was accidentally deleted.  This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/CosmosDBRestorableMongodbCollectionList.json
 */
async function cosmosDbRestorableMongodbCollectionList() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const location = "WestUS";
  const instanceId = "98a570f2-63db-4117-91f0-366327b7b353";
  const restorableMongodbDatabaseRid = "PD5DALigDgw=";
  const options = {
    restorableMongodbDatabaseRid,
  };
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.restorableMongodbCollections.list(location, instanceId, options)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

Código de status:: 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

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

CloudError

Uma resposta de erro do serviço.

Nome	Tipo	Description
error	ErrorResponse	Resposta de erro.

ErrorResponse

Resposta de erro.

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

OperationType

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

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

Resource

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

Nome	Tipo	Description
_rid	string	Uma propriedade gerada pelo sistema. Um identificador exclusivo.
canUndelete	string	Um estado dessa coleção para identificar se esse contêiner é restaurável na mesma conta.
canUndeleteReason	string	O motivo pelo qual essa coleção não pode ser restaurada na mesma conta.
eventTimestamp	string	A hora em que esse evento de coleção aconteceu.
operationType	OperationType	O tipo de operação desse evento de coleção.
ownerId	string	O nome desta coleção do MongoDB.
ownerResourceId	string	A ID do recurso desta coleção do MongoDB.

RestorableMongodbCollectionGetResult

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

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