Restorable Sql Containers - List

Référence

Service:: Cosmos DB Resource Provider

Version d'API:: 2024-11-15

Affichez le flux d’événements de toutes les mutations effectuées sur tous les conteneurs SQL Azure Cosmos DB sous une base de données spécifique. Cela permet de scénario où le conteneur a été supprimé accidentellement. Cette API nécessite l’autorisation « Microsoft.DocumentDB/locations/restorableDatabaseAccounts/.../read »

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

Avec des paramètres facultatifs:

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}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
instanceId	path	True	string	GUID instanceId d’un compte de base de données restaurable.
location	path	True	string	Région Cosmos DB, avec des espaces entre les mots et chaque mot en majuscules.
subscriptionId	path	True	string	ID de l’abonnement cible.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.
endTime	query		string	Heure de fin du flux d’événements des conteneurs Sql restaurables.
restorableSqlDatabaseRid	query		string	ID de ressource de la base de données SQL.
startTime	query		string	Heure de début du flux d’événements des conteneurs Sql restaurables.

Réponses

Nom	Type	Description
200 OK	RestorableSqlContainersListResult	L’opération s’est terminée avec succès.
Other Status Codes	CloudError	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

CosmosDBRestorableSqlContainerList

Exemple de requête

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

Exemple de réponse

Code d’état:: 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\""
          }
        }
      }
    }
  ]
}

Définitions

Nom	Description
ClientEncryptionIncludedPath	.
ClientEncryptionPolicy	Stratégie de chiffrement du client Cosmos DB.
CloudError	Réponse d’erreur du service.
CompositePath
CompositePathSortOrder	Ordre de tri pour les chemins composites.
ComputedProperty	Définition d’une propriété calculée
ConflictResolutionMode	Indique le mode de résolution de conflit.
ConflictResolutionPolicy	Stratégie de résolution des conflits pour le conteneur.
Container	Objet de ressource de conteneur Cosmos DB SQL
ContainerPartitionKey	Configuration de la clé de partition à utiliser pour partitionner des données dans plusieurs partitions
CreateMode	Énumération pour indiquer le mode de création de compte.
DataType	Type de données auquel le comportement d’indexation est appliqué.
DistanceFunction	Fonction de distance à utiliser pour le calcul de distance entre les vecteurs.
ErrorResponse	Réponse d’erreur.
ExcludedPath
IncludedPath	Chemins d’accès inclus dans l’indexation
Indexes	Index du chemin d’accès.
IndexingMode	Indique le mode d’indexation.
IndexingPolicy	Stratégie d’indexation Cosmos DB
IndexKind	Indique le type d’index.
OperationType	Énumération pour indiquer le type d’opération de l’événement.
PartitionKind	Indique le type d’algorithme utilisé pour le partitionnement. Pour MultiHash, plusieurs clés de partition (jusqu’à trois maximum) sont prises en charge pour la création de conteneur
Resource	Ressource d’un événement de conteneur SQL Azure Cosmos DB
ResourceRestoreParameters	Paramètres pour indiquer les informations relatives à la restauration.
RestorableSqlContainerGetResult	Événement de conteneur SQL Azure Cosmos DB
RestorableSqlContainersListResult	Réponse de l’opération De liste qui contient les événements de conteneur SQL et leurs propriétés.
SpatialSpec
SpatialType	Indique le type spatial d’index.
UniqueKey	Clé unique sur laquelle applique la contrainte d’unicité sur les documents de la collection dans le service Azure Cosmos DB.
UniqueKeyPolicy	Configuration de la stratégie de clé unique pour spécifier des contraintes d’unicité sur les documents de la collection dans le service Azure Cosmos DB.
VectorDataType	Indique le type de données du vecteur.
VectorEmbedding	Représente un incorporation vectorielle. Une incorporation de vecteurs est utilisée pour définir un champ vectoriel dans les documents.
VectorEmbeddingPolicy	Stratégie d’incorporation de vecteur Cosmos DB
VectorIndex
VectorIndexType	Type d’index du vecteur. Actuellement, flat, diskANN et quantizedFlat sont pris en charge.

