Freigeben über

Microsoft.DocumentDB-DatenbankAccounts/sqlDatabases/containers 2023-11-15

  • Artikel

Bicep-Ressourcendefinition

Der Ressourcentyp databaseAccounts/sqlDatabases/containers kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2023-11-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      analyticalStorageTtl: int
      clientEncryptionPolicy: {
        includedPaths: [
          {
            clientEncryptionKeyId: 'string'
            encryptionAlgorithm: 'string'
            encryptionType: 'string'
            path: 'string'
          }
        ]
        policyFormatVersion: int
      }
      computedProperties: [
        {
          name: 'string'
          query: 'string'
        }
      ]
      conflictResolutionPolicy: {
        conflictResolutionPath: 'string'
        conflictResolutionProcedure: 'string'
        mode: 'string'
      }
      createMode: 'string'
      defaultTtl: int
      id: 'string'
      indexingPolicy: {
        automatic: bool
        compositeIndexes: [
          {
            order: 'string'
            path: 'string'
          }
        ]
        excludedPaths: [
          {
            path: 'string'
          }
        ]
        includedPaths: [
          {
            indexes: [
              {
                dataType: 'string'
                kind: 'string'
                precision: int
              }
            ]
            path: 'string'
          }
        ]
        indexingMode: 'string'
        spatialIndexes: [
          {
            path: 'string'
            types: [
              'string'
            ]
          }
        ]
      }
      partitionKey: {
        kind: 'string'
        paths: [
          'string'
        ]
        version: int
      }
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
      }
      uniqueKeyPolicy: {
        uniqueKeys: [
          {
            paths: [
              'string'
            ]
          }
        ]
      }
    }
  }
}

Eigenschaftswerte

databaseAccounts/sqlDatabases/containers

Name BESCHREIBUNG Wert
name Der Ressourcenname

Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in Bicep festlegen.		 Zeichenfolge (erforderlich)
location Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. Zeichenfolge
tags Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Die Standardumgebung für einen Vorlagentyp ist beispielsweise mit "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB". Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
parent 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 vom Typ: sqlDatabases
properties Eigenschaften zum Erstellen und Aktualisieren eines Azure Cosmos DB-Containers. SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (erforderlich)

SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...

Name BESCHREIBUNG Wert
Optionen Ein Schlüssel-Wert-Paar von Optionen, die für die Anforderung angewendet werden sollen. Dies entspricht den Headern, die mit der Anforderung gesendet wurden. CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
resource Das JSON-Standardformat eines Containers SqlContainerResourceOrSqlContainerGetPropertiesResou... (erforderlich)

CreateUpdateOptionsOrSqlContainerGetPropertiesOption...

Name BESCHREIBUNG Wert
autoscaleSettings Gibt die Einstellungen für die automatische Skalierung an. Hinweis: Entweder durchsatz oder autoscaleSettings ist erforderlich, aber nicht beides. AutoscaleSettings
throughput Anforderungseinheiten pro Sekunde. Beispiel: "Durchsatz": 10000. INT

AutoscaleSettings

Name BESCHREIBUNG Wert
maxThroughput Stellt den maximalen Durchsatz dar, auf den die Ressource hochskaliert werden kann. INT

SqlContainerResourceOrSqlContainerGetPropertiesResou...

Name BESCHREIBUNG Wert
analyticalStorageTtl Analytische Gültigkeitsdauer. 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 Enumeration, um den Modus der Ressourcenerstellung anzugeben. 'Standardwert'
"Wiederherstellen"
defaultTtl Standardzeit für die Lebzeit INT
id Name des Cosmos DB-SQL-Containers Zeichenfolge (erforderlich)
indexingPolicy Die Konfiguration der Indizierungsrichtlinie. Standardmäßig erfolgt die Indizierung für alle Dokumentpfade innerhalb des Containers automatisch. IndexingPolicy
partitionKey Die Konfiguration des Partitionsschlüssels, der zum Partitionieren von Daten in mehrere Partitionen verwendet werden soll ContainerPartitionKey
restoreParameters Parameter zum Angeben der Informationen zur Wiederherstellung ResourceRestoreParameters
uniqueKeyPolicy Die Richtlinienkonfiguration für eindeutige Schlüssel zum Angeben von Eindeutigkeitseinschränkungen für Dokumente in der Sammlung im Azure Cosmos DB-Dienst. UniqueKeyPolicy

