Restorable Sql Containers - List

Riferimento

Servizio:: Cosmos DB Resource Provider

Versione API:: 2024-11-15

Visualizzare il feed di eventi di tutte le mutazioni eseguite in tutti i contenitori SQL di Azure Cosmos DB in un database specifico. Ciò è utile nello scenario in cui il contenitore è stato eliminato accidentalmente. Questa API richiede l'autorizzazione '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

Con parametri facoltativi:

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}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
instanceId	path	True	string	GUID instanceId di un account di database ripristinabile.
location	path	True	string	Area di Cosmos DB, con spazi tra le parole e ogni parola maiuscola.
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
api-version	query	True	string	Versione dell'API da usare per questa operazione.
endTime	query		string	Ora di fine del feed di eventi dei contenitori Sql ripristinabili.
restorableSqlDatabaseRid	query		string	ID risorsa del database SQL.
startTime	query		string	Ora di inizio del feed di eventi dei contenitori Sql ripristinabili.

Risposte

Nome	Tipo	Descrizione
200 OK	RestorableSqlContainersListResult	Operazione completata correttamente.
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	Rappresentare l'account utente

Esempio

CosmosDBRestorableSqlContainerList

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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\""
          }
        }
      }
    }
  ]
}

Definizioni

Nome	Descrizione
ClientEncryptionIncludedPath	.
ClientEncryptionPolicy	Criteri di crittografia client di Cosmos DB.
CloudError	Risposta di errore dal servizio.
CompositePath
CompositePathSortOrder	Ordinamento per i percorsi compositi.
ComputedProperty	Definizione di una proprietà calcolata
ConflictResolutionMode	Indica la modalità di risoluzione dei conflitti.
ConflictResolutionPolicy	Criteri di risoluzione dei conflitti per il contenitore.
Container	Oggetto risorsa contenitore SQL di Cosmos DB
ContainerPartitionKey	Configurazione della chiave di partizione da usare per il partizionamento dei dati in più partizioni
CreateMode	Enumerazione per indicare la modalità di creazione dell'account.
DataType	Tipo di dati a cui viene applicato il comportamento di indicizzazione.
DistanceFunction	Funzione distance da usare per il calcolo della distanza tra vettori.
ErrorResponse	Risposta errore.
ExcludedPath
IncludedPath	Percorsi inclusi nell'indicizzazione
Indexes	Indici per il percorso.
IndexingMode	Indica la modalità di indicizzazione.
IndexingPolicy	Criteri di indicizzazione di Cosmos DB
IndexKind	Indica il tipo di indice.
OperationType	Enumerazione per indicare il tipo di operazione dell'evento.
PartitionKind	Indica il tipo di algoritmo utilizzato per il partizionamento. Per MultiHash sono supportate più chiavi di partizione (fino a tre massime) per la creazione di contenitori
Resource	Risorsa di un evento contenitore SQL di Azure Cosmos DB
ResourceRestoreParameters	Parametri per indicare le informazioni sul ripristino.
RestorableSqlContainerGetResult	Un evento del contenitore SQL di Azure Cosmos DB
RestorableSqlContainersListResult	Risposta dell'operazione List, che contiene gli eventi del contenitore SQL e le relative proprietà.
SpatialSpec
SpatialType	Indica il tipo spaziale di indice.
UniqueKey	Chiave univoca su che impone vincoli di univocità sui documenti nella raccolta nel servizio Azure Cosmos DB.
UniqueKeyPolicy	Configurazione dei criteri chiave univoca per specificare vincoli di univocità per i documenti nella raccolta nel servizio Azure Cosmos DB.
VectorDataType	Indica il tipo di dati del vettore.
VectorEmbedding	Rappresenta un incorporamento vettoriale. Per definire un campo vettoriale nei documenti viene usato un incorporamento vettoriale.
VectorEmbeddingPolicy	Criteri di incorporamento vettoriali di Cosmos DB
VectorIndex
VectorIndexType	Tipo di indice del vettore. Attualmente sono supportati flat, diskANN e quantiizedFlat.

ClientEncryptionIncludedPath

Nome	Tipo	Descrizione
clientEncryptionKeyId	string	Identificatore della chiave di crittografia client da usare per crittografare il percorso.
encryptionAlgorithm	string	Algoritmo di crittografia che verrà usato. Ad esempio, AEAD_AES_256_CBC_HMAC_SHA256.
encryptionType	string	Tipo di crittografia da eseguire. Ad esempio: deterministico, casuale.
path	string	Percorso che deve essere crittografato.

ClientEncryptionPolicy

