Restorable Sql Containers - List

Reference

Služba:: Cosmos DB Resource Provider

Verze rozhraní API:: 2024-11-15

Zobrazte kanál událostí všech mutací provedených ve všech kontejnerech SQL služby Azure Cosmos DB v konkrétní databázi. To pomáhá ve scénáři, kdy se kontejner omylem odstranil. Toto rozhraní API vyžaduje oprávnění 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

S volitelnými parametry:

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}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
instanceId	path	True	string	Identifikátor GUID instanceId obnovitelného databázového účtu.
location	path	True	string	Oblast Cosmos DB s mezerami mezi slovy a jednotlivými slovy velkými písmeny
subscriptionId	path	True	string minLength: 1	ID cílového předplatného.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.
endTime	query		string	Doba ukončení kanálu událostí obnovitelného kontejneru Sql
restorableSqlDatabaseRid	query		string	ID prostředku databáze SQL.
startTime	query		string	Čas spuštění kanálu událostí obnovitelného kontejneru Sql

Odpovědi

Name	Typ	Description
200 OK	RestorableSqlContainersListResult	Operace byla úspěšně dokončena.
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	Zosobnění uživatelského účtu

Příklady

CosmosDBRestorableSqlContainerList

Ukázkový požadavek

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


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

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/2024-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

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/ded6306d00ae294c24211e5069c1f56b15ba8ef5/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-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

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/2024-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

Ukázková odpověď

Stavový kód:: 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\""
          }
        }
      }
    }
  ]
}

Definice

Name	Description
ClientEncryptionIncludedPath	.
ClientEncryptionPolicy	Zásady šifrování klienta Cosmos DB
CloudError	Chybová odpověď ze služby.
CompositePath
CompositePathSortOrder	Pořadí řazení složených cest
ComputedProperty	Definice vypočítané vlastnosti
ConflictResolutionMode	Označuje režim řešení konfliktů.
ConflictResolutionPolicy	Zásady řešení konfliktů pro kontejner.
Container	Objekt prostředku kontejneru SQL služby Cosmos DB
ContainerPartitionKey	Konfigurace klíče oddílu, který se má použít k dělení dat do více oddílů
CreateMode	Výčet označující režim vytváření účtu.
DataType	Datový typ, na který se používá chování indexování.
DistanceFunction	Funkce vzdálenosti, která se má použít pro výpočet vzdálenosti mezi vektory.
ErrorResponse	Chybová odpověď.
ExcludedPath
IncludedPath	Cesty, které jsou součástí indexování
Indexes	Indexy pro cestu.
IndexingMode	Označuje režim indexování.
IndexingPolicy	Zásady indexování služby Cosmos DB
IndexKind	Určuje typ indexu.
OperationType	Výčet označující typ operace události.
PartitionKind	Označuje typ algoritmu, který se používá k dělení. V případě multiHash se pro vytvoření kontejneru podporuje více klíčů oddílů (maximálně tři).
Resource	Prostředek události kontejneru SQL služby Azure Cosmos DB
ResourceRestoreParameters	Parametry označující informace o obnovení
RestorableSqlContainerGetResult	Událost kontejneru SQL služby Azure Cosmos DB
RestorableSqlContainersListResult	Odpověď operace List, která obsahuje události kontejneru SQL a jejich vlastnosti.
SpatialSpec
SpatialType	Označuje prostorový typ indexu.
UniqueKey	Jedinečný klíč, který vynucuje omezení jedinečnosti u dokumentů v kolekci ve službě Azure Cosmos DB.
UniqueKeyPolicy	Konfigurace zásad jedinečného klíče pro určení omezení jedinečnosti dokumentů v kolekci ve službě Azure Cosmos DB.
VectorDataType	Označuje datový typ vektoru.
VectorEmbedding	Představuje vektorové vkládání. Vektorové vkládání se používá k definování vektorového pole v dokumentech.
VectorEmbeddingPolicy	Zásady vkládání vektorů ve službě Cosmos DB
VectorIndex
VectorIndexType	Typ indexu vektoru. V současné době se podporují ploché, diskANN a quantizedFlat.

ClientEncryptionIncludedPath

Objekt