ClientEncryptionIncludedPath

Nom	Type	Description
clientEncryptionKeyId	string	Identificateur de la clé de chiffrement du client à utiliser pour chiffrer le chemin d’accès.
encryptionAlgorithm	string	Algorithme de chiffrement qui sera utilisé. Par exemple , AEAD_AES_256_CBC_HMAC_SHA256.
encryptionType	string	Type de chiffrement à effectuer. Par exemple : déterministe, aléatoire.
path	string	Chemin d’accès qui doit être chiffré.

ClientEncryptionPolicy

Stratégie de chiffrement du client Cosmos DB.

Nom	Type	Description
includedPaths	ClientEncryptionIncludedPath[]	Chemins d’accès de l’élément qui ont besoin d’un chiffrement avec des paramètres spécifiques au chemin d’accès.
policyFormatVersion	integer	Version de la définition de stratégie de chiffrement du client. Les versions prises en charge sont 1 et 2. La version 2 prend en charge le chiffrement d’ID et de clé de partition.

CloudError

Réponse d’erreur du service.

Nom	Type	Description
error	ErrorResponse	Réponse d’erreur.

CompositePath

Nom	Type	Description
order	CompositePathSortOrder	Ordre de tri pour les chemins composites.
path	string	Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et la fin avec le caractère générique (/path/*)

CompositePathSortOrder

Ordre de tri pour les chemins composites.

Nom	Type	Description
ascending	string
descending	string

ComputedProperty

Définition d’une propriété calculée

Nom	Type	Description
name	string	Nom d’une propriété calculée, par exemple : « cp_lowerName »
query	string	Requête qui évalue la valeur de la propriété calculée, par exemple : « SELECT VALUE LOWER(c.name) FROM c »

ConflictResolutionMode

Indique le mode de résolution de conflit.

Nom	Type	Description
Custom	string
LastWriterWins	string

ConflictResolutionPolicy

Stratégie de résolution des conflits pour le conteneur.

Nom	Type	Valeur par défaut	Description
conflictResolutionPath	string		Chemin de résolution de conflit dans le cas du mode LastWriterWins.
conflictResolutionProcedure	string		Procédure de résolution des conflits en cas de mode personnalisé.
mode	ConflictResolutionMode	LastWriterWins	Indique le mode de résolution de conflit.

Container

Objet de ressource de conteneur Cosmos DB SQL

Nom	Type	Valeur par défaut	Description
_etag	string		Propriété générée par le système représentant l’etag de ressource requise pour le contrôle d’accès concurrentiel optimiste.
_rid	string		Propriété générée par le système. Identificateur unique.
_self	string		Propriété générée par le système qui spécifie le chemin d’accès adressable de la ressource de conteneur.
_ts	number		Propriété générée par le système qui désigne le dernier horodatage mis à jour de la ressource.
analyticalStorageTtl	integer		Durée de vie analytique.
clientEncryptionPolicy	ClientEncryptionPolicy		Stratégie de chiffrement du client pour le conteneur.
computedProperties	ComputedProperty[]		Liste des propriétés calculées
conflictResolutionPolicy	ConflictResolutionPolicy		Stratégie de résolution des conflits pour le conteneur.
createMode	CreateMode	Default	Énumération pour indiquer le mode de création de ressources.
defaultTtl	integer		Durée de vie par défaut
id	string		Nom du conteneur SQL Cosmos DB
indexingPolicy	IndexingPolicy		Configuration de la stratégie d’indexation. Par défaut, l’indexation est automatique pour tous les chemins d’accès au document dans le conteneur
partitionKey	ContainerPartitionKey		Configuration de la clé de partition à utiliser pour partitionner des données dans plusieurs partitions
restoreParameters	ResourceRestoreParameters		Paramètres pour indiquer les informations relatives à la restauration
uniqueKeyPolicy	UniqueKeyPolicy		Configuration de la stratégie de clé unique pour spécifier des contraintes d’unicité sur les documents de la collection dans le service Azure Cosmos DB.
vectorEmbeddingPolicy	VectorEmbeddingPolicy		Stratégie d’incorporation de vecteur pour le conteneur.

ContainerPartitionKey

Configuration de la clé de partition à utiliser pour partitionner des données dans plusieurs partitions

Nom	Type	Valeur par défaut	Description
kind	PartitionKind	Hash	Indique le type d’algorithme utilisé pour le partitionnement. Pour MultiHash, plusieurs clés de partition (jusqu’à trois maximum) sont prises en charge pour la création de conteneur
paths	string[]		Liste des chemins d’accès à l’aide desquels les données du conteneur peuvent être partitionnés
systemKey	boolean		Indique si le conteneur utilise une clé de partition générée par le système
version	integer		Indique la version de la définition de clé de partition

CreateMode

Énumération pour indiquer le mode de création de compte.

Nom	Type	Description
Default	string
Restore	string

DataType

Type de données auquel le comportement d’indexation est appliqué.

Nom	Type	Description
LineString	string
MultiPolygon	string
Number	string
Point	string
Polygon	string
String	string

DistanceFunction

Fonction de distance à utiliser pour le calcul de distance entre les vecteurs.

Nom	Type	Description
cosine	string
dotproduct	string
euclidean	string

ErrorResponse

Réponse d’erreur.

Nom	Type	Description
code	string	Code d’erreur.
message	string	Message d’erreur indiquant pourquoi l’opération a échoué.

ExcludedPath

Nom	Type	Description
path	string	Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et la fin avec le caractère générique (/path/*)

IncludedPath

Chemins d’accès inclus dans l’indexation

Nom	Type	Description
indexes	Indexes[]	Liste des index pour ce chemin d’accès
path	string	Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et la fin avec le caractère générique (/path/*)

Indexes

Index du chemin d’accès.

Nom	Type	Valeur par défaut	Description
dataType	DataType	String	Type de données auquel le comportement d’indexation est appliqué.
kind	IndexKind	Hash	Indique le type d’index.
precision	integer		Précision de l’index. -1 est une précision maximale.

IndexingMode

Indique le mode d’indexation.

Nom	Type	Description
consistent	string
lazy	string
none	string

IndexingPolicy

Stratégie d’indexation Cosmos DB

Nom	Type	Valeur par défaut	Description
automatic	boolean		Indique si la stratégie d’indexation est automatique
compositeIndexes	CompositePath[]		Liste des chemins composites
excludedPaths	ExcludedPath[]		Liste des chemins d’accès à exclure de l’indexation
includedPaths	IncludedPath[]		Liste des chemins à inclure dans l’indexation
indexingMode	IndexingMode	consistent	Indique le mode d’indexation.
spatialIndexes	SpatialSpec[]		Liste des spécificités spatiales
vectorIndexes	VectorIndex[]		Liste des chemins à inclure dans l’indexation vectorielle

IndexKind

Indique le type d’index.

Nom	Type	Description
Hash	string
Range	string
Spatial	string

OperationType

Énumération pour indiquer le type d’opération de l’événement.

Nom	Type	Description
Create	string
Delete	string
Recreate	string
Replace	string
SystemOperation	string

PartitionKind

Indique le type d’algorithme utilisé pour le partitionnement. Pour MultiHash, plusieurs clés de partition (jusqu’à trois maximum) sont prises en charge pour la création de conteneur

Nom	Type	Description
Hash	string
MultiHash	string
Range	string

Resource

Ressource d’un événement de conteneur SQL Azure Cosmos DB

Nom	Type	Description
_rid	string	Propriété générée par le système. Identificateur unique.
canUndelete	string	État de ce conteneur à identifier si ce conteneur peut être restauré dans le même compte.
canUndeleteReason	string	La raison pour laquelle ce conteneur ne peut pas être restauré dans le même compte.
container	Container	Objet de ressource de conteneur Cosmos DB SQL
eventTimestamp	string	Lorsque cet événement de conteneur s’est produit.
operationType	OperationType	Type d’opération de cet événement de conteneur.
ownerId	string	Nom de ce conteneur SQL.
ownerResourceId	string	ID de ressource de ce conteneur SQL.

ResourceRestoreParameters

Paramètres pour indiquer les informations relatives à la restauration.

Nom	Type	Description
restoreSource	string	ID du compte de base de données pouvant être restauré à partir duquel la restauration doit être lancée. Par exemple : /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccounts}}
restoreTimestampInUtc	string	Heure à laquelle le compte doit être restauré (format ISO-8601).
restoreWithTtlDisabled	boolean	Spécifie si le compte restauré aura le délai d'To-Live désactivé lors de la restauration réussie.

RestorableSqlContainerGetResult

Événement de conteneur SQL Azure Cosmos DB

Nom	Type	Description
id	string	Identificateur de ressource unique de la ressource ARM.
name	string	Nom de la ressource ARM.
properties.resource	Resource	Ressource d’un événement de conteneur SQL Azure Cosmos DB
type	string	Type de ressource Azure.

RestorableSqlContainersListResult

Réponse de l’opération De liste qui contient les événements de conteneur SQL et leurs propriétés.

Nom	Type	Description
value	RestorableSqlContainerGetResult[]	Liste des événements de conteneur SQL et de leurs propriétés.

SpatialSpec

Nom	Type	Description
path	string	Chemin d’accès auquel le comportement d’indexation s’applique. Les chemins d’index commencent généralement par la racine et la fin avec le caractère générique (/path/*)
types	SpatialType[]	Liste du type spatial du chemin d’accès

SpatialType

Indique le type spatial d’index.

Nom	Type	Description
LineString	string
MultiPolygon	string
Point	string
Polygon	string

UniqueKey

Clé unique sur laquelle applique la contrainte d’unicité sur les documents de la collection dans le service Azure Cosmos DB.

Nom	Type	Description
paths	string[]	La liste des chemins d’accès doit être unique pour chaque document du service Azure Cosmos DB

UniqueKeyPolicy

Configuration de la stratégie de clé unique pour spécifier des contraintes d’unicité sur les documents de la collection dans le service Azure Cosmos DB.

Nom	Type	Description
uniqueKeys	UniqueKey[]	Liste des clés uniques sur laquelle applique la contrainte d’unicité sur les documents de la collection dans le service Azure Cosmos DB.

VectorDataType

Indique le type de données du vecteur.

Nom	Type	Description
float32	string
int8	string
uint8	string

VectorEmbedding

Représente un incorporation vectorielle. Une incorporation de vecteurs est utilisée pour définir un champ vectoriel dans les documents.

Nom	Type	Description
dataType	VectorDataType	Indique le type de données du vecteur.
dimensions	integer	Nombre de dimensions dans le vecteur.
distanceFunction	DistanceFunction	Fonction de distance à utiliser pour le calcul de distance entre les vecteurs.
path	string	Chemin d’accès au champ vectoriel dans le document.

VectorEmbeddingPolicy

Stratégie d’incorporation de vecteur Cosmos DB

Nom	Type	Description
vectorEmbeddings	VectorEmbedding[]	Liste des incorporations de vecteurs

VectorIndex

Nom	Type	Description
path	string	Chemin d’accès au champ vectoriel dans le document.
type	VectorIndexType	Type d’index du vecteur. Actuellement, flat, diskANN et quantizedFlat sont pris en charge.

VectorIndexType

Type d’index du vecteur. Actuellement, flat, diskANN et quantizedFlat sont pris en charge.

Nom	Type	Description
diskANN	string
flat	string
quantizedFlat	string

Partager via

Restorable Sql Containers - List

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

CosmosDBRestorableSqlContainerList

Exemple de requête

Exemple de réponse

Définitions

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

Ressources supplémentaires