Restorable Sql Containers - List

Referentie

Service:: Cosmos DB Resource Provider

API-versie:: 2024-11-15

Geef de gebeurtenisfeed weer van alle mutaties die zijn uitgevoerd op alle Azure Cosmos DB SQL-containers onder een specifieke database. Dit helpt bij het scenario waarin de container per ongeluk is verwijderd. Voor deze API is de machtiging Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read vereist

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

Met optionele parameters:

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

Name	In	Vereist	Type	Description
instanceId	path	True	string	De instanceId-GUID van een restorable databaseaccount.
location	path	True	string	Cosmos DB-regio, met spaties tussen woorden en elk woord met hoofdletters.
subscriptionId	path	True	string minLength: 1	De id van het doelabonnement.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.
endTime	query		string	Restorable Sql Containers event feed end time.
restorableSqlDatabaseRid	query		string	De resource-id van de SQL-database.
startTime	query		string	Begintijd van de gebeurtenisfeed voor restorable Sql-containers.

Antwoorden

Name	Type	Description
200 OK	RestorableSqlContainersListResult	De bewerking is voltooid.
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

CosmosDBRestorableSqlContainerList

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
ClientEncryptionIncludedPath	.
ClientEncryptionPolicy	Cosmos DB-clientversleutelingsbeleid.
CloudError	Een foutreactie van de service.
CompositePath
CompositePathSortOrder	Sorteervolgorde voor samengestelde paden.
ComputedProperty	De definitie van een berekende eigenschap
ConflictResolutionMode	Geeft de conflictoplossingsmodus aan.
ConflictResolutionPolicy	Het conflictoplossingsbeleid voor de container.
Container	Cosmos DB SQL-containerresourceobject
ContainerPartitionKey	De configuratie van de partitiesleutel die moet worden gebruikt voor het partitioneren van gegevens in meerdere partities
CreateMode	Opsomming om de modus voor het maken van accounts aan te geven.
DataType	Het gegevenstype waarop het indexeringsgedrag wordt toegepast.
DistanceFunction	De afstandsfunctie die moet worden gebruikt voor de berekening van de afstand tussen vectoren.
ErrorResponse	Foutreactie.
ExcludedPath
IncludedPath	De paden die zijn opgenomen in indexering
Indexes	De indexen voor het pad.
IndexingMode	Geeft de indexeringsmodus aan.
IndexingPolicy	Indexeringsbeleid van Cosmos DB
IndexKind	Geeft het type index aan.
OperationType	Opsomming om het bewerkingstype van de gebeurtenis aan te geven.
PartitionKind	Geeft het type algoritme aan dat wordt gebruikt voor partitionering. Voor MultiHash worden meerdere partitiesleutels (maximaal drie maximum) ondersteund voor het maken van containers
Resource	De resource van een Azure Cosmos DB SQL-container gebeurtenis
ResourceRestoreParameters	Parameters om de informatie over de herstelbewerking aan te geven.
RestorableSqlContainerGetResult	Een Azure Cosmos DB SQL-container gebeurtenis
RestorableSqlContainersListResult	Het antwoord van de lijstbewerking, die de SQL-container gebeurtenissen en de bijbehorende eigenschappen bevat.
SpatialSpec
SpatialType	Geeft het ruimtelijke type index aan.
UniqueKey	De unieke sleutel voor die beperking voor uniekheid afdwingt voor documenten in de verzameling in de Azure Cosmos DB-service.
UniqueKeyPolicy	De configuratie van het unieke sleutelbeleid voor het opgeven van beperkingen voor uniekheid voor documenten in de verzameling in de Azure Cosmos DB-service.
VectorDataType	Geeft het gegevenstype van vector aan.
VectorEmbedding	Vertegenwoordigt een vector insluiten. Een vector insluiten wordt gebruikt om een vectorveld in de documenten te definiëren.
VectorEmbeddingPolicy	Cosmos DB Vector Embedding-beleid
VectorIndex
VectorIndexType	Het indextype van de vector. Momenteel worden flat, diskANN en quantizedFlat ondersteund.

ClientEncryptionIncludedPath

Object

