Restorable Sql Resources - List

指定されたタイムスタンプと場所にあるアカウントに存在するデータベースとコンテナーの結合の一覧を返します。 これは、指定されたタイムスタンプと場所に存在するリソースを検証するシナリオで役立ちます。 この API には、'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' アクセス許可が必要です。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlResources?api-version=2023-11-15
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlResources?api-version=2023-11-15&restoreLocation={restoreLocation}&restoreTimestampInUtc={restoreTimestampInUtc}

URI パラメーター

名前 / 必須 説明
instanceId
path True

string

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

location
path True

string

Cosmos DB リージョン。単語と各単語の間にスペースが大文字で表示されます。

subscriptionId
path True

string

ターゲット サブスクリプションの ID。

api-version
query True

string

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

restoreLocation
query

string

復元可能なリソースが配置されている場所。

restoreTimestampInUtc
query

string

復元可能リソースが存在したときのタイムスタンプ。

応答

名前 説明
200 OK

RestorableSqlResourcesListResult

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

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 ユーザー アカウントの借用

CosmosDBRestorableSqlResourceList

Sample Request

GET https://management.azure.com/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/WestUS/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorableSqlResources?api-version=2023-11-15&restoreLocation=WestUS&restoreTimestampInUtc=06/01/2022 4:56

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorablesqlresources/Database1",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorablesqlresources",
      "name": "Database1",
      "databaseName": "Database1",
      "collectionNames": [
        "Container1"
      ]
    },
    {
      "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorablesqlresources/Database2",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorablesqlresources",
      "name": "Database2",
      "databaseName": "Database2",
      "collectionNames": [
        "Container1",
        "Container2"
      ]
    },
    {
      "id": "/subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d/restorablesqlresources/Database3",
      "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorablesqlresources",
      "name": "Database3",
      "databaseName": "Database3",
      "collectionNames": []
    }
  ]
}

定義

名前 説明
CloudError

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

ErrorResponse

エラー応答。

RestorableSqlResourcesGetResult

復元する特定のデータベース。

RestorableSqlResourcesListResult

リスト操作の応答。復元可能な SQL リソースが含まれます。

CloudError

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

名前 説明
error

ErrorResponse

エラー応答。

ErrorResponse

エラー応答。

名前 説明
code

string

エラー コード。

message

string

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

RestorableSqlResourcesGetResult

復元する特定のデータベース。

名前 説明
collectionNames

string[]

復元に使用できるコレクションの名前。

databaseName

string

復元に使用できるデータベースの名前。

id

string

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

name

string

ARM リソースの名前。

type

string

Azure リソースの種類。

RestorableSqlResourcesListResult

リスト操作の応答。復元可能な SQL リソースが含まれます。

名前 説明
value

RestorableSqlResourcesGetResult[]

データベース名とコレクション名を含む、復元可能な SQL リソースの一覧。