Database Microsoft.DocumentDBAccounts/sqlDatabases/containers 2022-11-15-preview

  • Articolo

Definizione di risorsa Bicep

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

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

Formato di risorsa

Per creare una risorsa Microsoft.DocumentDB/databaseAccounts/sqlDatabases/contenitori, aggiungere il modello Bicep seguente.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2022-11-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      analyticalStorageTtl: int
      clientEncryptionPolicy: {
        includedPaths: [
          {
            clientEncryptionKeyId: 'string'
            encryptionAlgorithm: 'string'
            encryptionType: 'string'
            path: 'string'
          }
        ]
        policyFormatVersion: int
      }
      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'
            ]
          }
        ]
      }
      partitionKey: {
        kind: 'string'
        paths: [
          'string'
        ]
        version: int
      }
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
      }
      uniqueKeyPolicy: {
        uniqueKeys: [
          {
            paths: [
              'string'
            ]
          }
        ]
      }
    }
  }
}

Valori delle proprietà

databaseAccounts/sqlDatabases/containers

Nome Descrizione valore
name Nome della risorsa

Vedere come impostare nomi e tipi per le risorse figlio in Bicep.		 stringa (obbligatoria)
posizione Posizione del gruppo di risorse a cui appartiene la risorsa. string
tags I tag sono un elenco di coppie chiave-valore che descrivono la risorsa. Questi tag possono essere utilizzati nella visualizzazione e nel raggruppamento di questa risorsa (tra gruppi di risorse). È possibile specificare un massimo di 15 tag per una risorsa. Ogni tag deve avere una chiave non superiore a 128 caratteri con un valore che non superi i 256 caratteri. Ad esempio, l'esperienza predefinita per un tipo di modello è impostata con "defaultExperience": "Cassandra". I valori "defaultExperience" correnti includono anche "Table", "Graph", "DocumentDB" e "MongoDB". Dizionario dei nomi e dei valori dei tag. Vedere Tag nei modelli
padre 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 esterna alla risorsa padre.		 Nome simbolico per la risorsa di tipo: sqlDatabases
identity Identità per la risorsa. ManagedServiceIdentity
properties Proprietà per creare e aggiornare il contenitore Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (obbligatorio)

ManagedServiceIdentity

Nome Descrizione Valore
tipo Tipo di identità utilizzata per la risorsa. Il tipo 'SystemAssigned,UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo 'Nessuno' rimuoverà le identità dal servizio. 'Nessuno'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Elenco delle identità utente associate alla risorsa. I riferimenti alla chiave del dizionario delle identità utente saranno id risorsa ARM nel modulo: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nome Descrizione Valore
{proprietà personalizzata} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.

SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...

Nome Descrizione Valore
opzioni Coppia chiave-valore delle opzioni da applicare per la richiesta. Corrisponde alle intestazioni inviate con la richiesta. CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
Risorsa Formato JSON standard di un contenitore SqlContainerResourceOrSqlContainerGetPropertiesResou... (obbligatorio)

CreateUpdateOptionsOrSqlContainerGetPropertiesOption...

Nome Descrizione Valore
autoscaleSettings Specifica le impostazioni di scalabilità automatica. Scalabilità automaticaSettings
throughput Unità richiesta al secondo. Ad esempio, "velocità effettiva": 10000. INT

Scalabilità automaticaSettings

Nome Descrizione Valore
maxThroughput Rappresenta la velocità effettiva massima, la risorsa può aumentare fino a. INT

SqlContainerResourceOrSqlContainerGetPropertiesResou...

Nome Descrizione Valore
analyticsStorageTtl TTL analitico. INT
clientEncryptionPolicy Criteri di crittografia client per il contenitore. ClientEncryptionPolicy
Conflictresolutionpolicy Criteri di risoluzione dei conflitti per il contenitore. Conflictresolutionpolicy
createMode Enumerazione per indicare la modalità di creazione delle risorse. Impostazione predefinita
'Restore'
defaultTtl Tempo predefinito da vivere INT
id Nome del contenitore SQL di Cosmos DB stringa (obbligatoria)
indexingPolicy Configurazione dei criteri di indicizzazione. Per impostazione predefinita, l'indicizzazione è automatica per tutti i percorsi del documento all'interno del contenitore IndexingPolicy
partitionKey Configurazione della chiave di partizione da usare per partizionamento dei dati in più partizioni ContainerPartitionKey
restoreParameters Parametri per indicare le informazioni sul ripristino ResourceRestoreParameters
uniqueKeyPolicy Configurazione dei criteri chiave univoca per specificare vincoli di univocità sui documenti nella raccolta nel servizio Azure Cosmos DB. UniqueKeyPolicy

