Restorable Sql Containers - List

특정 데이터베이스 아래의 모든 Azure Cosmos DB SQL 컨테이너에서 수행된 모든 변형의 이벤트 피드를 표시합니다. 이는 컨테이너가 실수로 삭제된 시나리오에서 도움이 됩니다. 이 API에는 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' 권한이 필요합니다.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlContainers?api-version=2023-11-15
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlContainers?api-version=2023-11-15&restorableSqlDatabaseRid={restorableSqlDatabaseRid}&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

복원 가능한 Sql 컨테이너 이벤트 피드 종료 시간입니다.

restorableSqlDatabaseRid
query

string

SQL 데이터베이스의 리소스 ID입니다.

startTime
query

string

복원 가능한 Sql 컨테이너 이벤트 피드 시작 시간입니다.

응답

Name 형식 Description
200 OK

RestorableSqlContainersListResult

작업이 성공적으로 완료되었습니다.

Other Status Codes

CloudError

작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

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 사용자 계정 가장

예제

CosmosDBRestorableSqlContainerList

Sample Request

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.DocumentDB/locations/WestUS/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableSqlContainers?api-version=2023-11-15&restorableSqlDatabaseRid=3fu-hg==

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableSqlContainers/79609a98-3394-41f8-911f-cfab0c075c86",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlContainers",
      "name": "79609a98-3394-41f8-911f-cfab0c075c86",
      "properties": {
        "resource": {
          "_rid": "zAyAPQAAAA==",
          "eventTimestamp": "2020-10-13T04:56:42Z",
          "ownerId": "Container1",
          "ownerResourceId": "V18LoLrv-qA=",
          "operationType": "Create",
          "canUndelete": "invalid",
          "container": {
            "id": "Container1",
            "indexingPolicy": {
              "indexingMode": "consistent",
              "automatic": true,
              "includedPaths": [
                {
                  "path": "/*"
                },
                {
                  "path": "/\"_ts\"/?"
                }
              ],
              "excludedPaths": [
                {
                  "path": "/\"_etag\"/?"
                }
              ]
            },
            "conflictResolutionPolicy": {
              "mode": "LastWriterWins",
              "conflictResolutionPath": "/_ts",
              "conflictResolutionProcedure": ""
            },
            "_rid": "V18LoLrv-qA=",
            "_self": "dbs/V18LoA==/colls/V18LoLrv-qA=/",
            "_etag": "\"00003e00-0000-0700-0000-5f85338a0000\""
          }
        }
      }
    },
    {
      "id": "/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableSqlContainers/e85298a1-c631-4726-825e-a7ca092e9098",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlContainers",
      "name": "e85298a1-c631-4726-825e-a7ca092e9098",
      "properties": {
        "resource": {
          "_rid": "PrArcgAAAA==",
          "eventTimestamp": "2020-10-13T05:03:27Z",
          "ownerId": "Container1",
          "ownerResourceId": "V18LoLrv-qA=",
          "operationType": "Replace",
          "canUndelete": "invalid",
          "container": {
            "id": "Container1",
            "indexingPolicy": {
              "indexingMode": "consistent",
              "automatic": true,
              "includedPaths": [
                {
                  "path": "/*"
                },
                {
                  "path": "/\"_ts\"/?"
                }
              ],
              "excludedPaths": [
                {
                  "path": "/\"_etag\"/?"
                }
              ]
            },
            "defaultTtl": 12345,
            "conflictResolutionPolicy": {
              "mode": "LastWriterWins",
              "conflictResolutionPath": "/_ts",
              "conflictResolutionProcedure": ""
            },
            "_rid": "V18LoLrv-qA=",
            "_self": "dbs/V18LoA==/colls/V18LoLrv-qA=/",
            "_etag": "\"00004400-0000-0700-0000-5f85351f0000\""
          }
        }
      }
    }
  ]
}

정의

Name Description
ClientEncryptionIncludedPath

.

ClientEncryptionPolicy

Cosmos DB 클라이언트 암호화 정책.

CloudError

서비스의 오류 응답입니다.

CompositePath
CompositePathSortOrder

복합 경로의 정렬 순서입니다.

ComputedProperty

