Restorable Sql Containers - 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}/restorableSqlContainers?api-version=2024-11-15

省略可能なパラメーターを含む:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlContainers?api-version=2024-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 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

CosmosDBRestorableSqlContainerList

要求のサンプル

HTTP

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

Java

/**
 * Samples for RestorableSqlContainers List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/
     * CosmosDBRestorableSqlContainerList.json
     */
    /**
     * Sample code: CosmosDBRestorableSqlContainerList.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBRestorableSqlContainerList(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getRestorableSqlContainers().list("WestUS",
            "98a570f2-63db-4117-91f0-366327b7b353", "3fu-hg==", null, null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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_container_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="subid",
    )

    response = client.restorable_sql_containers.list(
        location="WestUS",
        instance_id="98a570f2-63db-4117-91f0-366327b7b353",
    )
    for item in response:
        print(item)


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

Go

package armcosmos_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmos/armcosmos/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ded6306d00ae294c24211e5069c1f56b15ba8ef5/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/CosmosDBRestorableSqlContainerList.json
func ExampleRestorableSQLContainersClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcosmos.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewRestorableSQLContainersClient().NewListPager("WestUS", "98a570f2-63db-4117-91f0-366327b7b353", &armcosmos.RestorableSQLContainersClientListOptions{RestorableSQLDatabaseRid: to.Ptr("3fu-hg=="),
		StartTime: nil,
		EndTime:   nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.RestorableSQLContainersListResult = armcosmos.RestorableSQLContainersListResult{
		// 	Value: []*armcosmos.RestorableSQLContainerGetResult{
		// 		{
		// 			Name: to.Ptr("79609a98-3394-41f8-911f-cfab0c075c86"),
		// 			Type: to.Ptr("Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlContainers"),
		// 			ID: to.Ptr("/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableSqlContainers/79609a98-3394-41f8-911f-cfab0c075c86"),
		// 			Properties: &armcosmos.RestorableSQLContainerProperties{
		// 				Resource: &armcosmos.RestorableSQLContainerPropertiesResource{
		// 					Rid: to.Ptr("zAyAPQAAAA=="),
		// 					CanUndelete: to.Ptr("invalid"),
		// 					Container: &armcosmos.RestorableSQLContainerPropertiesResourceContainer{
		// 						Etag: to.Ptr("\"00003e00-0000-0700-0000-5f85338a0000\""),
		// 						Rid: to.Ptr("V18LoLrv-qA="),
		// 						ConflictResolutionPolicy: &armcosmos.ConflictResolutionPolicy{
		// 							ConflictResolutionPath: to.Ptr("/_ts"),
		// 							ConflictResolutionProcedure: to.Ptr(""),
		// 							Mode: to.Ptr(armcosmos.ConflictResolutionModeLastWriterWins),
		// 						},
		// 						ID: to.Ptr("Container1"),
		// 						IndexingPolicy: &armcosmos.IndexingPolicy{
		// 							Automatic: to.Ptr(true),
		// 							ExcludedPaths: []*armcosmos.ExcludedPath{
		// 								{
		// 									Path: to.Ptr("/\"_etag\"/?"),
		// 							}},
		// 							IncludedPaths: []*armcosmos.IncludedPath{
		// 								{
		// 									Path: to.Ptr("/*"),
		// 								},
		// 								{
		// 									Path: to.Ptr("/\"_ts\"/?"),
		// 							}},
		// 							IndexingMode: to.Ptr(armcosmos.IndexingModeConsistent),
		// 						},
		// 						Self: to.Ptr("dbs/V18LoA==/colls/V18LoLrv-qA=/"),
		// 					},
		// 					EventTimestamp: to.Ptr("2020-10-13T04:56:42Z"),
		// 					OperationType: to.Ptr(armcosmos.OperationTypeCreate),
		// 					OwnerID: to.Ptr("Container1"),
		// 					OwnerResourceID: to.Ptr("V18LoLrv-qA="),
		// 				},
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("e85298a1-c631-4726-825e-a7ca092e9098"),
		// 			Type: to.Ptr("Microsoft.DocumentDB/locations/restorableDatabaseAccounts/restorableSqlContainers"),
		// 			ID: to.Ptr("/subscriptions/subid/providers/Microsoft.DocumentDb/locations/westus/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableSqlContainers/e85298a1-c631-4726-825e-a7ca092e9098"),
		// 			Properties: &armcosmos.RestorableSQLContainerProperties{
		// 				Resource: &armcosmos.RestorableSQLContainerPropertiesResource{
		// 					Rid: to.Ptr("PrArcgAAAA=="),
		// 					CanUndelete: to.Ptr("invalid"),
		// 					Container: &armcosmos.RestorableSQLContainerPropertiesResourceContainer{
		// 						Etag: to.Ptr("\"00004400-0000-0700-0000-5f85351f0000\""),
		// 						Rid: to.Ptr("V18LoLrv-qA="),
		// 						ConflictResolutionPolicy: &armcosmos.ConflictResolutionPolicy{
		// 							ConflictResolutionPath: to.Ptr("/_ts"),
		// 							ConflictResolutionProcedure: to.Ptr(""),
		// 							Mode: to.Ptr(armcosmos.ConflictResolutionModeLastWriterWins),
		// 						},
		// 						DefaultTTL: to.Ptr[int32](12345),
		// 						ID: to.Ptr("Container1"),
		// 						IndexingPolicy: &armcosmos.IndexingPolicy{
		// 							Automatic: to.Ptr(true),
		// 							ExcludedPaths: []*armcosmos.ExcludedPath{
		// 								{
		// 									Path: to.Ptr("/\"_etag\"/?"),
		// 							}},
		// 							IncludedPaths: []*armcosmos.IncludedPath{
		// 								{
		// 									Path: to.Ptr("/*"),
		// 								},
		// 								{
		// 									Path: to.Ptr("/\"_ts\"/?"),
		// 							}},
		// 							IndexingMode: to.Ptr(armcosmos.IndexingModeConsistent),
		// 						},
		// 						Self: to.Ptr("dbs/V18LoA==/colls/V18LoLrv-qA=/"),
		// 					},
		// 					EventTimestamp: to.Ptr("2020-10-13T05:03:27Z"),
		// 					OperationType: to.Ptr(armcosmos.OperationTypeReplace),
		// 					OwnerID: to.Ptr("Container1"),
		// 					OwnerResourceID: to.Ptr("V18LoLrv-qA="),
		// 				},
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Show the event feed of all mutations done on all the Azure Cosmos DB SQL containers under a specific database.  This helps in scenario where container was accidentally deleted.  This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission
 *
 * @summary Show the event feed of all mutations done on all the Azure Cosmos DB SQL containers under a specific database.  This helps in scenario where container was accidentally deleted.  This API requires 'Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read' permission
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/CosmosDBRestorableSqlContainerList.json
 */
