Restorable Sql Containers - List

Dienst:: Cosmos DB Resource Provider

API-Version:: 2025-10-15

Zeigt den Ereignisfeed aller Mutationen an, die für alle Azure Cosmos DB SQL-Container unter einer bestimmten Datenbank vorgenommen wurden. Dies ist hilfreich in Szenarien, in denen der Container versehentlich gelöscht wurde. Für diese API ist die Berechtigung "Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read" erforderlich.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlContainers?api-version=2025-10-15

Mit optionalen Parametern:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}/restorableSqlContainers?api-version=2025-10-15&restorableSqlDatabaseRid={restorableSqlDatabaseRid}&startTime={startTime}&endTime={endTime}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
instanceId	path	True	string	Die instanceId-GUID eines wiederherstellbaren Datenbankkontos.
location	path	True	string	Cosmos DB-Region, mit Leerzeichen zwischen den Wörtern und jedem Wort in Großbuchstaben.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.
endTime	query		string	Endzeit für wiederherstellbare Sql-Container-Ereignisfeeds.
restorableSqlDatabaseRid	query		string	Die Ressourcen-ID der SQL-Datenbank.
startTime	query		string	Startzeit für wiederherstellbare Sql-Container-Ereignisfeeds.

Antworten

Name	Typ	Beschreibung
200 OK	RestorableSqlContainersListResult	Der Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

CosmosDBRestorableSqlContainerList

Beispielanforderung

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.DocumentDB/locations/WestUS/restorableDatabaseAccounts/98a570f2-63db-4117-91f0-366327b7b353/restorableSqlContainers?api-version=2025-10-15&restorableSqlDatabaseRid=3fu-hg==

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/DocumentDB/stable/2025-10-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/8b53f9cfc1fdb24dbfa28e311d3be4c645169297/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/DocumentDB/stable/2025-10-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");
require("dotenv/config");