ClientEncryptionPolicy

Nome Descrizione Valore
includedPaths 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 del percorso id e chiave di partizione. int (obbligatorio)

Vincoli:
Valore minimo = 1
Valore massimo = 2

ClientEncryptionIncludedPath

Nome Descrizione Valore
clientEncryptionKeyId Identificatore della chiave di crittografia client da usare per crittografare il percorso. stringa (obbligatoria)
encryptionAlgorithm Algoritmo di crittografia che verrà usato. Eg : AEAD_AES_256_CBC_HMAC_SHA256. stringa (obbligatoria)
encryptionType Tipo di crittografia da eseguire. Eg - Deterministico, Casualizzato. stringa (obbligatoria)
path Percorso che deve essere crittografato. stringa (obbligatoria)

Conflictresolutionpolicy

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

IndexingPolicy

Nome Descrizione Valore
automatic Indica se il criterio di indicizzazione è automatico bool
compositeIndexes Elenco di percorsi compositi CompositePath[]
esclusiPath Elenco di percorsi da escludere dall'indicizzazione ExcludedPath[]
includedPaths Elenco dei percorsi da includere nell'indicizzazione IncludedPath[]
indexingMode Indica la modalità di indicizzazione. 'coerente'
'lazy'
'nessuno'
spatialIndexes Elenco di specifiche spaziali SpatialSpec[]

CompositePath

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

ExcludedPath

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

IncludePath

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

Indici

Nome Descrizione Valore
dataType Tipo di dati a cui viene applicato il comportamento di indicizzazione. 'LineString'
'MultiPolygon'
'Number'
'Punto'
'Poligono'
'String'
kind Indica il tipo di indice. 'Hash'
'Range'
'Spaziale'
precisione Precisione dell'indice. -1 è precisione massima. INT

SpatialSpec

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

ContainerPartitionKey

Nome Descrizione Valore
kind Indica il tipo di algoritmo utilizzato per il partizionamento. Per MultiHash sono supportate più chiavi di partizione (fino a tre al massimo) per la creazione del contenitore 'Hash'
'MultiHash'
'Range'
percorsi Elenco di percorsi che usano i dati all'interno del contenitore che possono essere partizionati string[]
version Indica la versione della definizione della chiave di partizione INT

Vincoli:
Valore minimo = 1
Valore massimo = 2

ResourceRestoreParameters

Nome Descrizione Valore
restoreSource ID dell'account del database ripristinabile da cui deve essere avviato il ripristino. Ad esempio: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Ora in cui è necessario ripristinare l'account (formato ISO-8601). string

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

UniqueKey

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

Modelli di avvio rapido

I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Modello Descrizione
Creare un account Azure Cosmos DB di livello gratuito

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

Distribuisci 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.
API SQL dell'account Azure Cosmos DB con archivio analitico

Distribuisci 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'API SQL dell'account Azure Cosmos DB con scalabilità automatica

Distribuisci 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

Distribuisci 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.
Distribuire Azure Data Explorer DB con connessione Cosmos DB

Distribuisci in Azure		 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 di risorsa

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
  "apiVersion": "2022-11-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "analyticalStorageTtl": "int",
      "clientEncryptionPolicy": {
        "includedPaths": [
          {
            "clientEncryptionKeyId": "string",
            "encryptionAlgorithm": "string",
            "encryptionType": "string",
            "path": "string"
          }
        ],
        "policyFormatVersion": "int"
      },
      "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" ]
          }
        ]
      },
      "partitionKey": {
        "kind": "string",
        "paths": [ "string" ],
        "version": "int"
      },
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string"
      },
      "uniqueKeyPolicy": {
        "uniqueKeys": [
          {
            "paths": [ "string" ]
          }
        ]
      }
    }
  }
}

