Compartir a través de

Base de datos Microsoft.DocumentDBAccounts/sqlDatabases/containers

  • Artículo

Definición de recursos de Bicep

El tipo de recurso databaseAccounts/sqlDatabases/containers se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-05-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  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'
            ]
          }
        ]
      }
      partitionKey: {
        kind: 'string'
        paths: [
          'string'
        ]
        version: int
      }
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
      }
      uniqueKeyPolicy: {
        uniqueKeys: [
          {
            paths: [
              'string'
            ]
          }
        ]
      }
    }
  }
}

Valores de propiedad

databaseAccounts/sqlDatabases/containers

Nombre Descripción Value
name El nombre del recurso

Vea cómo establecer nombres y tipos para recursos secundarios en Bicep.		 string (obligatorio)
ubicación Ubicación del grupo de recursos al que pertenece el recurso. string
etiquetas Las etiquetas son una lista de pares clave-valor que describen el recurso. Estas etiquetas pueden utilizarse para visualizar y agrupar este recurso a través de grupos de recursos. Se puede proporcionar un máximo de 15 etiquetas para un recurso. Cada etiqueta debe tener una clave no superior a 128 caracteres y un valor no superior a 256 caracteres. Por ejemplo, la experiencia predeterminada para un tipo de plantilla se establece con "defaultExperience": "Cassandra". Los valores actuales "defaultExperience" también incluyen "Table", "Graph", "DocumentDB" y "MongoDB". Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas.
primario En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario.

Para más información, consulte Recurso secundario fuera del recurso primario.		 Nombre simbólico del recurso de tipo: sqlDatabases
properties Propiedades para crear y actualizar el contenedor de Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (obligatorio)

SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...

Nombre Descripción Value
opciones Par clave-valor de las opciones que se aplicarán a la solicitud. Esto corresponde a los encabezados enviados con la solicitud. CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
resource Formato JSON estándar de un contenedor SqlContainerResourceOrSqlContainerGetPropertiesResou... (obligatorio)

CreateUpdateOptionsOrSqlContainerGetPropertiesOption...

Nombre Descripción Valor
autoscaleSettings Especifica la configuración de escalabilidad automática. Nota: Se requiere rendimiento o escalado automáticoConfiguración, pero no ambos. AutoscaleSettings
throughput Unidades de solicitud por segundo. Por ejemplo, "rendimiento": 10000. int

AutoscaleSettings

Nombre Descripción Valor
maxThroughput Representa el rendimiento máximo, el recurso se puede escalar verticalmente. int

SqlContainerResourceOrSqlContainerGetPropertiesResou...

Nombre Descripción Valor
analyticalStorageTtl TTL analítico. int
clientEncryptionPolicy Directiva de cifrado de cliente para el contenedor. ClientEncryptionPolicy
computedProperties Lista de propiedades calculadas ComputedProperty[]
conflictResolutionPolicy Directiva de resolución de conflictos para el contenedor. ConflictResolutionPolicy
createMode Enumeración para indicar el modo de creación de recursos. 'Default'
'Restaurar'
defaultTtl Período de vida predeterminado int
id Nombre del contenedor SQL de Cosmos DB string (obligatorio)
indexingPolicy Configuración de la directiva de indexación. De forma predeterminada, la indexación es automática para todas las rutas de acceso de documento dentro del contenedor. IndexingPolicy
partitionKey Configuración de la clave de partición que se va a usar para crear particiones de datos en varias particiones ContainerPartitionKey
restoreParameters Parámetros para indicar la información sobre la restauración ResourceRestoreParameters
uniqueKeyPolicy Configuración de directiva de clave única para especificar restricciones de unicidad en los documentos de la colección en el servicio Azure Cosmos DB. UniqueKeyPolicy

ClientEncryptionPolicy

Nombre Descripción Valor
includedPaths Rutas de acceso del elemento que necesitan cifrado junto con la configuración específica de la ruta de acceso. ClientEncryptionIncludedPath[] (obligatorio)
policyFormatVersion Versión de la definición de directiva de cifrado de cliente. Las versiones admitidas son 1 y 2. La versión 2 admite el cifrado de ruta de acceso de la clave de partición y el identificador. int (obligatorio)

