你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 Flow

类型: oauth2
流向: implicit
授权 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==

示例响应

状态代码:: 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，容器创建支持多个分区键（最多三个最大值）
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

名称	类型	说明
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，容器创建支持多个分区键（最多三个最大值）
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，容器创建支持多个分区键（最多三个最大值）

名称	类型	说明
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	指定还原的帐户是否在成功还原时禁用时间To-Live。

RestorableSqlContainerGetResult

Azure Cosmos DB SQL 容器事件

名称	类型	说明
id	string	ARM 资源的唯一资源标识符。
name	string	ARM 资源的名称。
properties.resource	Resource	Azure Cosmos DB SQL 容器事件的资源
type	string	Azure 资源的类型。