Restorable Sql Containers - List

Service:

Cosmos DB Resource Provider

API Version:

2023-11-15

Visa händelseflödet för alla mutationer som görs på alla Azure Cosmos DB SQL-containrar under en specifik databas. Detta hjälper till i scenariot där containern togs bort av misstag. Det här API:et kräver behörigheten 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}

URI-parametrar

Name	I	Obligatorisk	Typ	Description
instanceId	path	True	string	InstanceId-GUID för ett återställningsbart databaskonto.
location	path	True	string	Cosmos DB-region med blanksteg mellan ord och varje ord med versaler.
subscriptionId	path	True	string	ID för målprenumerationen.
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.
endTime	query		string	Återställningsbar sluttid för Sql-containrar för händelsefeed.
restorableSqlDatabaseRid	query		string	Resurs-ID för SQL-databasen.
startTime	query		string	Återställningsbar starttid för Sql-containrar för händelsefeed.

Svar

Name	Typ	Description
200 OK	RestorableSqlContainersListResult	Åtgärden har slutförts.
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

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	Personifiera ditt användarkonto

Exempel

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

Definitioner

Name	Description
ClientEncryptionIncludedPath	.
ClientEncryptionPolicy	Cosmos DB-klientkrypteringsprincip.
CloudError	Ett felsvar från tjänsten.
CompositePath
CompositePathSortOrder	Sorteringsordning för sammansatta sökvägar.
ComputedProperty	Definitionen av en beräknad egenskap
ConflictResolutionMode	Anger konfliktlösningsläget.
ConflictResolutionPolicy	Konfliktlösningsprincipen för containern.
Container	Resursobjekt för Cosmos DB SQL-container
ContainerPartitionKey	Konfigurationen av partitionsnyckeln som ska användas för att partitionera data i flera partitioner
CreateMode	Uppräkning för att ange läget för kontoskapande.
DataType	Den datatyp som indexeringsbeteendet tillämpas på.
ErrorResponse	Felsvar.
ExcludedPath
IncludedPath	Sökvägarna som ingår i indexeringen
Indexes	Index för sökvägen.
IndexingMode	Anger indexeringsläget.
IndexingPolicy	Cosmos DB-indexeringsprincip
IndexKind	Anger typen av index.
OperationType	Uppräkning för att ange åtgärdstypen för händelsen.
PartitionKind	Anger vilken typ av algoritm som används för partitionering. För MultiHash stöds flera partitionsnycklar (upp till högst tre) för containerskapande
Resource	Resursen för en Azure Cosmos DB SQL-containerhändelse
ResourceRestoreParameters	Parametrar som anger information om återställningen.
RestorableSqlContainerGetResult	En Azure Cosmos DB SQL-containerhändelse
RestorableSqlContainersListResult	Svar på liståtgärden som innehåller SQL-containerhändelserna och deras egenskaper.
SpatialSpec
SpatialType	Anger den rumsliga typen av index.
UniqueKey	Den unika nyckeln på som framtvingar unikhetsbegränsning för dokument i samlingen i Azure Cosmos DB-tjänsten.
UniqueKeyPolicy	Den unika nyckelprincipkonfigurationen för att ange unikhetsbegränsningar för dokument i samlingen i Azure Cosmos DB-tjänsten.

ClientEncryptionIncludedPath

.

Name	Typ	Description
clientEncryptionKeyId	string	Identifieraren för den klientkrypteringsnyckel som ska användas för att kryptera sökvägen.
encryptionAlgorithm	string	Krypteringsalgoritmen som ska användas. T.ex. - AEAD_AES_256_CBC_HMAC_SHA256.
encryptionType	string	Vilken typ av kryptering som ska utföras. T.ex. – deterministisk, randomiserad.
path	string	Sökväg som måste krypteras.

ClientEncryptionPolicy

Cosmos DB-klientkrypteringsprincip.

Name	Typ	Description
includedPaths	ClientEncryptionIncludedPath[]	Sökvägar för objektet som behöver kryptering tillsammans med sökvägsspecifika inställningar.
policyFormatVersion	integer	Version av principdefinitionen för klientkryptering. Versioner som stöds är 1 och 2. Version 2 stöder ID- och partitionsnyckelsökvägskryptering.

