Restorable Sql Containers - List

Service:

Cosmos DB Resource Provider

API Version:

2023-11-15

Belirli bir veritabanı altındaki tüm Azure Cosmos DB SQL kapsayıcılarında yapılan tüm mutasyonların olay akışını gösterin. Bu, kapsayıcının yanlışlıkla silindiği senaryoda yardımcı olur. Bu API için 'Microsoft.DocumentDB/locations/restoreableDatabaseAccounts/.../read' izni gerekiyor

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}

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
instanceId	path	True	string	Geri yüklenebilen bir veritabanı hesabının instanceId GUID değeri.
location	path	True	string	Cosmos DB bölgesi; sözcükler ve her sözcük arasında boşluklar büyük harfle yazıldı.
subscriptionId	path	True	string	Hedef aboneliğin kimliği.
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.
endTime	query		string	Geri yüklenebilen Sql kapsayıcıları olay akışı bitiş zamanı.
restorableSqlDatabaseRid	query		string	SQL veritabanının kaynak kimliği.
startTime	query		string	Geri yüklenebilen Sql kapsayıcıları olay akışı başlangıç zamanı.

Yanıtlar

Name	Tür	Description
200 OK	RestorableSqlContainersListResult	İşlem başarıyla tamamlandı.
Other Status Codes	CloudError	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	Kullanıcı hesabınızın kimliğine bürünme

Örnekler

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

Tanımlar

Name	Description
ClientEncryptionIncludedPath	.
ClientEncryptionPolicy	Cosmos DB istemci şifreleme ilkesi.
CloudError	Hizmetten bir hata yanıtı.
CompositePath
CompositePathSortOrder	Bileşik yollar için sıralama düzeni.
ComputedProperty	Hesaplanan özelliğin tanımı
ConflictResolutionMode	Çakışma çözümleme modunu gösterir.
ConflictResolutionPolicy	Kapsayıcı için çakışma çözümleme ilkesi.
Container	Cosmos DB SQL kapsayıcı kaynak nesnesi
ContainerPartitionKey	Verileri birden çok bölüme bölmek için kullanılacak bölüm anahtarının yapılandırması
CreateMode	Hesap oluşturma modunu belirtmek için sabit listesi.
DataType	Dizin oluşturma davranışının uygulandığı veri türü.
ErrorResponse	Hata Yanıtı.
ExcludedPath
IncludedPath	Dizin oluşturmada yer alan yollar
Indexes	Yol için dizinler.
IndexingMode	Dizin oluşturma modunu gösterir.
IndexingPolicy	Cosmos DB dizin oluşturma ilkesi
IndexKind	Dizinin türünü gösterir.
OperationType	Olayın işlem türünü belirtmek için sabit listesi.
PartitionKind	Bölümleme için kullanılan algoritma türünü gösterir. MultiHash için kapsayıcı oluşturma için birden çok bölüm anahtarı (en fazla üç bölüm anahtarı) desteklenir
Resource	Azure Cosmos DB SQL kapsayıcı olayının kaynağı
ResourceRestoreParameters	Geri yükleme hakkındaki bilgileri gösteren parametreler.
RestorableSqlContainerGetResult	Azure Cosmos DB SQL kapsayıcı olayı
RestorableSqlContainersListResult	SQL kapsayıcı olaylarını ve bunların özelliklerini içeren List işlemi yanıtı.
SpatialSpec
SpatialType	Dizinin uzamsal türünü gösterir.
UniqueKey	Üzerindeki benzersiz anahtar, Azure Cosmos DB hizmetindeki koleksiyondaki belgeler üzerinde benzersizlik kısıtlaması uygular.
UniqueKeyPolicy	Azure Cosmos DB hizmetindeki koleksiyondaki belgelerde benzersizlik kısıtlamalarını belirtmek için benzersiz anahtar ilkesi yapılandırması.

ClientEncryptionIncludedPath

.

Name	Tür	Description
clientEncryptionKeyId	string	Yolu şifrelemek için kullanılacak İstemci Şifreleme Anahtarının tanımlayıcısı.
encryptionAlgorithm	string	Kullanılacak şifreleme algoritması. Örneğin- AEAD_AES_256_CBC_HMAC_SHA256.
encryptionType	string	Gerçekleştirilecek şifreleme türü. Örneğin- Deterministik, Rastgele.
path	string	Şifrelenmesi gereken yol.

ClientEncryptionPolicy

Cosmos DB istemci şifreleme ilkesi.

Name	Tür	Description
includedPaths	ClientEncryptionIncludedPath[]	Yola özgü ayarlarla birlikte şifreleme gerektiren öğenin yolları.
policyFormatVersion	integer	İstemci şifreleme ilkesi tanımının sürümü. Desteklenen sürümler 1 ve 2'dir. Sürüm 2, kimlik ve bölüm anahtarı yolu şifrelemeyi destekler.

CloudError

Hizmetten bir hata yanıtı.

Name	Tür	Description
error	ErrorResponse	Hata Yanıtı.