Valori delle proprietà

databaseAccounts/sqlDatabases/containers

Nome Descrizione Valore
tipo Tipo di risorsa 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers'
apiVersion Versione dell'API della risorsa '2022-11-15-preview'
name Nome della risorsa

Informazioni su come impostare nomi e tipi per le risorse figlio nei modelli di Resource Manager JSON.		 stringa (obbligatorio)
posizione Posizione del gruppo di risorse a cui appartiene la risorsa. string
tags I tag sono un elenco di coppie chiave-valore che descrivono la risorsa. Questi tag possono essere utilizzati nella visualizzazione e nel raggruppamento di questa risorsa (tra gruppi di risorse). È possibile specificare un massimo di 15 tag per una risorsa. Ogni tag deve avere una chiave non superiore a 128 caratteri con un valore che non superi i 256 caratteri. Ad esempio, l'esperienza predefinita per un tipo di modello è impostata con "defaultExperience": "Cassandra". I valori correnti "defaultExperience" includono anche "Table", "Graph", "DocumentDB" e "MongoDB". Dizionario di nomi e valori di tag. Vedere Tag nei modelli
identity Identità per la risorsa. ManagedServiceIdentity
properties Proprietà per creare e aggiornare il contenitore Di Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (obbligatorio)

ManagedServiceIdentity

Nome Descrizione Valore
tipo Tipo di identità usata per la risorsa. Il tipo 'SystemAssigned,UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo "Nessuno" rimuoverà le identità dal servizio. 'Nessuno'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Elenco di identità utente associate alla risorsa. I riferimenti alla chiave del dizionario identità utente saranno ID risorsa ARM nel formato :'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nome Descrizione Valore
{proprietà personalizzata} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.

SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...

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

CreateUpdateOptionsOrSqlContainerGetPropertiesOption...

Nome Descrizione Valore
autoscaleSettings Specifica le impostazioni di scalabilità automatica. Impostazioni di scalabilità automatica
throughput Unità richiesta al secondo. Ad esempio, "velocità effettiva": 10000. INT

Impostazioni di scalabilità automatica

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

SqlContainerResourceOrSqlContainerGetPropertiesResou...

Nome Descrizione Valore
analyticalStorageTtl TTL analitico. INT
clientEncryptionPolicy Criteri di crittografia client per il contenitore. ClientEncryptionPolicy
Conflictresolutionpolicy Criteri di risoluzione dei conflitti per il contenitore. Conflictresolutionpolicy
createMode Enumerazione per indicare la modalità di creazione delle risorse. Impostazione predefinita
'Restore'
defaultTtl Durata predefinita INT
id Nome del contenitore SQL di Cosmos DB stringa (obbligatorio)
indexingPolicy Configurazione dei criteri di indicizzazione. Per impostazione predefinita, l'indicizzazione è automatica per tutti i percorsi dei documenti all'interno del contenitore IndexingPolicy
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 ResourceRestoreParameters
uniqueKeyPolicy Configurazione dei criteri chiave univoca per specificare vincoli di univocità per i documenti nella raccolta nel servizio Azure Cosmos DB. UniqueKeyPolicy

ClientEncryptionPolicy

Nome Descrizione Valore
includedPaths 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 del percorso id e chiave di partizione. int (obbligatorio)

Vincoli:
Valore minimo = 1
Valore massimo = 2

ClientEncryptionIncludedPath

Nome Descrizione Valore
clientEncryptionKeyId Identificatore della chiave di crittografia client da usare per crittografare il percorso. stringa (obbligatoria)
encryptionAlgorithm Algoritmo di crittografia che verrà usato. Eg : AEAD_AES_256_CBC_HMAC_SHA256. stringa (obbligatoria)
encryptionType Tipo di crittografia da eseguire. Eg - Deterministico, Casualizzato. stringa (obbligatoria)
path Percorso che deve essere crittografato. stringa (obbligatoria)

Conflictresolutionpolicy

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

IndexingPolicy