Name	Type	Description
clientEncryptionKeyId	string	De id van de clientversleutelingssleutel die moet worden gebruikt om het pad te versleutelen.
encryptionAlgorithm	string	Het versleutelingsalgoritmen dat wordt gebruikt. Bijvoorbeeld- AEAD_AES_256_CBC_HMAC_SHA256.
encryptionType	string	Het type versleuteling dat moet worden uitgevoerd. Bijvoorbeeld: deterministisch, gerandomiseerd.
path	string	Pad dat moet worden versleuteld.

ClientEncryptionPolicy

Object

Cosmos DB-clientversleutelingsbeleid.

Name	Type	Description
includedPaths	ClientEncryptionIncludedPath[]	Paden van het item dat versleuteling nodig heeft, samen met padspecifieke instellingen.
policyFormatVersion	integer (int32) minimum: 1 maximum: 2	Versie van de definitie van het clientversleutelingsbeleid. Ondersteunde versies zijn 1 en 2. Versie 2 ondersteunt versleuteling van id- en partitiesleutelpaden.

CloudError

Object

Een foutreactie van de service.

Name	Type	Description
error	ErrorResponse	Foutreactie.

CompositePath

Object

Name	Type	Description
order	CompositePathSortOrder	Sorteervolgorde voor samengestelde paden.
path	string	Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met jokertekens (/pad/*)

CompositePathSortOrder

Inventarisatie

Sorteervolgorde voor samengestelde paden.

Waarde	Description
ascending
descending

ComputedProperty

Object

De definitie van een berekende eigenschap

Name	Type	Description
name	string	De naam van een berekende eigenschap, bijvoorbeeld 'cp_lowerName'
query	string	De query waarmee de waarde voor de berekende eigenschap wordt geëvalueerd, bijvoorbeeld 'SELECT VALUE LOWER(c.name) FROM c'

ConflictResolutionMode

Inventarisatie

Geeft de conflictoplossingsmodus aan.

Waarde	Description
Custom
LastWriterWins

ConflictResolutionPolicy

Object

Het conflictoplossingsbeleid voor de container.

Name	Type	Default value	Description
conflictResolutionPath	string		Het pad naar conflictoplossing in het geval van de LastWriterWins-modus.
conflictResolutionProcedure	string		De procedure voor het oplossen van conflicten in het geval van aangepaste modus.
mode	ConflictResolutionMode	LastWriterWins	Geeft de conflictoplossingsmodus aan.

Container

Object

Cosmos DB SQL-containerresourceobject

Name	Type	Default value	Description
_etag	string		Een door het systeem gegenereerde eigenschap die de resource-etag vertegenwoordigt die is vereist voor optimistisch gelijktijdigheidsbeheer.
_rid	string		Een door het systeem gegenereerde eigenschap. Een unieke id.
_self	string		Een door het systeem gegenereerde eigenschap die het adresseerbare pad van de containerresource aangeeft.
_ts	number		Een door het systeem gegenereerde eigenschap die de laatst bijgewerkte tijdstempel van de resource aangeeft.
analyticalStorageTtl	integer (int64)		Analytische TTL.
clientEncryptionPolicy	ClientEncryptionPolicy		Het clientversleutelingsbeleid voor de container.
computedProperties	ComputedProperty[]		Lijst met berekende eigenschappen
conflictResolutionPolicy	ConflictResolutionPolicy		Het conflictoplossingsbeleid voor de container.
createMode	CreateMode	Default	Opsomming om de modus voor het maken van resources aan te geven.
defaultTtl	integer		Standaardtijd tot leven
id	string		Naam van de Cosmos DB SQL-container
indexingPolicy	IndexingPolicy		De configuratie van het indexeringsbeleid. De indexering is standaard automatisch voor alle documentpaden in de container
partitionKey	ContainerPartitionKey		De configuratie van de partitiesleutel die moet worden gebruikt voor het partitioneren van gegevens in meerdere partities
restoreParameters	ResourceRestoreParameters		Parameters om de informatie over de herstelbewerking aan te geven
uniqueKeyPolicy	UniqueKeyPolicy		De configuratie van het unieke sleutelbeleid voor het opgeven van beperkingen voor uniekheid voor documenten in de verzameling in de Azure Cosmos DB-service.
vectorEmbeddingPolicy	VectorEmbeddingPolicy		Het beleid voor het insluiten van vectoren voor de container.

ContainerPartitionKey

Object

De configuratie van de partitiesleutel die moet worden gebruikt voor het partitioneren van gegevens in meerdere partities

Name	Type	Default value	Description
kind	PartitionKind	Hash	Geeft het type algoritme aan dat wordt gebruikt voor partitionering. Voor MultiHash worden meerdere partitiesleutels (maximaal drie maximum) ondersteund voor het maken van containers
paths	string[]		Lijst met paden waarmee gegevens in de container kunnen worden gepartitioneerd
systemKey	boolean		Geeft aan of de container een door het systeem gegenereerde partitiesleutel gebruikt
version	integer (int32) minimum: 1 maximum: 2		Geeft de versie van de definitie van de partitiesleutel aan

CreateMode

Inventarisatie

Opsomming om de modus voor het maken van accounts aan te geven.

Waarde	Description
Default
Restore

DataType

Inventarisatie

Het gegevenstype waarop het indexeringsgedrag wordt toegepast.

Waarde	Description
LineString
MultiPolygon
Number
Point
Polygon
String

DistanceFunction

Inventarisatie

De afstandsfunctie die moet worden gebruikt voor de berekening van de afstand tussen vectoren.

Waarde	Description
cosine
dotproduct
euclidean

ErrorResponse

Object

Foutreactie.

Name	Type	Description
code	string	Foutcode.
message	string	Foutbericht dat aangeeft waarom de bewerking is mislukt.

ExcludedPath

Object

Name	Type	Description
path	string	Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met jokertekens (/pad/*)

IncludedPath

Object

De paden die zijn opgenomen in indexering

Name	Type	Description
indexes	Indexes[]	Lijst met indexen voor dit pad
path	string	Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met jokertekens (/pad/*)

Indexes

Object

De indexen voor het pad.

Name	Type	Default value	Description
dataType	DataType	String	Het gegevenstype waarop het indexeringsgedrag wordt toegepast.
kind	IndexKind	Hash	Geeft het type index aan.
precision	integer		De precisie van de index. -1 is maximale precisie.

IndexingMode

Inventarisatie

Geeft de indexeringsmodus aan.

Waarde	Description
consistent
lazy
none

IndexingPolicy

Object

Indexeringsbeleid van Cosmos DB

Name	Type	Default value	Description
automatic	boolean		Geeft aan of het indexeringsbeleid automatisch is
compositeIndexes	CompositePath[]		Lijst met samengestelde padlijst
excludedPaths	ExcludedPath[]		Lijst met paden die moeten worden uitgesloten van indexering
includedPaths	IncludedPath[]		Lijst met paden die moeten worden opgenomen in de indexering
indexingMode	IndexingMode	consistent	Geeft de indexeringsmodus aan.
spatialIndexes	SpatialSpec[]		Lijst met ruimtelijke gegevens
vectorIndexes	VectorIndex[]		Lijst met paden die moeten worden opgenomen in de vectorindexering

IndexKind

Inventarisatie

Geeft het type index aan.

Waarde	Description
Hash
Range
Spatial

OperationType

Inventarisatie

Opsomming om het bewerkingstype van de gebeurtenis aan te geven.

Waarde	Description
Create
Delete
Recreate
Replace
SystemOperation

PartitionKind

Inventarisatie

Geeft het type algoritme aan dat wordt gebruikt voor partitionering. Voor MultiHash worden meerdere partitiesleutels (maximaal drie maximum) ondersteund voor het maken van containers

Waarde	Description
Hash
MultiHash
Range

Resource

Object

De resource van een Azure Cosmos DB SQL-container gebeurtenis

Name	Type	Description
_rid	string	Een door het systeem gegenereerde eigenschap. Een unieke id.
canUndelete	string	Een status van deze container om te bepalen of deze container in hetzelfde account kan worden geplaatst.
canUndeleteReason	string	De reden waarom deze container niet kan worden hersteld in hetzelfde account.
container	Container	Cosmos DB SQL-containerresourceobject
eventTimestamp	string	De gebeurtenis toen deze container is opgetreden.
operationType	OperationType	Het bewerkingstype van deze container gebeurtenis.
ownerId	string	De naam van deze SQL-container.
ownerResourceId	string	De resource-id van deze SQL-container.

ResourceRestoreParameters

Object

Parameters om de informatie over de herstelbewerking aan te geven.

Name	Type	Description
restoreSource	string	De id van het herstelbare databaseaccount van waaruit het herstel moet worden gestart. Bijvoorbeeld: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string (date-time)	Tijd waarop het account moet worden hersteld (ISO-8601-indeling).
restoreWithTtlDisabled	boolean	Hiermee geeft u op of het herstelde account tijd-To-Live uitgeschakeld bij het herstellen.

RestorableSqlContainerGetResult

Object

Een Azure Cosmos DB SQL-container gebeurtenis

Name	Type	Description
id	string	De unieke resource-id van de ARM-resource.
name	string	De naam van de ARM-resource.
properties.resource	Resource	De resource van een Azure Cosmos DB SQL-container gebeurtenis
type	string	Het type Azure-resource.

RestorableSqlContainersListResult

Object

Het antwoord van de lijstbewerking, die de SQL-container gebeurtenissen en de bijbehorende eigenschappen bevat.

Name	Type	Description
value	RestorableSqlContainerGetResult[]	Lijst met SQL-containerevenementen en de bijbehorende eigenschappen.

SpatialSpec

Object

Name	Type	Description
path	string	Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met jokertekens (/pad/*)
types	SpatialType[]	Lijst met het ruimtelijke type pad

SpatialType

Inventarisatie

Geeft het ruimtelijke type index aan.

Waarde	Description
LineString
MultiPolygon
Point
Polygon

UniqueKey

Object

De unieke sleutel voor die beperking voor uniekheid afdwingt voor documenten in de verzameling in de Azure Cosmos DB-service.

Name	Type	Description
paths	string[]	Lijst met paden moet uniek zijn voor elk document in de Azure Cosmos DB-service

UniqueKeyPolicy

Object

De configuratie van het unieke sleutelbeleid voor het opgeven van beperkingen voor uniekheid voor documenten in de verzameling in de Azure Cosmos DB-service.

Name	Type	Description
uniqueKeys	UniqueKey[]	Lijst met unieke sleutels waarmee een beperking voor uniekheid wordt afgedwongen voor documenten in de verzameling in de Azure Cosmos DB-service.

VectorDataType

Inventarisatie

Geeft het gegevenstype van vector aan.

Waarde	Description
float32
int8
uint8

VectorEmbedding

Object

Vertegenwoordigt een vector insluiten. Een vector insluiten wordt gebruikt om een vectorveld in de documenten te definiëren.

Name	Type	Description
dataType	VectorDataType	Geeft het gegevenstype van vector aan.
dimensions	integer (int32)	Het aantal dimensies in de vector.
distanceFunction	DistanceFunction	De afstandsfunctie die moet worden gebruikt voor de berekening van de afstand tussen vectoren.
path	string	Het pad naar het vectorveld in het document.

VectorEmbeddingPolicy

Object

Cosmos DB Vector Embedding-beleid

Name	Type	Description
vectorEmbeddings	VectorEmbedding[]	Lijst met vector insluitingen

VectorIndex

Object

Name	Type	Description
path	string	Het pad naar het vectorveld in het document.
type	VectorIndexType	Het indextype van de vector. Momenteel worden flat, diskANN en quantizedFlat ondersteund.

VectorIndexType

Inventarisatie

Het indextype van de vector. Momenteel worden flat, diskANN en quantizedFlat ondersteund.

Waarde	Description
diskANN
flat
quantizedFlat

Delen via

Restorable Sql Containers - List

URI-parameters

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

CosmosDBRestorableSqlContainerList

Voorbeeldaanvraag

Voorbeeldrespons

Definities

ClientEncryptionIncludedPath

ClientEncryptionPolicy

CloudError

CompositePath

CompositePathSortOrder

ComputedProperty

ConflictResolutionMode

ConflictResolutionPolicy

Container

ContainerPartitionKey

CreateMode

DataType

DistanceFunction

ErrorResponse

ExcludedPath

IncludedPath

Indexes

IndexingMode

IndexingPolicy

IndexKind

OperationType

PartitionKind

Resource

ResourceRestoreParameters

RestorableSqlContainerGetResult

RestorableSqlContainersListResult

SpatialSpec

SpatialType

UniqueKey

UniqueKeyPolicy

VectorDataType

VectorEmbedding

VectorEmbeddingPolicy

VectorIndex

VectorIndexType

Aanvullende resources