Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers 2024-11-15
- neueste
- 2024-12-01-Preview-
- 2024-11-15
- 2024-09-01-Preview-
- 2024-08-15
- 2024-05-15
- 2024-05-15-Vorschau-
- 2024-02-15-Preview-
- 2023-11-15
- 2023-11-15-Vorschau-
- 2023-09-15
- 2023-09-15-Preview-
- 2023-04-15
- 2023-03-15
- 2023-03-15-Vorschau-
- 2023-03-01-Preview-
- 2022-11-15
- 2022-11-15-Vorschau-
- 2022-08-15
- 2022-08-15-Vorschau-
- 2022-05-15
- 2022-05-15-Preview-
- 2022-02-15-Preview-
- 2021-11-15-Preview-
- 2021-10-15
- 2021-10-15-Preview-
- 2021-07-01-Preview-
- 2021-06-15
- 2021-05-15
- 2021-04-15
- 2021-04-01-preview
- 2021-03-15
- 2021-03-01-Preview-
- 2021-01-15
- 2020-09-01
- 2020-06-01-Preview-
- 2020-04-01
- 2020-03-01
- 2019-12-12
- 2019-08-01
Bicep-Ressourcendefinition
Der Ressourcentyp "databaseAccounts/sqlDatabases/containers" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Ressource "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers" zu erstellen, fügen Sie Der Vorlage den folgenden Bicep hinzu.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-11-15' = {
parent: resourceSymbolicName
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'
}
]
}
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'
}
}
Eigenschaftswerte
AutoscaleSettings
| Name | Beschreibung | Wert |
|---|---|---|
| maxThroughput | Stellt den maximalen Durchsatz dar, auf den die Ressource skaliert werden kann. | Int |
ClientEncryptionIncludedPath
| Name | Beschreibung | Wert |
|---|---|---|
| clientEncryptionKeyId | Der Bezeichner des Clientverschlüsselungsschlüssels, der zum Verschlüsseln des Pfads verwendet werden soll. | Zeichenfolge (erforderlich) |
| encryptionAlgorithm | Der Verschlüsselungsalgorithmus, der verwendet wird. Eg - AEAD_AES_256_CBC_HMAC_SHA256. | Zeichenfolge (erforderlich) |
| encryptionType | Der Typ der zu verwendenden Verschlüsselung. Eg - Deterministisch, randomisiert. | Zeichenfolge (erforderlich) |
| Pfad | Pfad, der verschlüsselt werden muss. | Zeichenfolge (erforderlich) |
ClientEncryptionPolicy
| Name | Beschreibung | Wert |
|---|---|---|
| includedPaths | Pfade des Elements, die Verschlüsselung zusammen mit pfadspezifischen Einstellungen benötigen. | ClientEncryptionIncludedPath[] (erforderlich) |
| policyFormatVersion | Version der Clientverschlüsselungsrichtliniendefinition. Unterstützte Versionen sind 1 und 2. Version 2 unterstützt die ID- und Partitionsschlüsselpfadverschlüsselung. | Int Zwänge: Min.-Wert = 1 Max. Wert = 2 (erforderlich) |
CompositePath
| Name | Beschreibung | Wert |
|---|---|---|
| Bestellung | Sortierreihenfolge für zusammengesetzte Pfade. | "aufsteigend" "absteigend" |
| Pfad | Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Einem Wildcard (/pfad/*) | Schnur |
ComputedProperty
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Der Name einer berechneten Eigenschaft, z. B. "cp_lowerName" | Schnur |
| Frage | Die Abfrage, die den Wert für berechnete Eigenschaft auswertet, z. B. "SELECT VALUE LOWER(c.name) FROM c" | Schnur |
ConflictResolutionPolicy
| Name | Beschreibung | Wert |
|---|---|---|
| conflictResolutionPath | Der Konfliktlösungspfad im Fall des LastWriterWins-Modus. | Schnur |
| conflictResolutionProcedure | Die Prozedur zum Beheben von Konflikten im Fall des benutzerdefinierten Modus. | Schnur |
| Modus | Gibt den Konfliktauflösungsmodus an. | 'Benutzerdefiniert' "LastWriterWins" |
ContainerPartitionKey
| Name | Beschreibung | Wert |
|---|---|---|
| Art | Gibt die Art des Algorithmus an, der für die Partitionierung verwendet wird. Bei MultiHash werden mehrere Partitionsschlüssel (maximal drei) für die Containererstellung unterstützt. | "Hash" "MultiHash" 'Range' |
| Pfade | Liste der Pfade, die verwenden, welche Daten innerhalb des Containers partitioniert werden können | string[] |
| Version | Gibt die Version der Partitionsschlüsseldefinition an. | Int Zwänge: Min.-Wert = 1 Max. Wert = 2 |
CreateUpdateOptionsOrSqlContainerGetPropertiesOptions
| Name | Beschreibung | Wert |
|---|---|---|
| autoscaleSettings | Gibt die Einstellungen für die Autoskalen an. Hinweis: Entweder Durchsatz oder AutoscaleSettings ist erforderlich, aber nicht beides. | AutoscaleSettings- |
| Durchsatz | Anforderungseinheiten pro Sekunde. Beispiel: "Durchsatz": 10000. | Int |
ExcludedPath
| Name | Beschreibung | Wert |
|---|---|---|
| Pfad | Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Einem Wildcard (/pfad/*) | Schnur |
IncludedPath
| Name | Beschreibung | Wert |
|---|---|---|
| indexe | Liste der Indizes für diesen Pfad | Indizes[] |
| Pfad | Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Einem Wildcard (/pfad/*) | Schnur |
Indexe
| Name | Beschreibung | Wert |
|---|---|---|
| Datatype | Der Datentyp, auf den das Indizierungsverhalten angewendet wird. | 'LineString' "MultiPolygon" "Zahl" "Punkt" "Polygon" 'String' |
| Art | Gibt den Indextyp an. | "Hash" 'Range' "Raum" |
| Präzision | Die Genauigkeit des Indexes. -1 ist maximale Genauigkeit. | Int |
IndexingPolicy
| Name | Beschreibung | Wert |
|---|---|---|
| Automatisch | Gibt an, ob die Indizierungsrichtlinie automatisch ist. | Bool |
| compositeIndexes | Liste der zusammengesetzten Pfadliste | CompositePath-[][] |
| excludedPaths | Liste der Pfade, die von der Indizierung ausgeschlossen werden sollen | ExcludedPath-[] |
| includedPaths | Liste der Pfade, die in die Indizierung aufgenommen werden sollen | IncludedPath-[] |
| indexingMode | Gibt den Indizierungsmodus an. | "konsistent" "faul" 'none' |
| spatialIndexes | Liste der räumlichen Besonderheiten | SpatialSpec[] |
| vectorIndexes | Liste der Pfade, die in die Vektorindizierung aufgenommen werden sollen | VectorIndex-[] |
Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers
| Name | Beschreibung | Wert |
|---|---|---|
| Ort | Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. | Schnur |
| Name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| Elternteil | In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird. Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource. |
Symbolischer Name für Ressource des Typs: databaseAccounts/sqlDatabases |
| Eigenschaften | Eigenschaften zum Erstellen und Aktualisieren des Azure Cosmos DB-Containers. | SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (erforderlich) |
| Schilder | Ressourcentags | Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen |
ResourceRestoreParameters
| Name | Beschreibung | Wert |
|---|---|---|
| restoreSource | Die ID des wiederherstellbaren Datenbankkontos, von dem die Wiederherstellung initiiert werden muss. Beispiel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | Schnur |
| restoreTimestampInUtc | Zeit, zu der das Konto wiederhergestellt werden muss (ISO-8601-Format). | Schnur |
| restoreWithTtlDisabled | Gibt an, ob das wiederhergestellte Konto zeit-To-Live bei der erfolgreichen Wiederherstellung deaktiviert ist. | Bool |
SpatialSpec
| Name | Beschreibung | Wert |
|---|---|---|
| Pfad | Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Einem Wildcard (/pfad/*) | Schnur |
| Arten | Liste des räumlichen Pfadtyps | Zeichenfolgenarray, das eine der folgenden Elemente enthält: 'LineString' "MultiPolygon" "Punkt" "Polygon" |
SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Optionen | Ein Schlüssel-Wert-Optionspaar, das für die Anforderung angewendet werden soll. Dies entspricht den Kopfzeilen, die mit der Anforderung gesendet werden. | CreateUpdateOptionsOrSqlContainerGetPropertiesOptions- |
| Ressource | Das standardmäßige JSON-Format eines Containers | SqlContainerResourceOrSqlContainerGetPropertiesResource- (erforderlich) |
SqlContainerResourceOrSqlContainerGetPropertiesResource
| Name | Beschreibung | Wert |
|---|---|---|
| analyticalStorageTtl | Analytische tTL. | Int |
| clientEncryptionPolicy | Die Clientverschlüsselungsrichtlinie für den Container. | ClientEncryptionPolicy |
| computedProperties | Liste der berechneten Eigenschaften | ComputedProperty-[] |
| conflictResolutionPolicy | Die Konfliktlösungsrichtlinie für den Container. | ConflictResolutionPolicy- |
| createMode | Aufzählung, um den Modus der Ressourcenerstellung anzugeben. | 'Standard' "Wiederherstellen" |
| defaultTtl | Standardzeit für Live | Int |
| id | Name des Cosmos DB SQL-Containers | Zeichenfolge (erforderlich) |
| indexingPolicy | Die Konfiguration der Indizierungsrichtlinie. Standardmäßig ist die Indizierung für alle Dokumentpfade innerhalb des Containers automatisch. | IndexingPolicy- |
| partitionKey | Die Konfiguration des Partitionsschlüssels, der für die Partitionierung von Daten in mehrere Partitionen verwendet werden soll | ContainerPartitionKey- |
| restoreParameters | Parameter, die die Informationen zur Wiederherstellung angeben sollen | ResourceRestoreParameters- |
| uniqueKeyPolicy | Die Konfiguration der eindeutigen Schlüsselrichtlinie zum Angeben von Eindeutigkeitseinschränkungen für Dokumente in der Sammlung im Azure Cosmos DB-Dienst. | UniqueKeyPolicy- |
| vectorEmbeddingPolicy | Die Vektoreinbettungsrichtlinie für den Container. | VectorEmbeddingPolicy- |
Schilder
| Name | Beschreibung | Wert |
|---|
UniqueKey
| Name | Beschreibung | Wert |
|---|---|---|
| Pfade | Liste der Pfade muss für jedes Dokument im Azure Cosmos DB-Dienst eindeutig sein. | string[] |
UniqueKeyPolicy
| Name | Beschreibung | Wert |
|---|---|---|
| uniqueKeys | Liste der eindeutigen Schlüssel für die Erzwingung der Eindeutigkeitseinschränkung für Dokumente in der Sammlung im Azure Cosmos DB-Dienst. | UniqueKey-[] |
VectorEmbedding
| Name | Beschreibung | Wert |
|---|---|---|
| Datatype | Gibt den Datentyp des Vektors an. | "float32" "int8" "uint8" (erforderlich) |
| Dimensionen | Die Anzahl der Dimensionen im Vektor. | int (erforderlich) |
| distanceFunction | Die Abstandsfunktion, die für die Entfernungsberechnung zwischen Vektoren verwendet werden soll. | "Kosinus" "dotproduct" "Euklidan" (erforderlich) |
| Pfad | Der Pfad zum Vektorfeld im Dokument. | Zeichenfolge (erforderlich) |
VectorEmbeddingPolicy
| Name | Beschreibung | Wert |
|---|---|---|
| vectorEmbeddings | Liste der Vektoreinbettungen | VectorEmbedding-[] |
VectorIndex
| Name | Beschreibung | Wert |
|---|---|---|
| Pfad | Der Pfad zum Vektorfeld im Dokument. | Zeichenfolge (erforderlich) |
| Art | Der Indextyp des Vektors. Derzeit werden flat, diskANN und quantizedFlat unterstützt. | 'diskANN' "flach" 'quantizedFlat' (erforderlich) |
Schnellstartbeispiele
Die folgenden Schnellstartbeispiele stellen diesen Ressourcentyp bereit.
| Bicep-Datei | Beschreibung |
|---|---|
| Azure Cosmos DB-Konto-SQL-API mit analytischem Speicher | Diese Vorlage erstellt ein Azure Cosmos-Konto für die Core-API (SQL) mit einer Datenbank und einem Container, der mit dem analytischen Speicher konfiguriert ist. |
| Erstellen eines kostenlosen Azure Cosmos DB-Kontos | Diese Vorlage erstellt ein freistufiges Azure Cosmos DB-Konto für die SQL-API mit einer Datenbank mit freigegebenem Durchsatz und Container. |
| Erstellen eines Azure Cosmos DB-Kontos für die SQL-API- | Diese Vorlage erstellt ein Azure Cosmos-Konto für die Core-API (SQL) mit einer Datenbank und einem Container mit Durchsatz mit mehreren anderen Optionen. |
| Erstellen einer SQL-Konto-API für Azure Cosmos DB mit automatischer Skalierung | Diese Vorlage erstellt ein Azure Cosmos-Konto für die Core-API (SQL) mit einer Datenbank und einem Container mit automatischem Durchsatz mit mehreren anderen Optionen. |
| Erstellen von gespeicherten Prozeduren der Azure Cosmos DB Core -API (SQL) | Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die Core-API (SQL) und einen Container mit einer gespeicherten Prozedur, triggern und benutzerdefinierten Funktion. |
| Erstellt eine Dapr Microservices-App mit Container-Apps | Erstellen Sie eine Dapr Microservices-App mit Container-Apps. |
| Erstellt eine Dapr pub-sub servicebus-App mit Container-Apps | Erstellen Sie eine Dapr pub-sub servicebus-App mit Container-Apps. |
| Bereitstellen von Azure Data Explorer DB mit Cosmos DB-Verbindung | Bereitstellen von Azure Data Explorer DB mit Cosmos DB-Verbindung. |
ARM-Vorlagenressourcendefinition
Der Ressourcentyp "databaseAccounts/sqlDatabases/containers" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Ressource "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers" zu erstellen, fügen Sie Ihrer Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
"apiVersion": "2024-11-15",
"name": "string",
"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"
}
]
},
"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"
}
}
Eigenschaftswerte
AutoscaleSettings
| Name | Beschreibung | Wert |
|---|---|---|
| maxThroughput | Stellt den maximalen Durchsatz dar, auf den die Ressource skaliert werden kann. | Int |
ClientEncryptionIncludedPath
| Name | Beschreibung | Wert |
|---|---|---|
| clientEncryptionKeyId | Der Bezeichner des Clientverschlüsselungsschlüssels, der zum Verschlüsseln des Pfads verwendet werden soll. | Zeichenfolge (erforderlich) |
| encryptionAlgorithm | Der Verschlüsselungsalgorithmus, der verwendet wird. Eg - AEAD_AES_256_CBC_HMAC_SHA256. | Zeichenfolge (erforderlich) |
| encryptionType | Der Typ der zu verwendenden Verschlüsselung. Eg - Deterministisch, randomisiert. | Zeichenfolge (erforderlich) |
| Pfad | Pfad, der verschlüsselt werden muss. | Zeichenfolge (erforderlich) |
ClientEncryptionPolicy
| Name | Beschreibung | Wert |
|---|---|---|
| includedPaths | Pfade des Elements, die Verschlüsselung zusammen mit pfadspezifischen Einstellungen benötigen. | ClientEncryptionIncludedPath[] (erforderlich) |
| policyFormatVersion | Version der Clientverschlüsselungsrichtliniendefinition. Unterstützte Versionen sind 1 und 2. Version 2 unterstützt die ID- und Partitionsschlüsselpfadverschlüsselung. | Int Zwänge: Min.-Wert = 1 Max. Wert = 2 (erforderlich) |
CompositePath
| Name | Beschreibung | Wert |
|---|---|---|
| Bestellung | Sortierreihenfolge für zusammengesetzte Pfade. | "aufsteigend" "absteigend" |
| Pfad | Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Einem Wildcard (/pfad/*) | Schnur |
ComputedProperty
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Der Name einer berechneten Eigenschaft, z. B. "cp_lowerName" | Schnur |
| Frage | Die Abfrage, die den Wert für berechnete Eigenschaft auswertet, z. B. "SELECT VALUE LOWER(c.name) FROM c" | Schnur |
ConflictResolutionPolicy
| Name | Beschreibung | Wert |
|---|---|---|
| conflictResolutionPath | Der Konfliktlösungspfad im Fall des LastWriterWins-Modus. | Schnur |
| conflictResolutionProcedure | Die Prozedur zum Beheben von Konflikten im Fall des benutzerdefinierten Modus. | Schnur |
| Modus | Gibt den Konfliktauflösungsmodus an. | 'Benutzerdefiniert' "LastWriterWins" |
ContainerPartitionKey
| Name | Beschreibung | Wert |
|---|---|---|
| Art | Gibt die Art des Algorithmus an, der für die Partitionierung verwendet wird. Bei MultiHash werden mehrere Partitionsschlüssel (maximal drei) für die Containererstellung unterstützt. | "Hash" "MultiHash" 'Range' |
| Pfade | Liste der Pfade, die verwenden, welche Daten innerhalb des Containers partitioniert werden können | string[] |
| Version | Gibt die Version der Partitionsschlüsseldefinition an. | Int Zwänge: Min.-Wert = 1 Max. Wert = 2 |
CreateUpdateOptionsOrSqlContainerGetPropertiesOptions
| Name | Beschreibung | Wert |
|---|---|---|
| autoscaleSettings | Gibt die Einstellungen für die Autoskalen an. Hinweis: Entweder Durchsatz oder AutoscaleSettings ist erforderlich, aber nicht beides. | AutoscaleSettings- |
| Durchsatz | Anforderungseinheiten pro Sekunde. Beispiel: "Durchsatz": 10000. | Int |
ExcludedPath
| Name | Beschreibung | Wert |
|---|---|---|
| Pfad | Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Einem Wildcard (/pfad/*) | Schnur |
IncludedPath
| Name | Beschreibung | Wert |
|---|---|---|
| indexe | Liste der Indizes für diesen Pfad | Indizes[] |
| Pfad | Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Einem Wildcard (/pfad/*) | Schnur |
Indexe
| Name | Beschreibung | Wert |
|---|---|---|
| Datatype | Der Datentyp, auf den das Indizierungsverhalten angewendet wird. | 'LineString' "MultiPolygon" "Zahl" "Punkt" "Polygon" 'String' |
| Art | Gibt den Indextyp an. | "Hash" 'Range' "Raum" |
| Präzision | Die Genauigkeit des Indexes. -1 ist maximale Genauigkeit. | Int |
IndexingPolicy
| Name | Beschreibung | Wert |
|---|---|---|
| Automatisch | Gibt an, ob die Indizierungsrichtlinie automatisch ist. | Bool |
| compositeIndexes | Liste der zusammengesetzten Pfadliste | CompositePath-[][] |
| excludedPaths | Liste der Pfade, die von der Indizierung ausgeschlossen werden sollen | ExcludedPath-[] |
| includedPaths | Liste der Pfade, die in die Indizierung aufgenommen werden sollen | IncludedPath-[] |
| indexingMode | Gibt den Indizierungsmodus an. | "konsistent" "faul" 'none' |
| spatialIndexes | Liste der räumlichen Besonderheiten | SpatialSpec[] |
| vectorIndexes | Liste der Pfade, die in die Vektorindizierung aufgenommen werden sollen | VectorIndex-[] |
Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers
| Name | Beschreibung | Wert |
|---|---|---|
| apiVersion | Die API-Version | '2024-11-15' |
| Ort | Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. | Schnur |
| Name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| Eigenschaften | Eigenschaften zum Erstellen und Aktualisieren des Azure Cosmos DB-Containers. | SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (erforderlich) |
| Schilder | Ressourcentags | Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen |
| Art | Der Ressourcentyp | "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers" |
ResourceRestoreParameters
| Name | Beschreibung | Wert |
|---|---|---|
| restoreSource | Die ID des wiederherstellbaren Datenbankkontos, von dem die Wiederherstellung initiiert werden muss. Beispiel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | Schnur |
| restoreTimestampInUtc | Zeit, zu der das Konto wiederhergestellt werden muss (ISO-8601-Format). | Schnur |
| restoreWithTtlDisabled | Gibt an, ob das wiederhergestellte Konto zeit-To-Live bei der erfolgreichen Wiederherstellung deaktiviert ist. | Bool |
SpatialSpec
| Name | Beschreibung | Wert |
|---|---|---|
| Pfad | Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Einem Wildcard (/pfad/*) | Schnur |
| Arten | Liste des räumlichen Pfadtyps | Zeichenfolgenarray, das eine der folgenden Elemente enthält: 'LineString' "MultiPolygon" "Punkt" "Polygon" |
SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Optionen | Ein Schlüssel-Wert-Optionspaar, das für die Anforderung angewendet werden soll. Dies entspricht den Kopfzeilen, die mit der Anforderung gesendet werden. | CreateUpdateOptionsOrSqlContainerGetPropertiesOptions- |
| Ressource | Das standardmäßige JSON-Format eines Containers | SqlContainerResourceOrSqlContainerGetPropertiesResource- (erforderlich) |
SqlContainerResourceOrSqlContainerGetPropertiesResource
| Name | Beschreibung | Wert |
|---|---|---|
| analyticalStorageTtl | Analytische tTL. | Int |
| clientEncryptionPolicy | Die Clientverschlüsselungsrichtlinie für den Container. | ClientEncryptionPolicy |
| computedProperties | Liste der berechneten Eigenschaften | ComputedProperty-[] |
| conflictResolutionPolicy | Die Konfliktlösungsrichtlinie für den Container. | ConflictResolutionPolicy- |
| createMode | Aufzählung, um den Modus der Ressourcenerstellung anzugeben. | 'Standard' "Wiederherstellen" |
| defaultTtl | Standardzeit für Live | Int |
| id | Name des Cosmos DB SQL-Containers | Zeichenfolge (erforderlich) |
| indexingPolicy | Die Konfiguration der Indizierungsrichtlinie. Standardmäßig ist die Indizierung für alle Dokumentpfade innerhalb des Containers automatisch. | IndexingPolicy- |
| partitionKey | Die Konfiguration des Partitionsschlüssels, der für die Partitionierung von Daten in mehrere Partitionen verwendet werden soll | ContainerPartitionKey- |
| restoreParameters | Parameter, die die Informationen zur Wiederherstellung angeben sollen | ResourceRestoreParameters- |
| uniqueKeyPolicy | Die Konfiguration der eindeutigen Schlüsselrichtlinie zum Angeben von Eindeutigkeitseinschränkungen für Dokumente in der Sammlung im Azure Cosmos DB-Dienst. | UniqueKeyPolicy- |
| vectorEmbeddingPolicy | Die Vektoreinbettungsrichtlinie für den Container. | VectorEmbeddingPolicy- |
Schilder
| Name | Beschreibung | Wert |
|---|
UniqueKey
| Name | Beschreibung | Wert |
|---|---|---|
| Pfade | Liste der Pfade muss für jedes Dokument im Azure Cosmos DB-Dienst eindeutig sein. | string[] |
UniqueKeyPolicy
| Name | Beschreibung | Wert |
|---|---|---|
| uniqueKeys | Liste der eindeutigen Schlüssel für die Erzwingung der Eindeutigkeitseinschränkung für Dokumente in der Sammlung im Azure Cosmos DB-Dienst. | UniqueKey-[] |
VectorEmbedding
| Name | Beschreibung | Wert |
|---|---|---|
| Datatype | Gibt den Datentyp des Vektors an. | "float32" "int8" "uint8" (erforderlich) |
| Dimensionen | Die Anzahl der Dimensionen im Vektor. | int (erforderlich) |
| distanceFunction | Die Abstandsfunktion, die für die Entfernungsberechnung zwischen Vektoren verwendet werden soll. | "Kosinus" "dotproduct" "Euklidan" (erforderlich) |
| Pfad | Der Pfad zum Vektorfeld im Dokument. | Zeichenfolge (erforderlich) |
VectorEmbeddingPolicy
| Name | Beschreibung | Wert |
|---|---|---|
| vectorEmbeddings | Liste der Vektoreinbettungen | VectorEmbedding-[] |
VectorIndex
| Name | Beschreibung | Wert |
|---|---|---|
| Pfad | Der Pfad zum Vektorfeld im Dokument. | Zeichenfolge (erforderlich) |
| Art | Der Indextyp des Vektors. Derzeit werden flat, diskANN und quantizedFlat unterstützt. | 'diskANN' "flach" 'quantizedFlat' (erforderlich) |
Schnellstartvorlagen
Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.
| Schablone | Beschreibung |
|---|---|
Azure Cosmos DB-Konto-SQL-API mit analytischem Speicher
|
Diese Vorlage erstellt ein Azure Cosmos-Konto für die Core-API (SQL) mit einer Datenbank und einem Container, der mit dem analytischen Speicher konfiguriert ist. |
|
Erstellen eines kostenlosen Azure Cosmos DB-Kontos
|
Diese Vorlage erstellt ein freistufiges Azure Cosmos DB-Konto für die SQL-API mit einer Datenbank mit freigegebenem Durchsatz und Container. |
|
Erstellen eines Azure Cosmos DB-Kontos für die SQL-API-
|
Diese Vorlage erstellt ein Azure Cosmos-Konto für die Core-API (SQL) mit einer Datenbank und einem Container mit Durchsatz mit mehreren anderen Optionen. |
|
Erstellen einer SQL-Konto-API für Azure Cosmos DB mit automatischer Skalierung
|
Diese Vorlage erstellt ein Azure Cosmos-Konto für die Core-API (SQL) mit einer Datenbank und einem Container mit automatischem Durchsatz mit mehreren anderen Optionen. |
|
Erstellen von gespeicherten Prozeduren der Azure Cosmos DB Core -API (SQL)
|
Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die Core-API (SQL) und einen Container mit einer gespeicherten Prozedur, triggern und benutzerdefinierten Funktion. |
|
Erstellt eine Dapr Microservices-App mit Container-Apps
|
Erstellen Sie eine Dapr Microservices-App mit Container-Apps. |
|
Erstellt eine Dapr pub-sub servicebus-App mit Container-Apps
|
Erstellen Sie eine Dapr pub-sub servicebus-App mit Container-Apps. |
|
Bereitstellen von Azure Data Explorer DB mit Cosmos DB-Verbindung
|
Bereitstellen von Azure Data Explorer DB mit Cosmos DB-Verbindung. |
Terraform -Ressourcendefinition (AzAPI-Anbieter)
Der Ressourcentyp "databaseAccounts/sqlDatabases/containers" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Ressource "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers" zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-11-15"
name = "string"
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"
}
]
}
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"
}
]
}
}
}
})
}
Eigenschaftswerte
AutoscaleSettings
| Name | Beschreibung | Wert |
|---|---|---|
| maxThroughput | Stellt den maximalen Durchsatz dar, auf den die Ressource skaliert werden kann. | Int |
ClientEncryptionIncludedPath
| Name | Beschreibung | Wert |
|---|---|---|
| clientEncryptionKeyId | Der Bezeichner des Clientverschlüsselungsschlüssels, der zum Verschlüsseln des Pfads verwendet werden soll. | Zeichenfolge (erforderlich) |
| encryptionAlgorithm | Der Verschlüsselungsalgorithmus, der verwendet wird. Eg - AEAD_AES_256_CBC_HMAC_SHA256. | Zeichenfolge (erforderlich) |
| encryptionType | Der Typ der zu verwendenden Verschlüsselung. Eg - Deterministisch, randomisiert. | Zeichenfolge (erforderlich) |
| Pfad | Pfad, der verschlüsselt werden muss. | Zeichenfolge (erforderlich) |
ClientEncryptionPolicy
| Name | Beschreibung | Wert |
|---|---|---|
| includedPaths | Pfade des Elements, die Verschlüsselung zusammen mit pfadspezifischen Einstellungen benötigen. | ClientEncryptionIncludedPath[] (erforderlich) |
| policyFormatVersion | Version der Clientverschlüsselungsrichtliniendefinition. Unterstützte Versionen sind 1 und 2. Version 2 unterstützt die ID- und Partitionsschlüsselpfadverschlüsselung. | Int Zwänge: Min.-Wert = 1 Max. Wert = 2 (erforderlich) |
CompositePath
| Name | Beschreibung | Wert |
|---|---|---|
| Bestellung | Sortierreihenfolge für zusammengesetzte Pfade. | "aufsteigend" "absteigend" |
| Pfad | Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Einem Wildcard (/pfad/*) | Schnur |
ComputedProperty
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Der Name einer berechneten Eigenschaft, z. B. "cp_lowerName" | Schnur |
| Frage | Die Abfrage, die den Wert für berechnete Eigenschaft auswertet, z. B. "SELECT VALUE LOWER(c.name) FROM c" | Schnur |
ConflictResolutionPolicy
| Name | Beschreibung | Wert |
|---|---|---|
| conflictResolutionPath | Der Konfliktlösungspfad im Fall des LastWriterWins-Modus. | Schnur |
| conflictResolutionProcedure | Die Prozedur zum Beheben von Konflikten im Fall des benutzerdefinierten Modus. | Schnur |
| Modus | Gibt den Konfliktauflösungsmodus an. | 'Benutzerdefiniert' "LastWriterWins" |
ContainerPartitionKey
| Name | Beschreibung | Wert |
|---|---|---|
| Art | Gibt die Art des Algorithmus an, der für die Partitionierung verwendet wird. Bei MultiHash werden mehrere Partitionsschlüssel (maximal drei) für die Containererstellung unterstützt. | "Hash" "MultiHash" 'Range' |
| Pfade | Liste der Pfade, die verwenden, welche Daten innerhalb des Containers partitioniert werden können | string[] |
| Version | Gibt die Version der Partitionsschlüsseldefinition an. | Int Zwänge: Min.-Wert = 1 Max. Wert = 2 |
CreateUpdateOptionsOrSqlContainerGetPropertiesOptions
| Name | Beschreibung | Wert |
|---|---|---|
| autoscaleSettings | Gibt die Einstellungen für die Autoskalen an. Hinweis: Entweder Durchsatz oder AutoscaleSettings ist erforderlich, aber nicht beides. | AutoscaleSettings- |
| Durchsatz | Anforderungseinheiten pro Sekunde. Beispiel: "Durchsatz": 10000. | Int |
ExcludedPath
| Name | Beschreibung | Wert |
|---|---|---|
| Pfad | Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Einem Wildcard (/pfad/*) | Schnur |
IncludedPath
| Name | Beschreibung | Wert |
|---|---|---|
| indexe | Liste der Indizes für diesen Pfad | Indizes[] |
| Pfad | Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Einem Wildcard (/pfad/*) | Schnur |
Indexe
| Name | Beschreibung | Wert |
|---|---|---|
| Datatype | Der Datentyp, auf den das Indizierungsverhalten angewendet wird. | 'LineString' "MultiPolygon" "Zahl" "Punkt" "Polygon" 'String' |
| Art | Gibt den Indextyp an. | "Hash" 'Range' "Raum" |
| Präzision | Die Genauigkeit des Indexes. -1 ist maximale Genauigkeit. | Int |
IndexingPolicy
| Name | Beschreibung | Wert |
|---|---|---|
| Automatisch | Gibt an, ob die Indizierungsrichtlinie automatisch ist. | Bool |
| compositeIndexes | Liste der zusammengesetzten Pfadliste | CompositePath-[][] |
| excludedPaths | Liste der Pfade, die von der Indizierung ausgeschlossen werden sollen | ExcludedPath-[] |
| includedPaths | Liste der Pfade, die in die Indizierung aufgenommen werden sollen | IncludedPath-[] |
| indexingMode | Gibt den Indizierungsmodus an. | "konsistent" "faul" 'none' |
| spatialIndexes | Liste der räumlichen Besonderheiten | SpatialSpec[] |
| vectorIndexes | Liste der Pfade, die in die Vektorindizierung aufgenommen werden sollen | VectorIndex-[] |
Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers
| Name | Beschreibung | Wert |
|---|---|---|
| Ort | Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. | Schnur |
| Name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| parent_id | Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. | ID für Ressource des Typs: databaseAccounts/sqlDatabases |
| Eigenschaften | Eigenschaften zum Erstellen und Aktualisieren des Azure Cosmos DB-Containers. | SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (erforderlich) |
| Schilder | Ressourcentags | Wörterbuch der Tagnamen und -werte. |
| Art | Der Ressourcentyp | "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-11-15" |
ResourceRestoreParameters
| Name | Beschreibung | Wert |
|---|---|---|
| restoreSource | Die ID des wiederherstellbaren Datenbankkontos, von dem die Wiederherstellung initiiert werden muss. Beispiel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | Schnur |
| restoreTimestampInUtc | Zeit, zu der das Konto wiederhergestellt werden muss (ISO-8601-Format). | Schnur |
| restoreWithTtlDisabled | Gibt an, ob das wiederhergestellte Konto zeit-To-Live bei der erfolgreichen Wiederherstellung deaktiviert ist. | Bool |
SpatialSpec
| Name | Beschreibung | Wert |
|---|---|---|
| Pfad | Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Einem Wildcard (/pfad/*) | Schnur |
| Arten | Liste des räumlichen Pfadtyps | Zeichenfolgenarray, das eine der folgenden Elemente enthält: 'LineString' "MultiPolygon" "Punkt" "Polygon" |
SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Optionen | Ein Schlüssel-Wert-Optionspaar, das für die Anforderung angewendet werden soll. Dies entspricht den Kopfzeilen, die mit der Anforderung gesendet werden. | CreateUpdateOptionsOrSqlContainerGetPropertiesOptions- |
| Ressource | Das standardmäßige JSON-Format eines Containers | SqlContainerResourceOrSqlContainerGetPropertiesResource- (erforderlich) |
SqlContainerResourceOrSqlContainerGetPropertiesResource
| Name | Beschreibung | Wert |
|---|---|---|
| analyticalStorageTtl | Analytische tTL. | Int |
| clientEncryptionPolicy | Die Clientverschlüsselungsrichtlinie für den Container. | ClientEncryptionPolicy |
| computedProperties | Liste der berechneten Eigenschaften | ComputedProperty-[] |
| conflictResolutionPolicy | Die Konfliktlösungsrichtlinie für den Container. | ConflictResolutionPolicy- |
| createMode | Aufzählung, um den Modus der Ressourcenerstellung anzugeben. | 'Standard' "Wiederherstellen" |
| defaultTtl | Standardzeit für Live | Int |
| id | Name des Cosmos DB SQL-Containers | Zeichenfolge (erforderlich) |
| indexingPolicy | Die Konfiguration der Indizierungsrichtlinie. Standardmäßig ist die Indizierung für alle Dokumentpfade innerhalb des Containers automatisch. | IndexingPolicy- |
| partitionKey | Die Konfiguration des Partitionsschlüssels, der für die Partitionierung von Daten in mehrere Partitionen verwendet werden soll | ContainerPartitionKey- |
| restoreParameters | Parameter, die die Informationen zur Wiederherstellung angeben sollen | ResourceRestoreParameters- |
| uniqueKeyPolicy | Die Konfiguration der eindeutigen Schlüsselrichtlinie zum Angeben von Eindeutigkeitseinschränkungen für Dokumente in der Sammlung im Azure Cosmos DB-Dienst. | UniqueKeyPolicy- |
| vectorEmbeddingPolicy | Die Vektoreinbettungsrichtlinie für den Container. | VectorEmbeddingPolicy- |
Schilder
| Name | Beschreibung | Wert |
|---|
UniqueKey
| Name | Beschreibung | Wert |
|---|---|---|
| Pfade | Liste der Pfade muss für jedes Dokument im Azure Cosmos DB-Dienst eindeutig sein. | string[] |
UniqueKeyPolicy
| Name | Beschreibung | Wert |
|---|---|---|
| uniqueKeys | Liste der eindeutigen Schlüssel für die Erzwingung der Eindeutigkeitseinschränkung für Dokumente in der Sammlung im Azure Cosmos DB-Dienst. | UniqueKey-[] |
VectorEmbedding
| Name | Beschreibung | Wert |
|---|---|---|
| Datatype | Gibt den Datentyp des Vektors an. | "float32" "int8" "uint8" (erforderlich) |
| Dimensionen | Die Anzahl der Dimensionen im Vektor. | int (erforderlich) |
| distanceFunction | Die Abstandsfunktion, die für die Entfernungsberechnung zwischen Vektoren verwendet werden soll. | "Kosinus" "dotproduct" "Euklidan" (erforderlich) |
| Pfad | Der Pfad zum Vektorfeld im Dokument. | Zeichenfolge (erforderlich) |
VectorEmbeddingPolicy
| Name | Beschreibung | Wert |
|---|---|---|
| vectorEmbeddings | Liste der Vektoreinbettungen | VectorEmbedding-[] |
VectorIndex
| Name | Beschreibung | Wert |
|---|---|---|
| Pfad | Der Pfad zum Vektorfeld im Dokument. | Zeichenfolge (erforderlich) |
| Art | Der Indextyp des Vektors. Derzeit werden flat, diskANN und quantizedFlat unterstützt. | 'diskANN' "flach" 'quantizedFlat' (erforderlich) |