Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers

Bicep-resursdefinition

Resurstypen databaseAccounts/sqlDatabases/containers kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers-resurs lägger du till följande Bicep i mallen.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2025-05-01-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  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
      fullTextPolicy: {
        defaultLanguage: 'string'
        fullTextPaths: [
          {
            language: 'string'
            path: 'string'
          }
        ]
      }
      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'
          }
        ]
      }
      materializedViewDefinition: {
        definition: 'string'
        sourceCollectionId: 'string'
      }
      materializedViews: [
        {
          id: 'string'
          _rid: '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'
  }
}

Egenskapsvärden

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

AutoskalningInställningar

ClientEncryptionIncludedPath (på engelska)

ClientEncryptionPolicy (på engelska)

Komponenter1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

CompositePath

ComputedProperty (beräknad)

Konfliktlösningspolicy

ContainerPartitionKey (på engelska)

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

ExcludedPath (Utesluten)

FullTextPath

FullTextPolicy

InkluderadSökväg

Index

Indexeringspolicy

ManagedServiceIdentity (HanteradServiceIdentitet)

ManagedServiceIdentityUserAssignedIdentiteter

MaterializedViewDefinition (på engelska)

MaterializedViewDetails (på engelska)

ResourceRestoreParameters (på engelska)

SpatialSpec (på engelska)

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

SqlContainerResourceOrSqlContainerGetPropertiesResource

Taggar

UniqueKey (Unik nyckel)

UniqueKeyPolicy (på engelska)

Vektor Inbäddning

VectorEmbeddingPolicy (på engelska)

Vektorindex

Användningsexempel

Azure-snabbstartsexempel

Följande Azure-snabbstartsmallar innehålla Bicep-exempel för distribution av den här resurstypen.

Resursdefinition för ARM-mall

Resurstypen databaseAccounts/sqlDatabases/containers kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers-resurs lägger du till följande JSON i mallen.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
  "apiVersion": "2025-05-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "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",
      "fullTextPolicy": {
        "defaultLanguage": "string",
        "fullTextPaths": [
          {
            "language": "string",
            "path": "string"
          }
        ]
      },
      "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"
          }
        ]
      },
      "materializedViewDefinition": {
        "definition": "string",
        "sourceCollectionId": "string"
      },
      "materializedViews": [
        {
          "id": "string",
          "_rid": "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"
  }
}

Egenskapsvärden

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

AutoskalningInställningar

ClientEncryptionIncludedPath (på engelska)

ClientEncryptionPolicy (på engelska)

Komponenter1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

CompositePath

ComputedProperty (beräknad)

Konfliktlösningspolicy

ContainerPartitionKey (på engelska)

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

ExcludedPath (Utesluten)

FullTextPath

FullTextPolicy

InkluderadSökväg

Index

Indexeringspolicy

ManagedServiceIdentity (HanteradServiceIdentitet)

ManagedServiceIdentityUserAssignedIdentiteter

MaterializedViewDefinition (på engelska)

MaterializedViewDetails (på engelska)

ResourceRestoreParameters (på engelska)

SpatialSpec (på engelska)

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

SqlContainerResourceOrSqlContainerGetPropertiesResource

Taggar

UniqueKey (Unik nyckel)

UniqueKeyPolicy (på engelska)

Vektor Inbäddning

VectorEmbeddingPolicy (på engelska)

Vektorindex

Användningsexempel

Azure-snabbstartsmallar

Följande Azure-snabbstartsmallar distribuera den här resurstypen.

Mall	Beskrivning
SQL API för Azure Cosmos DB-konto med analysarkiv	Den här mallen skapar ett Azure Cosmos-konto för Core (SQL) API med en databas och container som konfigurerats med analysarkivet.
Skapa ett Azure Cosmos DB-konto på kostnadsfri nivå	Den här mallen skapar ett Azure Cosmos DB-konto på den kostnadsfria nivån för SQL API med en databas med delat dataflöde och en container.
Skapa ett Azure Cosmos DB-konto för Core (SQL) API	Den här mallen skapar ett Azure Cosmos-konto för Core -API (SQL) med en databas och container med dataflöde med flera andra alternativ.
Skapa ett SQL-API för Azure Cosmos DB-konto med autoskalning	Den här mallen skapar ett Azure Cosmos-konto för Core (SQL) API med en databas och container med autoskalningsdataflöde med flera andra alternativ.
Skapa azure Cosmos DB Core-API-lagrade procedurer (SQL)	Den här mallen skapar ett Azure Cosmos DB-konto för Core -API (SQL) och en container med en lagrad procedur, utlösare och användardefinierad funktion.
Skapar en Dapr-mikrotjänstapp med containerappar	Skapa en Dapr-mikrotjänstapp med containerappar.
Skapar en Dapr pub-sub servicebus-app med containerappar	Skapa en Dapr pub-sub servicebus-app med containerappar.
Distribuera Azure Data Explorer DB med Cosmos DB-anslutning	Distribuera Azure Data Explorer DB med Cosmos DB-anslutning.

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen databaseAccounts/sqlDatabases/containers kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers-resurs lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2025-05-01-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "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
        fullTextPolicy = {
          defaultLanguage = "string"
          fullTextPaths = [
            {
              language = "string"
              path = "string"
            }
          ]
        }
        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"
            }
          ]
        }
        materializedViewDefinition = {
          definition = "string"
          sourceCollectionId = "string"
        }
        materializedViews = [
          {
            id = "string"
            _rid = "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"
            }
          ]
        }
      }
    }
  }
}

Egenskapsvärden

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

AutoskalningInställningar

ClientEncryptionIncludedPath (på engelska)

ClientEncryptionPolicy (på engelska)

Komponenter1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

CompositePath

ComputedProperty (beräknad)

Konfliktlösningspolicy

ContainerPartitionKey (på engelska)

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

ExcludedPath (Utesluten)

FullTextPath

FullTextPolicy

InkluderadSökväg

Index

Indexeringspolicy

ManagedServiceIdentity (HanteradServiceIdentitet)

ManagedServiceIdentityUserAssignedIdentiteter

MaterializedViewDefinition (på engelska)

MaterializedViewDetails (på engelska)

ResourceRestoreParameters (på engelska)

SpatialSpec (på engelska)

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

SqlContainerResourceOrSqlContainerGetPropertiesResource

Taggar

UniqueKey (Unik nyckel)

UniqueKeyPolicy (på engelska)

Vektor Inbäddning

VectorEmbeddingPolicy (på engelska)

Vektorindex

Användningsexempel

Terraform-exempel

Ett grundläggande exempel på hur du distribuerar SQL Container i ett Cosmos DB-konto.

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    = ["*"]
}