Restricciones:
Valor mínimo = 1
Valor máximo = 2

ClientEncryptionIncludedPath

Nombre Descripción Valor
clientEncryptionKeyId Identificador de la clave de cifrado de cliente que se va a usar para cifrar la ruta de acceso. string (obligatorio)
encryptionAlgorithm Algoritmo de cifrado que se usará. Por ejemplo, AEAD_AES_256_CBC_HMAC_SHA256. string (obligatorio)
encryptionType Tipo de cifrado que se va a realizar. Por ejemplo: determinista, aleatorio. string (obligatorio)
path Ruta de acceso que debe cifrarse. string (obligatorio)

ComputedProperty

Nombre Descripción Value
name Nombre de una propiedad calculada, por ejemplo: "cp_lowerName" string
Query Consulta que evalúa el valor de la propiedad calculada, por ejemplo: "SELECT VALUE LOWER(c.name) FROM c" string

ConflictResolutionPolicy

Nombre Descripción Valor
conflictResolutionPath Ruta de acceso de resolución de conflictos en el caso del modo LastWriterWins. string
conflictResolutionProcedure Procedimiento para resolver conflictos en el caso del modo personalizado. string
mode Indica el modo de resolución de conflictos. 'Personalizado'
'LastWriterWins'

IndexingPolicy

Nombre Descripción Valor
automatic Indica si la directiva de indexación es automática. bool
compositeIndexes Lista de listas de rutas de acceso compuestas CompositePath[]
excludedPaths Lista de rutas de acceso que se van a excluir de la indexación ExcludedPath[]
includedPaths Lista de rutas de acceso que se van a incluir en la indexación IncludedPath[]
indexingMode Indica el modo de indexación. "coherente"
'diferida'
'none'
spatialIndexes Lista de detalles espaciales SpatialSpec[]

CompositePath

