Condividi tramite

Database Microsoft.DocumentDBAccounts/sqlDatabases/containers 2024-11-15

Definizione di risorsa Bicep

Il tipo di risorsa databaseAccounts/sqlDatabases/containers può essere distribuito con operazioni destinate a:

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers, aggiungere il bicep seguente al modello.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-11-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      analyticalStorageTtl: int
      clientEncryptionPolicy: {
        includedPaths: [
          {
            clientEncryptionKeyId: 'string'
            encryptionAlgorithm: 'string'
            encryptionType: 'string'
            path: 'string'
          }
        ]
        policyFormatVersion: int
      }
      computedProperties: [
        {
          name: 'string'
          query: 'string'
        }
      ]
      conflictResolutionPolicy: {
        conflictResolutionPath: 'string'
        conflictResolutionProcedure: 'string'
        mode: 'string'
      }
      createMode: 'string'
      defaultTtl: int
      id: 'string'
      indexingPolicy: {
        automatic: bool
        compositeIndexes: [
          [
            {
              order: 'string'
              path: 'string'
            }
          ]
        ]
        excludedPaths: [
          {
            path: 'string'
          }
        ]
        includedPaths: [
          {
            indexes: [
              {
                dataType: 'string'
                kind: 'string'
                precision: int
              }
            ]
            path: 'string'
          }
        ]
        indexingMode: 'string'
        spatialIndexes: [
          {
            path: 'string'
            types: [
              'string'
            ]
          }
        ]
        vectorIndexes: [
          {
            path: 'string'
            type: 'string'
          }
        ]
      }
      partitionKey: {
        kind: 'string'
        paths: [
          'string'
        ]
        version: int
      }
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
        restoreWithTtlDisabled: bool
      }
      uniqueKeyPolicy: {
        uniqueKeys: [
          {
            paths: [
              'string'
            ]
          }
        ]
      }
      vectorEmbeddingPolicy: {
        vectorEmbeddings: [
          {
            dataType: 'string'
            dimensions: int
            distanceFunction: 'string'
            path: 'string'
          }
        ]
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Valori delle proprietà

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/contenitori

Nome Descrizione Valore
ubicazione Posizione del gruppo di risorse a cui appartiene la risorsa. corda
nome Nome della risorsa stringa (obbligatorio)
genitore In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre.

Per altre informazioni, vedere risorsa figlio all'esterno della risorsa padre.		 Nome simbolico per la risorsa di tipo: databaseAccounts/sqlDatabases
proprietà Proprietà per creare e aggiornare il contenitore Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (obbligatorio)
Tag Tag delle risorse Dizionario di nomi e valori di tag. Vedere tag nei modelli

Impostazioni di scalabilità automatica

Nome Descrizione Valore
maxThroughput Rappresenta la velocità effettiva massima, la risorsa può aumentare le prestazioni. Int

ClientEncryptionIncludedPath

Nome Descrizione Valore
clientEncryptionKeyId Identificatore della chiave di crittografia client da usare per crittografare il percorso. stringa (obbligatorio)
crittografiaAlgoritmo Algoritmo di crittografia che verrà usato. Ad esempio, AEAD_AES_256_CBC_HMAC_SHA256. stringa (obbligatorio)
encryptionType Tipo di crittografia da eseguire. Ad esempio: deterministico, casuale. stringa (obbligatorio)
sentiero Percorso che deve essere crittografato. stringa (obbligatorio)

Criteri di crittografia client

Nome Descrizione Valore
inclusoPercorsi Percorsi dell'elemento che richiedono la crittografia insieme alle impostazioni specifiche del percorso. ClientEncryptionIncludedPath[] (obbligatorio)
policyFormatVersion 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. Int

Vincoli:
Valore minimo = 1
Valore massimo = 2 (obbligatorio)

Percorso composito

Nome Descrizione Valore
ordine Ordinamento per i percorsi compositi. 'crescente'
'decrescente'
sentiero Percorso a cui si applica il comportamento di indicizzazione. I percorsi di indice iniziano in genere con radice e terminano con caratteri jolly (/path/*) corda

ComputedProperty

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

Politica di risoluzione dei conflitti

Nome Descrizione Valore
conflictResolutionPath Percorso di risoluzione dei conflitti nel caso della modalità LastWriterWins. corda
conflictRisoluzioneProcedura Procedura per risolvere i conflitti in caso di modalità personalizzata. corda
modo Indica la modalità di risoluzione dei conflitti. 'Personalizzato'
'LastWritersWins'

ContainerPartitionKey

Nome Descrizione Valore
gentile 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 'Hash'
'MultiHash'
'Intervallo'
Percorsi Elenco di percorsi che usano i dati all'interno del contenitore che possono essere partizionati stringa[]
Versione Indica la versione della definizione della chiave di partizione Int

Vincoli:
Valore minimo = 1
Valore massimo = 2

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

Nome Descrizione Valore
autoscaleImpostazioni Specifica le impostazioni di scalabilità automatica. Nota: la velocità effettiva o la scalabilità automaticaImpostazioni è obbligatoria, ma non entrambe. impostazione di scalabilità automaticaImpostazioni di scalabilità automatica
Velocità effettiva Unità richiesta al secondo. Ad esempio, "velocità effettiva": 10000. Int

Percorso escluso

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

Percorso incluso

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

Indici

Nome Descrizione Valore
Datatype Tipo di dati a cui viene applicato il comportamento di indicizzazione. 'LineString'
'MultiPoligono'
'Numero'
'Punto'
'Poligono'
'Stringa'
gentile Indica il tipo di indice. 'Hash'
'Intervallo'
'Spaziale'
precisione Precisione dell'indice. -1 è la precisione massima. Int

Politica di Indicizzazione

Nome Descrizione Valore
Automatico Indica se i criteri di indicizzazione sono automatici Bool
compositeIndexes Elenco di elenco di percorsi compositi CompositePath [][]
excludedPaths Elenco di percorsi da escludere dall'indicizzazione ExcludedPath []
inclusoPercorsi Elenco di percorsi da includere nell'indicizzazione IncludedPath []
indexingMode Indica la modalità di indicizzazione. 'coerente'
'pigro'
'nessuno'
spatialIndexes Elenco di specifiche spaziali SpatialSpec []
vectorIndexes Elenco di percorsi da includere nell'indicizzazione vettoriale VectorIndex[]

Parametri di ripristino delle risorse

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

Specifiche spaziali

Nome Descrizione Valore
sentiero Percorso a cui si applica il comportamento di indicizzazione. I percorsi di indice iniziano in genere con radice e terminano con caratteri jolly (/path/*) corda
Tipi Elenco del tipo spaziale del percorso Matrice di stringhe contenente uno dei seguenti elementi:
'LineString'
'MultiPoligono'
'Punto'
'Poligono'

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

Nome Descrizione Valore
Opzioni Coppia chiave-valore di opzioni da applicare per la richiesta. Corrisponde alle intestazioni inviate con la richiesta. CreateUpdateOptionsOrSqlContainerGetPropertiesOptions
risorsa Formato JSON standard di un contenitore SqlContainerResourceOrSqlContainerGetPropertiesResource (obbligatorio)

SqlContainerResourceOrSqlContainerGetPropertiesResource

Nome Descrizione Valore
analiticodi stoccaggioTtl TTL analitico. Int
clientEncryptionPolicy Criteri di crittografia client per il contenitore. Criteri di crittografia client
Proprietà calcolate Elenco delle proprietà calcolate ComputedProperty[]
conflictResolutionPolicy Criteri di risoluzione dei conflitti per il contenitore. Politica di risoluzione dei conflitti
createMode Enumerazione per indicare la modalità di creazione della risorsa. Impostazione predefinita
'Ripristina'
defaultTtl Durata predefinita Int
Id Nome del contenitore SQL di Cosmos DB stringa (obbligatorio)
indicizzazionePolicy Configurazione dei criteri di indicizzazione. Per impostazione predefinita, l'indicizzazione è automatica per tutti i percorsi dei documenti all'interno del contenitore Politica di indicizzazione
partitionKey Configurazione della chiave di partizione da usare per il partizionamento dei dati in più partizioni ContainerPartitionKey
restoreParameters Parametri per indicare le informazioni sul ripristino Parametri di ripristino delle risorse
uniqueKeyPolicy Configurazione dei criteri chiave univoca per specificare vincoli di univocità per i documenti nella raccolta nel servizio Azure Cosmos DB. UniqueKeyPolicy
vectorEmbeddingPolicy Criterio di incorporamento vettoriale per il contenitore. Politica di incorporamento vettoriale

Tag

Nome Descrizione Valore

Chiave univoca

Nome Descrizione Valore
Percorsi L'elenco dei percorsi deve essere univoco per ogni documento nel servizio Azure Cosmos DB stringa[]

UniqueKeyPolicy

Nome Descrizione Valore
uniqueKeys Elenco di chiavi univoche in che applicano vincoli di univocità per i documenti nella raccolta nel servizio Azure Cosmos DB. UniqueKey []

VectorEmbedding

Nome Descrizione Valore
Datatype Indica il tipo di dati del vettore. 'galleggiante32'
'int8'
'uint8' (obbligatorio)
dimensioni Numero di dimensioni nel vettore. int (obbligatorio)
Funzione distanceFunction Funzione distance da usare per il calcolo della distanza tra vettori. 'coseno'
'dotproduct'
'euclideo' (obbligatorio)
sentiero Percorso del campo vettore nel documento. stringa (obbligatorio)

Politica di incorporamento vettoriale

Nome Descrizione Valore
vectorEmbedding Elenco di incorporamenti vettoriali VectorEmbedding[]

Indice vettoriale

Nome Descrizione Valore
sentiero Percorso del campo vettore nel documento. stringa (obbligatorio)
digitare Tipo di indice del vettore. Attualmente sono supportati flat, diskANN e quantiizedFlat. 'diskANN'
'piatto'
'quantiizedFlat' (obbligatorio)

Esempi di utilizzo

Esempi di avvio rapido di Azure

I modelli di avvio rapido di Azure seguenti contengono esempi Bicep per la distribuzione di questo tipo di risorsa.

File bicipite Descrizione
'API SQL dell'account Azure Cosmos DB con l'archivio analitico Questo modello crea un account Azure Cosmos per l'API Core (SQL) con un database e un contenitore configurati con l'archivio analitico.
Creare un account Azure Cosmos DB di livello gratuito Questo modello crea un account Azure Cosmos DB di livello gratuito per l'API SQL con un database con velocità effettiva e contenitore condivisi.
Creare un account Azure Cosmos DB per l'API Core (SQL) Questo modello crea un account Azure Cosmos per l'API Core (SQL) con un database e un contenitore con velocità effettiva con più altre opzioni.
Creare un'API SQL dell'account Azure Cosmos DB con scalabilità automatica Questo modello crea un account Azure Cosmos per l'API Core (SQL) con un database e un contenitore con velocità effettiva con scalabilità automatica con più altre opzioni.
Creare stored procedure dell'API Core (SQL) di Azure Cosmos DB Questo modello crea un account Azure Cosmos DB per l'API Core (SQL) e un contenitore con una stored procedure, un trigger e una funzione definita dall'utente.
Crea un'app di microservizi Dapr usando app contenitore Creare un'app di microservizi Dapr usando App contenitore.
Crea un'app pub-sub-servicebus dapr usando app contenitore Creare un'app pub-sub servicebus dapr usando App contenitore.
Distribuire Azure Data Explorer DB con la connessione di Cosmos DB Distribuire Azure Data Explorer DB con la connessione Cosmos DB.

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa databaseAccounts/sqlDatabases/containers può essere distribuito con operazioni destinate a:

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers, aggiungere il codice JSON seguente al modello.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
  "apiVersion": "2024-11-15",
  "name": "string",
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "analyticalStorageTtl": "int",
      "clientEncryptionPolicy": {
        "includedPaths": [
          {
            "clientEncryptionKeyId": "string",
            "encryptionAlgorithm": "string",
            "encryptionType": "string",
            "path": "string"
          }
        ],
        "policyFormatVersion": "int"
      },
      "computedProperties": [
        {
          "name": "string",
          "query": "string"
        }
      ],
      "conflictResolutionPolicy": {
        "conflictResolutionPath": "string",
        "conflictResolutionProcedure": "string",
        "mode": "string"
      },
      "createMode": "string",
      "defaultTtl": "int",
      "id": "string",
      "indexingPolicy": {
        "automatic": "bool",
        "compositeIndexes": [
          [
            {
              "order": "string",
              "path": "string"
            }
          ]
        ],
        "excludedPaths": [
          {
            "path": "string"
          }
        ],
        "includedPaths": [
          {
            "indexes": [
              {
                "dataType": "string",
                "kind": "string",
                "precision": "int"
              }
            ],
            "path": "string"
          }
        ],
        "indexingMode": "string",
        "spatialIndexes": [
          {
            "path": "string",
            "types": [ "string" ]
          }
        ],
        "vectorIndexes": [
          {
            "path": "string",
            "type": "string"
          }
        ]
      },
      "partitionKey": {
        "kind": "string",
        "paths": [ "string" ],
        "version": "int"
      },
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string",
        "restoreWithTtlDisabled": "bool"
      },
      "uniqueKeyPolicy": {
        "uniqueKeys": [
          {
            "paths": [ "string" ]
          }
        ]
      },
      "vectorEmbeddingPolicy": {
        "vectorEmbeddings": [
          {
            "dataType": "string",
            "dimensions": "int",
            "distanceFunction": "string",
            "path": "string"
          }
        ]
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valori delle proprietà

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/contenitori

Nome Descrizione Valore
versione dell'API Versione dell'API '2024-11-15'
ubicazione Posizione del gruppo di risorse a cui appartiene la risorsa. corda
nome Nome della risorsa stringa (obbligatorio)
proprietà Proprietà per creare e aggiornare il contenitore Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (obbligatorio)
Tag Tag delle risorse Dizionario di nomi e valori di tag. Vedere tag nei modelli
digitare Tipo di risorsa 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/contenitori'

Impostazioni di scalabilità automatica

Nome Descrizione Valore
maxThroughput Rappresenta la velocità effettiva massima, la risorsa può aumentare le prestazioni. Int

ClientEncryptionIncludedPath

Nome Descrizione Valore
clientEncryptionKeyId Identificatore della chiave di crittografia client da usare per crittografare il percorso. stringa (obbligatorio)
crittografiaAlgoritmo Algoritmo di crittografia che verrà usato. Ad esempio, AEAD_AES_256_CBC_HMAC_SHA256. stringa (obbligatorio)
encryptionType Tipo di crittografia da eseguire. Ad esempio: deterministico, casuale. stringa (obbligatorio)
sentiero Percorso che deve essere crittografato. stringa (obbligatorio)

Criteri di crittografia client

Nome Descrizione Valore
inclusoPercorsi Percorsi dell'elemento che richiedono la crittografia insieme alle impostazioni specifiche del percorso. ClientEncryptionIncludedPath[] (obbligatorio)
policyFormatVersion 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. Int

Vincoli:
Valore minimo = 1
Valore massimo = 2 (obbligatorio)

Percorso composito

Nome Descrizione Valore
ordine Ordinamento per i percorsi compositi. 'crescente'
'decrescente'
sentiero Percorso a cui si applica il comportamento di indicizzazione. I percorsi di indice iniziano in genere con radice e terminano con caratteri jolly (/path/*) corda

ComputedProperty

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

Politica di risoluzione dei conflitti

Nome Descrizione Valore
conflictResolutionPath Percorso di risoluzione dei conflitti nel caso della modalità LastWriterWins. corda
conflictRisoluzioneProcedura Procedura per risolvere i conflitti in caso di modalità personalizzata. corda
modo Indica la modalità di risoluzione dei conflitti. 'Personalizzato'
'LastWritersWins'

ContainerPartitionKey

Nome Descrizione Valore
gentile 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 'Hash'
'MultiHash'
'Intervallo'
Percorsi Elenco di percorsi che usano i dati all'interno del contenitore che possono essere partizionati stringa[]
Versione Indica la versione della definizione della chiave di partizione Int

Vincoli:
Valore minimo = 1
Valore massimo = 2

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

Nome Descrizione Valore
autoscaleImpostazioni Specifica le impostazioni di scalabilità automatica. Nota: la velocità effettiva o la scalabilità automaticaImpostazioni è obbligatoria, ma non entrambe. impostazione di scalabilità automaticaImpostazioni di scalabilità automatica
Velocità effettiva Unità richiesta al secondo. Ad esempio, "velocità effettiva": 10000. Int

Percorso escluso

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

Percorso incluso

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

Indici

Nome Descrizione Valore
Datatype Tipo di dati a cui viene applicato il comportamento di indicizzazione. 'LineString'
'MultiPoligono'
'Numero'
'Punto'
'Poligono'
'Stringa'
gentile Indica il tipo di indice. 'Hash'
'Intervallo'
'Spaziale'
precisione Precisione dell'indice. -1 è la precisione massima. Int

Politica di Indicizzazione

Nome Descrizione Valore
Automatico Indica se i criteri di indicizzazione sono automatici Bool
compositeIndexes Elenco di elenco di percorsi compositi CompositePath [][]
excludedPaths Elenco di percorsi da escludere dall'indicizzazione ExcludedPath []
inclusoPercorsi Elenco di percorsi da includere nell'indicizzazione IncludedPath []
indexingMode Indica la modalità di indicizzazione. 'coerente'
'pigro'
'nessuno'
spatialIndexes Elenco di specifiche spaziali SpatialSpec []
vectorIndexes Elenco di percorsi da includere nell'indicizzazione vettoriale VectorIndex[]

Parametri di ripristino delle risorse

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

Specifiche spaziali

Nome Descrizione Valore
sentiero Percorso a cui si applica il comportamento di indicizzazione. I percorsi di indice iniziano in genere con radice e terminano con caratteri jolly (/path/*) corda
Tipi Elenco del tipo spaziale del percorso Matrice di stringhe contenente uno dei seguenti elementi:
'LineString'
'MultiPoligono'
'Punto'
'Poligono'

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

Nome Descrizione Valore
Opzioni Coppia chiave-valore di opzioni da applicare per la richiesta. Corrisponde alle intestazioni inviate con la richiesta. CreateUpdateOptionsOrSqlContainerGetPropertiesOptions
risorsa Formato JSON standard di un contenitore SqlContainerResourceOrSqlContainerGetPropertiesResource (obbligatorio)

SqlContainerResourceOrSqlContainerGetPropertiesResource

Nome Descrizione Valore
analiticodi stoccaggioTtl TTL analitico. Int
clientEncryptionPolicy Criteri di crittografia client per il contenitore. Criteri di crittografia client
Proprietà calcolate Elenco delle proprietà calcolate ComputedProperty[]
conflictResolutionPolicy Criteri di risoluzione dei conflitti per il contenitore. Politica di risoluzione dei conflitti
createMode Enumerazione per indicare la modalità di creazione della risorsa. Impostazione predefinita
'Ripristina'
defaultTtl Durata predefinita Int
Id Nome del contenitore SQL di Cosmos DB stringa (obbligatorio)
indicizzazionePolicy Configurazione dei criteri di indicizzazione. Per impostazione predefinita, l'indicizzazione è automatica per tutti i percorsi dei documenti all'interno del contenitore Politica di indicizzazione
partitionKey Configurazione della chiave di partizione da usare per il partizionamento dei dati in più partizioni ContainerPartitionKey
restoreParameters Parametri per indicare le informazioni sul ripristino Parametri di ripristino delle risorse
uniqueKeyPolicy Configurazione dei criteri chiave univoca per specificare vincoli di univocità per i documenti nella raccolta nel servizio Azure Cosmos DB. UniqueKeyPolicy
vectorEmbeddingPolicy Criterio di incorporamento vettoriale per il contenitore. Politica di incorporamento vettoriale

Tag

Nome Descrizione Valore

Chiave univoca

Nome Descrizione Valore
Percorsi L'elenco dei percorsi deve essere univoco per ogni documento nel servizio Azure Cosmos DB stringa[]

UniqueKeyPolicy

Nome Descrizione Valore
uniqueKeys Elenco di chiavi univoche in che applicano vincoli di univocità per i documenti nella raccolta nel servizio Azure Cosmos DB. UniqueKey []

VectorEmbedding

Nome Descrizione Valore
Datatype Indica il tipo di dati del vettore. 'galleggiante32'
'int8'
'uint8' (obbligatorio)
dimensioni Numero di dimensioni nel vettore. int (obbligatorio)
Funzione distanceFunction Funzione distance da usare per il calcolo della distanza tra vettori. 'coseno'
'dotproduct'
'euclideo' (obbligatorio)
sentiero Percorso del campo vettore nel documento. stringa (obbligatorio)

Politica di incorporamento vettoriale

Nome Descrizione Valore
vectorEmbedding Elenco di incorporamenti vettoriali VectorEmbedding[]

Indice vettoriale

Nome Descrizione Valore
sentiero Percorso del campo vettore nel documento. stringa (obbligatorio)
digitare Tipo di indice del vettore. Attualmente sono supportati flat, diskANN e quantiizedFlat. 'diskANN'
'piatto'
'quantiizedFlat' (obbligatorio)

Esempi di utilizzo

Modelli di avvio rapido di Azure

I modelli di avvio rapido di Azure seguenti distribuire questo tipo di risorsa.

Sagoma Descrizione
'API SQL dell'account Azure Cosmos DB con l'archivio analitico

Distribuire in Azure 		Questo modello crea un account Azure Cosmos per l'API Core (SQL) con un database e un contenitore configurati con l'archivio analitico.
Creare un account Azure Cosmos DB di livello gratuito

Distribuire in Azure 		Questo modello crea un account Azure Cosmos DB di livello gratuito per l'API SQL con un database con velocità effettiva e contenitore condivisi.
Creare un account Azure Cosmos DB per l'API Core (SQL)

Distribuire in Azure 		Questo modello crea un account Azure Cosmos per l'API Core (SQL) con un database e un contenitore con velocità effettiva con più altre opzioni.
Creare un'API SQL dell'account Azure Cosmos DB con scalabilità automatica

Distribuire in Azure 		Questo modello crea un account Azure Cosmos per l'API Core (SQL) con un database e un contenitore con velocità effettiva con scalabilità automatica con più altre opzioni.
Creare stored procedure dell'API Core (SQL) di Azure Cosmos DB

Distribuire in Azure 		Questo modello crea un account Azure Cosmos DB per l'API Core (SQL) e un contenitore con una stored procedure, un trigger e una funzione definita dall'utente.
Crea un'app di microservizi Dapr usando app contenitore

Distribuire in Azure 		Creare un'app di microservizi Dapr usando App contenitore.
Crea un'app pub-sub-servicebus dapr usando app contenitore

Distribuire in Azure 		Creare un'app pub-sub servicebus dapr usando App contenitore.
Distribuire Azure Data Explorer DB con la connessione di Cosmos DB

Distribuire in Azure 		Distribuire Azure Data Explorer DB con la connessione Cosmos DB.

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa databaseAccounts/sqlDatabases/containers può essere distribuito con operazioni destinate a:

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers, aggiungere il codice Terraform seguente al modello.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-11-15"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        analyticalStorageTtl = int
        clientEncryptionPolicy = {
          includedPaths = [
            {
              clientEncryptionKeyId = "string"
              encryptionAlgorithm = "string"
              encryptionType = "string"
              path = "string"
            }
          ]
          policyFormatVersion = int
        }
        computedProperties = [
          {
            name = "string"
            query = "string"
          }
        ]
        conflictResolutionPolicy = {
          conflictResolutionPath = "string"
          conflictResolutionProcedure = "string"
          mode = "string"
        }
        createMode = "string"
        defaultTtl = int
        id = "string"
        indexingPolicy = {
          automatic = bool
          compositeIndexes = [
            [
              {
                order = "string"
                path = "string"
              }
            ]
          ]
          excludedPaths = [
            {
              path = "string"
            }
          ]
          includedPaths = [
            {
              indexes = [
                {
                  dataType = "string"
                  kind = "string"
                  precision = int
                }
              ]
              path = "string"
            }
          ]
          indexingMode = "string"
          spatialIndexes = [
            {
              path = "string"
              types = [
                "string"
              ]
            }
          ]
          vectorIndexes = [
            {
              path = "string"
              type = "string"
            }
          ]
        }
        partitionKey = {
          kind = "string"
          paths = [
            "string"
          ]
          version = int
        }
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
          restoreWithTtlDisabled = bool
        }
        uniqueKeyPolicy = {
          uniqueKeys = [
            {
              paths = [
                "string"
              ]
            }
          ]
        }
        vectorEmbeddingPolicy = {
          vectorEmbeddings = [
            {
              dataType = "string"
              dimensions = int
              distanceFunction = "string"
              path = "string"
            }
          ]
        }
      }
    }
  }
}

Valori delle proprietà

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/contenitori

Nome Descrizione Valore
ubicazione Posizione del gruppo di risorse a cui appartiene la risorsa. corda
nome Nome della risorsa stringa (obbligatorio)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: databaseAccounts/sqlDatabases
proprietà Proprietà per creare e aggiornare il contenitore Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (obbligatorio)
Tag Tag delle risorse Dizionario di nomi e valori di tag.
digitare Tipo di risorsa "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-11-15"

Impostazioni di scalabilità automatica

Nome Descrizione Valore
maxThroughput Rappresenta la velocità effettiva massima, la risorsa può aumentare le prestazioni. Int

ClientEncryptionIncludedPath

Nome Descrizione Valore
clientEncryptionKeyId Identificatore della chiave di crittografia client da usare per crittografare il percorso. stringa (obbligatorio)
crittografiaAlgoritmo Algoritmo di crittografia che verrà usato. Ad esempio, AEAD_AES_256_CBC_HMAC_SHA256. stringa (obbligatorio)
encryptionType Tipo di crittografia da eseguire. Ad esempio: deterministico, casuale. stringa (obbligatorio)
sentiero Percorso che deve essere crittografato. stringa (obbligatorio)

Criteri di crittografia client

Nome Descrizione Valore
inclusoPercorsi Percorsi dell'elemento che richiedono la crittografia insieme alle impostazioni specifiche del percorso. ClientEncryptionIncludedPath[] (obbligatorio)
policyFormatVersion 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. Int

Vincoli:
Valore minimo = 1
Valore massimo = 2 (obbligatorio)

Percorso composito

Nome Descrizione Valore
ordine Ordinamento per i percorsi compositi. 'crescente'
'decrescente'
sentiero Percorso a cui si applica il comportamento di indicizzazione. I percorsi di indice iniziano in genere con radice e terminano con caratteri jolly (/path/*) corda

ComputedProperty

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

Politica di risoluzione dei conflitti

Nome Descrizione Valore
conflictResolutionPath Percorso di risoluzione dei conflitti nel caso della modalità LastWriterWins. corda
conflictRisoluzioneProcedura Procedura per risolvere i conflitti in caso di modalità personalizzata. corda
modo Indica la modalità di risoluzione dei conflitti. 'Personalizzato'
'LastWritersWins'

ContainerPartitionKey

Nome Descrizione Valore
gentile 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 'Hash'
'MultiHash'
'Intervallo'
Percorsi Elenco di percorsi che usano i dati all'interno del contenitore che possono essere partizionati stringa[]
Versione Indica la versione della definizione della chiave di partizione Int

Vincoli:
Valore minimo = 1
Valore massimo = 2

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

Nome Descrizione Valore
autoscaleImpostazioni Specifica le impostazioni di scalabilità automatica. Nota: la velocità effettiva o la scalabilità automaticaImpostazioni è obbligatoria, ma non entrambe. impostazione di scalabilità automaticaImpostazioni di scalabilità automatica
Velocità effettiva Unità richiesta al secondo. Ad esempio, "velocità effettiva": 10000. Int

Percorso escluso

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

Percorso incluso

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

Indici

Nome Descrizione Valore
Datatype Tipo di dati a cui viene applicato il comportamento di indicizzazione. 'LineString'
'MultiPoligono'
'Numero'
'Punto'
'Poligono'
'Stringa'
gentile Indica il tipo di indice. 'Hash'
'Intervallo'
'Spaziale'
precisione Precisione dell'indice. -1 è la precisione massima. Int

Politica di Indicizzazione

Nome Descrizione Valore
Automatico Indica se i criteri di indicizzazione sono automatici Bool
compositeIndexes Elenco di elenco di percorsi compositi CompositePath [][]
excludedPaths Elenco di percorsi da escludere dall'indicizzazione ExcludedPath []
inclusoPercorsi Elenco di percorsi da includere nell'indicizzazione IncludedPath []
indexingMode Indica la modalità di indicizzazione. 'coerente'
'pigro'
'nessuno'
spatialIndexes Elenco di specifiche spaziali SpatialSpec []
vectorIndexes Elenco di percorsi da includere nell'indicizzazione vettoriale VectorIndex[]

Parametri di ripristino delle risorse

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

Specifiche spaziali

Nome Descrizione Valore
sentiero Percorso a cui si applica il comportamento di indicizzazione. I percorsi di indice iniziano in genere con radice e terminano con caratteri jolly (/path/*) corda
Tipi Elenco del tipo spaziale del percorso Matrice di stringhe contenente uno dei seguenti elementi:
'LineString'
'MultiPoligono'
'Punto'
'Poligono'

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

Nome Descrizione Valore
Opzioni Coppia chiave-valore di opzioni da applicare per la richiesta. Corrisponde alle intestazioni inviate con la richiesta. CreateUpdateOptionsOrSqlContainerGetPropertiesOptions
risorsa Formato JSON standard di un contenitore SqlContainerResourceOrSqlContainerGetPropertiesResource (obbligatorio)

SqlContainerResourceOrSqlContainerGetPropertiesResource

Nome Descrizione Valore
analiticodi stoccaggioTtl TTL analitico. Int
clientEncryptionPolicy Criteri di crittografia client per il contenitore. Criteri di crittografia client
Proprietà calcolate Elenco delle proprietà calcolate ComputedProperty[]
conflictResolutionPolicy Criteri di risoluzione dei conflitti per il contenitore. Politica di risoluzione dei conflitti
createMode Enumerazione per indicare la modalità di creazione della risorsa. Impostazione predefinita
'Ripristina'
defaultTtl Durata predefinita Int
Id Nome del contenitore SQL di Cosmos DB stringa (obbligatorio)
indicizzazionePolicy Configurazione dei criteri di indicizzazione. Per impostazione predefinita, l'indicizzazione è automatica per tutti i percorsi dei documenti all'interno del contenitore Politica di indicizzazione
partitionKey Configurazione della chiave di partizione da usare per il partizionamento dei dati in più partizioni ContainerPartitionKey
restoreParameters Parametri per indicare le informazioni sul ripristino Parametri di ripristino delle risorse
uniqueKeyPolicy Configurazione dei criteri chiave univoca per specificare vincoli di univocità per i documenti nella raccolta nel servizio Azure Cosmos DB. UniqueKeyPolicy
vectorEmbeddingPolicy Criterio di incorporamento vettoriale per il contenitore. Politica di incorporamento vettoriale

Tag

Nome Descrizione Valore

Chiave univoca

Nome Descrizione Valore
Percorsi L'elenco dei percorsi deve essere univoco per ogni documento nel servizio Azure Cosmos DB stringa[]

UniqueKeyPolicy

Nome Descrizione Valore
uniqueKeys Elenco di chiavi univoche in che applicano vincoli di univocità per i documenti nella raccolta nel servizio Azure Cosmos DB. UniqueKey []

VectorEmbedding

Nome Descrizione Valore
Datatype Indica il tipo di dati del vettore. 'galleggiante32'
'int8'
'uint8' (obbligatorio)
dimensioni Numero di dimensioni nel vettore. int (obbligatorio)
Funzione distanceFunction Funzione distance da usare per il calcolo della distanza tra vettori. 'coseno'
'dotproduct'
'euclideo' (obbligatorio)
sentiero Percorso del campo vettore nel documento. stringa (obbligatorio)

Politica di incorporamento vettoriale

Nome Descrizione Valore
vectorEmbedding Elenco di incorporamenti vettoriali VectorEmbedding[]

Indice vettoriale

Nome Descrizione Valore
sentiero Percorso del campo vettore nel documento. stringa (obbligatorio)
digitare Tipo di indice del vettore. Attualmente sono supportati flat, diskANN e quantiizedFlat. 'diskANN'
'piatto'
'quantiizedFlat' (obbligatorio)

Esempi di utilizzo

Esempi di Terraform

Esempio di base di distribuzione di SQL Container all'interno di un account Cosmos DB.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "databaseAccount" {
  type      = "Microsoft.DocumentDB/databaseAccounts@2021-10-15"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "GlobalDocumentDB"
    properties = {
      capabilities = [
      ]
      consistencyPolicy = {
        defaultConsistencyLevel = "BoundedStaleness"
        maxIntervalInSeconds    = 10
        maxStalenessPrefix      = 200
      }
      databaseAccountOfferType           = "Standard"
      defaultIdentity                    = "FirstPartyIdentity"
      disableKeyBasedMetadataWriteAccess = false
      disableLocalAuth                   = false
      enableAnalyticalStorage            = false
      enableAutomaticFailover            = false
      enableFreeTier                     = false
      enableMultipleWriteLocations       = false
      ipRules = [
      ]
      isVirtualNetworkFilterEnabled = false
      locations = [
        {
          failoverPriority = 0
          isZoneRedundant  = false
          locationName     = "West Europe"
        },
      ]
      networkAclBypass = "None"
      networkAclBypassResourceIds = [
      ]
      publicNetworkAccess = "Enabled"
      virtualNetworkRules = [
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "sqlDatabase" {
  type      = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-10-15"
  parent_id = azapi_resource.databaseAccount.id
  name      = var.resource_name
  body = {
    properties = {
      options = {
        throughput = 400
      }
      resource = {
        id = var.resource_name
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "container" {
  type      = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2023-04-15"
  parent_id = azapi_resource.sqlDatabase.id
  name      = var.resource_name
  body = {
    properties = {
      options = {
      }
      resource = {
        id = "test-containerWest Europe"
        partitionKey = {
          kind = "Hash"
          paths = [
            "/definition",
          ]
        }
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}
  • Last updated on