ClientEncryptionPolicy

Name BESCHREIBUNG Wert
includedPaths Pfade des Elements, die eine Verschlüsselung zusammen mit pfadspezifischen Einstellungen erfordern. ClientEncryptionIncludedPath[] (erforderlich)
policyFormatVersion Version der Definition der Clientverschlüsselungsrichtlinie. Unterstützte Versionen sind 1 und 2. Version 2 unterstützt die Verschlüsselung von ID- und Partitionsschlüsselpfaden. int (erforderlich)

Einschränkungen:
Minimaler Wert = 1
Max. Wert = 2

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. Beispiel: AEAD_AES_256_CBC_HMAC_SHA256. Zeichenfolge (erforderlich)
encryptionType Der Typ der auszuführenden Verschlüsselung. Z. B. deterministisch, randomisiert. Zeichenfolge (erforderlich)
path Pfad, der verschlüsselt werden muss. Zeichenfolge (erforderlich)

ComputedProperty

Name BESCHREIBUNG Wert
name Der Name einer berechneten Eigenschaft, z. B. "cp_lowerName" Zeichenfolge
Abfrage Die Abfrage, die den Wert für die berechnete Eigenschaft auswertet, z. B. "SELECT VALUE LOWER(c.name) FROM c" Zeichenfolge

Conflictresolutionpolicy

Name BESCHREIBUNG Wert
conflictResolutionPath Der Konfliktauflösungspfad im Fall des LastWriterWins-Modus. Zeichenfolge
conflictResolutionProcedure Die Prozedur zum Auflösen von Konflikten im Fall des benutzerdefinierten Modus. Zeichenfolge
Modus Gibt den Konfliktauflösungsmodus an. "Benutzerdefiniert"
"LastWriterWins"

IndexingPolicy

Name BESCHREIBUNG Wert
automatic 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 einbezogen werden sollen IncludedPath[]
indexingMode Gibt den Indizierungsmodus an. "konsistent"
"faul"
"keine"
spatialIndexes Liste der räumlichen Besonderheiten SpatialSpec[]

CompositePath