/**
 * 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/DocumentDB/stable/2025-10-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 (const 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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.CosmosDB.Models;
using Azure.ResourceManager.CosmosDB;

// Generated from example definition: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/DocumentDB/stable/2025-10-15/examples/CosmosDBRestorableSqlContainerList.json
// this example is just showing the usage of "RestorableSqlContainers_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://v4.hkg1.meaqua.org/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this RestorableCosmosDBAccountResource created on azure
// for more information of creating RestorableCosmosDBAccountResource, please refer to the document of RestorableCosmosDBAccountResource
string subscriptionId = "subid";
AzureLocation location = new AzureLocation("WestUS");
Guid instanceId = Guid.Parse("98a570f2-63db-4117-91f0-366327b7b353");
ResourceIdentifier restorableCosmosDBAccountResourceId = RestorableCosmosDBAccountResource.CreateResourceIdentifier(subscriptionId, location, instanceId);
RestorableCosmosDBAccountResource restorableCosmosDBAccount = client.GetRestorableCosmosDBAccountResource(restorableCosmosDBAccountResourceId);

// invoke the operation and iterate over the result
string restorableSqlDatabaseRid = "3fu-hg==";
await foreach (RestorableSqlContainer item in restorableCosmosDBAccount.GetRestorableSqlContainersAsync(restorableSqlDatabaseRid: restorableSqlDatabaseRid))
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
ClientEncryptionIncludedPath	.
ClientEncryptionPolicy	Cosmos DB-Clientverschlüsselungsrichtlinie.
CloudError	Eine Fehlerantwort des Diensts.
CompositePath
CompositePathSortOrder	Sortierreihenfolge für zusammengesetzte Pfade.
ComputedProperty	Die Definition einer berechneten Eigenschaft
ConflictResolutionMode	Gibt den Konfliktauflösungsmodus an.
ConflictResolutionPolicy	Die Konfliktlösungsrichtlinie für den Container.
Container	Cosmos DB SQL-Containerressourcenobjekt
ContainerPartitionKey	Die Konfiguration des Partitionsschlüssels, der für die Partitionierung von Daten in mehrere Partitionen verwendet werden soll
CreateMode	Aufzählung, um den Modus der Kontoerstellung anzugeben.
DataType	Der Datentyp, auf den das Indizierungsverhalten angewendet wird.
DistanceFunction	Die Abstandsfunktion, die für die Entfernungsberechnung zwischen Vektoren verwendet werden soll.
ErrorResponse	Fehlerantwort.
ExcludedPath
FullTextIndexPath	Stellt den Volltextindexpfad dar.
FullTextPath	Stellt die Spezifikation des Volltextpfads dar.
FullTextPolicy	Cosmos DB-Volltextrichtlinie
IncludedPath	Die Pfade, die in die Indizierung einbezogen werden
Indexes	Die Indizes für den Pfad.
IndexingMode	Gibt den Indizierungsmodus an.
IndexingPolicy	Cosmos DB-Indizierungsrichtlinie
IndexKind	Gibt den Indextyp an.
OperationType	Enum, um den Vorgangstyp des Ereignisses anzugeben.
PartitionKind	Gibt die Art des Algorithmus an, der für die Partitionierung verwendet wird. Bei MultiHash werden mehrere Partitionsschlüssel (maximal drei) für die Containererstellung unterstützt.
Resource	Die Ressource eines Azure Cosmos DB SQL-Containerereignisses
ResourceRestoreParameters	Parameter, die die Informationen zur Wiederherstellung angeben sollen.
RestorableSqlContainerGetResult	Ein Azure Cosmos DB SQL-Containerereignis
RestorableSqlContainersListResult	Die Antwort auf den List-Vorgang, die die SQL-Containerereignisse und deren Eigenschaften enthält.
SpatialSpec
SpatialType	Gibt den räumlichen Typ des Indexes an.
UniqueKey	Der eindeutige Schlüssel, der die Eindeutigkeitseinschränkung für Dokumente in der Sammlung im Azure Cosmos DB-Dienst erzwingt.
UniqueKeyPolicy	Die Konfiguration der eindeutigen Schlüsselrichtlinie zum Angeben von Eindeutigkeitseinschränkungen für Dokumente in der Sammlung im Azure Cosmos DB-Dienst.
VectorDataType	Gibt den Datentyp des Vektors an.
VectorEmbedding	Stellt eine Vektoreinbettung dar. Eine Vektoreinbettung wird verwendet, um ein Vektorfeld in den Dokumenten zu definieren.
VectorEmbeddingPolicy	Richtlinie zum Einbetten von Cosmos DB-Vektoren
VectorIndex
VectorIndexType	Der Indextyp des Vektors. Derzeit werden flat, diskANN und quantizedFlat unterstützt.

ClientEncryptionIncludedPath

Objekt

Name	Typ	Beschreibung
clientEncryptionKeyId	string	Der Bezeichner des Clientverschlüsselungsschlüssels, der zum Verschlüsseln des Pfads verwendet werden soll.
encryptionAlgorithm	string	Der Verschlüsselungsalgorithmus, der verwendet wird. Z.B. - AEAD_AES_256_CBC_HMAC_SHA256.
encryptionType	string	Der Typ der zu verwendenden Verschlüsselung. Eg - Deterministisch, randomisiert.
path	string	Pfad, der verschlüsselt werden muss.

ClientEncryptionPolicy

Objekt

Cosmos DB-Clientverschlüsselungsrichtlinie.

Name	Typ	Beschreibung
includedPaths	ClientEncryptionIncludedPath[]	Pfade des Elements, die Verschlüsselung zusammen mit pfadspezifischen Einstellungen benötigen.
policyFormatVersion	integer (int32) minimum: 1 maximum: 2	Version der Clientverschlüsselungsrichtliniendefinition. Unterstützte Versionen sind 1 und 2. Version 2 unterstützt die ID- und Partitionsschlüsselpfadverschlüsselung.

CloudError

Objekt

Eine Fehlerantwort des Diensts.

Name	Typ	Beschreibung
error	ErrorResponse	Fehlerantwort.

CompositePath

Objekt

Name	Typ	Beschreibung
order	CompositePathSortOrder	Sortierreihenfolge für zusammengesetzte Pfade.
path	string	Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Einem Wildcard (/pfad/*)

CompositePathSortOrder

Enumeration

Sortierreihenfolge für zusammengesetzte Pfade.

Wert	Beschreibung
ascending
descending

ComputedProperty

Objekt

Die Definition einer berechneten Eigenschaft

Name	Typ	Beschreibung
name	string	Der Name einer berechneten Eigenschaft, z. B. "cp_lowerName"
query	string	Die Abfrage, die den Wert für berechnete Eigenschaft auswertet, z. B. "SELECT VALUE LOWER(c.name) FROM c"

ConflictResolutionMode

Enumeration

Gibt den Konfliktauflösungsmodus an.

Wert	Beschreibung
LastWriterWins
Custom

ConflictResolutionPolicy

Objekt

Die Konfliktlösungsrichtlinie für den Container.

Name	Typ	Standardwert	Beschreibung
conflictResolutionPath	string		Der Konfliktlösungspfad im Fall des LastWriterWins-Modus.
conflictResolutionProcedure	string		Die Prozedur zum Beheben von Konflikten im Fall des benutzerdefinierten Modus.
mode	ConflictResolutionMode	LastWriterWins	Gibt den Konfliktauflösungsmodus an.

Container

Objekt

Cosmos DB SQL-Containerressourcenobjekt

Name	Typ	Standardwert	Beschreibung
_etag	string		Eine vom System generierte Eigenschaft, die das Ressourcen-ETAG darstellt, das für die Steuerung der optimistischen Parallelität erforderlich ist.
_rid	string		Eine vom System generierte Eigenschaft. Eine eindeutige Kennung.
_self	string		Eine vom System generierte Eigenschaft, die den adressierbaren Pfad der Containerressource angibt.
_ts	number		Eine vom System generierte Eigenschaft, die den zuletzt aktualisierten Zeitstempel der Ressource angibt.
analyticalStorageTtl	integer (int64)		Analytische tTL.
clientEncryptionPolicy	ClientEncryptionPolicy		Die Clientverschlüsselungsrichtlinie für den Container.
computedProperties	ComputedProperty[]		Liste der berechneten Eigenschaften
conflictResolutionPolicy	ConflictResolutionPolicy		Die Konfliktlösungsrichtlinie für den Container.
createMode	CreateMode	Default	Aufzählung, um den Modus der Ressourcenerstellung anzugeben.
defaultTtl	integer		Standardzeit für Live
fullTextPolicy	FullTextPolicy		Die FullText-Richtlinie für den Container.
id	string		Name des Cosmos DB SQL-Containers
indexingPolicy	IndexingPolicy		Die Konfiguration der Indizierungsrichtlinie. Standardmäßig ist die Indizierung für alle Dokumentpfade innerhalb des Containers automatisch.
partitionKey	ContainerPartitionKey		Die Konfiguration des Partitionsschlüssels, der für die Partitionierung von Daten in mehrere Partitionen verwendet werden soll
restoreParameters	ResourceRestoreParameters		Parameter, die die Informationen zur Wiederherstellung angeben sollen
uniqueKeyPolicy	UniqueKeyPolicy		Die Konfiguration der eindeutigen Schlüsselrichtlinie zum Angeben von Eindeutigkeitseinschränkungen für Dokumente in der Sammlung im Azure Cosmos DB-Dienst.
vectorEmbeddingPolicy	VectorEmbeddingPolicy		Die Vektoreinbettungsrichtlinie für den Container.

ContainerPartitionKey

Objekt

Die Konfiguration des Partitionsschlüssels, der für die Partitionierung von Daten in mehrere Partitionen verwendet werden soll

Name	Typ	Standardwert	Beschreibung
kind	PartitionKind	Hash	Gibt die Art des Algorithmus an, der für die Partitionierung verwendet wird. Bei MultiHash werden mehrere Partitionsschlüssel (maximal drei) für die Containererstellung unterstützt.
paths	string[]		Liste der Pfade, die verwenden, welche Daten innerhalb des Containers partitioniert werden können
systemKey	boolean		Gibt an, ob der Container einen vom System generierten Partitionsschlüssel verwendet.
version	integer (int32) minimum: 1 maximum: 2		Gibt die Version der Partitionsschlüsseldefinition an.

CreateMode

Enumeration

Aufzählung, um den Modus der Kontoerstellung anzugeben.

Wert	Beschreibung
Default
Restore

DataType

Enumeration

Der Datentyp, auf den das Indizierungsverhalten angewendet wird.

Wert	Beschreibung
String
Number
Point
Polygon
LineString
MultiPolygon

DistanceFunction

Enumeration

Die Abstandsfunktion, die für die Entfernungsberechnung zwischen Vektoren verwendet werden soll.

Wert	Beschreibung
euclidean
cosine
dotproduct

ErrorResponse

Objekt

Fehlerantwort.

Name	Typ	Beschreibung
code	string	Fehlercode.
message	string	Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

ExcludedPath

Objekt

Name	Typ	Beschreibung
path	string	Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Einem Wildcard (/pfad/*)

FullTextIndexPath

Objekt

Stellt den Volltextindexpfad dar.

Name	Typ	Beschreibung
path	string	Der Pfad zum Volltextfeld im Dokument.

FullTextPath

Objekt

Stellt die Spezifikation des Volltextpfads dar.

Name	Typ	Beschreibung
language	string	Die Sprache des Volltextfelds im Dokument.
path	string	Der Pfad zum Volltextfeld im Dokument.

FullTextPolicy

Objekt

Cosmos DB-Volltextrichtlinie

Name	Typ	Beschreibung
defaultLanguage	string	Die Standardsprache für Volltextpfade.
fullTextPaths	FullTextPath[]	Liste der FullText-Pfade

IncludedPath

Objekt

Die Pfade, die in die Indizierung einbezogen werden

Name	Typ	Beschreibung
indexes	Indexes[]	Liste der Indizes für diesen Pfad
path	string	Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Einem Wildcard (/pfad/*)

Indexes

Objekt

Die Indizes für den Pfad.

Name	Typ	Standardwert	Beschreibung
dataType	DataType	String	Der Datentyp, auf den das Indizierungsverhalten angewendet wird.
kind	IndexKind	Hash	Gibt den Indextyp an.
precision	integer		Die Genauigkeit des Indexes. -1 ist maximale Genauigkeit.

IndexingMode

Enumeration

Gibt den Indizierungsmodus an.

Wert	Beschreibung
consistent
lazy
none

IndexingPolicy

Objekt

Cosmos DB-Indizierungsrichtlinie

Name	Typ	Standardwert	Beschreibung
automatic	boolean		Gibt an, ob die Indizierungsrichtlinie automatisch ist.
compositeIndexes	CompositePath[]		Liste der zusammengesetzten Pfadliste
excludedPaths	ExcludedPath[]		Liste der Pfade, die von der Indizierung ausgeschlossen werden sollen
fullTextIndexes	FullTextIndexPath[]		Liste der Pfade, die in die Volltextindizierung einbezogen werden sollen
includedPaths	IncludedPath[]		Liste der Pfade, die in die Indizierung aufgenommen werden sollen
indexingMode	IndexingMode	consistent	Gibt den Indizierungsmodus an.
spatialIndexes	SpatialSpec[]		Liste der räumlichen Besonderheiten
vectorIndexes	VectorIndex[]		Liste der Pfade, die in die Vektorindizierung aufgenommen werden sollen

IndexKind

Enumeration

Gibt den Indextyp an.

Wert	Beschreibung
Hash
Range
Spatial

OperationType

Enumeration

Enum, um den Vorgangstyp des Ereignisses anzugeben.

Wert	Beschreibung
Create
Replace
Delete
Recreate
SystemOperation

PartitionKind

Enumeration

Gibt die Art des Algorithmus an, der für die Partitionierung verwendet wird. Bei MultiHash werden mehrere Partitionsschlüssel (maximal drei) für die Containererstellung unterstützt.

Wert	Beschreibung
Hash
Range
MultiHash

Resource

Objekt

Die Ressource eines Azure Cosmos DB SQL-Containerereignisses

Name	Typ	Beschreibung
_rid	string	Eine vom System generierte Eigenschaft. Eine eindeutige Kennung.
canUndelete	string	Ein Status dieses Containers, um zu identifizieren, ob dieser Container im selben Konto wiederhergestellt werden kann.
canUndeleteReason	string	Der Grund, warum dieser Container im selben Konto nicht wiederhergestellt werden kann.
container	Container	Cosmos DB SQL-Containerressourcenobjekt
eventTimestamp	string	Das, wann dieses Containerereignis aufgetreten ist.
operationType	OperationType	Der Vorgangstyp dieses Containerereignisses.
ownerId	string	Der Name dieses SQL-Containers.
ownerResourceId	string	Die Ressourcen-ID dieses SQL-Containers.

ResourceRestoreParameters

Objekt

Parameter, die die Informationen zur Wiederherstellung angeben sollen.

Name	Typ	Beschreibung
restoreSource	string	Die ID des wiederherstellbaren Datenbankkontos, von dem die Wiederherstellung initiiert werden muss. Beispiel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string (date-time)	Zeit, zu der das Konto wiederhergestellt werden muss (ISO-8601-Format).
restoreWithTtlDisabled	boolean	Gibt an, ob das wiederhergestellte Konto zeit-To-Live bei der erfolgreichen Wiederherstellung deaktiviert ist.

RestorableSqlContainerGetResult

Objekt

Ein Azure Cosmos DB SQL-Containerereignis

Name	Typ	Beschreibung
id	string	Der eindeutige Ressourcenbezeichner der ARM-Ressource.
name	string	Der Name der ARM-Ressource.
properties.resource	Resource	Die Ressource eines Azure Cosmos DB SQL-Containerereignisses
type	string	Der Typ der Azure-Ressource.

RestorableSqlContainersListResult

Objekt

Die Antwort auf den List-Vorgang, die die SQL-Containerereignisse und deren Eigenschaften enthält.

Name	Typ	Beschreibung
value	RestorableSqlContainerGetResult[]	Liste der SQL-Containerereignisse und ihrer Eigenschaften.

SpatialSpec

Objekt

Name	Typ	Beschreibung
path	string	Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Einem Wildcard (/pfad/*)
types	SpatialType[]	Liste des räumlichen Pfadtyps

SpatialType

Enumeration

Gibt den räumlichen Typ des Indexes an.

Wert	Beschreibung
Point
LineString
Polygon
MultiPolygon

UniqueKey

Objekt

Der eindeutige Schlüssel, der die Eindeutigkeitseinschränkung für Dokumente in der Sammlung im Azure Cosmos DB-Dienst erzwingt.

Name	Typ	Beschreibung
paths	string[]	Liste der Pfade muss für jedes Dokument im Azure Cosmos DB-Dienst eindeutig sein.

UniqueKeyPolicy

Objekt

Die Konfiguration der eindeutigen Schlüsselrichtlinie zum Angeben von Eindeutigkeitseinschränkungen für Dokumente in der Sammlung im Azure Cosmos DB-Dienst.

Name	Typ	Beschreibung
uniqueKeys	UniqueKey[]	Liste der eindeutigen Schlüssel für die Erzwingung der Eindeutigkeitseinschränkung für Dokumente in der Sammlung im Azure Cosmos DB-Dienst.

VectorDataType

Enumeration

Gibt den Datentyp des Vektors an.

Wert	Beschreibung
float32
uint8
int8
float16

VectorEmbedding

Objekt

Stellt eine Vektoreinbettung dar. Eine Vektoreinbettung wird verwendet, um ein Vektorfeld in den Dokumenten zu definieren.

Name	Typ	Beschreibung
dataType	VectorDataType	Gibt den Datentyp des Vektors an.
dimensions	integer (int32)	Die Anzahl der Dimensionen im Vektor.
distanceFunction	DistanceFunction	Die Abstandsfunktion, die für die Entfernungsberechnung zwischen Vektoren verwendet werden soll.
path	string	Der Pfad zum Vektorfeld im Dokument.

VectorEmbeddingPolicy

Objekt

Richtlinie zum Einbetten von Cosmos DB-Vektoren

Name	Typ	Beschreibung
vectorEmbeddings	VectorEmbedding[]	Liste der Vektoreinbettungen

VectorIndex

Objekt

Name	Typ	Standardwert	Beschreibung
indexingSearchListSize	integer (int64) minimum: 25 maximum: 500	100	Dies ist die Größe der Kandidatenliste der ungefähren Nachbarn, die beim Erstellen des DiskANN-Index als Teil der Optimierungsprozesse gespeichert werden. Große Werte können den Abruf auf Kosten der Latenz verbessern. Dies gilt nur für den diskANN-Vektorindextyp.
path	string		Der Pfad zum Vektorfeld im Dokument.
quantizationByteSize	integer (int64) minimum: 4		Die Anzahl der Bytes, die bei der Produktquantisierung der Vektoren verwendet werden. Ein größerer Wert kann zu einem besseren Abruf bei Vektorsuchen auf Kosten der Latenz führen. Dies gilt nur für die Vektorindextypen quantizedFlat und diskANN.
type	VectorIndexType		Der Indextyp des Vektors. Derzeit werden flat, diskANN und quantizedFlat unterstützt.
vectorIndexShardKey	string[]		Array von Shard-Schlüsseln für den Vektorindex. Dies gilt nur für die Vektorindextypen quantizedFlat und diskANN.

VectorIndexType

Enumeration

Der Indextyp des Vektors. Derzeit werden flat, diskANN und quantizedFlat unterstützt.

Wert	Beschreibung
flat
diskANN
quantizedFlat

Freigeben über

Restorable Sql Containers - List

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

CosmosDBRestorableSqlContainerList

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ClientEncryptionIncludedPath

ClientEncryptionPolicy

CloudError

CompositePath

CompositePathSortOrder

ComputedProperty

ConflictResolutionMode

ConflictResolutionPolicy

Container

ContainerPartitionKey

CreateMode

DataType

DistanceFunction

ErrorResponse

ExcludedPath

FullTextIndexPath

FullTextPath

FullTextPolicy

IncludedPath

Indexes

IndexingMode

IndexingPolicy

IndexKind

OperationType

PartitionKind

Resource

ResourceRestoreParameters

RestorableSqlContainerGetResult

RestorableSqlContainersListResult

SpatialSpec

SpatialType

UniqueKey

UniqueKeyPolicy

VectorDataType

VectorEmbedding

VectorEmbeddingPolicy

VectorIndex

VectorIndexType