Restorable Sql Containers - List

Referenz

Dienst:: Cosmos DB Resource Provider

API-Version:: 2024-11-15

Zeigen Sie den Ereignisfeed aller Mutationen an, die für alle Azure Cosmos DB SQL-Container unter einer bestimmten Datenbank ausgeführt wurden. Dies hilft 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=2024-11-15

Mit optionalen Parametern:

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}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
instanceId	path	True	string	Die instanceId-GUID eines wiederhergestellten Datenbankkontos.
location	path	True	string	Cosmos DB-Region mit Leerzeichen zwischen Wörtern und jedem Wort mit Großbuchstaben.
subscriptionId	path	True	string	Die ID des Zielabonnements.
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.
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=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

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
IncludedPath	Die Pfade, die in der Indizierung enthalten sind
Indexes	Die Indizes für den Pfad.
IndexingMode	Gibt den Indizierungsmodus an.
IndexingPolicy	Cosmos DB-Indizierungsrichtlinie
IndexKind	Gibt den Indextyp an.
OperationType	Aufzählung, 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-Containerereignis
RestorableSqlContainersListResult	Die Listenvorgangsantwort, die die SQL-Containerereignisse und deren Eigenschaften enthält.
SpatialSpec
SpatialType	Gibt den räumlichen Indextyp an.
UniqueKey	Der eindeutige Schlüssel für die Erzwingung der Eindeutigkeitseinschränkung für Dokumente in der Sammlung im Azure Cosmos DB-Dienst.
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	Cosmos DB Vector Embedding Policy
VectorIndex
VectorIndexType	Der Indextyp des Vektors. Derzeit werden flat, diskANN und quantizedFlat unterstützt.

ClientEncryptionIncludedPath

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. Eg - 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

Cosmos DB-Clientverschlüsselungsrichtlinie.

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

CloudError

Eine Fehlerantwort des Diensts.

Name	Typ	Beschreibung
error	ErrorResponse	Fehlerantwort.

CompositePath

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

Sortierreihenfolge für zusammengesetzte Pfade.

Name	Typ	Beschreibung
ascending	string
descending	string

ComputedProperty

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

Gibt den Konfliktauflösungsmodus an.

Name	Typ	Beschreibung
Custom	string
LastWriterWins	string

ConflictResolutionPolicy

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

Cosmos DB SQL-Containerressourcenobjekt

Name	Typ	Standardwert	Beschreibung
_etag	string		Eine vom System generierte Eigenschaft, die das Ressourcen-Etag darstellt, das für ein optimistisches Parallelitätssteuerelement erforderlich ist.
_rid	string		Eine vom System generierte Eigenschaft. Ein eindeutiger Bezeichner.
_self	string		Eine vom System generierte Eigenschaft, die den adressierbaren Pfad der Containerressource angibt.
_ts	number		Eine vom System generierte Eigenschaft, die den letzten aktualisierten Zeitstempel der Ressource angibt.
analyticalStorageTtl	integer		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
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

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		Gibt die Version der Partitionsschlüsseldefinition an.

CreateMode

Aufzählung, um den Modus der Kontoerstellung anzugeben.

Name	Typ	Beschreibung
Default	string
Restore	string

DataType

Der Datentyp, auf den das Indizierungsverhalten angewendet wird.

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

DistanceFunction

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

Name	Typ	Beschreibung
cosine	string
dotproduct	string
euclidean	string

ErrorResponse

Fehlerantwort.

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

ExcludedPath

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/*)

IncludedPath

Die Pfade, die in der Indizierung enthalten sind

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

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

Gibt den Indizierungsmodus an.

Name	Typ	Beschreibung
consistent	string
lazy	string
none	string

IndexingPolicy

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

Gibt den Indextyp an.

Name	Typ	Beschreibung
Hash	string
Range	string
Spatial	string

OperationType

Aufzählung, um den Vorgangstyp des Ereignisses anzugeben.

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

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.

Name	Typ	Beschreibung
Hash	string
MultiHash	string
Range	string

Resource

Die Ressource eines Azure Cosmos DB SQL-Containerereignisses

Name	Typ	Beschreibung
_rid	string	Eine vom System generierte Eigenschaft. Ein eindeutiger Bezeichner.
canUndelete	string	Ein Status dieses Containers, der identifiziert, ob dieser Container in demselben Konto wiederhergestellt werden kann.
canUndeleteReason	string	Der Grund, warum dieser Container nicht in demselben Konto wiederhergestellt werden kann.
container	Container	Cosmos DB SQL-Containerressourcenobjekt
eventTimestamp	string	Der Zeitpunkt, an dem 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

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

Ein Azure Cosmos DB-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.