Criteri di crittografia client di Cosmos DB.

Nome	Tipo	Descrizione
includedPaths	ClientEncryptionIncludedPath[]	Percorsi dell'elemento che richiedono la crittografia insieme alle impostazioni specifiche del percorso.
policyFormatVersion	integer	Versione della definizione dei criteri di crittografia client. Le versioni supportate sono 1 e 2. La versione 2 supporta la crittografia id e percorso della chiave di partizione.

CloudError

Risposta di errore dal servizio.

Nome	Tipo	Descrizione
error	ErrorResponse	Risposta errore.

CompositePath

Nome	Tipo	Descrizione
order	CompositePathSortOrder	Ordinamento per i percorsi compositi.
path	string	Percorso a cui si applica il comportamento di indicizzazione. I percorsi di indice iniziano in genere con radice e terminano con caratteri jolly (/path/*)

CompositePathSortOrder

Ordinamento per i percorsi compositi.

Nome	Tipo	Descrizione
ascending	string
descending	string

ComputedProperty

Definizione di una proprietà calcolata

Nome	Tipo	Descrizione
name	string	Nome di una proprietà calcolata, ad esempio " cp_lowerName"
query	string	Query che valuta il valore per la proprietà calcolata, ad esempio "SELECT VALUE LOWER(c.name) FROM c"

ConflictResolutionMode

Indica la modalità di risoluzione dei conflitti.

Nome	Tipo	Descrizione
Custom	string
LastWriterWins	string

ConflictResolutionPolicy

Criteri di risoluzione dei conflitti per il contenitore.

Nome	Tipo	Valore predefinito	Descrizione
conflictResolutionPath	string		Percorso di risoluzione dei conflitti nel caso della modalità LastWriterWins.
conflictResolutionProcedure	string		Procedura per risolvere i conflitti in caso di modalità personalizzata.
mode	ConflictResolutionMode	LastWriterWins	Indica la modalità di risoluzione dei conflitti.

Container

Oggetto risorsa contenitore SQL di Cosmos DB

Nome	Tipo	Valore predefinito	Descrizione
_etag	string		Proprietà generata dal sistema che rappresenta l'etag della risorsa necessaria per il controllo della concorrenza ottimistica.
_rid	string		Proprietà generata dal sistema. Identificatore univoco.
_self	string		Proprietà generata dal sistema che specifica il percorso indirizzabile della risorsa contenitore.
_ts	number		Proprietà generata dal sistema che indica il timestamp dell'ultimo aggiornamento della risorsa.
analyticalStorageTtl	integer		TTL analitico.
clientEncryptionPolicy	ClientEncryptionPolicy		Criteri di crittografia client per il contenitore.
computedProperties	ComputedProperty[]		Elenco delle proprietà calcolate
conflictResolutionPolicy	ConflictResolutionPolicy		Criteri di risoluzione dei conflitti per il contenitore.
createMode	CreateMode	Default	Enumerazione per indicare la modalità di creazione della risorsa.
defaultTtl	integer		Durata predefinita
id	string		Nome del contenitore SQL di Cosmos DB
indexingPolicy	IndexingPolicy		Configurazione dei criteri di indicizzazione. Per impostazione predefinita, l'indicizzazione è automatica per tutti i percorsi dei documenti all'interno del contenitore
partitionKey	ContainerPartitionKey		Configurazione della chiave di partizione da usare per il partizionamento dei dati in più partizioni
restoreParameters	ResourceRestoreParameters		Parametri per indicare le informazioni sul ripristino
uniqueKeyPolicy	UniqueKeyPolicy		Configurazione dei criteri chiave univoca per specificare vincoli di univocità per i documenti nella raccolta nel servizio Azure Cosmos DB.
vectorEmbeddingPolicy	VectorEmbeddingPolicy		Criterio di incorporamento vettoriale per il contenitore.

ContainerPartitionKey

Configurazione della chiave di partizione da usare per il partizionamento dei dati in più partizioni

Nome	Tipo	Valore predefinito	Descrizione
kind	PartitionKind	Hash	Indica il tipo di algoritmo utilizzato per il partizionamento. Per MultiHash sono supportate più chiavi di partizione (fino a tre massime) per la creazione di contenitori
paths	string[]		Elenco di percorsi che usano i dati all'interno del contenitore che possono essere partizionati
systemKey	boolean		Indica se il contenitore usa una chiave di partizione generata dal sistema
version	integer		Indica la versione della definizione della chiave di partizione

CreateMode

Enumerazione per indicare la modalità di creazione dell'account.

Nome	Tipo	Descrizione
Default	string
Restore	string

DataType

Tipo di dati a cui viene applicato il comportamento di indicizzazione.

Nome	Tipo	Descrizione
LineString	string
MultiPolygon	string
Number	string
Point	string
Polygon	string
String	string

DistanceFunction

Funzione distance da usare per il calcolo della distanza tra vettori.

Nome	Tipo	Descrizione
cosine	string
dotproduct	string
euclidean	string

ErrorResponse

Risposta errore.

Nome	Tipo	Descrizione
code	string	Codice di errore.
message	string	Messaggio di errore che indica il motivo per cui l'operazione non è riuscita.

ExcludedPath

Nome	Tipo	Descrizione
path	string	Percorso a cui si applica il comportamento di indicizzazione. I percorsi di indice iniziano in genere con radice e terminano con caratteri jolly (/path/*)

IncludedPath

Percorsi inclusi nell'indicizzazione

Nome	Tipo	Descrizione
indexes	Indexes[]	Elenco di indici per questo percorso
path	string	Percorso a cui si applica il comportamento di indicizzazione. I percorsi di indice iniziano in genere con radice e terminano con caratteri jolly (/path/*)

Indexes

Indici per il percorso.

Nome	Tipo	Valore predefinito	Descrizione
dataType	DataType	String	Tipo di dati a cui viene applicato il comportamento di indicizzazione.
kind	IndexKind	Hash	Indica il tipo di indice.
precision	integer		Precisione dell'indice. -1 è la precisione massima.

IndexingMode

Indica la modalità di indicizzazione.

Nome	Tipo	Descrizione
consistent	string
lazy	string
none	string

IndexingPolicy

Criteri di indicizzazione di Cosmos DB

Nome	Tipo	Valore predefinito	Descrizione
automatic	boolean		Indica se i criteri di indicizzazione sono automatici
compositeIndexes	CompositePath[]		Elenco di elenco di percorsi compositi
excludedPaths	ExcludedPath[]		Elenco di percorsi da escludere dall'indicizzazione
includedPaths	IncludedPath[]		Elenco di percorsi da includere nell'indicizzazione
indexingMode	IndexingMode	consistent	Indica la modalità di indicizzazione.
spatialIndexes	SpatialSpec[]		Elenco di specifiche spaziali
vectorIndexes	VectorIndex[]		Elenco di percorsi da includere nell'indicizzazione vettoriale

IndexKind

Indica il tipo di indice.

Nome	Tipo	Descrizione
Hash	string
Range	string
Spatial	string

OperationType

Enumerazione per indicare il tipo di operazione dell'evento.

Nome	Tipo	Descrizione
Create	string
Delete	string
Recreate	string
Replace	string
SystemOperation	string

PartitionKind

Indica il tipo di algoritmo utilizzato per il partizionamento. Per MultiHash sono supportate più chiavi di partizione (fino a tre massime) per la creazione di contenitori

Nome	Tipo	Descrizione
Hash	string
MultiHash	string
Range	string

Resource

Risorsa di un evento contenitore SQL di Azure Cosmos DB

Nome	Tipo	Descrizione
_rid	string	Proprietà generata dal sistema. Identificatore univoco.
canUndelete	string	Stato di questo contenitore per identificare se il contenitore è ripristinabile nello stesso account.
canUndeleteReason	string	Motivo per cui questo contenitore non può essere ripristinato nello stesso account.
container	Container	Oggetto risorsa contenitore SQL di Cosmos DB
eventTimestamp	string	Oggetto quando si è verificato l'evento del contenitore.
operationType	OperationType	Tipo di operazione di questo evento contenitore.
ownerId	string	Nome del contenitore SQL.
ownerResourceId	string	ID risorsa di questo contenitore SQL.

ResourceRestoreParameters

Parametri per indicare le informazioni sul ripristino.

Nome	Tipo	Descrizione
restoreSource	string	ID dell'account di database ripristinabile da cui deve essere avviato il ripristino. Ad esempio: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
restoreTimestampInUtc	string	Ora di ripristino dell'account (formato ISO-8601).
restoreWithTtlDisabled	boolean	Specifica se l'account ripristinato avrà time-To-Live disabilitato al termine del ripristino.

RestorableSqlContainerGetResult

Un evento del contenitore SQL di Azure Cosmos DB

Nome	Tipo	Descrizione
id	string	Identificatore univoco della risorsa arm.
name	string	Nome della risorsa arm.
properties.resource	Resource	Risorsa di un evento contenitore SQL di Azure Cosmos DB
type	string	Tipo di risorsa di Azure.