Restorable Sql Databases - List

서비스:

Cosmos DB Resource Provider

API 버전:

2024-11-15

복원 가능한 계정 아래의 모든 Azure Cosmos DB SQL 데이터베이스에서 수행된 모든 변경의 이벤트 피드를 표시합니다. 이렇게 하면 삭제 시간을 얻기 위해 데이터베이스가 실수로 삭제된 시나리오에 도움이 됩니다. 이 API에는 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' 권한이 필요합니다.

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

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 버전입니다.

응답

Name	형식	Description
200 OK	RestorableSqlDatabasesListResult	작업이 성공적으로 완료되었습니다.
Other Status Codes	CloudError	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

CosmosDBRestorableSqlDatabaseList

샘플 요청

HTTP

GET https://management.azure.com/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/WestUS/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableSqlDatabases?api-version=2024-11-15

Python

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_sql_database_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="2296c272-5d55-40d9-bc05-4d56dc2d7588",
    )

    response = client.restorable_sql_databases.list(
        location="WestUS",
        instance_id="d9b26648-2f53-4541-b3d8-3044f4f9810d",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/CosmosDBRestorableSqlDatabaseList.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

샘플 응답

상태 코드:

200

{
  "value": [
    {
      "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/36f09704-6be3-4f33-aa05-17b73e504c75/restorableSqlDatabases/59c21367-b98b-4a8e-abb7-b6f46600decc",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlDatabases",
      "name": "59c21367-b98b-4a8e-abb7-b6f46600decc",
      "properties": {
        "resource": {
          "_rid": "DLB14gAAAA==",
          "eventTimestamp": "2020-09-02T19:45:03Z",
          "ownerId": "Database1",
          "ownerResourceId": "3fu-hg==",
          "operationType": "Create",
          "canUndelete": "invalid",
          "database": {
            "id": "Database1",
            "_rid": "3fu-hg==",
            "_self": "dbs/3fu-hg==/",
            "_etag": "\"0000c20a-0000-0700-0000-5f4ff63f0000\"",
            "_colls": "colls/",
            "_users": "users/"
          }
        }
      }
    },
    {
      "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableSqlDatabases/8456cb17-cdb0-4c6a-8db8-d0ff3f886257",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlDatabases",
      "name": "8456cb17-cdb0-4c6a-8db8-d0ff3f886257",
      "properties": {
        "resource": {
          "_rid": "ESXNLAAAAA==",
          "eventTimestamp": "2020-09-02T19:53:42Z",
          "ownerId": "Database1",
          "ownerResourceId": "3fu-hg==",
          "database": {
            "id": "Database1",
            "_rid": "3fu-hg==",
            "_self": "dbs/3fu-hg==/",
            "_etag": "\"0000c20a-0000-0700-0000-5f4ff63f0000\"",
            "_colls": "colls/",
            "_users": "users/",
            "_ts": 1599075903
          },
          "operationType": "Delete",
          "canUndelete": "notRestorable",
          "canUndeleteReason": "Database already exists. Only deleted resources can be restored within same account."
        }
      }
    },
    {
      "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableSqlDatabases/2c07991b-9c7c-4e85-be68-b18c1f2ff326",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlDatabases",
      "name": "2c07991b-9c7c-4e85-be68-b18c1f2ff326",
      "properties": {
        "resource": {
          "_rid": "aXFqUQAAAA==",
          "eventTimestamp": "2020-09-02T19:53:15Z",
          "ownerId": "Database2",
          "ownerResourceId": "0SziSg==",
          "database": {
            "id": "Database2",
            "_rid": "0SziSg==",
            "_self": "dbs/0SziSg==/",
            "_etag": "\"0000ca0a-0000-0700-0000-5f4ff82b0000\"",
            "_colls": "colls/",
            "_users": "users/"
          },
          "operationType": "Create",
          "canUndelete": "invalid"
        }
      }
    }
  ]
}

정의

Name	Description
CloudError	서비스의 오류 응답입니다.
CreateMode	계정 생성 모드를 나타내는 열거형입니다.
Database	Cosmos DB SQL 데이터베이스 리소스 개체
ErrorResponse	오류 응답입니다.
OperationType	이벤트의 작업 유형을 나타내는 열거형입니다.
Resource	Azure Cosmos DB SQL 데이터베이스 이벤트의 리소스
ResourceRestoreParameters	복원에 대한 정보를 나타내는 매개 변수입니다.
RestorableSqlDatabaseGetResult	Azure Cosmos DB SQL 데이터베이스 이벤트
RestorableSqlDatabasesListResult	SQL 데이터베이스 이벤트 및 해당 속성을 포함하는 목록 작업 응답입니다.

CloudError

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

Name	형식	Description
error	ErrorResponse	오류 응답입니다.

CreateMode

계정 생성 모드를 나타내는 열거형입니다.

Name	형식	Description
Default	string
Restore	string

Database

Cosmos DB SQL 데이터베이스 리소스 개체

Name	형식	Default value	Description
_colls	string		컬렉션 리소스의 주소 지정 가능 경로를 지정한 시스템 생성 속성입니다.
_etag	string		낙관적 동시성 제어에 필요한 리소스 etag를 나타내는 시스템 생성 속성입니다.
_rid	string		시스템 생성 속성입니다. 고유 식별자입니다.
_self	string		데이터베이스 리소스의 주소 지정 가능 경로를 지정하는 시스템 생성 속성입니다.
_ts	number		리소스의 마지막으로 업데이트된 타임스탬프를 나타내는 시스템 생성 속성입니다.
_users	string		사용자 리소스의 주소 지정 가능 경로를 지정하는 시스템 생성 속성입니다.
createMode	CreateMode	Default	리소스 생성 모드를 나타내는 열거형입니다.
id	string		Cosmos DB SQL 데이터베이스의 이름
restoreParameters	ResourceRestoreParameters		복원에 대한 정보를 나타내는 매개 변수

ErrorResponse

오류 응답입니다.

Name	형식	Description
code	string	오류 코드입니다.
message	string	작업이 실패한 이유를 나타내는 오류 메시지입니다.

OperationType

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

Name	형식	Description
Create	string
Delete	string
Recreate	string
Replace	string
SystemOperation	string

Resource

Azure Cosmos DB SQL 데이터베이스 이벤트의 리소스

Name	형식	Description
_rid	string	시스템 생성 속성입니다. 고유 식별자입니다.
canUndelete	string	동일한 계정에서 이 데이터베이스를 복원할 수 있는지 식별하는 이 데이터베이스의 상태입니다.
canUndeleteReason	string	이 데이터베이스를 동일한 계정으로 복원할 수 없는 이유입니다.
database	Database	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 형식)입니다.
restoreWithTtlDisabled	boolean	복원이 성공하면 복원된 계정에 Time-To-Live 사용하지 않도록 설정할지 여부를 지정합니다.

RestorableSqlDatabaseGetResult

Azure Cosmos DB SQL 데이터베이스 이벤트

Name	형식	Description
id	string	ARM 리소스의 고유 리소스 식별자입니다.
name	string	ARM 리소스의 이름입니다.
properties.resource	Resource	Azure Cosmos DB SQL 데이터베이스 이벤트의 리소스
type	string	Azure 리소스의 유형입니다.

RestorableSqlDatabasesListResult

SQL 데이터베이스 이벤트 및 해당 속성을 포함하는 목록 작업 응답입니다.

Name	형식	Description
value	RestorableSqlDatabaseGetResult[]	SQL 데이터베이스 이벤트 및 해당 속성 목록입니다.