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 パラメーター

名前 / 必須 説明
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 コンテナーイベント フィードの開始時刻。

応答

名前 説明
200 OK

RestorableSqlContainersListResult

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

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

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\""
          }
        }
      }
    }
  ]
}

定義

名前 説明
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

.

名前 説明
clientEncryptionKeyId

string

パスの暗号化に使用するクライアント暗号化キーの識別子。

encryptionAlgorithm

string

使用される暗号化アルゴリズム。 例: AEAD_AES_256_CBC_HMAC_SHA256。

encryptionType

string

実行する暗号化の種類。 例: 決定論的、ランダム化。

path

string

暗号化する必要があるパス。

ClientEncryptionPolicy

Cosmos DB クライアント暗号化ポリシー。

名前 説明
includedPaths

ClientEncryptionIncludedPath[]

パス固有の設定と共に暗号化が必要な項目のパス。

policyFormatVersion

integer

クライアント暗号化ポリシー定義のバージョン。 サポートされているバージョンは 1 と 2 です。 バージョン 2 では、ID とパーティション キーパスの暗号化がサポートされています。

CloudError

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

名前 説明
error

ErrorResponse

エラー応答。

CompositePath

名前 説明
order

CompositePathSortOrder

複合パスの並べ替え順序。

path

string

インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる

CompositePathSortOrder

複合パスの並べ替え順序。

名前 説明
ascending

string

descending

string

ComputedProperty

計算されたプロパティの定義

名前 説明
name

string

計算されたプロパティの名前 (例: "cp_lowerName"

query

string

計算されたプロパティの値を評価するクエリ (例: "SELECT VALUE LOWER(c.name) FROM c"

ConflictResolutionMode

競合解決モードを示します。

名前 説明
Custom

string

LastWriterWins

string

ConflictResolutionPolicy

コンテナーの競合解決ポリシー。

名前 既定値 説明
conflictResolutionPath

string

LastWriterWins モードの場合の競合解決パス。

conflictResolutionProcedure

string

カスタム モードの場合の競合を解決する手順。

mode

ConflictResolutionMode

LastWriterWins

競合解決モードを示します。

Container

Cosmos DB SQL コンテナー リソース オブジェクト

名前 既定値 説明
_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

複数のパーティションにデータをパーティション分割するために使用するパーティション キーの構成

名前 既定値 説明
kind

PartitionKind

Hash

パーティション分割に使用されるアルゴリズムの種類を示します。 MultiHash の場合、コンテナーの作成では複数のパーティション キー (最大 3 つ) がサポートされます

paths

string[]

コンテナー内のどのデータをパーティション分割できるかを使用するパスの一覧

systemKey

boolean

コンテナーがシステムによって生成されたパーティション キーを使用しているかどうかを示します

version

integer

パーティション キー定義のバージョンを示します

CreateMode

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

名前 説明
Default

string

Restore

string

DataType

インデックス作成の動作が適用されるデータ型。

名前 説明
LineString

string

MultiPolygon

string

Number

string

Point

string

Polygon

string

String

string

ErrorResponse

エラー応答。

名前 説明
code

string

エラー コード。

message

string

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

ExcludedPath

名前 説明
path

string

インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる

IncludedPath

インデックス作成に含まれるパス

名前 説明
indexes

Indexes[]

このパスのインデックスの一覧

path

string

インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる

Indexes

パスのインデックス。

名前 既定値 説明
dataType

DataType

String

インデックス作成の動作が適用されるデータ型。

kind

IndexKind

Hash

インデックスの種類を示します。

precision

integer

インデックスの有効桁数。 -1 は最大精度です。

IndexingMode

インデックス作成モードを示します。

名前 説明
consistent

string

lazy

string

none

string

IndexingPolicy

Cosmos DB インデックス作成ポリシー

名前 既定値 説明
automatic

boolean

インデックス作成ポリシーが自動かどうかを示します

compositeIndexes

CompositePath[]

複合パス リストの一覧

excludedPaths

ExcludedPath[]

インデックス作成から除外するパスの一覧

includedPaths

IncludedPath[]

インデックス作成に含めるパスの一覧

indexingMode

IndexingMode

consistent

インデックス作成モードを示します。

spatialIndexes

SpatialSpec[]

空間の詳細の一覧

IndexKind

インデックスの種類を示します。

名前 説明
Hash

string

Range

string

Spatial

string

OperationType

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

名前 説明
Create

string

Delete

string

Recreate

string

Replace

string

SystemOperation

string

PartitionKind

パーティション分割に使用されるアルゴリズムの種類を示します。 MultiHash の場合、コンテナーの作成では複数のパーティション キー (最大 3 つ) がサポートされます

名前 説明
Hash

string

MultiHash

string

Range

string

Resource

Azure Cosmos DB SQL コンテナー イベントのリソース

名前 説明
_rid

string

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

canUndelete

string

このコンテナーが同じアカウントで復元可能かどうかを識別する、このコンテナーの状態。

canUndeleteReason

string

このコンテナーを同じアカウントで復元できない理由。

container

Container

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 形式)。

RestorableSqlContainerGetResult

Azure Cosmos DB SQL コンテナー イベント

名前 説明
id

string

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

name

string

ARM リソースの名前。

properties.resource

Resource

Azure Cosmos DB SQL コンテナー イベントのリソース

type

string

Azure リソースの種類。

RestorableSqlContainersListResult

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

名前 説明
value

RestorableSqlContainerGetResult[]

SQL コンテナー イベントとそのプロパティの一覧。

SpatialSpec

名前 説明
path

string

インデックス作成の動作が適用されるパス。 インデックス パスは通常、ルートで始まり、ワイルドカード (/path/*) で終わる

types

SpatialType[]

パスの空間型の一覧

SpatialType

インデックスの空間型を示します。

名前 説明
LineString

string

MultiPolygon

string

Point

string

Polygon

string

UniqueKey

Azure Cosmos DB サービスのコレクション内のドキュメントに一意性制約を適用する の一意キー。

名前 説明
paths

string[]

パスの一覧は、Azure Cosmos DB サービスのドキュメントごとに一意である必要があります

UniqueKeyPolicy

Azure Cosmos DB サービスのコレクション内のドキュメントに対する一意性制約を指定するための一意キー ポリシー構成。

名前 説明
uniqueKeys

UniqueKey[]

Azure Cosmos DB サービスのコレクション内のドキュメントに一意性制約を適用する の一意キーの一覧。