Nome Descrizione Valore
automatic Indica se il criterio di indicizzazione è automatico bool
compositeIndexes Elenco di percorsi compositi CompositePath[]
esclusiPath Elenco di percorsi da escludere dall'indicizzazione ExcludedPath[]
includedPaths Elenco dei percorsi da includere nell'indicizzazione IncludedPath[]
indexingMode Indica la modalità di indicizzazione. 'coerente'
'lazy'
'nessuno'
spatialIndexes Elenco di specifiche spaziali SpatialSpec[]

CompositePath

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

ExcludedPath

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

IncludePath

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

Indici

Nome Descrizione Valore
dataType Tipo di dati a cui viene applicato il comportamento di indicizzazione. 'LineString'
'MultiPolygon'
'Number'
'Point'
'Poligono'
'String'
kind Indica il tipo di indice. 'Hash'
'Range'
'Spatial'
precisione Precisione dell'indice. -1 è la precisione massima. INT

SpatialSpec

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

ContainerPartitionKey

Nome Descrizione Valore
kind Indica il tipo di algoritmo utilizzato per il partizionamento. Per MultiHash sono supportate più chiavi di partizione (fino a tre al massimo) per la creazione del contenitore 'Hash'
'MultiHash'
'Range'
percorsi Elenco di percorsi che usano i dati all'interno del contenitore che possono essere partizionati string[]
version Indica la versione della definizione della chiave di partizione INT

Vincoli:
Valore minimo = 1
Valore massimo = 2

ResourceRestoreParameters

Nome Descrizione Valore
restoreSource ID dell'account del database ripristinabile da cui deve essere avviato il ripristino. Ad esempio: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Ora in cui è necessario ripristinare l'account (formato ISO-8601). string

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

UniqueKey

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

Modelli di avvio rapido

I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Modello Descrizione
Creare un account Azure Cosmos DB di livello gratuito

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

Distribuisci 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.
API SQL dell'account Azure Cosmos DB con archivio analitico

Distribuisci 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'API SQL dell'account Azure Cosmos DB con scalabilità automatica

Distribuisci 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

Distribuisci 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.
Distribuire Azure Data Explorer DB con connessione Cosmos DB

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

Definizione della risorsa Terraform (provider AzAPI)

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

  • Gruppi di risorse

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

Formato di 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@2022-11-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        analyticalStorageTtl = int
        clientEncryptionPolicy = {
          includedPaths = [
            {
              clientEncryptionKeyId = "string"
              encryptionAlgorithm = "string"
              encryptionType = "string"
              path = "string"
            }
          ]
          policyFormatVersion = int
        }
        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"
              ]
            }
          ]
        }
        partitionKey = {
          kind = "string"
          paths = [
            "string"
          ]
          version = int
        }
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
        }
        uniqueKeyPolicy = {
          uniqueKeys = [
            {
              paths = [
                "string"
              ]
            }
          ]
        }
      }
    }
  })
}

Valori delle proprietà

databaseAccounts/sqlDatabases/containers

Nome Descrizione Valore
tipo Tipo di risorsa "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2022-11-15-preview"
name Nome della risorsa stringa (obbligatorio)
posizione Posizione del gruppo di risorse a cui appartiene la risorsa. string
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: sqlDatabases
tags I tag sono un elenco di coppie chiave-valore che descrivono la risorsa. Questi tag possono essere utilizzati nella visualizzazione e nel raggruppamento di questa risorsa (tra gruppi di risorse). È possibile specificare un massimo di 15 tag per una risorsa. Ogni tag deve avere una chiave non superiore a 128 caratteri con un valore che non superi i 256 caratteri. Ad esempio, l'esperienza predefinita per un tipo di modello è impostata con "defaultExperience": "Cassandra". I valori correnti "defaultExperience" includono anche "Table", "Graph", "DocumentDB" e "MongoDB". Dizionario di nomi e valori di tag.
identity Identità per la risorsa. ManagedServiceIdentity
properties Proprietà per creare e aggiornare il contenitore Di Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (obbligatorio)

ManagedServiceIdentity

Nome Descrizione Valore
tipo Tipo di identità usata per la risorsa. Il tipo 'SystemAssigned,UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo "Nessuno" rimuoverà le identità dal servizio. "SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"
identity_ids Elenco di identità utente associate alla risorsa. I riferimenti alla chiave del dizionario identità utente saranno ID risorsa ARM nel formato :'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Matrice di ID identità utente.

