Restorable Sql Containers - List

服務:: Cosmos DB Resource Provider

API 版本:: 2025-10-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=2025-10-15

含選擇性參數:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlContainers?api-version=2025-10-15&restorableSqlDatabaseRid={restorableSqlDatabaseRid}&startTime={startTime}&endTime={endTime}

URI 參數

名稱	位於	必要	類型	Description
instanceId	path	True	string	可還原資料庫帳戶的 instanceId GUID。
location	path	True	string	Cosmos DB 區域，單字之間有空格，每個單字都大寫。
subscriptionId	path	True	string minLength: 1	目標訂用帳戶的標識碼。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。
endTime	query		string	可還原的 Sql 容器事件摘要結束時間。
restorableSqlDatabaseRid	query		string	SQL 資料庫的資源識別碼。
startTime	query		string	可還原的 SQL 容器事件摘要開始時間。

回應

名稱	類型	Description
200 OK	RestorableSqlContainersListResult	作業已順利完成。
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 流

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

CosmosDBRestorableSqlContainerList

範例要求

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

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/DocumentDB/stable/2025-10-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

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/8b53f9cfc1fdb24dbfa28e311d3be4c645169297/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/DocumentDB/stable/2025-10-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

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

/**
 * 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/DocumentDB/stable/2025-10-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 (const 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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.CosmosDB.Models;
using Azure.ResourceManager.CosmosDB;

// Generated from example definition: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/DocumentDB/stable/2025-10-15/examples/CosmosDBRestorableSqlContainerList.json
// this example is just showing the usage of "RestorableSqlContainers_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this RestorableCosmosDBAccountResource created on azure
// for more information of creating RestorableCosmosDBAccountResource, please refer to the document of RestorableCosmosDBAccountResource
string subscriptionId = "subid";
AzureLocation location = new AzureLocation("WestUS");
Guid instanceId = Guid.Parse("98a570f2-63db-4117-91f0-366327b7b353");
ResourceIdentifier restorableCosmosDBAccountResourceId = RestorableCosmosDBAccountResource.CreateResourceIdentifier(subscriptionId, location, instanceId);
RestorableCosmosDBAccountResource restorableCosmosDBAccount = client.GetRestorableCosmosDBAccountResource(restorableCosmosDBAccountResourceId);

// invoke the operation and iterate over the result
string restorableSqlDatabaseRid = "3fu-hg==";
await foreach (RestorableSqlContainer item in restorableCosmosDBAccount.GetRestorableSqlContainersAsync(restorableSqlDatabaseRid: restorableSqlDatabaseRid))
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

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

定義

名稱	Description
ClientEncryptionIncludedPath	.
ClientEncryptionPolicy	Cosmos DB 用戶端加密原則。
CloudError	來自服務的錯誤回應。
CompositePath
CompositePathSortOrder	複合路徑的排序順序。
ComputedProperty	計算屬性的定義
ConflictResolutionMode	表示衝突解決模式。
ConflictResolutionPolicy	容器的衝突解決原則。
Container	Cosmos DB SQL 容器資源物件
ContainerPartitionKey	分割區索引鍵的組態，用於將數據分割成多個分割區
CreateMode	列舉，表示帳戶建立模式。
DataType	套用索引行為的數據類型。
DistanceFunction	用於向量之間距離計算的 distance 函式。
ErrorResponse	錯誤回應。
ExcludedPath
FullTextIndexPath	代表全文檢索索引路徑。
FullTextPath	代表全文檢索路徑規格。
FullTextPolicy	Cosmos DB 全文檢索原則
IncludedPath	索引中包含的路徑
Indexes	路徑的索引。
IndexingMode	表示索引模式。
IndexingPolicy	Cosmos DB 索引原則
IndexKind	表示索引的類型。
OperationType	列舉，以指出事件的作業類型。
PartitionKind	表示用於數據分割的演算法類型。針對 MultiHash，容器建立支援多個分割區索引鍵（最多三個最大值）
Resource	Azure Cosmos DB SQL 容器事件的資源
ResourceRestoreParameters	用來指出還原相關信息的參數。
RestorableSqlContainerGetResult	Azure Cosmos DB SQL 容器事件
RestorableSqlContainersListResult	列出作業回應，其中包含 SQL 儲存器事件及其內容。
SpatialSpec
SpatialType	指出索引的空間類型。
UniqueKey	上的唯一索引鍵會對 Azure Cosmos DB 服務中集合中的檔強制執行唯一性限制。
UniqueKeyPolicy	針對 Azure Cosmos DB 服務集合中檔指定唯一性條件約束的唯一索引鍵原則組態。
VectorDataType	表示向量的數據型別。
VectorEmbedding	表示向量內嵌。向量內嵌可用來定義檔中的向量欄位。
VectorEmbeddingPolicy	Cosmos DB 向量內嵌原則
VectorIndex
VectorIndexType	向量的索引類型。目前支援一般、diskANN 和 quantizedFlat。

ClientEncryptionIncludedPath

Object

名稱	類型	Description
clientEncryptionKeyId	string	要用來加密路徑之用戶端加密金鑰的識別碼。
encryptionAlgorithm	string	將使用的加密演算法。例如 - AEAD_AES_256_CBC_HMAC_SHA256。
encryptionType	string	要執行的加密類型。例如 - 決定性、隨機化。
path	string	需要加密的路徑。

ClientEncryptionPolicy

Object

Cosmos DB 用戶端加密原則。

名稱	類型	Description
includedPaths	ClientEncryptionIncludedPath[]	需要加密的項目路徑以及路徑特定設定。
policyFormatVersion	integer (int32) minimum: 1 maximum: 2	用戶端加密原則定義的版本。支援的版本為 1 和 2。第 2 版支援識別碼和資料分割金鑰路徑加密。

CloudError

Object

來自服務的錯誤回應。

名稱	類型	Description
error	ErrorResponse	錯誤回應。

CompositePath

Object

名稱	類型	Description
order	CompositePathSortOrder	複合路徑的排序順序。
path	string	索引行為套用的路徑。索引路徑通常以根開頭，並以通配符結尾（/path/*）

CompositePathSortOrder

列舉型別

複合路徑的排序順序。

值	Description
ascending
descending

ComputedProperty

Object

計算屬性的定義

名稱	類型	Description
name	string	計算屬性的名稱，例如 - “cp_lowerName”
query	string	評估計算屬性值的查詢，例如 - “SELECT VALUE LOWER（c.name） FROM c”

ConflictResolutionMode

列舉型別

表示衝突解決模式。

值	Description
LastWriterWins
Custom

ConflictResolutionPolicy

Object

容器的衝突解決原則。

名稱	類型	預設值	Description
conflictResolutionPath	string		LastWriterWins 模式的衝突解決路徑。
conflictResolutionProcedure	string		解決自定義模式衝突的程式。
mode	ConflictResolutionMode	LastWriterWins	表示衝突解決模式。

Container

Object

Cosmos DB SQL 容器資源物件

名稱	類型	預設值	Description
_etag	string		系統產生的屬性，代表樂觀並行控制所需的資源 etag。
_rid	string		系統產生的屬性。唯一識別碼。
_self	string		系統產生的內容，指定容器資源的可定址路徑。
_ts	number		系統產生的內容，表示資源的上次更新時間戳記。
analyticalStorageTtl	integer (int64)		分析TTL。
clientEncryptionPolicy	ClientEncryptionPolicy		容器的用戶端加密原則。
computedProperties	ComputedProperty[]		計算屬性的清單
conflictResolutionPolicy	ConflictResolutionPolicy		容器的衝突解決原則。
createMode	CreateMode	Default	列舉，表示資源建立模式。
defaultTtl	integer		默認存留時間
fullTextPolicy	FullTextPolicy		容器的 FullText 原則。
id	string		Cosmos DB SQL 容器的名稱
indexingPolicy	IndexingPolicy		編製索引原則的組態。根據預設，容器內所有文件路徑的索引會自動編製索引
partitionKey	ContainerPartitionKey		分割區索引鍵的組態，用於將數據分割成多個分割區
restoreParameters	ResourceRestoreParameters		用來指出還原相關信息的參數
uniqueKeyPolicy	UniqueKeyPolicy		針對 Azure Cosmos DB 服務集合中檔指定唯一性條件約束的唯一索引鍵原則組態。
vectorEmbeddingPolicy	VectorEmbeddingPolicy		容器的向量內嵌原則。

ContainerPartitionKey

Object

分割區索引鍵的組態，用於將數據分割成多個分割區

名稱	類型	預設值	Description
kind	PartitionKind	Hash	表示用於數據分割的演算法類型。針對 MultiHash，容器建立支援多個分割區索引鍵（最多三個最大值）
paths	string[]		使用容器內可分割數據的路徑清單
systemKey	boolean		指出容器是否使用系統產生的分割區索引鍵
version	integer (int32) minimum: 1 maximum: 2		指出分割區索引鍵定義的版本

CreateMode

列舉型別

列舉，表示帳戶建立模式。

值	Description
Default
Restore

DataType

列舉型別

套用索引行為的數據類型。

值	Description
String
Number
Point
Polygon
LineString
MultiPolygon

DistanceFunction

列舉型別

用於向量之間距離計算的 distance 函式。

值	Description
euclidean
cosine
dotproduct

ErrorResponse

Object

錯誤回應。

名稱	類型	Description
code	string	錯誤碼。
message	string	錯誤訊息，指出作業失敗的原因。

ExcludedPath

Object

名稱	類型	Description
path	string	索引行為套用的路徑。索引路徑通常以根開頭，並以通配符結尾（/path/*）

FullTextIndexPath

Object

代表全文檢索索引路徑。

名稱	類型	Description
path	string	檔中全文檢索欄位的路徑。

FullTextPath

Object

代表全文檢索路徑規格。

名稱	類型	Description
language	string	檔中全文檢索欄位的語言。
path	string	檔中全文檢索欄位的路徑。

FullTextPolicy

Object

Cosmos DB 全文檢索原則

名稱	類型	Description
defaultLanguage	string	全文檢索路徑的預設語言。
fullTextPaths	FullTextPath[]	FullText 路徑清單

IncludedPath

Object

索引中包含的路徑

名稱	類型	Description
indexes	Indexes[]	此路徑的索引清單
path	string	索引行為套用的路徑。索引路徑通常以根開頭，並以通配符結尾（/path/*）

Indexes

Object

路徑的索引。

名稱	類型	預設值	Description
dataType	DataType	String	套用索引行為的數據類型。
kind	IndexKind	Hash	表示索引的類型。
precision	integer		索引的有效位數。 -1 是最大精確度。

IndexingMode

列舉型別

表示索引模式。

值	Description
consistent
lazy
none

IndexingPolicy

Object

Cosmos DB 索引原則

名稱	類型	預設值	Description
automatic	boolean		指出索引編製原則是否為自動
compositeIndexes	CompositePath[]		複合路徑清單清單
excludedPaths	ExcludedPath[]		要從索引編製中排除的路徑清單
fullTextIndexes	FullTextIndexPath[]		要包含在全文索引中的路徑清單
includedPaths	IncludedPath[]		要包含在索引中的路徑清單
indexingMode	IndexingMode	consistent	表示索引模式。
spatialIndexes	SpatialSpec[]		空間特定項目清單
vectorIndexes	VectorIndex[]		要包含在向量索引中的路徑清單

IndexKind

列舉型別

表示索引的類型。

值	Description
Hash
Range
Spatial

OperationType

列舉型別

列舉，以指出事件的作業類型。

值	Description
Create
Replace
Delete
Recreate
SystemOperation

PartitionKind

列舉型別

表示用於數據分割的演算法類型。針對 MultiHash，容器建立支援多個分割區索引鍵（最多三個最大值）

值	Description
Hash
Range
MultiHash

Resource

Object

Azure Cosmos DB SQL 容器事件的資源

名稱	類型	Description
_rid	string	系統產生的屬性。唯一識別碼。
canUndelete	string	此容器的狀態，以識別此容器是否可在同一帳戶中還原。
canUndeleteReason	string	這個容器無法在同一個帳戶中恢復的原因。
container	Container	Cosmos DB SQL 容器資源物件
eventTimestamp	string	此容器事件發生的時間。
operationType	OperationType	此容器事件的作業類型。
ownerId	string	此 SQL 容器的名稱。
ownerResourceId	string	此 SQL 容器的資源識別碼。

ResourceRestoreParameters

Object

用來指出還原相關信息的參數。

名稱	類型	Description
restoreSource	string	必須起始還原的可還原資料庫帳戶標識碼。例如：/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string (date-time)	帳戶必須還原的時間（ISO-8601 格式）。
restoreWithTtlDisabled	boolean	指定還原的帳戶是否會在成功還原時停用時間To-Live。

RestorableSqlContainerGetResult

Object

Azure Cosmos DB SQL 容器事件

名稱	類型	Description
id	string	ARM 資源的唯一資源識別碼。
name	string	ARM 資源的名稱。
properties.resource	Resource	Azure Cosmos DB SQL 容器事件的資源
type	string	Azure 資源的類型。