Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers 2024-09-01-preview

Bicep-resourcedefinitie

Het resourcetype databaseAccounts/sqlDatabases/containers kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-09-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
      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'
            ]
          }
        ]
      }
      materializedViewDefinition: {
        definition: 'string'
        sourceCollectionId: 'string'
      }
      partitionKey: {
        kind: 'string'
        paths: [
          'string'
        ]
        version: int
      }
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
        restoreWithTtlDisabled: bool
      }
      uniqueKeyPolicy: {
        uniqueKeys: [
          {
            paths: [
              'string'
            ]
          }
        ]
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Eigenschapswaarden

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

Instellingen voor automatisch schalen

ClientEncryptionIncludedPath

ClientEncryptionPolicy

Componenten1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Samengesteld pad

Berekend eigendom

Beleid voor conflictoplossing

ContainerPartitionKey

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

UitgeslotenPad

Inbegrepen pad

Indexen

Indexeerbeleid

Beheerde ServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

GematerialiseerdeWeergaveDefinitie

ResourceRestoreParameters

Ruimtelijke specificaties

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

SqlContainerResourceOrSqlContainerGetPropertiesResource

Tags

Unieke sleutel

Uniek sleutelbeleid

Gebruiksvoorbeelden

Azure-snelstartvoorbeelden

De volgende Azure-quickstartsjablonen bicep-voorbeelden bevatten voor het implementeren van dit resourcetype.

Resourcedefinitie van ARM-sjabloon

Het resourcetype databaseAccounts/sqlDatabases/containers kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
  "apiVersion": "2024-09-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",
      "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" ]
          }
        ]
      },
      "materializedViewDefinition": {
        "definition": "string",
        "sourceCollectionId": "string"
      },
      "partitionKey": {
        "kind": "string",
        "paths": [ "string" ],
        "version": "int"
      },
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string",
        "restoreWithTtlDisabled": "bool"
      },
      "uniqueKeyPolicy": {
        "uniqueKeys": [
          {
            "paths": [ "string" ]
          }
        ]
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Eigenschapswaarden

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

Instellingen voor automatisch schalen

ClientEncryptionIncludedPath

ClientEncryptionPolicy

Componenten1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Samengesteld pad

Berekend eigendom

Beleid voor conflictoplossing

ContainerPartitionKey

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

UitgeslotenPad

Inbegrepen pad

Indexen

Indexeerbeleid

Beheerde ServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

GematerialiseerdeWeergaveDefinitie

ResourceRestoreParameters

Ruimtelijke specificaties

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

SqlContainerResourceOrSqlContainerGetPropertiesResource

Tags

Unieke sleutel

Uniek sleutelbeleid

Gebruiksvoorbeelden

Azure-snelstartsjablonen

De volgende Azure-quickstartsjablonen dit resourcetype implementeren.

Sjabloon	Beschrijving
SQL API voor Azure Cosmos DB-account met analytische opslag	Met deze sjabloon maakt u een Azure Cosmos-account voor Core (SQL) API met een database en container die is geconfigureerd met analytische opslag.
Een Gratis Azure Cosmos DB-account maken	Met deze sjabloon maakt u een Gratis Azure Cosmos DB-account voor SQL API met een database met gedeelde doorvoer en container.
Een Azure Cosmos DB-account maken voor Core (SQL) API-	Met deze sjabloon maakt u een Azure Cosmos-account voor Core (SQL) API met een database en container met doorvoer met meerdere andere opties.
Een SQL API voor een Azure Cosmos DB-account maken met automatische schaalaanpassing	Met deze sjabloon maakt u een Azure Cosmos-account voor Core (SQL) API met een database en container met doorvoer voor automatische schaalaanpassing met meerdere andere opties.
Opgeslagen procedures voor azure Cosmos DB Core (SQL) MAKEN	Met deze sjabloon maakt u een Azure Cosmos DB-account voor Core (SQL) API en een container met een opgeslagen procedure, trigger en door de gebruiker gedefinieerde functie.
Maakt een Dapr-microservices-app met container-apps	Een Dapr-microservices-app maken met behulp van Container Apps.
Maakt een Dapr pub-sub servicebus-app met behulp van Container Apps	Maak een Dapr pub-sub servicebus-app met behulp van Container Apps.
Azure Data Explorer DB implementeren met Cosmos DB-verbinding	Azure Data Explorer DB implementeren met Cosmos DB-verbinding.

Resourcedefinitie van Terraform (AzAPI-provider)

Het resourcetype databaseAccounts/sqlDatabases/containers kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-09-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
        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"
              ]
            }
          ]
        }
        materializedViewDefinition = {
          definition = "string"
          sourceCollectionId = "string"
        }
        partitionKey = {
          kind = "string"
          paths = [
            "string"
          ]
          version = int
        }
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
          restoreWithTtlDisabled = bool
        }
        uniqueKeyPolicy = {
          uniqueKeys = [
            {
              paths = [
                "string"
              ]
            }
          ]
        }
      }
    }
  }
}

Eigenschapswaarden

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

Instellingen voor automatisch schalen

ClientEncryptionIncludedPath

ClientEncryptionPolicy

Componenten1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Samengesteld pad

Berekend eigendom

Beleid voor conflictoplossing

ContainerPartitionKey

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

UitgeslotenPad

Inbegrepen pad

Indexen

Indexeerbeleid

Beheerde ServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

GematerialiseerdeWeergaveDefinitie

ResourceRestoreParameters

Ruimtelijke specificaties

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

SqlContainerResourceOrSqlContainerGetPropertiesResource

Tags

Unieke sleutel

Uniek sleutelbeleid

Gebruiksvoorbeelden

Terraform-monsters

Een eenvoudig voorbeeld van het implementeren van SQL Container binnen een Cosmos DB-account.

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