CompositePath

Name	Tür	Description
order	CompositePathSortOrder	Bileşik yollar için sıralama düzeni.
path	string	Dizin oluşturma davranışının uygulandığı yol. Dizin yolları genellikle kök ile başlar ve joker karakterle biter (/path/*)

CompositePathSortOrder

Bileşik yollar için sıralama düzeni.

Name	Tür	Description
ascending	string
descending	string

ComputedProperty

Hesaplanan özelliğin tanımı

Name	Tür	Description
name	string	Hesaplanan özelliğin adı, örneğin - "cp_lowerName"
query	string	Hesaplanan özelliğin değerini değerlendiren sorgu, örneğin: "SELECT VALUE LOWER(c.name) FROM c"

ConflictResolutionMode

Çakışma çözümleme modunu gösterir.

Name	Tür	Description
Custom	string
LastWriterWins	string

ConflictResolutionPolicy

Kapsayıcı için çakışma çözümleme ilkesi.

Name	Tür	Varsayılan değer	Description
conflictResolutionPath	string		LastWriterWins modunda çakışma çözümleme yolu.
conflictResolutionProcedure	string		Özel mod durumunda çakışmaları çözümleme yordamı.
mode	ConflictResolutionMode	LastWriterWins	Çakışma çözümleme modunu gösterir.

Container

Cosmos DB SQL kapsayıcı kaynak nesnesi

Name	Tür	Varsayılan değer	Description
_etag	string		İyimser eşzamanlılık denetimi için gereken kaynak etiketini temsil eden sistem tarafından oluşturulan özellik.
_rid	string		Sistem tarafından oluşturulan özellik. Benzersiz bir tanımlayıcı.
_self	string		Kapsayıcı kaynağının adreslenebilir yolunu belirten sistem tarafından oluşturulan özellik.
_ts	number		Kaynağın son güncelleştirilen zaman damgasını belirten sistem tarafından oluşturulan özellik.
analyticalStorageTtl	integer		Analitik TTL.
clientEncryptionPolicy	ClientEncryptionPolicy		Kapsayıcı için istemci şifreleme ilkesi.
computedProperties	ComputedProperty[]		Hesaplanan özelliklerin listesi
conflictResolutionPolicy	ConflictResolutionPolicy		Kapsayıcı için çakışma çözümleme ilkesi.
createMode	CreateMode	Default	Kaynak oluşturma modunu belirtmek için sabit listesi.
defaultTtl	integer		Varsayılan yaşam süresi
id	string		Cosmos DB SQL kapsayıcısının adı
indexingPolicy	IndexingPolicy		Dizin oluşturma ilkesinin yapılandırması. Varsayılan olarak, dizin oluşturma kapsayıcı içindeki tüm belge yolları için otomatiktir
partitionKey	ContainerPartitionKey		Verileri birden çok bölüme bölmek için kullanılacak bölüm anahtarının yapılandırması
restoreParameters	ResourceRestoreParameters		Geri yükleme hakkındaki bilgileri gösteren parametreler
uniqueKeyPolicy	UniqueKeyPolicy		Azure Cosmos DB hizmetindeki koleksiyondaki belgelerde benzersizlik kısıtlamalarını belirtmek için benzersiz anahtar ilkesi yapılandırması.

ContainerPartitionKey

Verileri birden çok bölüme bölmek için kullanılacak bölüm anahtarının yapılandırması

Name	Tür	Varsayılan değer	Description
kind	PartitionKind	Hash	Bölümleme için kullanılan algoritma türünü gösterir. MultiHash için kapsayıcı oluşturma için birden çok bölüm anahtarı (en fazla üç bölüm anahtarı) desteklenir
paths	string[]		Kapsayıcı içindeki hangi verilerin bölümlenebileceğini kullanan yolların listesi
systemKey	boolean		Kapsayıcının sistem tarafından oluşturulan bir bölüm anahtarı kullanıp kullanmadiğini gösterir
version	integer		Bölüm anahtarı tanımının sürümünü gösterir

CreateMode

Hesap oluşturma modunu belirtmek için sabit listesi.

Name	Tür	Description
Default	string
Restore	string

DataType

Dizin oluşturma davranışının uygulandığı veri türü.

Name	Tür	Description
LineString	string
MultiPolygon	string
Number	string
Point	string
Polygon	string
String	string

ErrorResponse

Hata Yanıtı.

Name	Tür	Description
code	string	Hata kodu.
message	string	İşlemin neden başarısız olduğunu belirten hata iletisi.

ExcludedPath

Name	Tür	Description
path	string	Dizin oluşturma davranışının uygulandığı yol. Dizin yolları genellikle kök ile başlar ve joker karakterle biter (/path/*)

IncludedPath

Dizin oluşturmada yer alan yollar

Name	Tür	Description
indexes	Indexes[]	Bu yol için dizin listesi
path	string	Dizin oluşturma davranışının uygulandığı yol. Dizin yolları genellikle kök ile başlar ve joker karakterle biter (/path/*)

Indexes

Yol için dizinler.

Name	Tür	Varsayılan değer	Description
dataType	DataType	String	Dizin oluşturma davranışının uygulandığı veri türü.
kind	IndexKind	Hash	Dizinin türünü gösterir.
precision	integer		Dizinin duyarlığı. -1 maksimum duyarlıktır.

IndexingMode

Dizin oluşturma modunu gösterir.

Name	Tür	Description
consistent	string
lazy	string
none	string

IndexingPolicy

Cosmos DB dizin oluşturma ilkesi

Name	Tür	Varsayılan değer	Description
automatic	boolean		Dizin oluşturma ilkesinin otomatik olup olmadığını gösterir
compositeIndexes	CompositePath[]		Bileşik yol listesi listesi
excludedPaths	ExcludedPath[]		Dizin oluşturmanın dışında tutulacak yolların listesi
includedPaths	IncludedPath[]		Dizine eklenecek yolların listesi
indexingMode	IndexingMode	consistent	Dizin oluşturma modunu gösterir.
spatialIndexes	SpatialSpec[]		Uzamsal özelliklerin listesi

IndexKind

Dizinin türünü gösterir.

Name	Tür	Description
Hash	string
Range	string
Spatial	string

OperationType

Olayın işlem türünü belirtmek için sabit listesi.

Name	Tür	Description
Create	string
Delete	string
Recreate	string
Replace	string
SystemOperation	string

PartitionKind

Bölümleme için kullanılan algoritma türünü gösterir. MultiHash için kapsayıcı oluşturma için birden çok bölüm anahtarı (en fazla üç bölüm anahtarı) desteklenir

Name	Tür	Description
Hash	string
MultiHash	string
Range	string

Resource

Azure Cosmos DB SQL kapsayıcı olayının kaynağı

Name	Tür	Description
_rid	string	Sistem tarafından oluşturulan özellik. Benzersiz bir tanımlayıcı.
canUndelete	string	Bu kapsayıcının aynı hesapta geri yüklenebilen olup olmadığını belirlemek için bu kapsayıcının durumu.
canUndeleteReason	string	Bu kapsayıcının aynı hesapta geri yüklenememe nedeni.
container	Container	Cosmos DB SQL kapsayıcı kaynak nesnesi
eventTimestamp	string	Bu kapsayıcı olayının gerçekleştiği zaman.
operationType	OperationType	Bu kapsayıcı olayının işlem türü.
ownerId	string	Bu SQL kapsayıcısının adı.
ownerResourceId	string	Bu SQL kapsayıcısının kaynak kimliği.

ResourceRestoreParameters

Geri yükleme hakkındaki bilgileri gösteren parametreler.

Name	Tür	Description
restoreSource	string	Geri yüklemenin başlatılması gereken geri yüklenebilir veritabanı hesabının kimliği. Örneğin: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restoreableDatabaseAccounts/{restoreableDatabaseAccountName}
restoreTimestampInUtc	string	Hesabın geri yüklenmesi gereken süre (ISO-8601 biçimi).

RestorableSqlContainerGetResult

Azure Cosmos DB SQL kapsayıcı olayı

Name	Tür	Description
id	string	ARM kaynağının benzersiz kaynak Tanımlayıcısı.
name	string	ARM kaynağının adı.
properties.resource	Resource	Azure Cosmos DB SQL kapsayıcı olayının kaynağı
type	string	Azure kaynağının türü.

RestorableSqlContainersListResult

SQL kapsayıcı olaylarını ve bunların özelliklerini içeren List işlemi yanıtı.

Name	Tür	Description
value	RestorableSqlContainerGetResult[]	SQL kapsayıcısı olaylarının ve özelliklerinin listesi.

SpatialSpec

Name	Tür	Description
path	string	Dizin oluşturma davranışının uygulandığı yol. Dizin yolları genellikle kök ile başlar ve joker karakterle biter (/path/*)
types	SpatialType[]	Yolun uzamsal türünün listesi

SpatialType

Dizinin uzamsal türünü gösterir.

Name	Tür	Description
LineString	string
MultiPolygon	string
Point	string
Polygon	string

UniqueKey

Üzerindeki benzersiz anahtar, Azure Cosmos DB hizmetindeki koleksiyondaki belgeler üzerinde benzersizlik kısıtlaması uygular.

Name	Tür	Description
paths	string[]	Yolların listesi Azure Cosmos DB hizmetindeki her belge için benzersiz olmalıdır

UniqueKeyPolicy

Azure Cosmos DB hizmetindeki koleksiyondaki belgelerde benzersizlik kısıtlamalarını belirtmek için benzersiz anahtar ilkesi yapılandırması.

Name	Tür	Description
uniqueKeys	UniqueKey[]	Azure Cosmos DB hizmetindeki koleksiyondaki belgelerde benzersizlik kısıtlaması uygulayan benzersiz anahtarların listesi.