Partager via

Microsoft.DocumentDB databaseAccounts/apis/databases/collections

  • Article

Définition de ressource Bicep

Le type de ressource databaseAccounts/apis/databases/collections peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/apis/databases/collections, ajoutez le bicep suivant à votre modèle.

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

Valeurs de propriété

CreateUpdateOptions

Nom Description Valeur

Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

Nom Description Valeur
nom Nom de la ressource chaîne (obligatoire)
parent Dans Bicep, vous pouvez spécifier la ressource parente d’une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente.

Pour plus d’informations, consultez ressource enfant en dehors de la ressource parente.		 Nom symbolique de la ressource de type : databaseAccounts/apis/databases
Propriétés Propriétés permettant de créer et de mettre à jour la collection MongoDB Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties (obligatoire)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

Nom Description Valeur
Options Paire clé-valeur d’options à appliquer pour la requête. Cela correspond aux en-têtes envoyés avec la requête. CreateUpdateOptions (obligatoire)
ressource Format JSON standard d’une collection MongoDB MongoDBCollectionResource (obligatoire)

MongoDBCollectionResource

Nom Description Valeur
id Nom de la collection MongoDB Cosmos DB chaîne (obligatoire)
Index Liste des clés d’index MongoIndex[]
shardKey Paire clé-valeur de clés de partition à appliquer pour la requête. ShardKeys

MongoIndex

Nom Description Valeur
clé Clés d’index de collection MongoDB Cosmos DB MongoIndexKeys
Options Options de clé d’index d’index de collection Cosmos DB MongoDB MongoIndexOptions

MongoIndexKeys

Nom Description Valeur
Clés Liste des clés pour chaque collection MongoDB dans le service Azure Cosmos DB string[]

MongoIndexOptions

Nom Description Valeur
expireAfterSeconds Expirer après secondes Int
unique Est unique ou non Bool

ShardKeys

Nom Description Valeur

Définition de ressource de modèle ARM

Le type de ressource databaseAccounts/apis/databases/collections peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/apis/databases/collections, ajoutez le code JSON suivant à votre modèle.

{
  "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"
      }
    }
  }
}

Valeurs de propriété

CreateUpdateOptions

Nom Description Valeur

Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

Nom Description Valeur
apiVersion Version de l’API '2016-03-31'
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés permettant de créer et de mettre à jour la collection MongoDB Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties (obligatoire)
type Type de ressource 'Microsoft.DocumentDB/databaseAccounts/apis/databases/collections'

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

Nom Description Valeur
Options Paire clé-valeur d’options à appliquer pour la requête. Cela correspond aux en-têtes envoyés avec la requête. CreateUpdateOptions (obligatoire)
ressource Format JSON standard d’une collection MongoDB MongoDBCollectionResource (obligatoire)

MongoDBCollectionResource

Nom Description Valeur
id Nom de la collection MongoDB Cosmos DB chaîne (obligatoire)
Index Liste des clés d’index MongoIndex[]
shardKey Paire clé-valeur de clés de partition à appliquer pour la requête. ShardKeys

MongoIndex

Nom Description Valeur
clé Clés d’index de collection MongoDB Cosmos DB MongoIndexKeys
Options Options de clé d’index d’index de collection Cosmos DB MongoDB MongoIndexOptions

MongoIndexKeys

Nom Description Valeur
Clés Liste des clés pour chaque collection MongoDB dans le service Azure Cosmos DB string[]

MongoIndexOptions

Nom Description Valeur
expireAfterSeconds Expirer après secondes Int
unique Est unique ou non Bool

ShardKeys

Nom Description Valeur

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource databaseAccounts/apis/databases/collections peut être déployé avec des opérations qui ciblent :

  • groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/apis/databases/collections, ajoutez la terraform suivante à votre modèle.

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"
        }
      }
    }
  })
}

Valeurs de propriété

CreateUpdateOptions

Nom Description Valeur

Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

Nom Description Valeur
nom Nom de la ressource chaîne (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID de ressource de type : databaseAccounts/apis/databases
Propriétés Propriétés permettant de créer et de mettre à jour la collection MongoDB Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties (obligatoire)
type Type de ressource « Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2016-03-31 »

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

Nom Description Valeur
Options Paire clé-valeur d’options à appliquer pour la requête. Cela correspond aux en-têtes envoyés avec la requête. CreateUpdateOptions (obligatoire)
ressource Format JSON standard d’une collection MongoDB MongoDBCollectionResource (obligatoire)

MongoDBCollectionResource

Nom Description Valeur
id Nom de la collection MongoDB Cosmos DB chaîne (obligatoire)
Index Liste des clés d’index MongoIndex[]
shardKey Paire clé-valeur de clés de partition à appliquer pour la requête. ShardKeys

MongoIndex

Nom Description Valeur
clé Clés d’index de collection MongoDB Cosmos DB MongoIndexKeys
Options Options de clé d’index d’index de collection Cosmos DB MongoDB MongoIndexOptions

MongoIndexKeys

Nom Description Valeur
Clés Liste des clés pour chaque collection MongoDB dans le service Azure Cosmos DB string[]

MongoIndexOptions

Nom Description Valeur
expireAfterSeconds Expirer après secondes Int
unique Est unique ou non Bool

ShardKeys

Nom Description Valeur