Freigeben über


Microsoft.DocumentDB-DatenbankAccounts/apis/databases/collections

Bicep-Ressourcendefinition

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2016-03-31' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    options: {
      {customized property}: 'string'
    }
    resource: {
      id: 'string'
      indexes: [
        {
          key: {
            keys: [
              'string'
            ]
          }
          options: {
            expireAfterSeconds: int
            unique: bool
          }
        }
      ]
      shardKey: {
        {customized property}: 'string'
      }
    }
  }
}

Eigenschaftswerte

databaseAccounts/apis/databases/collections

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 der MongoDB-Sammlung von Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (erforderlich)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

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 einer MongoDB-Sammlung MongoDBCollectionResource (erforderlich)

CreateUpdateOptions

Name BESCHREIBUNG Wert
{angepasste Eigenschaft} Zeichenfolge

MongoDBCollectionResource

Name BESCHREIBUNG Wert
id Name der Cosmos DB MongoDB-Sammlung Zeichenfolge (erforderlich)
Indizes Liste der Indexschlüssel MongoIndex[]
shardKey Ein Schlüssel-Wert-Paar von Shardschlüsseln, die für die Anforderung angewendet werden sollen. ShardKeys

MongoIndex

Name BESCHREIBUNG Wert
Schlüssel Cosmos DB MongoDB-Sammlungsindexschlüssel MongoIndexKeys
Optionen Cosmos DB MongoDB-Sammlungsindexschlüsseloptionen MongoIndexOptions

MongoIndexKeys

Name BESCHREIBUNG Wert
keys Liste der Schlüssel für jede MongoDB-Sammlung im Azure Cosmos DB-Dienst string[]

MongoIndexOptions

Name BESCHREIBUNG Wert
expireAfterSeconds Ablauf nach Sekunden INT
unique Eindeutig ist oder nicht bool

ShardKeys

Name BESCHREIBUNG Wert
{angepasste Eigenschaft} Zeichenfolge

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp databaseAccounts/apis/databases/collections 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/collections zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections",
  "apiVersion": "2016-03-31",
  "name": "string",
  "properties": {
    "options": {
      "{customized property}": "string"
    },
    "resource": {
      "id": "string",
      "indexes": [
        {
          "key": {
            "keys": [ "string" ]
          },
          "options": {
            "expireAfterSeconds": "int",
            "unique": "bool"
          }
        }
      ],
      "shardKey": {
        "{customized property}": "string"
      }
    }
  }
}

Eigenschaftswerte

databaseAccounts/apis/databases/collections

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections"
apiVersion Die Version der Ressourcen-API '2016-03-31'
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 der MongoDB-Sammlung von Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (erforderlich)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

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 werden. CreateUpdateOptions (erforderlich)
resource Das JSON-Standardformat einer MongoDB-Auflistung MongoDBCollectionResource (erforderlich)

CreateUpdateOptions

Name BESCHREIBUNG Wert
{angepasste Eigenschaft} Zeichenfolge

MongoDBCollectionResource

Name BESCHREIBUNG Wert
id Name der MongoDB-Sammlung von Cosmos DB Zeichenfolge (erforderlich)
Indizes Liste der Indexschlüssel MongoIndex[]
shardKey Ein Schlüssel-Wert-Paar von Shardschlüsseln, die für die Anforderung angewendet werden sollen. ShardKeys

MongoIndex

Name BESCHREIBUNG Wert
Schlüssel Cosmos DB MongoDB-Sammlungsindexschlüssel MongoIndexKeys
Optionen Optionen für Cosmos DB-MongoDB-Sammlungsindexschlüssel MongoIndexOptions

MongoIndexKeys

Name BESCHREIBUNG Wert
keys Liste der Schlüssel für jede MongoDB-Sammlung im Azure Cosmos DB-Dienst string[]

MongoIndexOptions

Name BESCHREIBUNG Wert
expireAfterSeconds Ablauf nach Sekunden INT
unique Ist eindeutig oder nicht bool

ShardKeys

Name BESCHREIBUNG Wert
{angepasste Eigenschaft} Zeichenfolge

Terraform-Ressourcendefinition (AzAPI-Anbieter)

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

  • Ressourcengruppen

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

Ressourcenformat

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2016-03-31"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      options = {
        {customized property} = "string"
      }
      resource = {
        id = "string"
        indexes = [
          {
            key = {
              keys = [
                "string"
              ]
            }
            options = {
              expireAfterSeconds = int
              unique = bool
            }
          }
        ]
        shardKey = {
          {customized property} = "string"
        }
      }
    }
  })
}

Eigenschaftswerte

databaseAccounts/apis/databases/collections

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2016-03-31"
name Der Ressourcenname Zeichenfolge (erforderlich)
parent_id Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. ID für Ressource vom Typ: Datenbanken
properties Eigenschaften zum Erstellen und Aktualisieren der MongoDB-Sammlung von Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (erforderlich)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

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 werden. CreateUpdateOptions (erforderlich)
resource Das JSON-Standardformat einer MongoDB-Auflistung MongoDBCollectionResource (erforderlich)

CreateUpdateOptions

Name BESCHREIBUNG Wert
{angepasste Eigenschaft} Zeichenfolge

MongoDBCollectionResource

Name BESCHREIBUNG Wert
id Name der MongoDB-Sammlung von Cosmos DB Zeichenfolge (erforderlich)
Indizes Liste der Indexschlüssel MongoIndex[]
shardKey Ein Schlüssel-Wert-Paar von Shardschlüsseln, die für die Anforderung angewendet werden sollen. ShardKeys

MongoIndex

Name BESCHREIBUNG Wert
Schlüssel Cosmos DB MongoDB-Sammlungsindexschlüssel MongoIndexKeys
Optionen Optionen für Cosmos DB-MongoDB-Sammlungsindexschlüssel MongoIndexOptions

MongoIndexKeys

Name BESCHREIBUNG Wert
keys Liste der Schlüssel für jede MongoDB-Sammlung im Azure Cosmos DB-Dienst string[]

MongoIndexOptions

Name BESCHREIBUNG Wert
expireAfterSeconds Ablauf nach Sekunden INT
unique Ist eindeutig oder nicht bool

ShardKeys

Name BESCHREIBUNG Wert
{angepasste Eigenschaft} Zeichenfolge