Freigeben über


Microsoft.DocumentDB databaseAccounts/apis/databases/containers 2015-11-06

Bicep-Ressourcendefinition

Der Ressourcentyp "databaseAccounts/apis/databases/containers" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

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

Ressourcenformat

Um eine Ressource "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers" zu erstellen, fügen Sie ihrer Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2015-11-06' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    options: {
      {customized property}: 'string'
    }
    resource: {
      conflictResolutionPolicy: {
        conflictResolutionPath: 'string'
        conflictResolutionProcedure: 'string'
        mode: 'string'
      }
      defaultTtl: int
      id: 'string'
      indexingPolicy: {
        automatic: bool
        excludedPaths: [
          {
            path: 'string'
          }
        ]
        includedPaths: [
          {
            indexes: [
              {
                dataType: 'string'
                kind: 'string'
                precision: int
              }
            ]
            path: 'string'
          }
        ]
        indexingMode: 'string'
      }
      partitionKey: {
        kind: 'string'
        paths: [
          'string'
        ]
      }
      uniqueKeyPolicy: {
        uniqueKeys: [
          {
            paths: [
              'string'
            ]
          }
        ]
      }
    }
  }
}

Eigenschaftswerte

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. "Hash"
'Range'
Pfade Liste der Pfade, die verwenden, welche Daten innerhalb des Containers partitioniert werden können string[]

CreateUpdateOptions

Name Beschreibung Wert

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
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'

Microsoft.DocumentDB/databaseAccounts/apis/databases/containers

Name Beschreibung Wert
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/apis/databases
Eigenschaften Eigenschaften zum Erstellen und Aktualisieren des Azure Cosmos DB-Containers. SqlContainerCreateUpdatePropertiesOrSqlContainerProperties (erforderlich)

SqlContainerCreateUpdatePropertiesOrSqlContainerProperties

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. CreateUpdateOptions- (erforderlich)
Ressource Das standardmäßige JSON-Format eines Containers SqlContainerResource- (erforderlich)

SqlContainerResource

Name Beschreibung Wert
conflictResolutionPolicy Die Konfliktlösungsrichtlinie für den Container. ConflictResolutionPolicy-
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-
uniqueKeyPolicy Die Konfiguration der eindeutigen Schlüsselrichtlinie zum Angeben von Eindeutigkeitseinschränkungen für Dokumente in der Sammlung im Azure Cosmos DB-Dienst. UniqueKeyPolicy-

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-[]

ARM-Vorlagenressourcendefinition

Der Ressourcentyp "databaseAccounts/apis/databases/containers" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

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

Ressourcenformat

Um eine Ressource "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers" zu erstellen, fügen Sie Ihrer Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers",
  "apiVersion": "2015-11-06",
  "name": "string",
  "properties": {
    "options": {
      "{customized property}": "string"
    },
    "resource": {
      "conflictResolutionPolicy": {
        "conflictResolutionPath": "string",
        "conflictResolutionProcedure": "string",
        "mode": "string"
      },
      "defaultTtl": "int",
      "id": "string",
      "indexingPolicy": {
        "automatic": "bool",
        "excludedPaths": [
          {
            "path": "string"
          }
        ],
        "includedPaths": [
          {
            "indexes": [
              {
                "dataType": "string",
                "kind": "string",
                "precision": "int"
              }
            ],
            "path": "string"
          }
        ],
        "indexingMode": "string"
      },
      "partitionKey": {
        "kind": "string",
        "paths": [ "string" ]
      },
      "uniqueKeyPolicy": {
        "uniqueKeys": [
          {
            "paths": [ "string" ]
          }
        ]
      }
    }
  }
}

Eigenschaftswerte

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. "Hash"
'Range'
Pfade Liste der Pfade, die verwenden, welche Daten innerhalb des Containers partitioniert werden können string[]

CreateUpdateOptions

Name Beschreibung Wert

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
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'

Microsoft.DocumentDB/databaseAccounts/apis/databases/containers

Name Beschreibung Wert
apiVersion Die API-Version '2015-11-06'
Name Der Ressourcenname Zeichenfolge (erforderlich)
Eigenschaften Eigenschaften zum Erstellen und Aktualisieren des Azure Cosmos DB-Containers. SqlContainerCreateUpdatePropertiesOrSqlContainerProperties (erforderlich)
Art Der Ressourcentyp "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers"

SqlContainerCreateUpdatePropertiesOrSqlContainerProperties

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. CreateUpdateOptions- (erforderlich)
Ressource Das standardmäßige JSON-Format eines Containers SqlContainerResource- (erforderlich)

SqlContainerResource

Name Beschreibung Wert
conflictResolutionPolicy Die Konfliktlösungsrichtlinie für den Container. ConflictResolutionPolicy-
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-
uniqueKeyPolicy Die Konfiguration der eindeutigen Schlüsselrichtlinie zum Angeben von Eindeutigkeitseinschränkungen für Dokumente in der Sammlung im Azure Cosmos DB-Dienst. UniqueKeyPolicy-

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-[]

Schnellstartvorlagen

Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.

Schablone Beschreibung
Erstellen von Azure Cosmos mit SQL-API und mehreren Containern

Bereitstellen in Azure
Die Vorlage erstellt einen Cosmos-Container mit einer SQL-API und ermöglicht das Hinzufügen von multiitple Containern.

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp "databaseAccounts/apis/databases/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/apis/databases/containers" zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2015-11-06"
  name = "string"
  body = jsonencode({
    properties = {
      options = {
        {customized property} = "string"
      }
      resource = {
        conflictResolutionPolicy = {
          conflictResolutionPath = "string"
          conflictResolutionProcedure = "string"
          mode = "string"
        }
        defaultTtl = int
        id = "string"
        indexingPolicy = {
          automatic = bool
          excludedPaths = [
            {
              path = "string"
            }
          ]
          includedPaths = [
            {
              indexes = [
                {
                  dataType = "string"
                  kind = "string"
                  precision = int
                }
              ]
              path = "string"
            }
          ]
          indexingMode = "string"
        }
        partitionKey = {
          kind = "string"
          paths = [
            "string"
          ]
        }
        uniqueKeyPolicy = {
          uniqueKeys = [
            {
              paths = [
                "string"
              ]
            }
          ]
        }
      }
    }
  })
}

Eigenschaftswerte

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. "Hash"
'Range'
Pfade Liste der Pfade, die verwenden, welche Daten innerhalb des Containers partitioniert werden können string[]

CreateUpdateOptions

Name Beschreibung Wert

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
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'

Microsoft.DocumentDB/databaseAccounts/apis/databases/containers

Name Beschreibung Wert
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/apis/databases
Eigenschaften Eigenschaften zum Erstellen und Aktualisieren des Azure Cosmos DB-Containers. SqlContainerCreateUpdatePropertiesOrSqlContainerProperties (erforderlich)
Art Der Ressourcentyp "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2015-11-06"

SqlContainerCreateUpdatePropertiesOrSqlContainerProperties

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. CreateUpdateOptions- (erforderlich)
Ressource Das standardmäßige JSON-Format eines Containers SqlContainerResource- (erforderlich)

SqlContainerResource

Name Beschreibung Wert
conflictResolutionPolicy Die Konfliktlösungsrichtlinie für den Container. ConflictResolutionPolicy-
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-
uniqueKeyPolicy Die Konfiguration der eindeutigen Schlüsselrichtlinie zum Angeben von Eindeutigkeitseinschränkungen für Dokumente in der Sammlung im Azure Cosmos DB-Dienst. UniqueKeyPolicy-

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-[]