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=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 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
instance
|
path | True |
string |
可還原資料庫帳戶的instanceId GUID。 |
location
|
path | True |
string |
Cosmos DB 區域,單字與每個單字大寫之間的空格。 |
subscription
|
path | True |
string |
目標訂用帳戶的標識碼。 |
api-version
|
query | True |
string |
要用於這項作業的 API 版本。 |
end
|
query |
string |
可還原的 Sql 容器事件摘要結束時間。 |
|
restorable
|
query |
string |
SQL 資料庫的資源識別碼。 |
|
start
|
query |
string |
可還原的 Sql 容器事件摘要開始時間。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
作業已順利完成。 |
|
Other Status Codes |
描述作業失敗原因的錯誤回應。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow
類型:
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=2024-11-15&restorableSqlDatabaseRid=3fu-hg==
範例回覆
{
"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 |
---|---|
Client |
. |
Client |
Cosmos DB 用戶端加密原則。 |
Cloud |
來自服務的錯誤回應。 |
Composite |
|
Composite |
複合路徑的排序順序。 |
Computed |
計算屬性的定義 |
Conflict |
表示衝突解決模式。 |
Conflict |
容器的衝突解決原則。 |
Container |
Cosmos DB SQL 容器資源物件 |
Container |
分割區索引鍵的組態,用於將數據分割成多個分割區 |
Create |
列舉,表示帳戶建立模式。 |
Data |
套用索引行為的數據類型。 |
Distance |
用於向量之間距離計算的 distance 函式。 |
Error |
錯誤回應。 |
Excluded |
|
Included |
索引中包含的路徑 |
Indexes |
路徑的索引。 |
Indexing |
表示索引模式。 |
Indexing |
Cosmos DB 索引編製原則 |
Index |
表示索引的類型。 |
Operation |
列舉,表示事件的作業類型。 |
Partition |
表示用於數據分割的演算法類型。 針對 MultiHash,容器建立支援多個分割區索引鍵 (最多三個最大值) |
Resource |
Azure Cosmos DB SQL 容器事件的資源 |
Resource |
用來指出還原相關信息的參數。 |
Restorable |
Azure Cosmos DB SQL 容器事件 |
Restorable |
列出作業回應,其中包含 SQL 容器事件及其屬性。 |
Spatial |
|
Spatial |
表示索引的空間類型。 |
Unique |
上的唯一索引鍵,會在 Azure Cosmos DB 服務集合中的檔上強制執行唯一性條件約束。 |
Unique |
針對 Azure Cosmos DB 服務集合中檔指定唯一性條件約束的唯一索引鍵原則組態。 |
Vector |
表示向量的數據型別。 |
Vector |
表示向量內嵌。 向量內嵌可用來定義檔中的向量欄位。 |
Vector |
Cosmos DB 向量內嵌原則 |
Vector |
|
Vector |
向量的索引類型。 目前支援一般、diskANN 和 quantizedFlat。 |
ClientEncryptionIncludedPath
.
名稱 | 類型 | Description |
---|---|---|
clientEncryptionKeyId |
string |
要用來加密路徑之用戶端加密金鑰的識別碼。 |
encryptionAlgorithm |
string |
將使用的加密演算法。 例如 - AEAD_AES_256_CBC_HMAC_SHA256。 |
encryptionType |
string |
要執行的加密類型。 例如 - 決定性、隨機化。 |
path |
string |
需要加密的路徑。 |
ClientEncryptionPolicy
Cosmos DB 用戶端加密原則。
名稱 | 類型 | Description |
---|---|---|
includedPaths |
需要加密的項目路徑以及路徑特定設定。 |
|
policyFormatVersion |
integer |
用戶端加密原則定義的版本。 支援的版本為 1 和 2。 第 2 版支援識別碼和資料分割金鑰路徑加密。 |
CloudError
來自服務的錯誤回應。
名稱 | 類型 | Description |
---|---|---|
error |
錯誤回應。 |
CompositePath
名稱 | 類型 | Description |
---|---|---|
order |
複合路徑的排序順序。 |
|
path |
string |
索引行為套用的路徑。 索引路徑通常以根開頭,並以通配符結尾 (/path/*) |
CompositePathSortOrder
複合路徑的排序順序。
名稱 | 類型 | Description |
---|---|---|
ascending |
string |
|
descending |
string |
ComputedProperty
計算屬性的定義
名稱 | 類型 | Description |
---|---|---|
name |
string |
計算屬性的名稱,例如 - “cp_lowerName” |
query |
string |
評估計算屬性值的查詢,例如 - “SELECT VALUE LOWER(c.name) FROM c” |
ConflictResolutionMode
表示衝突解決模式。
名稱 | 類型 | Description |
---|---|---|
Custom |
string |
|
LastWriterWins |
string |
ConflictResolutionPolicy
容器的衝突解決原則。
名稱 | 類型 | 預設值 | Description |
---|---|---|---|
conflictResolutionPath |
string |
LastWriterWins 模式的衝突解決路徑。 |
|
conflictResolutionProcedure |
string |
解決自定義模式衝突的程式。 |
|
mode | LastWriterWins |
表示衝突解決模式。 |
Container
Cosmos DB SQL 容器資源物件
名稱 | 類型 | 預設值 | Description |
---|---|---|---|
_etag |
string |
系統產生的屬性,表示開放式並行控制所需的資源 etag。 |
|
_rid |
string |
系統產生的屬性。 唯一標識碼。 |
|
_self |
string |
系統產生的屬性,指定容器資源的可尋址路徑。 |
|
_ts |
number |
系統產生的屬性,表示資源上次更新的時間戳。 |
|
analyticalStorageTtl |
integer |
分析TTL。 |
|
clientEncryptionPolicy |
容器的用戶端加密原則。 |
||
computedProperties |
計算屬性的清單 |
||
conflictResolutionPolicy |
容器的衝突解決原則。 |
||
createMode | Default |
列舉,表示資源建立模式。 |
|
defaultTtl |
integer |
默認存留時間 |
|
id |
string |
Cosmos DB SQL 容器的名稱 |
|
indexingPolicy |
編製索引原則的組態。 根據預設,容器內所有文件路徑的索引會自動編製索引 |
||
partitionKey |
分割區索引鍵的組態,用於將數據分割成多個分割區 |
||
restoreParameters |
用來指出還原相關信息的參數 |
||
uniqueKeyPolicy |
針對 Azure Cosmos DB 服務集合中檔指定唯一性條件約束的唯一索引鍵原則組態。 |
||
vectorEmbeddingPolicy |
容器的向量內嵌原則。 |
ContainerPartitionKey
分割區索引鍵的組態,用於將數據分割成多個分割區
名稱 | 類型 | 預設值 | Description |
---|---|---|---|
kind | Hash |
表示用於數據分割的演算法類型。 針對 MultiHash,容器建立支援多個分割區索引鍵 (最多三個最大值) |
|
paths |
string[] |
使用容器內可分割數據的路徑清單 |
|
systemKey |
boolean |
指出容器是否使用系統產生的分割區索引鍵 |
|
version |
integer |
指出分割區索引鍵定義的版本 |
CreateMode
列舉,表示帳戶建立模式。
名稱 | 類型 | Description |
---|---|---|
Default |
string |
|
Restore |
string |
DataType
套用索引行為的數據類型。
名稱 | 類型 | Description |
---|---|---|
LineString |
string |
|
MultiPolygon |
string |
|
Number |
string |
|
Point |
string |
|
Polygon |
string |
|
String |
string |
DistanceFunction
用於向量之間距離計算的 distance 函式。
名稱 | 類型 | Description |
---|---|---|
cosine |
string |
|
dotproduct |
string |
|
euclidean |
string |
ErrorResponse
錯誤回應。
名稱 | 類型 | Description |
---|---|---|
code |
string |
錯誤碼。 |
message |
string |
錯誤訊息,指出作業失敗的原因。 |
ExcludedPath
名稱 | 類型 | Description |
---|---|---|
path |
string |
索引行為套用的路徑。 索引路徑通常以根開頭,並以通配符結尾 (/path/*) |
IncludedPath
索引中包含的路徑
名稱 | 類型 | Description |
---|---|---|
indexes |
Indexes[] |
此路徑的索引清單 |
path |
string |
索引行為套用的路徑。 索引路徑通常以根開頭,並以通配符結尾 (/path/*) |
Indexes
路徑的索引。
名稱 | 類型 | 預設值 | Description |
---|---|---|---|
dataType | String |
套用索引行為的數據類型。 |
|
kind | Hash |
表示索引的類型。 |
|
precision |
integer |
索引的有效位數。 -1 是最大精確度。 |
IndexingMode
表示索引模式。
名稱 | 類型 | Description |
---|---|---|
consistent |
string |
|
lazy |
string |
|
none |
string |
IndexingPolicy
Cosmos DB 索引編製原則
名稱 | 類型 | 預設值 | Description |
---|---|---|---|
automatic |
boolean |
指出索引編製原則是否為自動 |
|
compositeIndexes |
複合路徑清單清單 |
||
excludedPaths |
要從索引編製中排除的路徑清單 |
||
includedPaths |
要包含在索引中的路徑清單 |
||
indexingMode | consistent |
表示索引模式。 |
|
spatialIndexes |
空間特定項目清單 |
||
vectorIndexes |
要包含在向量索引中的路徑清單 |
IndexKind
表示索引的類型。
名稱 | 類型 | Description |
---|---|---|
Hash |
string |
|
Range |
string |
|
Spatial |
string |
OperationType
列舉,表示事件的作業類型。
名稱 | 類型 | Description |
---|---|---|
Create |
string |
|
Delete |
string |
|
Recreate |
string |
|
Replace |
string |
|
SystemOperation |
string |
PartitionKind
表示用於數據分割的演算法類型。 針對 MultiHash,容器建立支援多個分割區索引鍵 (最多三個最大值)
名稱 | 類型 | Description |
---|---|---|
Hash |
string |
|
MultiHash |
string |
|
Range |
string |
Resource
Azure Cosmos DB SQL 容器事件的資源
名稱 | 類型 | Description |
---|---|---|
_rid |
string |
系統產生的屬性。 唯一標識碼。 |
canUndelete |
string |
此容器的狀態,用來識別此容器是否可在相同帳戶中還原。 |
canUndeleteReason |
string |
此容器無法在同一個帳戶中還原的原因。 |
container |
Cosmos DB SQL 容器資源物件 |
|
eventTimestamp |
string |
發生此容器事件時的 。 |
operationType |
此容器事件的作業類型。 |
|
ownerId |
string |
這個 SQL 容器的名稱。 |
ownerResourceId |
string |
這個 SQL 容器的資源識別碼。 |
ResourceRestoreParameters
用來指出還原相關信息的參數。
名稱 | 類型 | Description |
---|---|---|
restoreSource |
string |
必須起始還原的可還原資料庫帳戶標識碼。 例如:/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
restoreTimestampInUtc |
string |
帳戶必須還原的時間(ISO-8601 格式)。 |
restoreWithTtlDisabled |
boolean |
指定還原的帳戶是否會在成功還原時停用時間To-Live。 |
RestorableSqlContainerGetResult
Azure Cosmos DB SQL 容器事件
名稱 | 類型 | Description |
---|---|---|
id |
string |
ARM 資源的唯一資源標識碼。 |
name |
string |
ARM 資源的名稱。 |
properties.resource |
Azure Cosmos DB SQL 容器事件的資源 |
|
type |
string |
Azure 資源的類型。 |
RestorableSqlContainersListResult
列出作業回應,其中包含 SQL 容器事件及其屬性。
名稱 | 類型 | Description |
---|---|---|
value |
SQL 容器事件及其屬性的清單。 |
SpatialSpec
名稱 | 類型 | Description |
---|---|---|
path |
string |
索引行為套用的路徑。 索引路徑通常以根開頭,並以通配符結尾 (/path/*) |
types |
路徑的空間類型清單 |
SpatialType
表示索引的空間類型。
名稱 | 類型 | Description |
---|---|---|
LineString |
string |
|
MultiPolygon |
string |
|
Point |
string |
|
Polygon |
string |
UniqueKey
上的唯一索引鍵,會在 Azure Cosmos DB 服務集合中的檔上強制執行唯一性條件約束。
名稱 | 類型 | Description |
---|---|---|
paths |
string[] |
Azure Cosmos DB 服務中每個文件的路徑清單必須是唯一的 |
UniqueKeyPolicy
針對 Azure Cosmos DB 服務集合中檔指定唯一性條件約束的唯一索引鍵原則組態。
名稱 | 類型 | Description |
---|---|---|
uniqueKeys |
上唯一索引鍵的清單,該索引鍵會對 Azure Cosmos DB 服務集合中的文件強制執行唯一性條件約束。 |
VectorDataType
表示向量的數據型別。
名稱 | 類型 | Description |
---|---|---|
float32 |
string |
|
int8 |
string |
|
uint8 |
string |
VectorEmbedding
表示向量內嵌。 向量內嵌可用來定義檔中的向量欄位。
名稱 | 類型 | Description |
---|---|---|
dataType |
表示向量的數據型別。 |
|
dimensions |
integer |
向量中的維度數目。 |
distanceFunction |
用於向量之間距離計算的 distance 函式。 |
|
path |
string |
檔中向量欄位的路徑。 |
VectorEmbeddingPolicy
Cosmos DB 向量內嵌原則
名稱 | 類型 | Description |
---|---|---|
vectorEmbeddings |
向量內嵌清單 |
VectorIndex
名稱 | 類型 | Description |
---|---|---|
path |
string |
檔中向量欄位的路徑。 |
type |
向量的索引類型。 目前支援一般、diskANN 和 quantizedFlat。 |
VectorIndexType
向量的索引類型。 目前支援一般、diskANN 和 quantizedFlat。
名稱 | 類型 | Description |
---|---|---|
diskANN |
string |
|
flat |
string |
|
quantizedFlat |
string |