Base de données Microsoft.DocumentDBAccounts/apis/databases/collections 31-2016-03-2016

• La plus récente
• 2016-03-31
• 2016-03-19
• 2015-11-06
• 2015-04-08
• 2015-04-01

Définition de ressource Bicep

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

• Groupes de ressources - Voir commandes de déploiement de groupes de ressources

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

Format des ressources

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

Valeurs de propriétés

databaseAccounts/apis/databases/collections

Nom	Description	Valeur
name	Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep.	chaîne (obligatoire)
parent	Dans Bicep, vous pouvez spécifier la ressource parente pour 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 : bases de données
properties	Propriétés permettant de créer et de mettre à jour la collection MongoDB Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (obligatoire)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

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

CreateUpdateOptions

Nom	Description	Valeur
{propriété personnalisée}		string

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 demande.	ShardKeys

MongoIndex

Nom	Description	Valeur
key	Clés d’index de collection MongoDB Cosmos DB	MongoIndexKeys
options	Options de clé d’index de collection MongoDB Cosmos DB	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 quelques secondes	int
unique	Est unique ou non	bool

ShardKeys

Nom	Description	Valeur
{propriété personnalisée}		string

Définition de ressources de modèle ARM

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

• Groupes de ressources - Voir commandes de déploiement de groupes de ressources

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

Format des ressources

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és

databaseAccounts/apis/databases/collections

Nom	Description	Valeur
type	Type de ressource	« Microsoft.DocumentDB/databaseAccounts/apis/databases/collections »
apiVersion	Version de l’API de ressource	'2016-03-31'
name	Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans des modèles ARM JSON.	chaîne (obligatoire)
properties	Propriétés permettant de créer et de mettre à jour la collection MongoDB Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (obligatoire)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

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

CreateUpdateOptions

Nom	Description	Valeur
{propriété personnalisée}		string

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 demande.	ShardKeys

MongoIndex

Nom	Description	Valeur
key	Clés d’index de collection MongoDB Cosmos DB	MongoIndexKeys
options	Options de clé d’index de collection MongoDB Cosmos DB	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 quelques secondes	int
unique	Est unique ou non	bool

ShardKeys

Nom	Description	Valeur
{propriété personnalisée}		string

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 des ressources

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

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

Valeurs de propriétés

databaseAccounts/apis/databases/collections

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

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

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

CreateUpdateOptions

Nom	Description	Valeur
{propriété personnalisée}		string

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 demande.	ShardKeys

MongoIndex

Nom	Description	Valeur
key	Clés d’index de collection MongoDB Cosmos DB	MongoIndexKeys
options	Options de clé d’index de collection MongoDB Cosmos DB	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 quelques secondes	int
unique	Est unique ou non	bool

ShardKeys

Nom	Description	Valeur
{propriété personnalisée}		string