Name BESCHREIBUNG Wert
order Sortierreihenfolge für zusammengesetzte Pfade. "Aufsteigend"
"absteigend"
path Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Platzhalter (/path/*) Zeichenfolge

ExcludedPath

Name BESCHREIBUNG Wert
path Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Platzhalter (/path/*) Zeichenfolge

IncludedPath

Name BESCHREIBUNG Wert
Indizes Liste der Indizes für diesen Pfad Indizes[]
path Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Platzhalter (/path/*) Zeichenfolge

Indizes

Name BESCHREIBUNG Wert
dataType Der Datentyp, auf den das Indizierungsverhalten angewendet wird. 'LineString'
"MultiPolygon"
"Zahl"
"Punkt"
"Polygon"
'Zeichenfolge'
kind Gibt den Indextyp an. "Hash"
"Bereich"
"Räumlicher Raum"
precision (Genauigkeit) Die Genauigkeit des Indexes. -1 ist maximale Genauigkeit. INT

SpatialSpec

Name BESCHREIBUNG Wert
path Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Platzhalter (/path/*) Zeichenfolge
types Liste des räumlichen Pfadtyps Zeichenfolgenarray, das folgendes enthält:
'LineString'
"MultiPolygon"
"Punkt"
"Polygon"

ContainerPartitionKey

Name BESCHREIBUNG Wert
kind Gibt die Art des Algorithmus an, der für die Partitionierung verwendet wird. Für MultiHash werden mehrere Partitionsschlüssel (bis zu drei maximal) für die Containererstellung unterstützt. "Hash"
"MultiHash"
"Bereich"
Pfade Liste der Pfade, mit denen Daten innerhalb des Containers partitioniert werden können string[]
version Gibt die Version der Partitionsschlüsseldefinition an. INT

Einschränkungen:
Min-Wert = 1
Maximaler Wert = 2

ResourceRestoreParameters

Name BESCHREIBUNG Wert
restoreSource Die ID des wiederherstellbaren Datenbankkontos, von dem aus die Wiederherstellung initiiert werden muss. Beispiel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} Zeichenfolge
restoreTimestampInUtc Zeit, zu der das Konto wiederhergestellt werden muss (ISO-8601-Format). Zeichenfolge

UniqueKeyPolicy

Name BESCHREIBUNG Wert
uniqueKeys Liste der eindeutigen Schlüssel für, die die Eindeutigkeitseinschränkungen für Dokumente in der Sammlung im Azure Cosmos DB-Dienst erzwingen. UniqueKey[]

UniqueKey

Name BESCHREIBUNG Wert
Pfade Die Liste der Pfade muss für jedes Dokument im Azure Cosmos DB-Dienst eindeutig sein. string[]

Schnellstartvorlagen

Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.

Vorlage BESCHREIBUNG
Erstellen eines Azure Cosmos DB-Kontos im Free-Tarif

Bereitstellen in Azure		 Mit dieser Vorlage wird ein Azure Cosmos DB-Konto für die SQL-API mit einer Datenbank mit freigegebenem Durchsatz und Container erstellt.
Erstellen eines Azure Cosmos DB-Kontos für die SQL-API (Core)

Bereitstellen in Azure		 Mit dieser Vorlage wird eine SQL-API (Azure Cosmos-Konto für Core) mit einer Datenbank und einem Container mit Durchsatz mit mehreren anderen Optionen erstellt.
SQL-API des Azure Cosmos DB-Kontos mit Analysespeicher

Bereitstellen in Azure		 Mit dieser Vorlage wird eine SQL-API (Azure Cosmos-Konto für Core) mit einer Datenbank und einem Container erstellt, die mit dem Analysespeicher konfiguriert sind.
Erstellen einer SQL-API für ein Azure Cosmos DB-Konto mit automatischer Skalierung

Bereitstellen in Azure		 Diese Vorlage erstellt eine SQL-API (Azure Cosmos-Konto für Core) mit einer Datenbank und einem Container mit automatischem Skalierungsdurchsatz mit mehreren anderen Optionen.
Erstellen gespeicherter Prozeduren der Azure Cosmos DB Core-API (SQL)

Bereitstellen in Azure		 Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die SQL-API (Core) und einen Container mit einer gespeicherten Prozedur, einem Trigger und einer benutzerdefinierten Funktion.
Bereitstellen von Azure Data Explorer DB mit Cosmos DB-Verbindung

Bereitstellen in Azure		 Bereitstellen von Azure Data Explorer DB mit Cosmos DB-Verbindung

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp databaseAccounts/sqlDatabases/containers kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
  "apiVersion": "2023-11-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "analyticalStorageTtl": "int",
      "clientEncryptionPolicy": {
        "includedPaths": [
          {
            "clientEncryptionKeyId": "string",
            "encryptionAlgorithm": "string",
            "encryptionType": "string",
            "path": "string"
          }
        ],
        "policyFormatVersion": "int"
      },
      "computedProperties": [
        {
          "name": "string",
          "query": "string"
        }
      ],
      "conflictResolutionPolicy": {
        "conflictResolutionPath": "string",
        "conflictResolutionProcedure": "string",
        "mode": "string"
      },
      "createMode": "string",
      "defaultTtl": "int",
      "id": "string",
      "indexingPolicy": {
        "automatic": "bool",
        "compositeIndexes": [
          {
            "order": "string",
            "path": "string"
          }
        ],
        "excludedPaths": [
          {
            "path": "string"
          }
        ],
        "includedPaths": [
          {
            "indexes": [
              {
                "dataType": "string",
                "kind": "string",
                "precision": "int"
              }
            ],
            "path": "string"
          }
        ],
        "indexingMode": "string",
        "spatialIndexes": [
          {
            "path": "string",
            "types": [ "string" ]
          }
        ]
      },
      "partitionKey": {
        "kind": "string",
        "paths": [ "string" ],
        "version": "int"
      },
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string"
      },
      "uniqueKeyPolicy": {
        "uniqueKeys": [
          {
            "paths": [ "string" ]
          }
        ]
      }
    }
  }
}

Eigenschaftswerte

databaseAccounts/sqlDatabases/containers

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers"
apiVersion Die Ressourcen-API-Version '2023-11-15'
name Der Ressourcenname

Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen festlegen.		 Zeichenfolge (erforderlich)
location Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. Zeichenfolge
tags Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Die Standardumgebung für einen Vorlagentyp ist beispielsweise mit "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB". Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
properties Eigenschaften zum Erstellen und Aktualisieren eines Azure Cosmos DB-Containers. SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (erforderlich)

SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...

Name BESCHREIBUNG Wert
Optionen Ein Schlüssel-Wert-Paar von Optionen, die für die Anforderung angewendet werden sollen. Dies entspricht den Headern, die mit der Anforderung gesendet wurden. CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
resource Das JSON-Standardformat eines Containers SqlContainerResourceOrSqlContainerGetPropertiesResou... (erforderlich)

CreateUpdateOptionsOrSqlContainerGetPropertiesOption...

Name BESCHREIBUNG Wert
autoscaleSettings Gibt die Einstellungen für die automatische Skalierung an. Hinweis: Entweder durchsatz oder autoscaleSettings ist erforderlich, aber nicht beides. AutoscaleSettings
throughput Anforderungseinheiten pro Sekunde. Beispiel: "Durchsatz": 10000. INT

AutoscaleSettings

Name BESCHREIBUNG Wert
maxThroughput Stellt den maximalen Durchsatz dar, auf den die Ressource hochskaliert werden kann. INT

SqlContainerResourceOrSqlContainerGetPropertiesResou...

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 Enumeration, um den Modus der Ressourcenerstellung anzugeben. 'Standardwert'
"Wiederherstellen"
defaultTtl Standardzeit INT
id Name des Cosmos DB SQL-Containers Zeichenfolge (erforderlich)
indexingPolicy Die Konfiguration der Indizierungsrichtlinie. Standardmäßig erfolgt die Indizierung für alle Dokumentpfade im Container automatisch. IndexingPolicy
partitionKey Die Konfiguration des Partitionsschlüssels, der zum Partitionieren von Daten in mehrere Partitionen verwendet werden soll ContainerPartitionKey
restoreParameters Parameter zum Angeben der Informationen zur Wiederherstellung ResourceRestoreParameters
uniqueKeyPolicy Die Richtlinienkonfiguration für eindeutige Schlüssel zum Angeben von Eindeutigkeitseinschränkungen für Dokumente in der Sammlung im Azure Cosmos DB-Dienst. UniqueKeyPolicy

ClientEncryptionPolicy

Name BESCHREIBUNG Wert
includedPaths Pfade des Elements, die verschlüsselungsbedürftig sind, sowie pfadspezifische Einstellungen. ClientEncryptionIncludedPath[] (erforderlich)
policyFormatVersion Version der Definition der Clientverschlüsselungsrichtlinie. Unterstützte Versionen sind 1 und 2. Version 2 unterstützt die Pfadverschlüsselung für ID und Partitionsschlüssel. int (erforderlich)

Einschränkungen:
Min-Wert = 1
Maximaler Wert = 2

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. Z. B. AEAD_AES_256_CBC_HMAC_SHA256. Zeichenfolge (erforderlich)
encryptionType Der Typ der auszuführenden Verschlüsselung. Z. B. deterministisch, randomisiert. Zeichenfolge (erforderlich)
path Pfad, der verschlüsselt werden muss. Zeichenfolge (erforderlich)

ComputedProperty

Name BESCHREIBUNG Wert
name Der Name einer berechneten Eigenschaft, z. B. "cp_lowerName" Zeichenfolge
Abfrage Die Abfrage, die den Wert für die berechnete Eigenschaft auswertet, z. B. "SELECT VALUE LOWER(c.name) FROM c" Zeichenfolge

Conflictresolutionpolicy

Name BESCHREIBUNG Wert
conflictResolutionPath Der Konfliktauflösungspfad im Fall des LastWriterWins-Modus. Zeichenfolge
conflictResolutionProcedure Die Prozedur zum Auflösen von Konflikten im Fall des benutzerdefinierten Modus. Zeichenfolge
Modus Gibt den Konfliktauflösungsmodus an. "Benutzerdefiniert"
"LastWriterWins"

IndexingPolicy

Name BESCHREIBUNG Wert
automatic Gibt an, ob die Indizierungsrichtlinie automatisch erfolgt. 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 einbezogen werden sollen IncludedPath[]
indexingMode Gibt den Indizierungsmodus an. "konsistent"
"faul"
"keine"
spatialIndexes Liste der räumlichen Besonderheiten SpatialSpec[]

CompositePath

Name BESCHREIBUNG Wert
order Sortierreihenfolge für zusammengesetzte Pfade. "aufsteigend"
"absteigend"
path Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit einem Wildcard (/path/*) Zeichenfolge

ExcludedPath

Name BESCHREIBUNG Wert
path Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit einem Wildcard (/path/*) Zeichenfolge

IncludedPath

Name BESCHREIBUNG Wert
Indizes Liste der Indizes für diesen Pfad Indizes[]
path Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit einem Wildcard (/path/*) Zeichenfolge

Indizes

Name BESCHREIBUNG Wert
dataType Der Datentyp, auf den das Indizierungsverhalten angewendet wird. 'LineString'
"MultiPolygon"
"Zahl"
"Punkt"
"Polygon"
"String"
kind Gibt den Indextyp an. "Hash"
"Bereich"
"Spatial"
precision (Genauigkeit) Die Genauigkeit des Indexes. -1 ist die maximale Genauigkeit. INT

SpatialSpec

Name BESCHREIBUNG Wert
path Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Platzhalter (/path/*) Zeichenfolge
types Liste des räumlichen Pfadtyps Zeichenfolgenarray, das folgendes enthält:
'LineString'
"MultiPolygon"
"Punkt"
"Polygon"

ContainerPartitionKey

Name BESCHREIBUNG Wert
kind Gibt die Art des Algorithmus an, der für die Partitionierung verwendet wird. Für MultiHash werden mehrere Partitionsschlüssel (bis zu drei maximal) für die Containererstellung unterstützt. "Hash"
"MultiHash"
"Bereich"
Pfade Liste der Pfade, mit denen Daten innerhalb des Containers partitioniert werden können string[]
version Gibt die Version der Partitionsschlüsseldefinition an. INT

Einschränkungen:
Min-Wert = 1
Maximaler Wert = 2

ResourceRestoreParameters

Name BESCHREIBUNG Wert
restoreSource Die ID des wiederherstellbaren Datenbankkontos, von dem aus die Wiederherstellung initiiert werden muss. Beispiel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} Zeichenfolge
restoreTimestampInUtc Zeit, zu der das Konto wiederhergestellt werden muss (ISO-8601-Format). Zeichenfolge

UniqueKeyPolicy

Name BESCHREIBUNG Wert
uniqueKeys Liste der eindeutigen Schlüssel für, die die Eindeutigkeitseinschränkungen für Dokumente in der Sammlung im Azure Cosmos DB-Dienst erzwingen. UniqueKey[]

UniqueKey

Name BESCHREIBUNG Wert
Pfade Die Liste der Pfade muss für jedes Dokument im Azure Cosmos DB-Dienst eindeutig sein. string[]

Schnellstartvorlagen

Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.

Vorlage BESCHREIBUNG
Erstellen eines Azure Cosmos DB-Kontos im Free-Tarif

Bereitstellen in Azure		 Mit dieser Vorlage wird ein Azure Cosmos DB-Konto für die SQL-API mit einer Datenbank mit freigegebenem Durchsatz und Container erstellt.
Erstellen eines Azure Cosmos DB-Kontos für die SQL-API (Core)

Bereitstellen in Azure		 Mit dieser Vorlage wird eine SQL-API (Azure Cosmos-Konto für Core) mit einer Datenbank und einem Container mit Durchsatz mit mehreren anderen Optionen erstellt.
SQL-API des Azure Cosmos DB-Kontos mit Analysespeicher

Bereitstellen in Azure		 Mit dieser Vorlage wird eine SQL-API (Azure Cosmos-Konto für Core) mit einer Datenbank und einem Container erstellt, die mit dem Analysespeicher konfiguriert sind.
Erstellen einer SQL-API für ein Azure Cosmos DB-Konto mit automatischer Skalierung

Bereitstellen in Azure		 Diese Vorlage erstellt eine SQL-API (Azure Cosmos-Konto für Core) mit einer Datenbank und einem Container mit automatischem Skalierungsdurchsatz mit mehreren anderen Optionen.
Erstellen gespeicherter Prozeduren der Azure Cosmos DB Core-API (SQL)

Bereitstellen in Azure		 Diese Vorlage erstellt ein Azure Cosmos DB-Konto für die SQL-API (Core) und einen Container mit einer gespeicherten Prozedur, einem Trigger und einer benutzerdefinierten Funktion.
Bereitstellen von Azure Data Explorer DB mit Cosmos DB-Verbindung

Bereitstellen in Azure		 Bereitstellen von Azure Data Explorer DB mit Cosmos DB-Verbindung

Terraform (AzAPI-Anbieter) Ressourcendefinition

Der Ressourcentyp databaseAccounts/sqlDatabases/containers kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers-Ressource zu erstellen, fügen Sie der Vorlage die folgende Terraform-Ressource hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2023-11-15"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        analyticalStorageTtl = int
        clientEncryptionPolicy = {
          includedPaths = [
            {
              clientEncryptionKeyId = "string"
              encryptionAlgorithm = "string"
              encryptionType = "string"
              path = "string"
            }
          ]
          policyFormatVersion = int
        }
        computedProperties = [
          {
            name = "string"
            query = "string"
          }
        ]
        conflictResolutionPolicy = {
          conflictResolutionPath = "string"
          conflictResolutionProcedure = "string"
          mode = "string"
        }
        createMode = "string"
        defaultTtl = int
        id = "string"
        indexingPolicy = {
          automatic = bool
          compositeIndexes = [
            {
              order = "string"
              path = "string"
            }
          ]
          excludedPaths = [
            {
              path = "string"
            }
          ]
          includedPaths = [
            {
              indexes = [
                {
                  dataType = "string"
                  kind = "string"
                  precision = int
                }
              ]
              path = "string"
            }
          ]
          indexingMode = "string"
          spatialIndexes = [
            {
              path = "string"
              types = [
                "string"
              ]
            }
          ]
        }
        partitionKey = {
          kind = "string"
          paths = [
            "string"
          ]
          version = int
        }
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
        }
        uniqueKeyPolicy = {
          uniqueKeys = [
            {
              paths = [
                "string"
              ]
            }
          ]
        }
      }
    }
  })
}

Eigenschaftswerte

databaseAccounts/sqlDatabases/containers

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2023-11-15"
name Der Ressourcenname Zeichenfolge (erforderlich)
location Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. Zeichenfolge
parent_id Die ID der Ressource, die die übergeordnete Ressource für diese Ressource ist. ID für Ressource vom Typ: sqlDatabases
tags Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Die Standardumgebung für einen Vorlagentyp ist beispielsweise mit "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB". Wörterbuch der Tagnamen und -werte.
properties Eigenschaften zum Erstellen und Aktualisieren eines Azure Cosmos DB-Containers. SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (erforderlich)

SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...

Name BESCHREIBUNG Wert
Optionen Ein Schlüssel-Wert-Paar von Optionen, die für die Anforderung angewendet werden sollen. Dies entspricht den Headern, die mit der Anforderung gesendet wurden. CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
resource Das JSON-Standardformat eines Containers SqlContainerResourceOrSqlContainerGetPropertiesResou... (erforderlich)

CreateUpdateOptionsOrSqlContainerGetPropertiesOption...

Name BESCHREIBUNG Wert
autoscaleSettings Gibt die Einstellungen für die automatische Skalierung an. Hinweis: Entweder durchsatz oder autoscaleSettings ist erforderlich, aber nicht beides. AutoscaleSettings
throughput Anforderungseinheiten pro Sekunde. Beispiel: "Durchsatz": 10000. INT

AutoscaleSettings

Name BESCHREIBUNG Wert
maxThroughput Stellt den maximalen Durchsatz dar, auf den die Ressource hochskaliert werden kann. INT

SqlContainerResourceOrSqlContainerGetPropertiesResou...

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 Enumeration, um den Modus der Ressourcenerstellung anzugeben. "Standard"
"Wiederherstellen"
defaultTtl Standardzeit INT
id Name des Cosmos DB SQL-Containers Zeichenfolge (erforderlich)
indexingPolicy Die Konfiguration der Indizierungsrichtlinie. Standardmäßig erfolgt die Indizierung für alle Dokumentpfade im Container automatisch. IndexingPolicy
partitionKey Die Konfiguration des Partitionsschlüssels, der zum Partitionieren von Daten in mehrere Partitionen verwendet werden soll ContainerPartitionKey
restoreParameters Parameter zum Angeben der Informationen zur Wiederherstellung ResourceRestoreParameters
uniqueKeyPolicy Die Richtlinienkonfiguration für eindeutige Schlüssel zum Angeben von Eindeutigkeitseinschränkungen für Dokumente in der Sammlung im Azure Cosmos DB-Dienst. UniqueKeyPolicy

ClientEncryptionPolicy

Name BESCHREIBUNG Wert
includedPaths Pfade des Elements, die verschlüsselungsbedürftig sind, sowie pfadspezifische Einstellungen. ClientEncryptionIncludedPath[] (erforderlich)
policyFormatVersion Version der Definition der Clientverschlüsselungsrichtlinie. Unterstützte Versionen sind 1 und 2. Version 2 unterstützt die Pfadverschlüsselung für ID und Partitionsschlüssel. int (erforderlich)

Einschränkungen:
Min-Wert = 1
Maximaler Wert = 2

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. Beispiel: AEAD_AES_256_CBC_HMAC_SHA256. Zeichenfolge (erforderlich)
encryptionType Der Typ der auszuführenden Verschlüsselung. Z. B. deterministisch, randomisiert. Zeichenfolge (erforderlich)
path Pfad, der verschlüsselt werden muss. Zeichenfolge (erforderlich)

ComputedProperty

Name BESCHREIBUNG Wert
name Der Name einer berechneten Eigenschaft, z. B. "cp_lowerName" Zeichenfolge
Abfrage Die Abfrage, die den Wert für die berechnete Eigenschaft auswertet, z. B. "SELECT VALUE LOWER(c.name) FROM c" Zeichenfolge

Conflictresolutionpolicy

Name BESCHREIBUNG Wert
conflictResolutionPath Der Konfliktauflösungspfad im Fall des LastWriterWins-Modus. Zeichenfolge
conflictResolutionProcedure Die Prozedur zum Auflösen von Konflikten im Fall des benutzerdefinierten Modus. Zeichenfolge
Modus Gibt den Konfliktauflösungsmodus an. "Custom"
"LastWriterWins"

IndexingPolicy

Name BESCHREIBUNG Wert
automatic Gibt an, ob die Indizierungsrichtlinie automatisch erfolgt. 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 einbezogen werden sollen IncludedPath[]
indexingMode Gibt den Indizierungsmodus an. "konsistent"
"faul"
"keine"
spatialIndexes Liste der räumlichen Besonderheiten SpatialSpec[]

CompositePath

Name BESCHREIBUNG Wert
order Sortierreihenfolge für zusammengesetzte Pfade. "Aufsteigend"
"absteigend"
path Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit einem Wildcard (/path/*) Zeichenfolge

ExcludedPath

Name BESCHREIBUNG Wert
path Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit einem Wildcard (/path/*) Zeichenfolge

IncludedPath

Name BESCHREIBUNG Wert
Indizes Liste der Indizes für diesen Pfad Indizes[]
path Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit einem Wildcard (/path/*) Zeichenfolge

Indizes

Name BESCHREIBUNG Wert
dataType Der Datentyp, auf den das Indizierungsverhalten angewendet wird. "LineString"
"MultiPolygon"
"Zahl"
"Punkt"
"Polygon"
"String"
kind Gibt den Indextyp an. "Hash"
"Bereich"
"Raum"
precision (Genauigkeit) Die Genauigkeit des Indexes. -1 ist maximale Genauigkeit. INT

SpatialSpec

Name BESCHREIBUNG Wert
path Der Pfad, für den das Indizierungsverhalten gilt. Indexpfade beginnen in der Regel mit stamm und enden mit Platzhalter (/path/*) Zeichenfolge
types Liste des räumlichen Pfadtyps Zeichenfolgenarray, das folgendes enthält:
"LineString"
"MultiPolygon"
"Punkt"
"Polygon"

ContainerPartitionKey

Name BESCHREIBUNG Wert
kind Gibt die Art des Algorithmus an, der für die Partitionierung verwendet wird. Für MultiHash werden mehrere Partitionsschlüssel (bis zu drei maximal) für die Containererstellung unterstützt. "Hash"
"MultiHash"
"Bereich"
Pfade Liste der Pfade, mit denen Daten innerhalb des Containers partitioniert werden können string[]
version Gibt die Version der Partitionsschlüsseldefinition an. INT

Einschränkungen:
Min-Wert = 1
Maximaler Wert = 2

ResourceRestoreParameters

Name BESCHREIBUNG Wert
restoreSource Die ID des wiederherstellbaren Datenbankkontos, von dem aus die Wiederherstellung initiiert werden muss. Beispiel: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} Zeichenfolge
restoreTimestampInUtc Zeit, zu der das Konto wiederhergestellt werden muss (ISO-8601-Format). Zeichenfolge

UniqueKeyPolicy

Name BESCHREIBUNG Wert
uniqueKeys Liste der eindeutigen Schlüssel für, die die Eindeutigkeitseinschränkungen für Dokumente in der Sammlung im Azure Cosmos DB-Dienst erzwingen. UniqueKey[]

UniqueKey

Name BESCHREIBUNG Wert
Pfade Die Liste der Pfade muss für jedes Dokument im Azure Cosmos DB-Dienst eindeutig sein. string[]