계산된 속성의 정의

ConflictResolutionMode

충돌 해결 모드를 나타냅니다.

ConflictResolutionPolicy

컨테이너에 대한 충돌 해결 정책입니다.

Container

Cosmos DB SQL 컨테이너 리소스 개체

ContainerPartitionKey

데이터를 여러 파티션으로 분할하는 데 사용할 파티션 키 구성

CreateMode

계정 만들기 모드를 나타내는 열거형입니다.

DataType

인덱싱 동작이 적용되는 데이터 형식입니다.

ErrorResponse

오류 응답.

ExcludedPath
IncludedPath

인덱싱에 포함된 경로

Indexes

경로의 인덱스입니다.

IndexingMode

인덱싱 모드를 나타냅니다.

IndexingPolicy

Cosmos DB 인덱싱 정책

IndexKind

인덱스의 유형을 나타냅니다.

OperationType

이벤트의 작업 유형을 나타내는 열거형입니다.

PartitionKind

분할에 사용되는 알고리즘의 종류를 나타냅니다. MultiHash의 경우 컨테이너 만들기에 대해 여러 파티션 키(최대 3개)가 지원됩니다.

Resource

Azure Cosmos DB SQL 컨테이너 이벤트의 리소스

ResourceRestoreParameters

복원에 대한 정보를 나타내는 매개 변수입니다.

RestorableSqlContainerGetResult

Azure Cosmos DB SQL 컨테이너 이벤트

RestorableSqlContainersListResult

SQL 컨테이너 이벤트 및 해당 속성을 포함하는 목록 작업 응답입니다.

SpatialSpec
SpatialType

인덱스의 공간 형식을 나타냅니다.

UniqueKey

Azure Cosmos DB 서비스의 컬렉션에 있는 문서에 고유성 제약 조건을 적용하는 의 고유 키입니다.

UniqueKeyPolicy

Azure Cosmos DB 서비스의 컬렉션에 있는 문서에 고유성 제약 조건을 지정하기 위한 고유 키 정책 구성입니다.

ClientEncryptionIncludedPath

.

Name 형식 Description
clientEncryptionKeyId

string

경로를 암호화하는 데 사용할 클라이언트 암호화 키의 식별자입니다.

encryptionAlgorithm

string

사용할 암호화 알고리즘입니다. 예 : AEAD_AES_256_CBC_HMAC_SHA256.

encryptionType

string

수행할 암호화 유형입니다. 예 : 결정적, 임의.

path

string

암호화해야 하는 경로입니다.

ClientEncryptionPolicy

Cosmos DB 클라이언트 암호화 정책.

Name 형식 Description
includedPaths

ClientEncryptionIncludedPath[]

경로별 설정과 함께 암호화가 필요한 항목의 경로입니다.

policyFormatVersion

integer

클라이언트 암호화 정책 정의의 버전입니다. 지원되는 버전은 1과 2입니다. 버전 2는 ID 및 파티션 키 경로 암호화를 지원합니다.

CloudError

서비스의 오류 응답입니다.

Name 형식 Description
error

ErrorResponse

오류 응답.

CompositePath

Name 형식 Description
order

CompositePathSortOrder

복합 경로에 대한 정렬 순서입니다.

path

string