Name	Typ	Description
clientEncryptionKeyId	string	Identifikátor šifrovacího klíče klienta, který se má použít k šifrování cesty.
encryptionAlgorithm	string	Šifrovací algoritmus, který se použije. Např - AEAD_AES_256_CBC_HMAC_SHA256.
encryptionType	string	Typ šifrování, který se má provést. Např - deterministický, randomizovaný.
path	string	Cesta, která musí být šifrovaná.

ClientEncryptionPolicy

Objekt

Zásady šifrování klienta Cosmos DB

Name	Typ	Description
includedPaths	ClientEncryptionIncludedPath[]	Cesty položky, které potřebují šifrování, spolu s nastavením specifickými pro cestu.
policyFormatVersion	integer (int32) minimum: 1 maximum: 2	Verze definice zásad šifrování klienta Podporované verze jsou 1 a 2. Verze 2 podporuje šifrování cesty id a klíče oddílu.

CloudError

Objekt

Chybová odpověď ze služby.

Name	Typ	Description
error	ErrorResponse	Chybová odpověď.

CompositePath

Objekt

Name	Typ	Description
order	CompositePathSortOrder	Pořadí řazení složených cest
path	string	Cesta, na kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*)

CompositePathSortOrder

Výčet

Pořadí řazení složených cest

Hodnota	Description
ascending
descending

ComputedProperty

Objekt

Definice vypočítané vlastnosti

Name	Typ	Description
name	string	Název počítané vlastnosti, například cp_lowerName
query	string	Dotaz, který vyhodnotí hodnotu pro vypočítanou vlastnost, například – SELECT VALUE LOWER(c.name) FROM c

ConflictResolutionMode

Výčet

Označuje režim řešení konfliktů.

Hodnota	Description
Custom
LastWriterWins

ConflictResolutionPolicy

Objekt

Zásady řešení konfliktů pro kontejner.

Name	Typ	Default value	Description
conflictResolutionPath	string		Cesta řešení konfliktů v případě režimu LastWriterWins.
conflictResolutionProcedure	string		Postup řešení konfliktů v případě vlastního režimu.
mode	ConflictResolutionMode	LastWriterWins	Označuje režim řešení konfliktů.

Container

Objekt

Objekt prostředku kontejneru SQL služby Cosmos DB

Name	Typ	Default value	Description
_etag	string		Systém vygenerovaná vlastnost představující značku etag prostředku vyžadovanou pro optimistické řízení souběžnosti.
_rid	string		Systém vygeneroval vlastnost. Jedinečný identifikátor.
_self	string		Systém vygenerovaná vlastnost, která určuje adresovatelnou cestu prostředku kontejneru.
_ts	number		Systém vygenerovaná vlastnost, která označuje časové razítko poslední aktualizace prostředku.
analyticalStorageTtl	integer (int64)		Hodnota TTL analytického úložiště.
clientEncryptionPolicy	ClientEncryptionPolicy		Zásady šifrování klienta pro kontejner.
computedProperties	ComputedProperty[]		Seznam vypočítaných vlastností
conflictResolutionPolicy	ConflictResolutionPolicy		Zásady řešení konfliktů pro kontejner.
createMode	CreateMode	Default	Výčet označující režim vytváření prostředků.
defaultTtl	integer		Výchozí čas k živému provozu
id	string		Název kontejneru SQL služby Cosmos DB
indexingPolicy	IndexingPolicy		Konfigurace zásad indexování Ve výchozím nastavení je indexování automatické pro všechny cesty k dokumentům v rámci kontejneru.
partitionKey	ContainerPartitionKey		Konfigurace klíče oddílu, který se má použít k dělení dat do více oddílů
restoreParameters	ResourceRestoreParameters		Parametry označující informace o obnovení
uniqueKeyPolicy	UniqueKeyPolicy		Konfigurace zásad jedinečného klíče pro určení omezení jedinečnosti dokumentů v kolekci ve službě Azure Cosmos DB.
vectorEmbeddingPolicy	VectorEmbeddingPolicy		Zásada vkládání vektorů pro kontejner.

ContainerPartitionKey

Objekt

Konfigurace klíče oddílu, který se má použít k dělení dat do více oddílů

Name	Typ	Default value	Description
kind	PartitionKind	Hash	Označuje typ algoritmu, který se používá k dělení. V případě multiHash se pro vytvoření kontejneru podporuje více klíčů oddílů (maximálně tři).
paths	string[]		Seznam cest, pomocí kterých je možné rozdělit data v rámci kontejneru
systemKey	boolean		Označuje, jestli kontejner používá systémový vygenerovaný klíč oddílu.
version	integer (int32) minimum: 1 maximum: 2		Označuje verzi definice klíče oddílu.