Nombre Descripción Valor
orden Criterio de ordenación de las rutas de acceso compuestas. 'ascendente'
'descendente'
path Ruta de acceso a la que se aplica el comportamiento de indexación. Las rutas de acceso de índice suelen comenzar con raíz y terminar con caracteres comodín (/path/*) string

ExcludedPath

Nombre Descripción Value
path Ruta de acceso a la que se aplica el comportamiento de indexación. Las rutas de acceso de índice suelen comenzar con raíz y terminar con caracteres comodín (/path/*) string

IncludedPath

Nombre Descripción Valor
índices Lista de índices para esta ruta de acceso Índices[]
path Ruta de acceso a la que se aplica el comportamiento de indexación. Las rutas de acceso de índice suelen comenzar con raíz y terminar con caracteres comodín (/path/*) string

Índices

Nombre Descripción Valor
dataType Tipo de datos al que se aplica el comportamiento de indexación. 'LineString'
"MultiPolygon"
'Number'
'Point'
'Polygon'
'String'
kind Indica el tipo de índice. 'Hash'
'Range'
"Espacial"
Precisión Precisión del índice. -1 es la precisión máxima. int

SpatialSpec

Nombre Descripción Value
path Ruta de acceso a la que se aplica el comportamiento de indexación. Las rutas de acceso de índice suelen comenzar con raíz y terminar con caracteres comodín (/path/*) string
types Lista del tipo espacial de la ruta de acceso Matriz de cadenas que contiene cualquiera de:
'LineString'
"MultiPolygon"
'Point'
'Polygon'

ContainerPartitionKey

Nombre Descripción Valor
kind Indica el tipo de algoritmo utilizado para la creación de particiones. Para MultiHash, se admiten varias claves de partición (hasta tres máximos) para la creación de contenedores. 'Hash'
"MultiHash"
'Range'
rutas Lista de rutas de acceso con las que se pueden crear particiones de datos dentro del contenedor string[]
version Indica la versión de la definición de clave de partición. int

Restricciones:
Valor mínimo = 1
Valor máximo = 2

ResourceRestoreParameters

Nombre Descripción Valor
restoreSource Identificador de la cuenta de base de datos restaurable desde la que se debe iniciar la restauración. Por ejemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Hora a la que se debe restaurar la cuenta (formato ISO-8601). string

UniqueKeyPolicy

Nombre Descripción Valor
uniqueKeys Lista de claves únicas en que aplica la restricción de unicidad en los documentos de la colección en el servicio Azure Cosmos DB. UniqueKey[]

UniqueKey

Nombre Descripción Valor
rutas La lista de rutas de acceso debe ser única para cada documento del servicio Azure Cosmos DB. string[]

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla Descripción
Creación de una cuenta de Azure Cosmos DB de nivel gratis

Implementación en Azure		 Esta plantilla crea una cuenta de Azure Cosmos DB de nivel gratuito para SQL API con una base de datos con rendimiento compartido y contenedor.
Creación de una cuenta de Azure Cosmos DB para Core (SQL) API

Implementación en Azure		 Esta plantilla crea una cuenta de Azure Cosmos para Core (SQL) API con una base de datos y un contenedor con rendimiento con varias otras opciones.
API de SQL de la cuenta de Azure Cosmos DB con almacén analítico

Implementación en Azure		 Esta plantilla crea una cuenta de Azure Cosmos para Core (SQL) API con una base de datos y un contenedor configurados con almacén analítico.
Creación de una API de SQL de cuenta de Azure Cosmos DB con escalabilidad automática

Implementación en Azure		 Esta plantilla crea una cuenta de Azure Cosmos para Core (SQL) API con una base de datos y un contenedor con rendimiento de escalabilidad automática con varias otras opciones.
Creación de procedimientos almacenados de la API de Azure Cosmos DB Core (SQL)

Implementación en Azure		 Esta plantilla crea una cuenta de Azure Cosmos DB para Core (SQL) API y un contenedor con un procedimiento almacenado, un desencadenador y una función definida por el usuario.
Implementación de Azure Data Explorer DB con conexión de Cosmos DB

Implementación en Azure		 Implemente Azure Data Explorer DB con la conexión de Cosmos DB.

Definición de recursos de plantilla de ARM

El tipo de recurso databaseAccounts/sqlDatabases/containers se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers, agregue el siguiente JSON a la plantilla.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
  "apiVersion": "2024-05-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "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" ]
          }
        ]
      },
      "partitionKey": {
        "kind": "string",
        "paths": [ "string" ],
        "version": "int"
      },
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string"
      },
      "uniqueKeyPolicy": {
        "uniqueKeys": [
          {
            "paths": [ "string" ]
          }
        ]
      }
    }
  }
}

Valores de propiedad

databaseAccounts/sqlDatabases/containers

Nombre Descripción Value
type Tipo de recurso 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers'
apiVersion La versión de la API de recursos '2024-05-15'
name El nombre del recurso

Vea cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM JSON.		 string (obligatorio)
ubicación Ubicación del grupo de recursos al que pertenece el recurso. string
etiquetas Las etiquetas son una lista de pares clave-valor que describen el recurso. Estas etiquetas pueden utilizarse para visualizar y agrupar este recurso a través de grupos de recursos. Se puede proporcionar un máximo de 15 etiquetas para un recurso. Cada etiqueta debe tener una clave no superior a 128 caracteres y un valor no superior a 256 caracteres. Por ejemplo, la experiencia predeterminada para un tipo de plantilla se establece con "defaultExperience": "Cassandra". Los valores actuales "defaultExperience" también incluyen "Table", "Graph", "DocumentDB" y "MongoDB". Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas.
properties Propiedades para crear y actualizar el contenedor de Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (obligatorio)

SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...

Nombre Descripción Value
opciones Par clave-valor de opciones que se aplicarán a la solicitud. Esto corresponde a los encabezados enviados con la solicitud. CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
resource Formato JSON estándar de un contenedor SqlContainerResourceOrSqlContainerGetPropertiesResou... (obligatorio)

CreateUpdateOptionsOrSqlContainerGetPropertiesOption...

Nombre Descripción Valor
autoscaleSettings Especifica la configuración de escalado automático. Nota: Se requiere el rendimiento o el escalado automáticoConfiguración, pero no ambos. AutoscaleSettings
throughput Unidades de solicitud por segundo. Por ejemplo, "rendimiento": 10000. int

AutoscaleSettings

Nombre Descripción Valor
maxThroughput Representa el rendimiento máximo, el recurso se puede escalar verticalmente. int

SqlContainerResourceOrSqlContainerGetPropertiesResou...

Nombre Descripción Valor
analyticalStorageTtl TTL analítico. int
clientEncryptionPolicy Directiva de cifrado de cliente para el contenedor. ClientEncryptionPolicy
computedProperties Lista de propiedades calculadas ComputedProperty[]
conflictResolutionPolicy Directiva de resolución de conflictos para el contenedor. ConflictResolutionPolicy
createMode Enumeración para indicar el modo de creación de recursos. 'Default'
'Restaurar'
defaultTtl Período de vida predeterminado int
id Nombre del contenedor SQL de Cosmos DB string (obligatorio)
indexingPolicy Configuración de la directiva de indexación. De forma predeterminada, la indexación es automática para todas las rutas de acceso de documento dentro del contenedor. IndexingPolicy
partitionKey Configuración de la clave de partición que se va a usar para crear particiones de datos en varias particiones ContainerPartitionKey
restoreParameters Parámetros para indicar la información sobre la restauración ResourceRestoreParameters
uniqueKeyPolicy Configuración de directiva de clave única para especificar restricciones de unicidad en los documentos de la colección en el servicio Azure Cosmos DB. UniqueKeyPolicy

ClientEncryptionPolicy

Nombre Descripción Valor
includedPaths Rutas de acceso del elemento que necesitan cifrado junto con la configuración específica de la ruta de acceso. ClientEncryptionIncludedPath[] (obligatorio)
policyFormatVersion Versión de la definición de directiva de cifrado de cliente. Las versiones admitidas son 1 y 2. La versión 2 admite el cifrado de ruta de acceso de la clave de partición y el identificador. int (obligatorio)

Restricciones:
Valor mínimo = 1
Valor máximo = 2

ClientEncryptionIncludedPath

Nombre Descripción Valor
clientEncryptionKeyId Identificador de la clave de cifrado de cliente que se va a usar para cifrar la ruta de acceso. string (obligatorio)
encryptionAlgorithm Algoritmo de cifrado que se usará. Por ejemplo, AEAD_AES_256_CBC_HMAC_SHA256. string (obligatorio)
encryptionType Tipo de cifrado que se va a realizar. Por ejemplo: determinista, aleatorio. string (obligatorio)
path Ruta de acceso que debe cifrarse. string (obligatorio)

ComputedProperty

Nombre Descripción Value
name Nombre de una propiedad calculada, por ejemplo: "cp_lowerName" string
Query Consulta que evalúa el valor de la propiedad calculada, por ejemplo: "SELECT VALUE LOWER(c.name) FROM c" string

ConflictResolutionPolicy

Nombre Descripción Valor
conflictResolutionPath Ruta de acceso de resolución de conflictos en el caso del modo LastWriterWins. string
conflictResolutionProcedure Procedimiento para resolver conflictos en el caso del modo personalizado. string
mode Indica el modo de resolución de conflictos. 'Personalizado'
'LastWriterWins'

IndexingPolicy

Nombre Descripción Valor
automatic Indica si la directiva de indexación es automática. bool
compositeIndexes Lista de listas de rutas de acceso compuestas CompositePath[]
excludedPaths Lista de rutas de acceso que se van a excluir de la indexación ExcludedPath[]
includedPaths Lista de rutas de acceso que se van a incluir en la indexación IncludedPath[]
indexingMode Indica el modo de indexación. "coherente"
'diferida'
'none'
spatialIndexes Lista de detalles espaciales SpatialSpec[]

CompositePath

Nombre Descripción Valor
orden Criterio de ordenación de las rutas de acceso compuestas. 'ascendente'
'descendente'
path Ruta de acceso a la que se aplica el comportamiento de indexación. Las rutas de acceso de índice suelen comenzar con raíz y terminar con caracteres comodín (/path/*) string

ExcludedPath

Nombre Descripción Value
path Ruta de acceso a la que se aplica el comportamiento de indexación. Las rutas de acceso de índice suelen comenzar con raíz y terminar con caracteres comodín (/path/*) string

IncludedPath

Nombre Descripción Valor
índices Lista de índices para esta ruta de acceso Índices[]
path Ruta de acceso a la que se aplica el comportamiento de indexación. Las rutas de acceso de índice suelen comenzar con raíz y terminar con caracteres comodín (/path/*) string

Índices

Nombre Descripción Valor
dataType Tipo de datos al que se aplica el comportamiento de indexación. 'LineString'
"MultiPolygon"
'Number'
'Point'
'Polygon'
'String'
kind Indica el tipo de índice. 'Hash'
'Range'
"Espacial"
Precisión Precisión del índice. -1 es la precisión máxima. int

SpatialSpec

Nombre Descripción Value
path Ruta de acceso a la que se aplica el comportamiento de indexación. Normalmente, las rutas de acceso de índice comienzan con raíz y terminan con caracteres comodín (/path/*) string
types Lista del tipo espacial de la ruta de acceso Matriz de cadenas que contiene cualquiera de:
'LineString'
'MultiPolygon'
'Point'
'Polígono'

ContainerPartitionKey

Nombre Descripción Valor
kind Indica el tipo de algoritmo utilizado para la creación de particiones. Para MultiHash, se admiten varias claves de partición (hasta tres máximos) para la creación de contenedores. 'Hash'
"MultiHash"
'Range'
rutas Lista de rutas de acceso con las que se pueden crear particiones de datos dentro del contenedor string[]
version Indica la versión de la definición de clave de partición. int

Restricciones:
Valor mínimo = 1
Valor máximo = 2

ResourceRestoreParameters

Nombre Descripción Valor
restoreSource Identificador de la cuenta de base de datos restaurable desde la que se debe iniciar la restauración. Por ejemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Hora a la que se debe restaurar la cuenta (formato ISO-8601). string

UniqueKeyPolicy

Nombre Descripción Valor
uniqueKeys Lista de claves únicas en que aplica la restricción de unicidad en los documentos de la colección en el servicio Azure Cosmos DB. UniqueKey[]

UniqueKey

Nombre Descripción Valor
rutas La lista de rutas de acceso debe ser única para cada documento del servicio Azure Cosmos DB. string[]

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla Descripción
Creación de una cuenta de Azure Cosmos DB de nivel gratis

Implementación en Azure		 Esta plantilla crea una cuenta de Azure Cosmos DB de nivel gratuito para SQL API con una base de datos con rendimiento compartido y contenedor.
Creación de una cuenta de Azure Cosmos DB para Core (SQL) API

Implementación en Azure		 Esta plantilla crea una cuenta de Azure Cosmos para Core (SQL) API con una base de datos y un contenedor con rendimiento con varias otras opciones.
API de SQL de la cuenta de Azure Cosmos DB con almacén analítico

Implementación en Azure		 Esta plantilla crea una cuenta de Azure Cosmos para Core (SQL) API con una base de datos y un contenedor configurados con almacén analítico.
Creación de una API de SQL de cuenta de Azure Cosmos DB con escalabilidad automática

Implementación en Azure		 Esta plantilla crea una cuenta de Azure Cosmos para Core (SQL) API con una base de datos y un contenedor con rendimiento de escalabilidad automática con varias otras opciones.
Creación de procedimientos almacenados de la API de Azure Cosmos DB Core (SQL)

Implementación en Azure		 Esta plantilla crea una cuenta de Azure Cosmos DB para Core (SQL) API y un contenedor con un procedimiento almacenado, un desencadenador y una función definida por el usuario.
Implementación de Azure Data Explorer DB con conexión de Cosmos DB

Implementación en Azure		 Implemente Azure Data Explorer DB con la conexión de Cosmos DB.

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso databaseAccounts/sqlDatabases/containers se puede implementar con operaciones destinadas a:

  • Grupos de recursos

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-05-15"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    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"
              ]
            }
          ]
        }
        partitionKey = {
          kind = "string"
          paths = [
            "string"
          ]
          version = int
        }
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
        }
        uniqueKeyPolicy = {
          uniqueKeys = [
            {
              paths = [
                "string"
              ]
            }
          ]
        }
      }
    }
  })
}

Valores de propiedad

databaseAccounts/sqlDatabases/containers

Nombre Descripción Value
type Tipo de recurso "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-05-15"
name El nombre del recurso string (obligatorio)
ubicación Ubicación del grupo de recursos al que pertenece el recurso. string
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: sqlDatabases
etiquetas Las etiquetas son una lista de pares clave-valor que describen el recurso. Estas etiquetas pueden utilizarse para visualizar y agrupar este recurso a través de grupos de recursos. Se puede proporcionar un máximo de 15 etiquetas para un recurso. Cada etiqueta debe tener una clave no superior a 128 caracteres y un valor no superior a 256 caracteres. Por ejemplo, la experiencia predeterminada para un tipo de plantilla se establece con "defaultExperience": "Cassandra". Los valores actuales "defaultExperience" también incluyen "Table", "Graph", "DocumentDB" y "MongoDB". Diccionario de nombres y valores de etiqueta.
properties Propiedades para crear y actualizar el contenedor de Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (obligatorio)

SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...

Nombre Descripción Value
opciones Par clave-valor de opciones que se aplicarán a la solicitud. Esto corresponde a los encabezados enviados con la solicitud. CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
resource Formato JSON estándar de un contenedor SqlContainerResourceOrSqlContainerGetPropertiesResou... (obligatorio)

CreateUpdateOptionsOrSqlContainerGetPropertiesOption...

Nombre Descripción Valor
autoscaleSettings Especifica la configuración de escalado automático. Nota: Se requiere el rendimiento o el escalado automáticoConfiguración, pero no ambos. AutoscaleSettings
throughput Unidades de solicitud por segundo. Por ejemplo, "rendimiento": 10000. int

AutoscaleSettings

Nombre Descripción Valor
maxThroughput Representa el rendimiento máximo, el recurso se puede escalar verticalmente. int

SqlContainerResourceOrSqlContainerGetPropertiesResou...

Nombre Descripción Valor
analyticalStorageTtl TTL analítico. int
clientEncryptionPolicy Directiva de cifrado de cliente para el contenedor. ClientEncryptionPolicy
computedProperties Lista de propiedades calculadas ComputedProperty[]
conflictResolutionPolicy Directiva de resolución de conflictos para el contenedor. ConflictResolutionPolicy
createMode Enumeración para indicar el modo de creación de recursos. "Valor predeterminado"
"Restaurar"
defaultTtl Período de vida predeterminado int
id Nombre del contenedor SQL de Cosmos DB string (obligatorio)
indexingPolicy Configuración de la directiva de indexación. De forma predeterminada, la indexación es automática para todas las rutas de acceso de documento dentro del contenedor. IndexingPolicy
partitionKey Configuración de la clave de partición que se va a usar para crear particiones de datos en varias particiones ContainerPartitionKey
restoreParameters Parámetros para indicar la información sobre la restauración ResourceRestoreParameters
uniqueKeyPolicy Configuración de directiva de clave única para especificar restricciones de unicidad en los documentos de la colección en el servicio Azure Cosmos DB. UniqueKeyPolicy

ClientEncryptionPolicy

Nombre Descripción Valor
includedPaths Rutas de acceso del elemento que necesitan cifrado junto con la configuración específica de la ruta de acceso. ClientEncryptionIncludedPath[] (obligatorio)
policyFormatVersion Versión de la definición de directiva de cifrado de cliente. Las versiones admitidas son 1 y 2. La versión 2 admite el cifrado de ruta de acceso de la clave de partición y el identificador. int (obligatorio)

Restricciones:
Valor mínimo = 1
Valor máximo = 2

ClientEncryptionIncludedPath

Nombre Descripción Valor
clientEncryptionKeyId Identificador de la clave de cifrado de cliente que se va a usar para cifrar la ruta de acceso. string (obligatorio)
encryptionAlgorithm Algoritmo de cifrado que se usará. Por ejemplo, AEAD_AES_256_CBC_HMAC_SHA256. string (obligatorio)
encryptionType Tipo de cifrado que se va a realizar. Por ejemplo- Determinista, Aleatorio. string (obligatorio)
path Ruta de acceso que debe cifrarse. string (obligatorio)

ComputedProperty

Nombre Descripción Value
name Nombre de una propiedad calculada, por ejemplo: "cp_lowerName" string
Query Consulta que evalúa el valor de la propiedad calculada, por ejemplo: "SELECT VALUE LOWER(c.name) FROM c" string

ConflictResolutionPolicy

Nombre Descripción Valor
conflictResolutionPath Ruta de acceso de resolución de conflictos en el caso del modo LastWriterWins. string
conflictResolutionProcedure Procedimiento para resolver conflictos en el caso del modo personalizado. string
mode Indica el modo de resolución de conflictos. "Custom"
"LastWriterWins"

IndexingPolicy

Nombre Descripción Valor
automatic Indica si la directiva de indexación es automática. bool
compositeIndexes Lista de listas de rutas de acceso compuestas CompositePath[]
excludedPaths Lista de rutas de acceso que se van a excluir de la indexación ExcludedPath[]
includedPaths Lista de rutas de acceso que se van a incluir en la indexación IncludedPath[]
indexingMode Indica el modo de indexación. "coherente"
"diferida"
"none"
spatialIndexes Lista de detalles espaciales SpatialSpec[]

CompositePath

Nombre Descripción Valor
orden Criterio de ordenación de las rutas de acceso compuestas. "ascendente"
"descendente"
path Ruta de acceso a la que se aplica el comportamiento de indexación. Las rutas de acceso de índice suelen comenzar con raíz y terminar con caracteres comodín (/path/*) string

ExcludedPath

Nombre Descripción Value
path Ruta de acceso a la que se aplica el comportamiento de indexación. Las rutas de acceso de índice suelen comenzar con raíz y terminar con caracteres comodín (/path/*) string

IncludedPath

Nombre Descripción Valor
índices Lista de índices para esta ruta de acceso Índices[]
path Ruta de acceso a la que se aplica el comportamiento de indexación. Las rutas de acceso de índice suelen comenzar con raíz y terminar con caracteres comodín (/path/*) string

Índices

Nombre Descripción Valor
dataType Tipo de datos al que se aplica el comportamiento de indexación. "LineString"
"MultiPolygon"
"Número"
"Point"
"Polígono"
"String"
kind Indica el tipo de índice. "Hash"
"Rango"
"Espacial"
Precisión Precisión del índice. -1 es la precisión máxima. int

SpatialSpec

Nombre Descripción Value
path Ruta de acceso a la que se aplica el comportamiento de indexación. Las rutas de acceso de índice suelen comenzar con raíz y terminar con caracteres comodín (/path/*) string
types Lista del tipo espacial de la ruta de acceso Matriz de cadenas que contiene cualquiera de:
"LineString"
"MultiPolygon"
"Point"
"Polígono"

ContainerPartitionKey

Nombre Descripción Valor
kind Indica el tipo de algoritmo utilizado para la creación de particiones. Para MultiHash, se admiten varias claves de partición (hasta tres máximos) para la creación de contenedores. "Hash"
"MultiHash"
"Rango"
rutas Lista de rutas de acceso mediante las que se pueden crear particiones de datos dentro del contenedor string[]
version Indica la versión de la definición de clave de partición. int

Restricciones:
Valor mínimo = 1
Valor máximo = 2

ResourceRestoreParameters

Nombre Descripción Valor
restoreSource Identificador de la cuenta de base de datos restaurable desde la que se debe iniciar la restauración. Por ejemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Hora a la que se debe restaurar la cuenta (formato ISO-8601). string

UniqueKeyPolicy

Nombre Descripción Valor
uniqueKeys Lista de claves únicas en las que aplica la restricción de unicidad en los documentos de la colección en el servicio Azure Cosmos DB. UniqueKey[]

UniqueKey

Nombre Descripción Valor
rutas La lista de rutas de acceso debe ser única para cada documento del servicio Azure Cosmos DB. string[]