Restorable Sql Databases - List

  • リファレンス
Service:
Cosmos DB Resource Provider
API Version:
2023-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=2023-11-15

URI パラメーター

名前 / 必須 型 説明
instanceId
 path True

string

復元可能なデータベース アカウントの InstanceId GUID。
location
 path True

string

単語と各単語の間のスペースが大文字の Cosmos DB リージョン。
subscriptionId
 path True

string

ターゲット サブスクリプションの ID。
api-version
 query True

string

この操作に使用する API バージョン。

応答

名前 型 説明
200 OK

RestorableSqlDatabasesListResult

操作は正常に完了しました。
Other Status Codes

CloudError

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前 説明
user_impersonation ユーザー アカウントの借用

例

CosmosDBRestorableSqlDatabaseList

Sample Request

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=2023-11-15

Sample Response

Status code:
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"
        }
      }
    }
  ]
}

定義

名前 説明
CloudError

サービスからのエラー応答。
CreateMode

アカウントの作成モードを示す列挙型。
Database

Cosmos DB SQL データベース リソース オブジェクト
ErrorResponse

エラー応答。
OperationType

イベントの操作の種類を示す列挙。
Resource

Azure Cosmos DB SQL データベース イベントのリソース
ResourceRestoreParameters

復元に関する情報を示すパラメーター。
RestorableSqlDatabaseGetResult

Azure Cosmos DB: SQL データベース イベント
RestorableSqlDatabasesListResult

リスト操作の応答。SQL データベース イベントとそのプロパティが含まれています。

CloudError

サービスからのエラー応答。

名前 型 説明
error

ErrorResponse

エラー応答。

CreateMode

アカウントの作成モードを示す列挙型。

名前 型 説明
Default

string

Restore

string

Database

Cosmos DB SQL データベース リソース オブジェクト

名前 型 既定値 説明
_colls

string

コレクション リソースのアドレス指定可能パスを指定するシステム生成プロパティ。
_etag

string

オプティミスティック コンカレンシー制御に必要なリソース etag を表すシステム生成プロパティ。
_rid

string

システムによって生成されたプロパティ。 一意識別子。
_self

string

データベース リソースのアドレス指定可能パスを指定するシステム生成プロパティ。
_ts

number

リソースの最後に更新されたタイムスタンプを示すシステム生成プロパティ。
_users

string

ユーザー リソースのアドレス指定可能パスを指定するシステム生成プロパティ。
createMode

CreateMode

Default

リソースの作成モードを示す列挙型。
id

string

Cosmos DB SQL データベースの名前
restoreParameters

ResourceRestoreParameters

復元に関する情報を示すパラメーター

ErrorResponse

エラー応答。

名前 型 説明
code

string

エラー コード。
message

string

操作が失敗した理由を示すエラー メッセージ。

OperationType

イベントの操作の種類を示す列挙。

名前 型 説明
Create

string

Delete

string

Recreate

string

Replace

string

SystemOperation

string

Resource

Azure Cosmos DB SQL データベース イベントのリソース

名前 型 説明
_rid

string

システムによって生成されたプロパティ。 一意識別子。
canUndelete

string

このデータベースが同じアカウントで復元可能かどうかを識別する、このデータベースの状態。
canUndeleteReason

string

このデータベースを同じアカウントで復元できない理由。
database

Database

Cosmos DB SQL データベース リソース オブジェクト
eventTimestamp

string

このデータベース イベントが発生した時刻。
operationType

OperationType

このデータベース イベントの操作の種類。
ownerId

string

SQL データベースの名前。
ownerResourceId

string

SQL データベースのリソース ID。

ResourceRestoreParameters

復元に関する情報を示すパラメーター。

名前 型 説明
restoreSource

string

復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc

string

アカウントを復元する必要がある時間 (ISO-8601 形式)。

RestorableSqlDatabaseGetResult

Azure Cosmos DB: SQL データベース イベント

名前 型 説明
id

string

ARM リソースの一意のリソース識別子。
name

string

ARM リソースの名前。
properties.resource

Resource

Azure Cosmos DB SQL データベース イベントのリソース
type

string

Azure リソースの種類。

RestorableSqlDatabasesListResult

リスト操作の応答。SQL データベース イベントとそのプロパティが含まれています。

名前 型 説明
value

RestorableSqlDatabaseGetResult[]

SQL データベース イベントとそのプロパティの一覧。