CloudError

Ett felsvar från tjänsten.

Name	Typ	Description
error	ErrorResponse	Felsvar.

CompositePath

Name	Typ	Description
order	CompositePathSortOrder	Sorteringsordning för sammansatta sökvägar.
path	string	Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slutar med jokertecken (/sökväg/*)

CompositePathSortOrder

Sorteringsordning för sammansatta sökvägar.

Name	Typ	Description
ascending	string
descending	string

ComputedProperty

Definitionen av en beräknad egenskap

Name	Typ	Description
name	string	Namnet på en beräknad egenskap, till exempel "cp_lowerName"
query	string	Frågan som utvärderar värdet för den beräknade egenskapen, till exempel "SELECT VALUE LOWER(c.name) FROM c"

ConflictResolutionMode

Anger konfliktlösningsläget.

Name	Typ	Description
Custom	string
LastWriterWins	string

ConflictResolutionPolicy

Konfliktlösningsprincipen för containern.

Name	Typ	Standardvärde	Description
conflictResolutionPath	string		Konfliktlösningssökvägen i fallet LastWriterWins-läge.
conflictResolutionProcedure	string		Proceduren för att lösa konflikter i ett anpassat läge.
mode	ConflictResolutionMode	LastWriterWins	Anger konfliktlösningsläget.

Container

Resursobjekt för Cosmos DB SQL-container

Name	Typ	Standardvärde	Description
_etag	string		En systemgenererad egenskap som representerar resursetaggen som krävs för optimistisk samtidighetskontroll.
_rid	string		En systemgenererad egenskap. En unik identifierare.
_self	string		En systemgenererad egenskap som anger containerresursens adresserbara sökväg.
_ts	number		En systemgenererad egenskap som anger den senast uppdaterade tidsstämpeln för resursen.
analyticalStorageTtl	integer		TTL för analys.
clientEncryptionPolicy	ClientEncryptionPolicy		Klientkrypteringsprincipen för containern.
computedProperties	ComputedProperty[]		Lista över beräknade egenskaper
conflictResolutionPolicy	ConflictResolutionPolicy		Konfliktlösningsprincipen för containern.
createMode	CreateMode	Default	Uppräkning för att ange läget för resursskapande.
defaultTtl	integer		Standardtid till live
id	string		Namnet på Cosmos DB SQL-containern
indexingPolicy	IndexingPolicy		Konfigurationen av indexeringsprincipen. Som standard är indexeringen automatisk för alla dokumentsökvägar i containern
partitionKey	ContainerPartitionKey		Konfigurationen av partitionsnyckeln som ska användas för att partitionera data i flera partitioner
restoreParameters	ResourceRestoreParameters		Parametrar för att ange information om återställningen
uniqueKeyPolicy	UniqueKeyPolicy		Den unika nyckelprincipkonfigurationen för att ange unikhetsbegränsningar för dokument i samlingen i Azure Cosmos DB-tjänsten.

ContainerPartitionKey

Konfigurationen av partitionsnyckeln som ska användas för att partitionera data i flera partitioner

Name	Typ	Standardvärde	Description
kind	PartitionKind	Hash	Anger vilken typ av algoritm som används för partitionering. För MultiHash stöds flera partitionsnycklar (upp till högst tre) för containerskapande
paths	string[]		Lista över sökvägar som använder vilka data i containern som kan partitioneras
systemKey	boolean		Anger om containern använder en systemgenererad partitionsnyckel
version	integer		Anger versionen av partitionsnyckeldefinitionen

CreateMode

Uppräkning för att ange läget för kontoskapande.

Name	Typ	Description
Default	string
Restore	string

DataType

Den datatyp som indexeringsbeteendet tillämpas på.

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

ErrorResponse

Felsvar.

Name	Typ	Description
code	string	Felkod.
message	string	Felmeddelande som anger varför åtgärden misslyckades.

ExcludedPath

Name	Typ	Description
path	string	Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slutar med jokertecken (/sökväg/*)

IncludedPath

Sökvägarna som ingår i indexeringen

Name	Typ	Description
indexes	Indexes[]	Lista över index för den här sökvägen
path	string	Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slutar med jokertecken (/sökväg/*)

Indexes

Index för sökvägen.

Name	Typ	Standardvärde	Description
dataType	DataType	String	Den datatyp som indexeringsbeteendet tillämpas på.
kind	IndexKind	Hash	Anger typen av index.
precision	integer		Precisionen för indexet. -1 är maximal precision.

IndexingMode

Anger indexeringsläget.

Name	Typ	Description
consistent	string
lazy	string
none	string

IndexingPolicy

Cosmos DB-indexeringsprincip

Name	Typ	Standardvärde	Description
automatic	boolean		Anger om indexeringsprincipen är automatisk
compositeIndexes	CompositePath[]		Lista över sammansatt sökvägslista
excludedPaths	ExcludedPath[]		Lista över sökvägar som ska undantas från indexering
includedPaths	IncludedPath[]		Lista över sökvägar som ska ingå i indexeringen
indexingMode	IndexingMode	consistent	Anger indexeringsläget.
spatialIndexes	SpatialSpec[]		Lista över rumsliga detaljer

IndexKind

Anger typen av index.

Name	Typ	Description
Hash	string
Range	string
Spatial	string

OperationType

Uppräkning för att ange åtgärdstypen för händelsen.

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

PartitionKind

Anger vilken typ av algoritm som används för partitionering. För MultiHash stöds flera partitionsnycklar (upp till högst tre) för containerskapande

Name	Typ	Description
Hash	string
MultiHash	string
Range	string

Resource

Resursen för en Azure Cosmos DB SQL-containerhändelse

Name	Typ	Description
_rid	string	En systemgenererad egenskap. En unik identifierare.
canUndelete	string	Ett tillstånd för den här containern för att identifiera om den här containern kan återställas i samma konto.
canUndeleteReason	string	Anledningen till att den här containern inte kan återställas i samma konto.
container	Container	Resursobjekt för Cosmos DB SQL-container
eventTimestamp	string	När den här containerhändelsen inträffade.
operationType	OperationType	Åtgärdstypen för den här containerhändelsen.
ownerId	string	Namnet på den här SQL-containern.
ownerResourceId	string	Resurs-ID för den här SQL-containern.

ResourceRestoreParameters

Parametrar som anger information om återställningen.

Name	Typ	Description
restoreSource	string	ID:t för det återställningsbara databaskonto som återställningen måste initieras från. Exempel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string	Tid till vilken kontot måste återställas (ISO-8601-format).

RestorableSqlContainerGetResult

En Azure Cosmos DB SQL-containerhändelse

Name	Typ	Description
id	string	Den unika resursidentifieraren för ARM-resursen.
name	string	Namnet på ARM-resursen.
properties.resource	Resource	Resursen för en Azure Cosmos DB SQL-containerhändelse
type	string	Typen av Azure-resurs.

RestorableSqlContainersListResult

Svar på liståtgärden som innehåller SQL-containerhändelserna och deras egenskaper.

Name	Typ	Description
value	RestorableSqlContainerGetResult[]	Lista över SQL-containerhändelser och deras egenskaper.

SpatialSpec

Name	Typ	Description
path	string	Den sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar vanligtvis med rot och slutar med jokertecken (/sökväg/*)
types	SpatialType[]	Lista över sökvägens rumsliga typ

SpatialType

Anger den rumsliga typen av index.

Name	Typ	Description
LineString	string
MultiPolygon	string
Point	string
Polygon	string

UniqueKey

Den unika nyckeln på som framtvingar unikhetsbegränsning för dokument i samlingen i Azure Cosmos DB-tjänsten.

Name	Typ	Description
paths	string[]	Listan över sökvägar måste vara unik för varje dokument i Azure Cosmos DB-tjänsten

UniqueKeyPolicy

Den unika nyckelprincipkonfigurationen för att ange unikhetsbegränsningar för dokument i samlingen i Azure Cosmos DB-tjänsten.

Name	Typ	Description
uniqueKeys	UniqueKey[]	Lista över unika nycklar för som framtvingar unikhetsbegränsning för dokument i samlingen i Azure Cosmos DB-tjänsten.