ManagedServiceIdentityUserAssignedIdentities

Nome Descrizione Valore
{proprietà personalizzata} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.

SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...

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

CreateUpdateOptionsOrSqlContainerGetPropertiesOption...

Nome Descrizione Valore
autoscaleSettings Specifica le impostazioni di scalabilità automatica. Impostazioni di scalabilità automatica
throughput Unità richiesta al secondo. Ad esempio, "velocità effettiva": 10000. INT

Impostazioni di scalabilità automatica

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

SqlContainerResourceOrSqlContainerGetPropertiesResou...

Nome Descrizione Valore
analyticalStorageTtl TTL analitico. INT
clientEncryptionPolicy Criteri di crittografia client per il contenitore. ClientEncryptionPolicy
Conflictresolutionpolicy Criteri di risoluzione dei conflitti per il contenitore. Conflictresolutionpolicy
createMode Enumerazione per indicare la modalità di creazione delle risorse. "Default"
"Ripristina"
defaultTtl Durata predefinita INT
id Nome del contenitore SQL di Cosmos DB stringa (obbligatorio)
indexingPolicy Configurazione dei criteri di indicizzazione. Per impostazione predefinita, l'indicizzazione è automatica per tutti i percorsi dei documenti all'interno del contenitore IndexingPolicy
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 ResourceRestoreParameters
uniqueKeyPolicy Configurazione dei criteri chiave univoca per specificare vincoli di univocità per i documenti nella raccolta nel servizio Azure Cosmos DB. UniqueKeyPolicy

ClientEncryptionPolicy

Nome Descrizione Valore
includedPaths 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 del percorso id e della chiave di partizione. int (obbligatorio)

Vincoli:
Valore minimo = 1
Valore massimo = 2

ClientEncryptionIncludedPath

Nome Descrizione Valore
clientEncryptionKeyId Identificatore della chiave di crittografia client da usare per crittografare il percorso. stringa (obbligatorio)
encryptionAlgorithm 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)
path Percorso che deve essere crittografato. stringa (obbligatorio)

Conflictresolutionpolicy

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

IndexingPolicy

Nome Descrizione Valore
automatic Indica se i criteri di indicizzazione sono automatici bool
compositeIndexes Elenco di percorsi compositi CompositePath[]
excludedPaths Elenco di percorsi da escludere dall'indicizzazione ExcludedPath[]
includedPaths Elenco di percorsi da includere nell'indicizzazione IncludedPath[]
indexingMode Indica la modalità di indicizzazione. "coerente"
"lazy"
"nessuno"
spatialIndexes Elenco di specifiche spaziali SpatialSpec[]

CompositePath

Nome Descrizione Valore
order Ordinare l'ordinamento per i percorsi compositi. "crescente"
"decrescente"
path Percorso a cui si applica il comportamento di indicizzazione. I percorsi di indice iniziano in genere con radice e terminano con caratteri jolly (/path/*) string

ExcludedPath

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

IncludedPath

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

Indici

Nome Descrizione Valore
dataType Tipo di dati a cui viene applicato il comportamento di indicizzazione. "LineString"
"MultiPolygon"
"Numero"
"Punto"
"Poligono"
"String"
kind Indica il tipo di indice. "Hash"
"Range"
"Spaziale"
precisione Precisione dell'indice. -1 è la precisione massima. INT

SpatialSpec

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

ContainerPartitionKey

Nome Descrizione Valore
kind Indica il tipo di algoritmo utilizzato per il partizionamento. Per MultiHash sono supportate più chiavi di partizione (fino a tre al massimo) per la creazione del contenitore "Hash"
"MultiHash"
"Range"
percorsi Elenco di percorsi che usano i dati all'interno del contenitore che possono essere partizionati string[]
version Indica la versione della definizione della chiave di partizione INT

Vincoli:
Valore minimo = 1
Valore massimo = 2

ResourceRestoreParameters

Nome Descrizione Valore
restoreSource ID dell'account del database ripristinabile da cui deve essere avviato il ripristino. Ad esempio: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Ora in cui è necessario ripristinare l'account (formato ISO-8601). string

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

UniqueKey

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