Restorable Sql Containers - List

Service:

Cosmos DB Resource Provider

API Version:

2023-11-15

Zobrazení informačního kanálu 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 došlo k náhodnému odstranění kontejneru. 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=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}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
instanceId	path	True	string	InstanceId GUID 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	ID cílového předplatného.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.
endTime	query		string	Koncový čas kanálu událostí obnovitelného kontejneru SQL
restorableSqlDatabaseRid	query		string	ID prostředku databáze SQL.
startTime	query		string	Čas zahájení 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

Tok Azure Active Directory OAuth2

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

Scopes

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

Příklady

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

Definice

Name	Description
ClientEncryptionIncludedPath	.
ClientEncryptionPolicy	Zásady šifrování klientů služby Cosmos DB.
CloudError	Chybová odpověď ze služby.
CompositePath
CompositePathSortOrder	Pořadí řazení složených cest
ComputedProperty	Definice počí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 rozdělení dat do více oddílů
CreateMode	Výčet označující režim vytváření účtu.
DataType	Datový typ, pro který je chování indexování použito.
ErrorResponse	Odpověď na chybu.
ExcludedPath
IncludedPath	Cesty zahrnuté v indexování
Indexes	Indexy pro cestu.
IndexingMode	Označuje režim indexování.
IndexingPolicy	Zásady indexování služby Cosmos DB
IndexKind	Označuje typ indexu.
OperationType	Výčtem označující typ operace události.
PartitionKind	Označuje typ algoritmu použitého k dělení. Pro 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 u dokumentů v kolekci ve službě Azure Cosmos DB

ClientEncryptionIncludedPath

.

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 zašifrovaná.

ClientEncryptionPolicy

Zásady šifrování klientů služby Cosmos DB.

Name	Typ	Description
includedPaths	ClientEncryptionIncludedPath[]	Cesty k položce, které vyžadují šifrování spolu s nastavením specifickými pro cestu.
policyFormatVersion	integer	Verze definice zásad šifrování klienta. Podporované verze jsou 1 a 2. Verze 2 podporuje šifrování cesty pomocí id a klíče oddílu.

CloudError

Chybová odpověď ze služby.

Name	Typ	Description
error	ErrorResponse	Odpověď na chybu.

CompositePath

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

CompositePathSortOrder

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

Name	Typ	Description
ascending	string
descending	string

ComputedProperty

Definice počítané vlastnosti

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

ConflictResolutionMode

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

Name	Typ	Description
Custom	string
LastWriterWins	string

ConflictResolutionPolicy

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

Name	Typ	Výchozí hodnota	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 prostředku kontejneru SQL služby Cosmos DB

Name	Typ	Výchozí hodnota	Description
_etag	string		Systémově vygenerovaná vlastnost představující značku prostředku vyžadovanou pro řízení optimistické souběžnosti.
_rid	string		Systém vygenerovaná vlastnost. Jedinečný identifikátor.
_self	string		Systém generovaná vlastnost, která určuje adresovatelnou cestu k prostředku kontejneru.
_ts	number		Systém generovaná vlastnost, která označuje poslední aktualizované časové razítko prostředku.
analyticalStorageTtl	integer		Hodnota TTL analýzy.
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í hodnota time to Live
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í pro všechny cesty k dokumentům v kontejneru automatické.
partitionKey	ContainerPartitionKey		Konfigurace klíče oddílu, který se má použít k rozdě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 u dokumentů v kolekci ve službě Azure Cosmos DB

ContainerPartitionKey

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

Name	Typ	Výchozí hodnota	Description
kind	PartitionKind	Hash	Označuje typ algoritmu použitého k dělení. Pro 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é dělit data v kontejneru
systemKey	boolean		Označuje, jestli kontejner používá klíč oddílu vygenerovaný systémem.
version	integer		Označuje verzi definice klíče oddílu.

CreateMode

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

Name	Typ	Description
Default	string
Restore	string

DataType

Datový typ, pro který je chování indexování použito.

Name	Typ	Description
LineString	string
MultiPolygon	string
Number	string
Point	string
Polygon	string
String	string

ErrorResponse

Odpověď na chybu.

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

ExcludedPath

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

IncludedPath

Cesty zahrnuté v indexování

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

Indexes

Indexy pro cestu.

Name	Typ	Výchozí hodnota	Description
dataType	DataType	String	Datový typ, pro který je chování indexování použito.
kind	IndexKind	Hash	Označuje typ indexu.
precision	integer		Přesnost indexu. -1 je maximální přesnost.

IndexingMode

Označuje režim indexování.

Name	Typ	Description
consistent	string
lazy	string
none	string

IndexingPolicy

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

Name	Typ	Výchozí hodnota	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

IndexKind

Označuje typ indexu.

Name	Typ	Description
Hash	string
Range	string
Spatial	string

OperationType

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

Name	Typ	Description
Create	string
Delete	string
Recreate	string
Replace	string
SystemOperation	string

PartitionKind

Označuje typ algoritmu použitého k dělení. Pro MultiHash se pro vytvoření kontejneru podporuje více klíčů oddílů (maximálně tři).

Name	Typ	Description
Hash	string
MultiHash	string
Range	string

Resource

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

Name	Typ	Description
_rid	string	Systém vygenerovaná vlastnost. Jedinečný identifikátor.
canUndelete	string	Stav tohoto kontejneru k určení, jestli je tento kontejner obnovitelný ve stejném účtu.
canUndeleteReason	string	Důvod, proč tento kontejner nejde obnovit ve stejném účtu.
container	Container	Objekt prostředku kontejneru SQL služby Cosmos DB
eventTimestamp	string	Kdy došlo k této události kontejneru.
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

Parametry označující informace o obnovení.

Name	Typ	Description
restoreSource	string	ID obnovitelného databázového účtu, ze kterého se má zahájit obnovení. Příklad: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string	Čas, do kterého musí být účet obnoven (formát ISO-8601).

RestorableSqlContainerGetResult

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.

RestorableSqlContainersListResult

Odpověď operace List, která obsahuje události kontejneru SQL a jejich vlastnosti.

Name	Typ	Description
value	RestorableSqlContainerGetResult[]	Seznam událostí kontejneru SQL a jejich vlastností

SpatialSpec

Name	Typ	Description
path	string	Cesta, pro kterou se chování indexování vztahuje. Cesty indexu obvykle začínají kořenem a končí zástupným znakem (/path/*).
types	SpatialType[]	Seznam prostorového typu cesty

SpatialType

Označuje prostorový typ indexu.

Name	Typ	Description
LineString	string
MultiPolygon	string
Point	string
Polygon	string

UniqueKey

Jedinečný klíč, který vynucuje omezení jedinečnosti u dokumentů v kolekci ve službě Azure Cosmos DB.

Name	Typ	Description
paths	string[]	Seznam cest musí být jedinečný pro každý dokument ve službě Azure Cosmos DB.

UniqueKeyPolicy

Konfigurace zásad jedinečného klíče pro určení omezení jedinečnosti u dokumentů v kolekci ve službě Azure Cosmos DB

Name	Typ	Description
uniqueKeys	UniqueKey[]	Seznam jedinečných klíčů, které vynucují omezení jedinečnosti u dokumentů v kolekci ve službě Azure Cosmos DB.