Delen via


Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers 2024-12-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-12-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'
            ]
          }
        ]
        vectorIndexes: [
          {
            path: 'string'
            type: 'string'
          }
        ]
      }
      materializedViewDefinition: {
        definition: 'string'
        sourceCollectionId: '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'
  }
}

Eigenschapswaarden

AutoscaleSettings

Naam Beschrijving Waarde
maxThroughput Vertegenwoordigt de maximale doorvoer, de resource kan omhoog worden geschaald. Int

ClientEncryptionIncludedPath

Naam Beschrijving Waarde
clientEncryptionKeyId De id van de clientversleutelingssleutel die moet worden gebruikt om het pad te versleutelen. tekenreeks (vereist)
encryptionAlgorithm Het versleutelingsalgoritmen dat wordt gebruikt. Bijvoorbeeld- AEAD_AES_256_CBC_HMAC_SHA256. tekenreeks (vereist)
encryptionType Het type versleuteling dat moet worden uitgevoerd. Bijvoorbeeld: deterministisch, gerandomiseerd. tekenreeks (vereist)
pad Pad dat moet worden versleuteld. tekenreeks (vereist)

ClientEncryptionPolicy

Naam Beschrijving Waarde
includedPaths Paden van het item dat versleuteling nodig heeft, samen met padspecifieke instellingen. ClientEncryptionIncludedPath[] (vereist)
policyFormatVersion Versie van de definitie van het clientversleutelingsbeleid. Ondersteunde versies zijn 1 en 2. Versie 2 ondersteunt versleuteling van id- en partitiesleutelpaden. Int

Beperkingen:
Minimumwaarde = 1
Maximumwaarde = 2 (vereist)

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Naam Beschrijving Waarde

CompositePath