async function cosmosDbRestorableSqlContainerList() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const location = "WestUS";
  const instanceId = "98a570f2-63db-4117-91f0-366327b7b353";
  const restorableSqlDatabaseRid = "3fu-hg==";
  const options = {
    restorableSqlDatabaseRid,
  };
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.restorableSqlContainers.list(location, instanceId, options)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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/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	インデックス作成の動作が適用されるデータ型。
DistanceFunction	ベクトル間の距離計算に使用する距離関数。
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 コンテナー イベントとそのプロパティを含む List 操作の応答。
SpatialSpec
SpatialType	インデックスの空間型を示します。
UniqueKey	Azure Cosmos DB サービス内のコレクション内のドキュメントに一意性制約を適用する一意キー。
UniqueKeyPolicy	Azure Cosmos DB サービス内のコレクション内のドキュメントに対する一意性制約を指定するための一意キー ポリシー構成。
VectorDataType	ベクターのデータ型を示します。
VectorEmbedding	ベクター埋め込みを表します。 ベクター埋め込みは、ドキュメント内のベクター フィールドを定義するために使用されます。
VectorEmbeddingPolicy	Cosmos DB ベクター埋め込みポリシー
VectorIndex
VectorIndexType	ベクターのインデックス型。 現在、フラット、diskANN、およびクオンタイズフラットがサポートされています。

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 サービス内のコレクション内のドキュメントに対する一意性制約を指定するための一意キー ポリシー構成。
vectorEmbeddingPolicy	VectorEmbeddingPolicy		コンテナーのベクター埋め込みポリシー。

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

DistanceFunction

ベクトル間の距離計算に使用する距離関数。

名前	型	説明
cosine	string
dotproduct	string
euclidean	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[]		空間の詳細の一覧
vectorIndexes	VectorIndex[]		ベクター インデックス作成に含めるパスの一覧

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 形式)。
restoreWithTtlDisabled	boolean	復元が成功した時点で、復元されたアカウントに Time-To-Live を無効にするかどうかを指定します。

RestorableSqlContainerGetResult

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

名前	型	説明
id	string	ARM リソースの一意のリソース識別子。
name	string	ARM リソースの名前。
properties.resource	Resource	Azure Cosmos DB SQL コンテナー イベントのリソース
type	string	Azure リソースの種類。

RestorableSqlContainersListResult

SQL コンテナー イベントとそのプロパティを含む List 操作の応答。

名前	型	説明
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 サービスのコレクション内のドキュメントに一意性制約を適用する一意キーの一覧。

VectorDataType

ベクターのデータ型を示します。

名前	型	説明
float32	string
int8	string
uint8	string

VectorEmbedding

ベクター埋め込みを表します。 ベクター埋め込みは、ドキュメント内のベクター フィールドを定義するために使用されます。

名前	型	説明
dataType	VectorDataType	ベクターのデータ型を示します。
dimensions	integer	ベクトル内の次元の数。
distanceFunction	DistanceFunction	ベクトル間の距離計算に使用する距離関数。
path	string	ドキュメント内のベクター フィールドへのパス。

VectorEmbeddingPolicy

Cosmos DB ベクター埋め込みポリシー

名前	型	説明
vectorEmbeddings	VectorEmbedding[]	ベクター埋め込みの一覧

VectorIndex

名前	型	説明
path	string	ドキュメント内のベクター フィールドへのパス。
type	VectorIndexType	ベクターのインデックス型。 現在、フラット、diskANN、およびクオンタイズフラットがサポートされています。

VectorIndexType

ベクターのインデックス型。 現在、フラット、diskANN、およびクオンタイズフラットがサポートされています。

名前	型	説明
diskANN	string
flat	string
quantizedFlat	string