Restorable Sql Containers - List

Service:

Cosmos DB Resource Provider

API Version:

2023-11-15

Tampilkan umpan peristiwa semua mutasi yang dilakukan pada semua kontainer Azure Cosmos DB SQL di bawah database tertentu. Ini membantu dalam skenario di mana kontainer dihapus secara tidak sengaja. API ini memerlukan izin '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

With optional parameters:

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}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
instanceId	path	True	string	GUID instanceId dari akun database yang dapat di memulihkan.
location	path	True	string	Wilayah Cosmos DB, dengan spasi antara kata dan setiap kata dikapitalisasi.
subscriptionId	path	True	string	ID langganan target.
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.
endTime	query		string	Waktu akhir umpan peristiwa kontainer Sql yang dapat di memulihkan.
restorableSqlDatabaseRid	query		string	ID sumber daya database SQL.
startTime	query		string	Waktu mulai umpan peristiwa kontainer Sql yang dapat di memulihkan.

Respons

Nama	Jenis	Deskripsi
200 OK	RestorableSqlContainersListResult	Operasi berhasil diselesaikan.
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nama	Deskripsi
user_impersonation	Meniru akun pengguna Anda

Contoh

CosmosDBRestorableSqlContainerList

Sample Request

HTTP

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==

Java

/**
 * Samples for RestorableSqlContainers List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-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/2023-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/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/41e4538ed7bb3ceac3c1322c9455a0812ed110ac/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-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/2023-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

Sample Response

Status code:

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

Definisi

Nama	Deskripsi
ClientEncryptionIncludedPath	.
ClientEncryptionPolicy	Kebijakan enkripsi klien Cosmos DB.
CloudError	Respons kesalahan dari layanan.
CompositePath
CompositePathSortOrder	Urutkan urutan untuk jalur komposit.
ComputedProperty	Definisi properti komputasi
ConflictResolutionMode	Menunjukkan mode resolusi konflik.
ConflictResolutionPolicy	Kebijakan resolusi konflik untuk kontainer.
Container	Objek sumber daya kontainer Cosmos DB SQL
ContainerPartitionKey	Konfigurasi kunci partisi yang akan digunakan untuk mempartisi data ke dalam beberapa partisi
CreateMode	Enum untuk menunjukkan mode pembuatan akun.
DataType	Jenis data tempat perilaku pengindeksan diterapkan.
ErrorResponse	Respons Kesalahan.
ExcludedPath
IncludedPath	Jalur yang disertakan dalam pengindeksan
Indexes	Indeks untuk jalur.
IndexingMode	Menunjukkan mode pengindeksan.
IndexingPolicy	Kebijakan pengindeksan Cosmos DB
IndexKind	Menunjukkan jenis indeks.
OperationType	Enum untuk menunjukkan jenis operasi peristiwa.
PartitionKind	Menunjukkan jenis algoritma yang digunakan untuk pemartisian. Untuk MultiHash, beberapa kunci partisi (hingga tiga maksimum) didukung untuk pembuatan kontainer
Resource	Sumber daya peristiwa kontainer Azure Cosmos DB SQL
ResourceRestoreParameters	Parameter untuk menunjukkan informasi tentang pemulihan.
RestorableSqlContainerGetResult	Peristiwa kontainer Azure Cosmos DB SQL
RestorableSqlContainersListResult	Respons operasi Daftar, yang berisi peristiwa kontainer SQL dan propertinya.
SpatialSpec
SpatialType	Menunjukkan jenis indeks spasial.
UniqueKey	Kunci unik pada yang memberlakukan batasan keunikan pada dokumen dalam koleksi di layanan Azure Cosmos DB.
UniqueKeyPolicy	Konfigurasi kebijakan kunci unik untuk menentukan batasan keunikan pada dokumen dalam koleksi di layanan Azure Cosmos DB.

ClientEncryptionIncludedPath

.

Nama	Jenis	Deskripsi
clientEncryptionKeyId	string	Pengidentifikasi Kunci Enkripsi Klien yang akan digunakan untuk mengenkripsi jalur.
encryptionAlgorithm	string	Algoritma enkripsi yang akan digunakan. Misalnya - AEAD_AES_256_CBC_HMAC_SHA256.
encryptionType	string	Jenis enkripsi yang akan dilakukan. Misalnya - Deterministik, Acak.
path	string	Jalur yang perlu dienkripsi.

ClientEncryptionPolicy

Kebijakan enkripsi klien Cosmos DB.

Nama	Jenis	Deskripsi
includedPaths	ClientEncryptionIncludedPath[]	Jalur item yang memerlukan enkripsi bersama dengan pengaturan khusus jalur.
policyFormatVersion	integer	Versi definisi kebijakan enkripsi klien. Versi yang didukung adalah 1 dan 2. Versi 2 mendukung enkripsi jalur kunci id dan partisi.

CloudError

Respons kesalahan dari layanan.

Nama	Jenis	Deskripsi
error	ErrorResponse	Respons Kesalahan.

CompositePath

Nama	Jenis	Deskripsi
order	CompositePathSortOrder	Urutkan urutan untuk jalur komposit.
path	string	Jalur tempat perilaku pengindeksan berlaku. Jalur indeks biasanya dimulai dengan root dan diakhir dengan wildcard (/path/*)

CompositePathSortOrder

Urutkan urutan untuk jalur komposit.

Nama	Jenis	Deskripsi
ascending	string
descending	string

ComputedProperty

Definisi properti komputasi

Nama	Jenis	Deskripsi
name	string	Nama properti komputasi, misalnya - "cp_lowerName"
query	string	Kueri yang mengevaluasi nilai untuk properti komputasi, misalnya - "SELECT VALUE LOWER(c.name) FROM c"

ConflictResolutionMode

Menunjukkan mode resolusi konflik.

Nama	Jenis	Deskripsi
Custom	string
LastWriterWins	string

ConflictResolutionPolicy

Kebijakan resolusi konflik untuk kontainer.

Nama	Jenis	Nilai Default	Deskripsi
conflictResolutionPath	string		Jalur resolusi konflik dalam kasus mode LastWriterWins.
conflictResolutionProcedure	string		Prosedur untuk mengatasi konflik dalam kasus mode kustom.
mode	ConflictResolutionMode	LastWriterWins	Menunjukkan mode resolusi konflik.

Container

Objek sumber daya kontainer Cosmos DB SQL

Nama	Jenis	Nilai Default	Deskripsi
_etag	string		Properti yang dihasilkan sistem yang mewakili etag sumber daya yang diperlukan untuk kontrol konkurensi optimis.
_rid	string		Properti yang dihasilkan sistem. Pengidentifikasi unik.
_self	string		Properti yang dihasilkan sistem yang menentukan jalur sumber daya kontainer yang dapat diatasi.
_ts	number		Properti yang dihasilkan sistem yang menunjukkan tanda waktu terakhir yang diperbarui dari sumber daya.
analyticalStorageTtl	integer		TTL analitis.
clientEncryptionPolicy	ClientEncryptionPolicy		Kebijakan enkripsi klien untuk kontainer.
computedProperties	ComputedProperty[]		Daftar properti komputasi
conflictResolutionPolicy	ConflictResolutionPolicy		Kebijakan resolusi konflik untuk kontainer.
createMode	CreateMode	Default	Enum untuk menunjukkan mode pembuatan sumber daya.
defaultTtl	integer		Waktu hidup default
id	string		Nama kontainer Cosmos DB SQL
indexingPolicy	IndexingPolicy		Konfigurasi kebijakan pengindeksan. Secara default, pengindeksan otomatis untuk semua jalur dokumen dalam kontainer
partitionKey	ContainerPartitionKey		Konfigurasi kunci partisi yang akan digunakan untuk mempartisi data ke dalam beberapa partisi
restoreParameters	ResourceRestoreParameters		Parameter untuk menunjukkan informasi tentang pemulihan
uniqueKeyPolicy	UniqueKeyPolicy		Konfigurasi kebijakan kunci unik untuk menentukan batasan keunikan pada dokumen dalam koleksi di layanan Azure Cosmos DB.

ContainerPartitionKey

Konfigurasi kunci partisi yang akan digunakan untuk mempartisi data ke dalam beberapa partisi

Nama	Jenis	Nilai Default	Deskripsi
kind	PartitionKind	Hash	Menunjukkan jenis algoritma yang digunakan untuk pemartisian. Untuk MultiHash, beberapa kunci partisi (hingga tiga maksimum) didukung untuk pembuatan kontainer
paths	string[]		Daftar jalur yang menggunakan data mana dalam kontainer yang dapat dipartisi
systemKey	boolean		Menunjukkan apakah kontainer menggunakan kunci partisi yang dihasilkan sistem
version	integer		Menunjukkan versi definisi kunci partisi

CreateMode

Enum untuk menunjukkan mode pembuatan akun.

Nama	Jenis	Deskripsi
Default	string
Restore	string

DataType

Jenis data tempat perilaku pengindeksan diterapkan.

Nama	Jenis	Deskripsi
LineString	string
MultiPolygon	string
Number	string
Point	string
Polygon	string
String	string

ErrorResponse

Respons Kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode Kesalahan.
message	string	Pesan kesalahan yang menunjukkan mengapa operasi gagal.

ExcludedPath

Nama	Jenis	Deskripsi
path	string	Jalur tempat perilaku pengindeksan berlaku. Jalur indeks biasanya dimulai dengan root dan diakhir dengan wildcard (/path/*)

IncludedPath

Jalur yang disertakan dalam pengindeksan

Nama	Jenis	Deskripsi
indexes	Indexes[]	Daftar indeks untuk jalur ini
path	string	Jalur tempat perilaku pengindeksan berlaku. Jalur indeks biasanya dimulai dengan root dan diakhir dengan wildcard (/path/*)

Indexes

Indeks untuk jalur.

Nama	Jenis	Nilai Default	Deskripsi
dataType	DataType	String	Jenis data tempat perilaku pengindeksan diterapkan.
kind	IndexKind	Hash	Menunjukkan jenis indeks.
precision	integer		Presisi indeks. -1 adalah presisi maksimum.

IndexingMode

Menunjukkan mode pengindeksan.

Nama	Jenis	Deskripsi
consistent	string
lazy	string
none	string

IndexingPolicy

Kebijakan pengindeksan Cosmos DB

Nama	Jenis	Nilai Default	Deskripsi
automatic	boolean		Menunjukkan apakah kebijakan pengindeksan bersifat otomatis
compositeIndexes	CompositePath[]		Daftar daftar jalur komposit
excludedPaths	ExcludedPath[]		Daftar jalur yang akan dikecualikan dari pengindeksan
includedPaths	IncludedPath[]		Daftar jalur yang akan disertakan dalam pengindeksan
indexingMode	IndexingMode	consistent	Menunjukkan mode pengindeksan.
spatialIndexes	SpatialSpec[]		Daftar spesifikasi spasial

IndexKind

Menunjukkan jenis indeks.

Nama	Jenis	Deskripsi
Hash	string
Range	string
Spatial	string

OperationType

Enum untuk menunjukkan jenis operasi peristiwa.

Nama	Jenis	Deskripsi
Create	string
Delete	string
Recreate	string
Replace	string
SystemOperation	string

PartitionKind

Menunjukkan jenis algoritma yang digunakan untuk pemartisian. Untuk MultiHash, beberapa kunci partisi (hingga tiga maksimum) didukung untuk pembuatan kontainer

Nama	Jenis	Deskripsi
Hash	string
MultiHash	string
Range	string

Resource

Sumber daya peristiwa kontainer Azure Cosmos DB SQL

Nama	Jenis	Deskripsi
_rid	string	Properti yang dihasilkan sistem. Pengidentifikasi unik.
canUndelete	string	Status kontainer ini untuk mengidentifikasi apakah kontainer ini dapat di memulihkan dalam akun yang sama.
canUndeleteReason	string	Alasan mengapa kontainer ini tidak dapat dipulihkan di akun yang sama.
container	Container	Objek sumber daya kontainer Cosmos DB SQL
eventTimestamp	string	Ketika peristiwa kontainer ini terjadi.
operationType	OperationType	Tipe operasi peristiwa kontainer ini.
ownerId	string	Nama kontainer SQL ini.
ownerResourceId	string	ID sumber daya kontainer SQL ini.

ResourceRestoreParameters

Parameter untuk menunjukkan informasi tentang pemulihan.

Nama	Jenis	Deskripsi
restoreSource	string	Id akun database yang dapat dipulihkan tempat pemulihan harus dimulai. Misalnya: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string	Waktu di mana akun harus dipulihkan (format ISO-8601).

RestorableSqlContainerGetResult

Peristiwa kontainer Azure Cosmos DB SQL

Nama	Jenis	Deskripsi
id	string	Pengidentifikasi sumber daya unik sumber daya ARM.
name	string	Nama sumber daya ARM.
properties.resource	Resource	Sumber daya peristiwa kontainer Azure Cosmos DB SQL
type	string	Jenis sumber daya Azure.

RestorableSqlContainersListResult

Respons operasi Daftar, yang berisi peristiwa kontainer SQL dan propertinya.

Nama	Jenis	Deskripsi
value	RestorableSqlContainerGetResult[]	Daftar peristiwa kontainer SQL dan propertinya.

SpatialSpec

Nama	Jenis	Deskripsi
path	string	Jalur tempat perilaku pengindeksan berlaku. Jalur indeks biasanya dimulai dengan root dan diakhir dengan wildcard (/path/*)
types	SpatialType[]	Daftar jenis spasial jalur

SpatialType

Menunjukkan jenis indeks spasial.

Nama	Jenis	Deskripsi
LineString	string
MultiPolygon	string
Point	string
Polygon	string

UniqueKey

Kunci unik pada yang memberlakukan batasan keunikan pada dokumen dalam koleksi di layanan Azure Cosmos DB.

Nama	Jenis	Deskripsi
paths	string[]	Daftar jalur harus unik untuk setiap dokumen dalam layanan Azure Cosmos DB

UniqueKeyPolicy

Konfigurasi kebijakan kunci unik untuk menentukan batasan keunikan pada dokumen dalam koleksi di layanan Azure Cosmos DB.

Nama	Jenis	Deskripsi
uniqueKeys	UniqueKey[]	Daftar kunci unik pada yang memberlakukan batasan keunikan pada dokumen dalam koleksi di layanan Azure Cosmos DB.