특정 데이터베이스 아래의 모든 Azure Cosmos DB MongoDB 컬렉션에서 수행된 모든 변형의 이벤트 피드를 표시합니다. 이는 컨테이너가 실수로 삭제된 시나리오에서 도움이 됩니다. 이 API에는 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' 권한이 필요합니다.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableMongodbCollections?api-version=2023-11-15
With optional parameters:
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableMongodbCollections?api-version=2023-11-15&restorableMongodbDatabaseRid={restorableMongodbDatabaseRid}&startTime={startTime}&endTime={endTime}
URI 매개 변수
| Name |
In(다음 안에) |
필수 |
형식 |
Description |
|
instanceId
|
path |
True
|
string
|
복원 가능한 데이터베이스 계정의 instanceId GUID입니다.
|
|
location
|
path |
True
|
string
|
단어와 각 단어 사이의 공백이 대문자로 표시된 Cosmos DB 영역입니다.
|
|
subscriptionId
|
path |
True
|
string
|
대상 구독의 ID입니다.
|
|
api-version
|
query |
True
|
string
|
이 작업에 사용할 API 버전입니다.
|
|
endTime
|
query |
|
string
|
복원 가능한 MongoDB 컬렉션 이벤트 피드 종료 시간입니다.
|
|
restorableMongodbDatabaseRid
|
query |
|
string
|
MongoDB 데이터베이스의 리소스 ID입니다.
|
|
startTime
|
query |
|
string
|
복원 가능한 MongoDB 컬렉션 이벤트 피드 시작 시간입니다.
|
응답
보안
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
|
사용자 계정 가장
|
예제
CosmosDBRestorableMongodbCollectionList
Sample Request
GET https://management.azure.com/subscriptions/subid/providers/Microsoft.DocumentDB/locations/WestUS/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableMongodbCollections?api-version=2023-11-15&restorableMongodbDatabaseRid=PD5DALigDgw=
/**
* Samples for RestorableMongodbCollections List.
*/
public final class Main {
/*
* x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-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/2023-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/v2"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/41e4538ed7bb3ceac3c1322c9455a0812ed110ac/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-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/2023-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
Sample Response
{
"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."
}
}
}
]
}
정의
CloudError
서비스의 오류 응답입니다.
ErrorResponse
오류 응답.
| Name |
형식 |
Description |
|
code
|
string
|
오류 코드
|
|
message
|
string
|
작업이 실패한 이유를 나타내는 오류 메시지입니다.
|
OperationType
이벤트의 작업 유형을 나타내는 열거형입니다.
| Name |
형식 |
Description |
|
Create
|
string
|
|
|
Delete
|
string
|
|
|
Recreate
|
string
|
|
|
Replace
|
string
|
|
|
SystemOperation
|
string
|
|
Resource
Azure Cosmos DB MongoDB 컬렉션 이벤트의 리소스
| Name |
형식 |
Description |
|
_rid
|
string
|
시스템 생성 속성입니다. 고유 식별자입니다.
|
|
canUndelete
|
string
|
이 컨테이너가 동일한 계정에서 복원 가능한지 식별하기 위한 이 컬렉션의 상태입니다.
|
|
canUndeleteReason
|
string
|
이 컬렉션을 동일한 계정에서 복원할 수 없는 이유입니다.
|
|
eventTimestamp
|
string
|
이 컬렉션 이벤트가 발생한 시간입니다.
|
|
operationType
|
OperationType
|
이 컬렉션 이벤트의 작업 형식입니다.
|
|
ownerId
|
string
|
이 MongoDB 컬렉션의 이름입니다.
|
|
ownerResourceId
|
string
|
이 MongoDB 컬렉션의 리소스 ID입니다.
|
RestorableMongodbCollectionGetResult
Azure Cosmos DB MongoDB 컬렉션 이벤트
| Name |
형식 |
Description |
|
id
|
string
|
ARM 리소스의 고유 리소스 식별자입니다.
|
|
name
|
string
|
ARM 리소스의 이름입니다.
|
|
properties.resource
|
Resource
|
Azure Cosmos DB MongoDB 컬렉션 이벤트의 리소스
|
|
type
|
string
|
Azure 리소스의 유형입니다.
|
RestorableMongodbCollectionsListResult
MongoDB 컬렉션 이벤트 및 해당 속성을 포함하는 목록 작업 응답입니다.