Freigeben über

Microsoft.DocumentDB databaseAccounts/apis/databases/collections 2016-03-31

  • Artikel

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

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

Eigenschaftswerte

CreateUpdateOptions

Name Beschreibung Wert

Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

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 der Azure Cosmos DB MongoDB-Auflistung. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties (erforderlich)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

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

MongoDBCollectionResource

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

MongoIndex

Name Beschreibung Wert
Schlüssel Cosmos DB MongoDB-Sammlungsindexschlüssel MongoIndexKeys
Optionen Schlüsseloptionen für Cosmos DB MongoDB-Auflistung MongoIndexOptions

MongoIndexKeys

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

MongoIndexOptions

Name Beschreibung Wert
expireAfterSeconds Ablauf nach Sekunden Int
einzigartig Ist eindeutig oder nicht Bool

ShardKeys

Name Beschreibung Wert

ARM-Vorlagenressourcendefinition

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

CreateUpdateOptions

Name Beschreibung Wert

Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

Name Beschreibung Wert
apiVersion Die API-Version '2016-03-31'
Name Der Ressourcenname Zeichenfolge (erforderlich)
Eigenschaften Eigenschaften zum Erstellen und Aktualisieren der Azure Cosmos DB MongoDB-Auflistung. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties (erforderlich)
Art Der Ressourcentyp "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections"

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

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

MongoDBCollectionResource

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

MongoIndex

Name Beschreibung Wert
Schlüssel Cosmos DB MongoDB-Sammlungsindexschlüssel MongoIndexKeys
Optionen Schlüsseloptionen für Cosmos DB MongoDB-Auflistung MongoIndexOptions

MongoIndexKeys

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

MongoIndexOptions

Name Beschreibung Wert
expireAfterSeconds Ablauf nach Sekunden Int
einzigartig Ist eindeutig oder nicht Bool

ShardKeys

Name Beschreibung Wert

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

Ressourcenformat

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

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

CreateUpdateOptions

Name Beschreibung Wert

Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

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 der Azure Cosmos DB MongoDB-Auflistung. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties (erforderlich)
Art Der Ressourcentyp "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2016-03-31"

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

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

MongoDBCollectionResource

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

MongoIndex

Name Beschreibung Wert
Schlüssel Cosmos DB MongoDB-Sammlungsindexschlüssel MongoIndexKeys
Optionen Schlüsseloptionen für Cosmos DB MongoDB-Auflistung MongoIndexOptions

MongoIndexKeys

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

MongoIndexOptions

Name Beschreibung Wert
expireAfterSeconds Ablauf nach Sekunden Int
einzigartig Ist eindeutig oder nicht Bool

ShardKeys

Name Beschreibung Wert