CreateMode

Výčet

Výčet označující režim vytváření účtu.

Hodnota	Description
Default
Restore

DataType

Výčet

Datový typ, na který se používá chování indexování.

Hodnota	Description
LineString
MultiPolygon
Number
Point
Polygon
String

DistanceFunction

Výčet

Funkce vzdálenosti, která se má použít pro výpočet vzdálenosti mezi vektory.

Hodnota	Description
cosine
dotproduct
euclidean

ErrorResponse

Objekt

Chybová odpověď.

Name	Typ	Description
code	string	Kód chyby
message	string	Chybová zpráva označující, proč operace selhala.

ExcludedPath

Objekt

Name	Typ	Description
path	string	Cesta, na kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*)

IncludedPath

Objekt

Cesty, které jsou součástí indexování

Name	Typ	Description
indexes	Indexes[]	Seznam indexů pro tuto cestu
path	string	Cesta, na kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*)

Indexes

Objekt

Indexy pro cestu.

Name	Typ	Default value	Description
dataType	DataType	String	Datový typ, na který se používá chování indexování.
kind	IndexKind	Hash	Určuje typ indexu.
precision	integer		Přesnost indexu. -1 je maximální přesnost.

IndexingMode

Výčet

Označuje režim indexování.

Hodnota	Description
consistent
lazy
none

IndexingPolicy

Objekt

Zásady indexování služby Cosmos DB

Name	Typ	Default value	Description
automatic	boolean		Označuje, jestli je zásada indexování automatická.
compositeIndexes	CompositePath[]		Seznam složených cest
excludedPaths	ExcludedPath[]		Seznam cest, které se mají vyloučit z indexování
includedPaths	IncludedPath[]		Seznam cest, které se mají zahrnout do indexování
indexingMode	IndexingMode	consistent	Označuje režim indexování.
spatialIndexes	SpatialSpec[]		Seznam prostorových specifik
vectorIndexes	VectorIndex[]		Seznam cest, které se mají zahrnout do indexování vektorů

IndexKind

Výčet

Určuje typ indexu.

Hodnota	Description
Hash
Range
Spatial

OperationType

Výčet

Výčet označující typ operace události.

Hodnota	Description
Create
Delete
Recreate
Replace
SystemOperation

PartitionKind

Výčet

Označuje typ algoritmu, který se používá k dělení. V případě multiHash se pro vytvoření kontejneru podporuje více klíčů oddílů (maximálně tři).

Hodnota	Description
Hash
MultiHash
Range

Resource

Objekt

Prostředek události kontejneru SQL služby Azure Cosmos DB

Name	Typ	Description
_rid	string	Systém vygeneroval vlastnost. Jedinečný identifikátor.
canUndelete	string	Stav tohoto kontejneru, který identifikuje, jestli se tento kontejner dá obnovit ve stejném účtu.
canUndeleteReason	string	Důvod, proč se tento kontejner nedá obnovit ve stejném účtu.
container	Container	Objekt prostředku kontejneru SQL služby Cosmos DB
eventTimestamp	string	Kdy k této události kontejneru došlo.
operationType	OperationType	Typ operace této události kontejneru.
ownerId	string	Název tohoto kontejneru SQL.
ownerResourceId	string	ID prostředku tohoto kontejneru SQL.

ResourceRestoreParameters

Objekt

Parametry označující informace o obnovení

Name	Typ	Description
restoreSource	string	ID obnovovatelného databázového účtu, ze kterého se má obnovení zahájit. Příklad: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string (date-time)	Čas obnovení účtu (formát ISO-8601)
restoreWithTtlDisabled	boolean	Určuje, jestli obnovený účet bude mít po úspěšném obnovení zakázaný časovýTo-Live.

RestorableSqlContainerGetResult

Objekt

Událost kontejneru SQL služby Azure Cosmos DB

Name	Typ	Description
id	string	Jedinečný identifikátor prostředku ARM.
name	string	Název prostředku ARM.
properties.resource	Resource	Prostředek události kontejneru SQL služby Azure Cosmos DB
type	string	Typ prostředku Azure.