Microsoft.DocumentDB-DatenbankAccounts/apis/databases/containers 2016-03-19

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 Microsoft.DocumentDB/databaseAccounts/apis/databases/containers-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2016-03-19' = {
  name: 'string'
  parent: resourceSymbolicName
  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

databaseAccounts/apis/databases/containers

Name BESCHREIBUNG Wert
name Der Ressourcenname

Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in Bicep festlegen.
Zeichenfolge (erforderlich)
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: Datenbanken
properties Eigenschaften zum Erstellen und Aktualisieren eines Azure Cosmos DB-Containers. SqlContainerCreateUpdatePropertiesOrSqlContainerProp... (erforderlich)

SqlContainerCreateUpdatePropertiesOrSqlContainerProp...

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. CreateUpdateOptions (erforderlich)
resource Das JSON-Standardformat eines Containers SqlContainerResource (erforderlich)

CreateUpdateOptions

Name BESCHREIBUNG Wert
{angepasste Eigenschaft} Zeichenfolge

SqlContainerResource

Name BESCHREIBUNG Wert
Conflictresolutionpolicy Die Konfliktlösungsrichtlinie für den Container. Conflictresolutionpolicy
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
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

Conflictresolutionpolicy

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

IndexingPolicy

Name BESCHREIBUNG Wert
automatic 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 einbezogen werden sollen IncludedPath[]
indexingMode Gibt den Indizierungsmodus an. "Konsistent"
"Faul"
"Keine"

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

ContainerPartitionKey

Name BESCHREIBUNG Wert
kind Gibt die Art des Algorithmus an, der für die Partitionierung verwendet wird. "Hash"
"Bereich"
Pfade Liste der Pfade, mit denen Daten innerhalb des Containers partitioniert werden können string[]

UniqueKeyPolicy

Name BESCHREIBUNG Wert
uniqueKeys Liste der eindeutigen Schlüssel für, die die Eindeutigkeitseinschränkung 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

In den folgenden Schnellstartvorlagen wird dieser Ressourcentyp bereitgestellt.

Vorlage BESCHREIBUNG
Erstellen von Azure Cosmos mit der 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.

Ressourcendefinition mit einer ARM-Vorlage

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 im Änderungsprotokoll.

Ressourcenformat

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers",
  "apiVersion": "2016-03-19",
  "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

databaseAccounts/apis/databases/containers

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers"
apiVersion Die Version der Ressourcen-API '2016-03-19'
name Der Ressourcenname

Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen.
Zeichenfolge (erforderlich)
properties Eigenschaften zum Erstellen und Aktualisieren eines Azure Cosmos DB-Containers. SqlContainerCreateUpdatePropertiesOrSqlContainerProp... (erforderlich)

SqlContainerCreateUpdatePropertiesOrSqlContainerProp...

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. CreateUpdateOptions (erforderlich)
resource Das JSON-Standardformat eines Containers SqlContainerResource (erforderlich)

CreateUpdateOptions

Name BESCHREIBUNG Wert
{angepasste Eigenschaft} Zeichenfolge

SqlContainerResource

Name BESCHREIBUNG Wert
Conflictresolutionpolicy Die Konfliktlösungsrichtlinie für den Container. Conflictresolutionpolicy
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
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

Conflictresolutionpolicy

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

IndexingPolicy

Name BESCHREIBUNG Wert
automatic 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 einbezogen werden sollen IncludedPath[]
indexingMode Gibt den Indizierungsmodus an. "Konsistent"
"Faul"
"Keine"

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

ContainerPartitionKey

Name BESCHREIBUNG Wert
kind Gibt die Art des Algorithmus an, der für die Partitionierung verwendet wird. "Hash"
"Bereich"
Pfade Liste der Pfade, mit denen Daten innerhalb des Containers partitioniert werden können string[]

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 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 mehreren Containern.

Terraform (AzAPI-Anbieter) Ressourcendefinition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2016-03-19"
  name = "string"
  parent_id = "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

databaseAccounts/apis/databases/containers

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2016-03-19"
name Der Ressourcenname Zeichenfolge (erforderlich)
parent_id Die ID der Ressource, die die übergeordnete Ressource für diese Ressource ist. ID für Ressource vom Typ: Datenbanken
properties Eigenschaften zum Erstellen und Aktualisieren eines Azure Cosmos DB-Containers. SqlContainerCreateUpdatePropertiesOrSqlContainerProp... (erforderlich)

SqlContainerCreateUpdatePropertiesOrSqlContainerProp...

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. CreateUpdateOptions (erforderlich)
resource Das JSON-Standardformat eines Containers SqlContainerResource (erforderlich)

CreateUpdateOptions

Name BESCHREIBUNG Wert
{angepasste Eigenschaft} Zeichenfolge

SqlContainerResource

Name BESCHREIBUNG Wert
Conflictresolutionpolicy Die Konfliktlösungsrichtlinie für den Container. Conflictresolutionpolicy
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
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

Conflictresolutionpolicy

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

IndexingPolicy

Name BESCHREIBUNG Wert
automatic 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 einbezogen werden sollen IncludedPath[]
indexingMode Gibt den Indizierungsmodus an. "Konsistent"
"Faul"
"None"

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"
"String"
kind Gibt den Indextyp an. "Hash"
"Bereich"
"Raum"
precision (Genauigkeit) Die Genauigkeit des Indexes. -1 ist maximale Genauigkeit. INT

ContainerPartitionKey

Name BESCHREIBUNG Wert
kind Gibt die Art des Algorithmus an, der für die Partitionierung verwendet wird. "Hash"
"Bereich"
Pfade Liste der Pfade, mit denen Daten innerhalb des Containers partitioniert werden können string[]

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