인덱싱 동작이 적용되는 경로입니다. 인덱스 경로는 일반적으로 루트로 시작하고 와일드카드(/path/*)로 끝납니다.

CompositePathSortOrder

복합 경로의 정렬 순서입니다.

Name 형식 Description
ascending

string

descending

string

ComputedProperty

계산된 속성의 정의

Name 형식 Description
name

string

계산된 속성의 이름(예: "cp_lowerName")

query

string

계산된 속성의 값을 평가하는 쿼리(예: "SELECT VALUE LOWER(c.name) FROM c"

ConflictResolutionMode

충돌 해결 모드를 나타냅니다.

Name 형식 Description
Custom

string

LastWriterWins

string

ConflictResolutionPolicy

컨테이너에 대한 충돌 해결 정책입니다.

Name 형식 기본값 Description
conflictResolutionPath

string

LastWriterWins 모드의 경우 충돌 해결 경로입니다.

conflictResolutionProcedure

string

사용자 지정 모드의 경우 충돌을 resolve 절차입니다.

mode

ConflictResolutionMode

LastWriterWins

충돌 해결 모드를 나타냅니다.

Container

Cosmos DB SQL 컨테이너 리소스 개체

Name 형식 기본값 Description
_etag

string

낙관적 동시성 제어에 필요한 리소스 etag를 나타내는 시스템 생성 속성입니다.

_rid

string

시스템 생성 속성입니다. 고유 식별자입니다.

_self

string

컨테이너 리소스의 주소 지정 가능 경로를 지정하는 시스템 생성 속성입니다.

_ts

number

리소스의 마지막으로 업데이트된 타임스탬프를 나타내는 시스템 생성 속성입니다.

analyticalStorageTtl

integer

분석 TTL.

clientEncryptionPolicy

ClientEncryptionPolicy

컨테이너에 대한 클라이언트 암호화 정책입니다.

computedProperties

ComputedProperty[]

계산된 속성 목록

conflictResolutionPolicy

ConflictResolutionPolicy

컨테이너에 대한 충돌 해결 정책입니다.

createMode

CreateMode

Default

리소스 만들기 모드를 나타내는 열거형입니다.

defaultTtl

integer

기본 사용 시간

id

string

Cosmos DB SQL 컨테이너의 이름

indexingPolicy

IndexingPolicy

인덱싱 정책의 구성입니다. 기본적으로 인덱싱은 컨테이너 내의 모든 문서 경로에 대해 자동으로 수행됩니다.

partitionKey

ContainerPartitionKey

데이터를 여러 파티션으로 분할하는 데 사용할 파티션 키 구성

restoreParameters

ResourceRestoreParameters

복원에 대한 정보를 나타내는 매개 변수

uniqueKeyPolicy

UniqueKeyPolicy

Azure Cosmos DB 서비스의 컬렉션에 있는 문서에 고유성 제약 조건을 지정하기 위한 고유 키 정책 구성입니다.

ContainerPartitionKey

데이터를 여러 파티션으로 분할하는 데 사용할 파티션 키 구성

Name 형식 기본값 Description
kind

PartitionKind

Hash

분할에 사용되는 알고리즘의 종류를 나타냅니다. MultiHash의 경우 컨테이너 만들기에 대해 여러 파티션 키(최대 3개)가 지원됩니다.

paths

string[]

컨테이너 내에서 분할할 수 있는 데이터를 사용하는 경로 목록

systemKey

boolean

컨테이너가 시스템 생성 파티션 키를 사용하고 있는지를 나타냅니다.

version

integer

파티션 키 정의의 버전을 나타냅니다.

CreateMode

계정 만들기 모드를 나타내는 열거형입니다.

Name 형식 Description
Default

string

Restore

string

DataType

인덱싱 동작이 적용되는 데이터 형식입니다.

Name 형식 Description
LineString

string

MultiPolygon

string

Number

string

Point

string

Polygon

string

String

string

ErrorResponse

오류 응답.

Name 형식 Description
code

string

오류 코드

message

string

작업이 실패한 이유를 나타내는 오류 메시지입니다.

ExcludedPath

Name 형식 Description
path

string

인덱싱 동작이 적용되는 경로입니다. 인덱스 경로는 일반적으로 루트로 시작하고 와일드카드(/path/*)로 끝납니다.

IncludedPath

인덱싱에 포함된 경로

Name 형식 Description
indexes

Indexes[]

이 경로에 대한 인덱스 목록

path

string

인덱싱 동작이 적용되는 경로입니다. 인덱스 경로는 일반적으로 루트로 시작하고 와일드카드(/path/*)로 끝납니다.

Indexes

경로의 인덱스입니다.

Name 형식 기본값 Description
dataType

DataType

String

인덱싱 동작이 적용되는 데이터 형식입니다.

kind

IndexKind

Hash

인덱스의 유형을 나타냅니다.

precision

integer

인덱스의 전체 자릿수입니다. -1은 최대 정밀도입니다.

IndexingMode

인덱싱 모드를 나타냅니다.

Name 형식 Description
consistent

string

lazy

string

none

string

IndexingPolicy

Cosmos DB 인덱싱 정책

Name 형식 기본값 Description
automatic

boolean

인덱싱 정책이 자동인지를 나타냅니다.

compositeIndexes

CompositePath[]

복합 경로 목록

excludedPaths

ExcludedPath[]

인덱싱에서 제외할 경로 목록

includedPaths

IncludedPath[]

인덱싱에 포함할 경로 목록

indexingMode

IndexingMode

consistent

인덱싱 모드를 나타냅니다.

spatialIndexes

SpatialSpec[]

공간 세부 정보 목록

IndexKind

인덱스의 유형을 나타냅니다.

Name 형식 Description
Hash

string

Range

string

Spatial

string

OperationType

이벤트의 작업 유형을 나타내는 열거형입니다.

Name 형식 Description
Create

string

Delete

string

Recreate

string

Replace

string

SystemOperation

string

PartitionKind

분할에 사용되는 알고리즘의 종류를 나타냅니다. MultiHash의 경우 컨테이너 만들기에 대해 여러 파티션 키(최대 3개)가 지원됩니다.

Name 형식 Description
Hash

string

MultiHash

string

Range

string

Resource

Azure Cosmos DB SQL 컨테이너 이벤트의 리소스

Name 형식 Description
_rid

string

시스템 생성 속성입니다. 고유 식별자입니다.

canUndelete

string

동일한 계정에서 이 컨테이너를 복원할 수 있는지 식별하는 이 컨테이너의 상태입니다.

canUndeleteReason

string

이 컨테이너를 동일한 계정으로 복원할 수 없는 이유입니다.

container

Container

Cosmos DB SQL 컨테이너 리소스 개체

eventTimestamp

string

이 컨테이너 이벤트가 발생한 경우 입니다.

operationType

OperationType

이 컨테이너 이벤트의 작업 형식입니다.

ownerId

string

이 SQL 컨테이너의 이름입니다.

ownerResourceId

string

이 SQL 컨테이너의 리소스 ID입니다.

ResourceRestoreParameters

복원에 대한 정보를 나타내는 매개 변수입니다.

Name 형식 Description
restoreSource

string

복원을 시작해야 하는 복원 가능한 데이터베이스 계정의 ID입니다. 예: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}

restoreTimestampInUtc

string

계정을 복원해야 하는 시간입니다(ISO-8601 형식).

RestorableSqlContainerGetResult

Azure Cosmos DB SQL 컨테이너 이벤트

Name 형식 Description
id

string

ARM 리소스의 고유 리소스 식별자입니다.

name

string

ARM 리소스의 이름입니다.

properties.resource

Resource

Azure Cosmos DB SQL 컨테이너 이벤트의 리소스

type

string

Azure 리소스의 유형입니다.

RestorableSqlContainersListResult

SQL 컨테이너 이벤트 및 해당 속성을 포함하는 목록 작업 응답입니다.

Name 형식 Description
value

RestorableSqlContainerGetResult[]

SQL 컨테이너 이벤트 및 해당 속성 목록입니다.

SpatialSpec

Name 형식 Description
path

string

인덱싱 동작이 적용되는 경로입니다. 인덱스 경로는 일반적으로 루트로 시작하고 와일드카드(/path/*)로 끝납니다.

types

SpatialType[]

경로의 공간 형식 목록

SpatialType

인덱스의 공간 형식을 나타냅니다.

Name 형식 Description
LineString

string

MultiPolygon

string

Point

string

Polygon

string

UniqueKey

Azure Cosmos DB 서비스의 컬렉션에 있는 문서에 고유성 제약 조건을 적용하는 의 고유 키입니다.

Name 형식 Description
paths

string[]

경로 목록은 Azure Cosmos DB 서비스의 각 문서에 대해 고유해야 합니다.

UniqueKeyPolicy

Azure Cosmos DB 서비스의 컬렉션에 있는 문서에 고유성 제약 조건을 지정하기 위한 고유 키 정책 구성입니다.

Name 형식 Description
uniqueKeys

UniqueKey[]

Azure Cosmos DB 서비스의 컬렉션에 있는 문서에 고유성 제약 조건을 적용하는 의 고유 키 목록입니다.