Naam Beschrijving Waarde
bevelen Sorteervolgorde voor samengestelde paden. 'oplopend'
'aflopend'
pad Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met jokertekens (/pad/*) snaar

ComputedProperty

Naam Beschrijving Waarde
naam De naam van een berekende eigenschap, bijvoorbeeld 'cp_lowerName' snaar
vraag De query waarmee de waarde voor de berekende eigenschap wordt geëvalueerd, bijvoorbeeld 'SELECT VALUE LOWER(c.name) FROM c' snaar

ConflictResolutionPolicy

Naam Beschrijving Waarde
conflictResolutionPath Het pad naar conflictoplossing in het geval van de LastWriterWins-modus. snaar
conflictResolutionProcedure De procedure voor het oplossen van conflicten in het geval van aangepaste modus. snaar
wijze Geeft de conflictoplossingsmodus aan. 'Aangepast'
'LastWriterWins'

ContainerPartitionKey

Naam Beschrijving Waarde
soort Geeft het type algoritme aan dat wordt gebruikt voor partitionering. Voor MultiHash worden meerdere partitiesleutels (maximaal drie maximum) ondersteund voor het maken van containers 'Hash'
'MultiHash'
'Bereik'
Paden Lijst met paden waarmee gegevens in de container kunnen worden gepartitioneerd tekenreeks[]
Versie Geeft de versie van de definitie van de partitiesleutel aan Int

Beperkingen:
Minimumwaarde = 1
Maximumwaarde = 2

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

Naam Beschrijving Waarde
autoscaleSettings Hiermee geeft u de instellingen voor automatisch schalen. Opmerking: doorvoer of autoscaleSettings is vereist, maar niet beide. AutoscaleSettings
Doorvoer Aanvraageenheden per seconde. Bijvoorbeeld 'doorvoer': 10000. Int

ExcludedPath

Naam Beschrijving Waarde
pad Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met jokertekens (/pad/*) snaar

IncludedPath

Naam Beschrijving Waarde
Indexen Lijst met indexen voor dit pad indexen[]
pad Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met jokertekens (/pad/*) snaar

Indexen

Naam Beschrijving Waarde
Datatype Het gegevenstype waarop het indexeringsgedrag wordt toegepast. 'LineString'
'MultiPolygon'
'Getal'
'Punt'
'Veelhoek'
'Tekenreeks'
soort Geeft het type index aan. 'Hash'
'Bereik'
'Ruimtelijk'
precisie De precisie van de index. -1 is maximale precisie. Int

IndexingPolicy

Naam Beschrijving Waarde
Automatisch Geeft aan of het indexeringsbeleid automatisch is Bool
compositeIndexes Lijst met samengestelde padlijst CompositePath[][]
excludedPaths Lijst met paden die moeten worden uitgesloten van indexering ExcludedPath[]
includedPaths Lijst met paden die moeten worden opgenomen in de indexering IncludedPath-[]
indexingMode Geeft de indexeringsmodus aan. 'consistent'
'luie'
'geen'
spatialIndexes Lijst met ruimtelijke gegevens SpatialSpec[]
vectorIndexen Lijst met paden die moeten worden opgenomen in de vectorindexering VectorIndex[]

ManagedServiceIdentity

Naam Beschrijving Waarde
type Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None worden alle identiteiten uit de service verwijderd. 'Geen'
'SystemAssigned'
'SystemAssigned, UserAssigned'
UserAssigned
userAssignedIdentities De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen voor de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Naam Beschrijving Waarde

MaterializedViewDefinition

Naam Beschrijving Waarde
definitie De definitie moet een SQL-query zijn die wordt gebruikt om gegevens op te halen uit de broncontainer om deze in te vullen in de container Gerealiseerde weergave. tekenreeks (vereist)
sourceCollectionId De naam van de broncontainer waarop de gerealiseerde weergave wordt gemaakt. tekenreeks (vereist)

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

Naam Beschrijving Waarde
identiteit Identiteit voor de resource. ManagedServiceIdentity-
plaats De locatie van de resourcegroep waartoe de resource behoort. snaar
naam De resourcenaam tekenreeks (vereist)
ouder In Bicep kunt u de bovenliggende resource voor een onderliggende resource opgeven. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd.

Zie onderliggende resource buiten de bovenliggende resourcevoor meer informatie.
Symbolische naam voor resource van het type: databaseAccounts/sqlDatabases
Eigenschappen Eigenschappen voor het maken en bijwerken van azure Cosmos DB-container. SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (vereist)
Tags Resourcetags Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen

ResourceRestoreParameters

Naam Beschrijving Waarde
restoreSource De id van het herstelbare databaseaccount van waaruit het herstel moet worden gestart. Bijvoorbeeld: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} snaar
restoreTimestampInUtc Tijd waarop het account moet worden hersteld (ISO-8601-indeling). snaar
restoreWithTtlDisabled Hiermee geeft u op of het herstelde account tijd-To-Live uitgeschakeld bij het herstellen. Bool

SpatialSpec

Naam Beschrijving Waarde
pad Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met jokertekens (/pad/*) snaar
Typen Lijst met het ruimtelijke type pad Tekenreeksmatrix met een van de volgende waarden:
'LineString'
'MultiPolygon'
'Punt'
'Veelhoek'

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

Naam Beschrijving Waarde
Opties Een sleutel-waardepaar met opties die moeten worden toegepast voor de aanvraag. Dit komt overeen met de headers die met de aanvraag zijn verzonden. CreateUpdateOptionsOrSqlContainerGetPropertiesOptions-
hulpbron De standaard JSON-indeling van een container SqlContainerResourceOrSqlContainerGetPropertiesResource (vereist)

SqlContainerResourceOrSqlContainerGetPropertiesResource

Naam Beschrijving Waarde
analyticalStorageTtl Analytische TTL. Int
clientEncryptionPolicy Het clientversleutelingsbeleid voor de container. ClientEncryptionPolicy-
computedProperties Lijst met berekende eigenschappen ComputedProperty[]
conflictResolutionPolicy Het conflictoplossingsbeleid voor de container. ConflictResolutionPolicy-
createMode Opsomming om de modus voor het maken van resources aan te geven. 'Standaard'
'Herstellen'
defaultTtl Standaardtijd tot leven Int
legitimatiebewijs Naam van de Cosmos DB SQL-container tekenreeks (vereist)
indexingPolicy De configuratie van het indexeringsbeleid. De indexering is standaard automatisch voor alle documentpaden in de container IndexingPolicy-
materializedViewDefinition De configuratie voor het definiëren van gerealiseerde weergaven. Dit moet alleen worden opgegeven voor het maken van een gerealiseerde weergavecontainer. MaterializedViewDefinition-
partitionKey De configuratie van de partitiesleutel die moet worden gebruikt voor het partitioneren van gegevens in meerdere partities ContainerPartitionKey
restoreParameters Parameters om de informatie over de herstelbewerking aan te geven ResourceRestoreParameters
uniqueKeyPolicy De configuratie van het unieke sleutelbeleid voor het opgeven van beperkingen voor uniekheid voor documenten in de verzameling in de Azure Cosmos DB-service. UniqueKeyPolicy-
vectorEmbeddingPolicy Het beleid voor het insluiten van vectoren voor de container. VectorEmbeddingPolicy-

Tags

Naam Beschrijving Waarde

UniqueKey

Naam Beschrijving Waarde
Paden Lijst met paden moet uniek zijn voor elk document in de Azure Cosmos DB-service tekenreeks[]

UniqueKeyPolicy

Naam Beschrijving Waarde
uniqueKeys Lijst met unieke sleutels waarmee een beperking voor uniekheid wordt afgedwongen voor documenten in de verzameling in de Azure Cosmos DB-service. UniqueKey[]

VectorEmbedding

Naam Beschrijving Waarde
Datatype Geeft het gegevenstype van vector aan. 'float32'
'int8'
uint8 (vereist)
Dimensies Het aantal dimensies in de vector. int (vereist)
distanceFunction De afstandsfunctie die moet worden gebruikt voor de berekening van de afstand tussen vectoren. 'cosinus'
"dotproduct"
"euclidean" (vereist)
pad Het pad naar het vectorveld in het document. tekenreeks (vereist)

VectorEmbeddingPolicy

Naam Beschrijving Waarde
vectorEmbeddings Lijst met vector insluitingen VectorEmbedding[]

VectorIndex

Naam Beschrijving Waarde
pad Het pad naar het vectorveld in het document. tekenreeks (vereist)
type Het indextype van de vector. Momenteel worden flat, diskANN en quantizedFlat ondersteund. 'diskANN'
'plat'
'quantizedFlat' (vereist)

Quickstart-voorbeelden

In de volgende quickstartvoorbeelden wordt dit resourcetype geïmplementeerd.

Bicep-bestand 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 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-12-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" ]
          }
        ],
        "vectorIndexes": [
          {
            "path": "string",
            "type": "string"
          }
        ]
      },
      "materializedViewDefinition": {
        "definition": "string",
        "sourceCollectionId": "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"
  }
}

Eigenschapswaarden

AutoscaleSettings

Naam Beschrijving Waarde
maxThroughput Vertegenwoordigt de maximale doorvoer, de resource kan omhoog worden geschaald. Int

ClientEncryptionIncludedPath

Naam Beschrijving Waarde
clientEncryptionKeyId De id van de clientversleutelingssleutel die moet worden gebruikt om het pad te versleutelen. tekenreeks (vereist)
encryptionAlgorithm Het versleutelingsalgoritmen dat wordt gebruikt. Bijvoorbeeld- AEAD_AES_256_CBC_HMAC_SHA256. tekenreeks (vereist)
encryptionType Het type versleuteling dat moet worden uitgevoerd. Bijvoorbeeld: deterministisch, gerandomiseerd. tekenreeks (vereist)
pad Pad dat moet worden versleuteld. tekenreeks (vereist)

ClientEncryptionPolicy

Naam Beschrijving Waarde
includedPaths Paden van het item dat versleuteling nodig heeft, samen met padspecifieke instellingen. ClientEncryptionIncludedPath[] (vereist)
policyFormatVersion Versie van de definitie van het clientversleutelingsbeleid. Ondersteunde versies zijn 1 en 2. Versie 2 ondersteunt versleuteling van id- en partitiesleutelpaden. Int

Beperkingen:
Minimumwaarde = 1
Maximumwaarde = 2 (vereist)

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Naam Beschrijving Waarde

CompositePath

Naam Beschrijving Waarde
bevelen Sorteervolgorde voor samengestelde paden. 'oplopend'
'aflopend'
pad Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met jokertekens (/pad/*) snaar

ComputedProperty

Naam Beschrijving Waarde
naam De naam van een berekende eigenschap, bijvoorbeeld 'cp_lowerName' snaar
vraag De query waarmee de waarde voor de berekende eigenschap wordt geëvalueerd, bijvoorbeeld 'SELECT VALUE LOWER(c.name) FROM c' snaar

ConflictResolutionPolicy

Naam Beschrijving Waarde
conflictResolutionPath Het pad naar conflictoplossing in het geval van de LastWriterWins-modus. snaar
conflictResolutionProcedure De procedure voor het oplossen van conflicten in het geval van aangepaste modus. snaar
wijze Geeft de conflictoplossingsmodus aan. 'Aangepast'
'LastWriterWins'

ContainerPartitionKey

Naam Beschrijving Waarde
soort Geeft het type algoritme aan dat wordt gebruikt voor partitionering. Voor MultiHash worden meerdere partitiesleutels (maximaal drie maximum) ondersteund voor het maken van containers 'Hash'
'MultiHash'
'Bereik'
Paden Lijst met paden waarmee gegevens in de container kunnen worden gepartitioneerd tekenreeks[]
Versie Geeft de versie van de definitie van de partitiesleutel aan Int

Beperkingen:
Minimumwaarde = 1
Maximumwaarde = 2

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

Naam Beschrijving Waarde
autoscaleSettings Hiermee geeft u de instellingen voor automatisch schalen. Opmerking: doorvoer of autoscaleSettings is vereist, maar niet beide. AutoscaleSettings
Doorvoer Aanvraageenheden per seconde. Bijvoorbeeld 'doorvoer': 10000. Int

ExcludedPath

Naam Beschrijving Waarde
pad Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met jokertekens (/pad/*) snaar

IncludedPath

Naam Beschrijving Waarde
Indexen Lijst met indexen voor dit pad indexen[]
pad Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met jokertekens (/pad/*) snaar

Indexen

Naam Beschrijving Waarde
Datatype Het gegevenstype waarop het indexeringsgedrag wordt toegepast. 'LineString'
'MultiPolygon'
'Getal'
'Punt'
'Veelhoek'
'Tekenreeks'
soort Geeft het type index aan. 'Hash'
'Bereik'
'Ruimtelijk'
precisie De precisie van de index. -1 is maximale precisie. Int

IndexingPolicy

Naam Beschrijving Waarde
Automatisch Geeft aan of het indexeringsbeleid automatisch is Bool
compositeIndexes Lijst met samengestelde padlijst CompositePath[][]
excludedPaths Lijst met paden die moeten worden uitgesloten van indexering ExcludedPath[]
includedPaths Lijst met paden die moeten worden opgenomen in de indexering IncludedPath-[]
indexingMode Geeft de indexeringsmodus aan. 'consistent'
'luie'
'geen'
spatialIndexes Lijst met ruimtelijke gegevens SpatialSpec[]
vectorIndexen Lijst met paden die moeten worden opgenomen in de vectorindexering VectorIndex[]

ManagedServiceIdentity

Naam Beschrijving Waarde
type Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None worden alle identiteiten uit de service verwijderd. 'Geen'
'SystemAssigned'
'SystemAssigned, UserAssigned'
UserAssigned
userAssignedIdentities De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen voor de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Naam Beschrijving Waarde

MaterializedViewDefinition

Naam Beschrijving Waarde
definitie De definitie moet een SQL-query zijn die wordt gebruikt om gegevens op te halen uit de broncontainer om deze in te vullen in de container Gerealiseerde weergave. tekenreeks (vereist)
sourceCollectionId De naam van de broncontainer waarop de gerealiseerde weergave wordt gemaakt. tekenreeks (vereist)

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

Naam Beschrijving Waarde
apiVersion De API-versie '2024-12-01-preview'
identiteit Identiteit voor de resource. ManagedServiceIdentity-
plaats De locatie van de resourcegroep waartoe de resource behoort. snaar
naam De resourcenaam tekenreeks (vereist)
Eigenschappen Eigenschappen voor het maken en bijwerken van azure Cosmos DB-container. SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (vereist)
Tags Resourcetags Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen
type Het resourcetype 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers'

ResourceRestoreParameters

Naam Beschrijving Waarde
restoreSource De id van het herstelbare databaseaccount van waaruit het herstel moet worden gestart. Bijvoorbeeld: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} snaar
restoreTimestampInUtc Tijd waarop het account moet worden hersteld (ISO-8601-indeling). snaar
restoreWithTtlDisabled Hiermee geeft u op of het herstelde account tijd-To-Live uitgeschakeld bij het herstellen. Bool

SpatialSpec

Naam Beschrijving Waarde
pad Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met jokertekens (/pad/*) snaar
Typen Lijst met het ruimtelijke type pad Tekenreeksmatrix met een van de volgende waarden:
'LineString'
'MultiPolygon'
'Punt'
'Veelhoek'

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

Naam Beschrijving Waarde
Opties Een sleutel-waardepaar met opties die moeten worden toegepast voor de aanvraag. Dit komt overeen met de headers die met de aanvraag zijn verzonden. CreateUpdateOptionsOrSqlContainerGetPropertiesOptions-
hulpbron De standaard JSON-indeling van een container SqlContainerResourceOrSqlContainerGetPropertiesResource (vereist)

SqlContainerResourceOrSqlContainerGetPropertiesResource

Naam Beschrijving Waarde
analyticalStorageTtl Analytische TTL. Int
clientEncryptionPolicy Het clientversleutelingsbeleid voor de container. ClientEncryptionPolicy-
computedProperties Lijst met berekende eigenschappen ComputedProperty[]
conflictResolutionPolicy Het conflictoplossingsbeleid voor de container. ConflictResolutionPolicy-
createMode Opsomming om de modus voor het maken van resources aan te geven. 'Standaard'
'Herstellen'
defaultTtl Standaardtijd tot leven Int
legitimatiebewijs Naam van de Cosmos DB SQL-container tekenreeks (vereist)
indexingPolicy De configuratie van het indexeringsbeleid. De indexering is standaard automatisch voor alle documentpaden in de container IndexingPolicy-
materializedViewDefinition De configuratie voor het definiëren van gerealiseerde weergaven. Dit moet alleen worden opgegeven voor het maken van een gerealiseerde weergavecontainer. MaterializedViewDefinition-
partitionKey De configuratie van de partitiesleutel die moet worden gebruikt voor het partitioneren van gegevens in meerdere partities ContainerPartitionKey
restoreParameters Parameters om de informatie over de herstelbewerking aan te geven ResourceRestoreParameters
uniqueKeyPolicy De configuratie van het unieke sleutelbeleid voor het opgeven van beperkingen voor uniekheid voor documenten in de verzameling in de Azure Cosmos DB-service. UniqueKeyPolicy-
vectorEmbeddingPolicy Het beleid voor het insluiten van vectoren voor de container. VectorEmbeddingPolicy-

Tags

Naam Beschrijving Waarde

UniqueKey

Naam Beschrijving Waarde
Paden Lijst met paden moet uniek zijn voor elk document in de Azure Cosmos DB-service tekenreeks[]

UniqueKeyPolicy

Naam Beschrijving Waarde
uniqueKeys Lijst met unieke sleutels waarmee een beperking voor uniekheid wordt afgedwongen voor documenten in de verzameling in de Azure Cosmos DB-service. UniqueKey[]

VectorEmbedding

Naam Beschrijving Waarde
Datatype Geeft het gegevenstype van vector aan. 'float32'
'int8'
uint8 (vereist)
Dimensies Het aantal dimensies in de vector. int (vereist)
distanceFunction De afstandsfunctie die moet worden gebruikt voor de berekening van de afstand tussen vectoren. 'cosinus'
"dotproduct"
"euclidean" (vereist)
pad Het pad naar het vectorveld in het document. tekenreeks (vereist)

VectorEmbeddingPolicy

Naam Beschrijving Waarde
vectorEmbeddings Lijst met vector insluitingen VectorEmbedding[]

VectorIndex

Naam Beschrijving Waarde
pad Het pad naar het vectorveld in het document. tekenreeks (vereist)
type Het indextype van de vector. Momenteel worden flat, diskANN en quantizedFlat ondersteund. 'diskANN'
'plat'
'quantizedFlat' (vereist)

Quickstart-sjablonen

Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.

Sjabloon Beschrijving
SQL API voor Azure Cosmos DB-account met analytische opslag

implementeren in Azure
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

implementeren in Azure
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-

implementeren in Azure
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

implementeren in Azure
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

implementeren in Azure
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

implementeren in Azure
Een Dapr-microservices-app maken met behulp van Container Apps.
Maakt een Dapr pub-sub servicebus-app met behulp van Container Apps

implementeren in Azure
Maak een Dapr pub-sub servicebus-app met behulp van Container Apps.
Azure Data Explorer DB implementeren met Cosmos DB-verbinding

implementeren in Azure
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:

  • resourcegroepen

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-12-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  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"
              ]
            }
          ]
          vectorIndexes = [
            {
              path = "string"
              type = "string"
            }
          ]
        }
        materializedViewDefinition = {
          definition = "string"
          sourceCollectionId = "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"
            }
          ]
        }
      }
    }
  })
}

Eigenschapswaarden

AutoscaleSettings

Naam Beschrijving Waarde
maxThroughput Vertegenwoordigt de maximale doorvoer, de resource kan omhoog worden geschaald. Int

ClientEncryptionIncludedPath

Naam Beschrijving Waarde
clientEncryptionKeyId De id van de clientversleutelingssleutel die moet worden gebruikt om het pad te versleutelen. tekenreeks (vereist)
encryptionAlgorithm Het versleutelingsalgoritmen dat wordt gebruikt. Bijvoorbeeld- AEAD_AES_256_CBC_HMAC_SHA256. tekenreeks (vereist)
encryptionType Het type versleuteling dat moet worden uitgevoerd. Bijvoorbeeld: deterministisch, gerandomiseerd. tekenreeks (vereist)
pad Pad dat moet worden versleuteld. tekenreeks (vereist)

ClientEncryptionPolicy

Naam Beschrijving Waarde
includedPaths Paden van het item dat versleuteling nodig heeft, samen met padspecifieke instellingen. ClientEncryptionIncludedPath[] (vereist)
policyFormatVersion Versie van de definitie van het clientversleutelingsbeleid. Ondersteunde versies zijn 1 en 2. Versie 2 ondersteunt versleuteling van id- en partitiesleutelpaden. Int

Beperkingen:
Minimumwaarde = 1
Maximumwaarde = 2 (vereist)

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Naam Beschrijving Waarde

CompositePath

Naam Beschrijving Waarde
bevelen Sorteervolgorde voor samengestelde paden. 'oplopend'
'aflopend'
pad Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met jokertekens (/pad/*) snaar

ComputedProperty

Naam Beschrijving Waarde
naam De naam van een berekende eigenschap, bijvoorbeeld 'cp_lowerName' snaar
vraag De query waarmee de waarde voor de berekende eigenschap wordt geëvalueerd, bijvoorbeeld 'SELECT VALUE LOWER(c.name) FROM c' snaar

ConflictResolutionPolicy

Naam Beschrijving Waarde
conflictResolutionPath Het pad naar conflictoplossing in het geval van de LastWriterWins-modus. snaar
conflictResolutionProcedure De procedure voor het oplossen van conflicten in het geval van aangepaste modus. snaar
wijze Geeft de conflictoplossingsmodus aan. 'Aangepast'
'LastWriterWins'

ContainerPartitionKey

Naam Beschrijving Waarde
soort Geeft het type algoritme aan dat wordt gebruikt voor partitionering. Voor MultiHash worden meerdere partitiesleutels (maximaal drie maximum) ondersteund voor het maken van containers 'Hash'
'MultiHash'
'Bereik'
Paden Lijst met paden waarmee gegevens in de container kunnen worden gepartitioneerd tekenreeks[]
Versie Geeft de versie van de definitie van de partitiesleutel aan Int

Beperkingen:
Minimumwaarde = 1
Maximumwaarde = 2

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

Naam Beschrijving Waarde
autoscaleSettings Hiermee geeft u de instellingen voor automatisch schalen. Opmerking: doorvoer of autoscaleSettings is vereist, maar niet beide. AutoscaleSettings
Doorvoer Aanvraageenheden per seconde. Bijvoorbeeld 'doorvoer': 10000. Int

ExcludedPath

Naam Beschrijving Waarde
pad Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met jokertekens (/pad/*) snaar

IncludedPath

Naam Beschrijving Waarde
Indexen Lijst met indexen voor dit pad indexen[]
pad Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met jokertekens (/pad/*) snaar

Indexen

Naam Beschrijving Waarde
Datatype Het gegevenstype waarop het indexeringsgedrag wordt toegepast. 'LineString'
'MultiPolygon'
'Getal'
'Punt'
'Veelhoek'
'Tekenreeks'
soort Geeft het type index aan. 'Hash'
'Bereik'
'Ruimtelijk'
precisie De precisie van de index. -1 is maximale precisie. Int

IndexingPolicy

Naam Beschrijving Waarde
Automatisch Geeft aan of het indexeringsbeleid automatisch is Bool
compositeIndexes Lijst met samengestelde padlijst CompositePath[][]
excludedPaths Lijst met paden die moeten worden uitgesloten van indexering ExcludedPath[]
includedPaths Lijst met paden die moeten worden opgenomen in de indexering IncludedPath-[]
indexingMode Geeft de indexeringsmodus aan. 'consistent'
'luie'
'geen'
spatialIndexes Lijst met ruimtelijke gegevens SpatialSpec[]
vectorIndexen Lijst met paden die moeten worden opgenomen in de vectorindexering VectorIndex[]

ManagedServiceIdentity

Naam Beschrijving Waarde
type Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None worden alle identiteiten uit de service verwijderd. 'Geen'
'SystemAssigned'
'SystemAssigned, UserAssigned'
UserAssigned
userAssignedIdentities De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen voor de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Naam Beschrijving Waarde

MaterializedViewDefinition

Naam Beschrijving Waarde
definitie De definitie moet een SQL-query zijn die wordt gebruikt om gegevens op te halen uit de broncontainer om deze in te vullen in de container Gerealiseerde weergave. tekenreeks (vereist)
sourceCollectionId De naam van de broncontainer waarop de gerealiseerde weergave wordt gemaakt. tekenreeks (vereist)

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

Naam Beschrijving Waarde
identiteit Identiteit voor de resource. ManagedServiceIdentity-
plaats De locatie van de resourcegroep waartoe de resource behoort. snaar
naam De resourcenaam tekenreeks (vereist)
parent_id De id van de resource die het bovenliggende item voor deze resource is. Id voor resource van het type: databaseAccounts/sqlDatabases
Eigenschappen Eigenschappen voor het maken en bijwerken van azure Cosmos DB-container. SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (vereist)
Tags Resourcetags Woordenlijst met tagnamen en -waarden.
type Het resourcetype "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-12-01-preview"

ResourceRestoreParameters

Naam Beschrijving Waarde
restoreSource De id van het herstelbare databaseaccount van waaruit het herstel moet worden gestart. Bijvoorbeeld: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} snaar
restoreTimestampInUtc Tijd waarop het account moet worden hersteld (ISO-8601-indeling). snaar
restoreWithTtlDisabled Hiermee geeft u op of het herstelde account tijd-To-Live uitgeschakeld bij het herstellen. Bool

SpatialSpec

Naam Beschrijving Waarde
pad Het pad waarop het indexeringsgedrag van toepassing is. Indexpaden beginnen meestal met de hoofdmap en eindigen met jokertekens (/pad/*) snaar
Typen Lijst met het ruimtelijke type pad Tekenreeksmatrix met een van de volgende waarden:
'LineString'
'MultiPolygon'
'Punt'
'Veelhoek'

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

Naam Beschrijving Waarde
Opties Een sleutel-waardepaar met opties die moeten worden toegepast voor de aanvraag. Dit komt overeen met de headers die met de aanvraag zijn verzonden. CreateUpdateOptionsOrSqlContainerGetPropertiesOptions-
hulpbron De standaard JSON-indeling van een container SqlContainerResourceOrSqlContainerGetPropertiesResource (vereist)

SqlContainerResourceOrSqlContainerGetPropertiesResource

Naam Beschrijving Waarde
analyticalStorageTtl Analytische TTL. Int
clientEncryptionPolicy Het clientversleutelingsbeleid voor de container. ClientEncryptionPolicy-
computedProperties Lijst met berekende eigenschappen ComputedProperty[]
conflictResolutionPolicy Het conflictoplossingsbeleid voor de container. ConflictResolutionPolicy-
createMode Opsomming om de modus voor het maken van resources aan te geven. 'Standaard'
'Herstellen'
defaultTtl Standaardtijd tot leven Int
legitimatiebewijs Naam van de Cosmos DB SQL-container tekenreeks (vereist)
indexingPolicy De configuratie van het indexeringsbeleid. De indexering is standaard automatisch voor alle documentpaden in de container IndexingPolicy-
materializedViewDefinition De configuratie voor het definiëren van gerealiseerde weergaven. Dit moet alleen worden opgegeven voor het maken van een gerealiseerde weergavecontainer. MaterializedViewDefinition-
partitionKey De configuratie van de partitiesleutel die moet worden gebruikt voor het partitioneren van gegevens in meerdere partities ContainerPartitionKey
restoreParameters Parameters om de informatie over de herstelbewerking aan te geven ResourceRestoreParameters
uniqueKeyPolicy De configuratie van het unieke sleutelbeleid voor het opgeven van beperkingen voor uniekheid voor documenten in de verzameling in de Azure Cosmos DB-service. UniqueKeyPolicy-
vectorEmbeddingPolicy Het beleid voor het insluiten van vectoren voor de container. VectorEmbeddingPolicy-

Tags

Naam Beschrijving Waarde

UniqueKey

Naam Beschrijving Waarde
Paden Lijst met paden moet uniek zijn voor elk document in de Azure Cosmos DB-service tekenreeks[]

UniqueKeyPolicy

Naam Beschrijving Waarde
uniqueKeys Lijst met unieke sleutels waarmee een beperking voor uniekheid wordt afgedwongen voor documenten in de verzameling in de Azure Cosmos DB-service. UniqueKey[]

VectorEmbedding

Naam Beschrijving Waarde
Datatype Geeft het gegevenstype van vector aan. 'float32'
'int8'
uint8 (vereist)
Dimensies Het aantal dimensies in de vector. int (vereist)
distanceFunction De afstandsfunctie die moet worden gebruikt voor de berekening van de afstand tussen vectoren. 'cosinus'
"dotproduct"
"euclidean" (vereist)
pad Het pad naar het vectorveld in het document. tekenreeks (vereist)

VectorEmbeddingPolicy

Naam Beschrijving Waarde
vectorEmbeddings Lijst met vector insluitingen VectorEmbedding[]

VectorIndex

Naam Beschrijving Waarde
pad Het pad naar het vectorveld in het document. tekenreeks (vereist)
type Het indextype van de vector. Momenteel worden flat, diskANN en quantizedFlat ondersteund. 'diskANN'
'plat'
'quantizedFlat' (vereist)