Share via


Microsoft.DocumentDB-databaseAccounts/apis/databases/collections 2015-11-06

Bicep-resourcedefinitie

Het resourcetype databaseAccounts/apis/databases/collections kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een resource Microsoft.DocumentDB/databaseAccounts/apis/databases/collections wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2015-11-06' = {
  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'
      }
    }
  }
}

Eigenschapswaarden

databaseAccounts/apis/databases/verzamelingen

Naam Description Waarde
naam De resourcenaam

Meer informatie over het instellen van namen en typen voor onderliggende resources in Bicep.
tekenreeks (vereist)
Bovenliggende In Bicep kunt u de bovenliggende resource voor een onderliggende resource opgeven. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd.

Zie Onderliggende resource buiten bovenliggende resource voor meer informatie.
Symbolische naam voor resource van het type: databases
properties Eigenschappen voor het maken en bijwerken van Azure Cosmos DB MongoDB-verzameling. MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (vereist)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Naam Description Waarde
opties Een sleutel-waardepaar met opties die moeten worden toegepast op de aanvraag. Dit komt overeen met de headers die met de aanvraag zijn verzonden. CreateUpdateOptions (vereist)
resource De standaard-JSON-indeling van een MongoDB-verzameling MongoDBCollectionResource (vereist)

CreateUpdateOptions

Naam Description Waarde
{aangepaste eigenschap} tekenreeks

MongoDBCollectionResource

Naam Description Waarde
id Naam van de Cosmos DB MongoDB-verzameling tekenreeks (vereist)
Indexen Lijst met indexsleutels MongoIndex[]
shardKey Een sleutel-waardepaar van shardsleutels die moeten worden toegepast op de aanvraag. ShardKeys

MongoIndex

Naam Description Waarde
sleutel Cosmos DB MongoDB-verzamelingsindexsleutels MongoIndexKeys
opties Opties voor cosmos DB MongoDB-verzamelingsindexsleutels MongoIndexOptions

MongoIndexKeys

Naam Description Waarde
keys Lijst met sleutels voor elke MongoDB-verzameling in de Azure Cosmos DB-service tekenreeks[]

MongoIndexOptions

Naam Description Waarde
expireAfterSeconds Verlopen na seconden int
Unieke Is uniek of niet booleaans

ShardKeys

Naam Description Waarde
{aangepaste eigenschap} tekenreeks

Resourcedefinitie van ARM-sjabloon

Het resourcetype databaseAccounts/apis/databases/collections kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een resource Microsoft.DocumentDB/databaseAccounts/apis/databases/collections wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

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

Eigenschapswaarden

databaseAccounts/apis/databases/verzamelingen

Naam Description Waarde
type Het resourcetype 'Microsoft.DocumentDB/databaseAccounts/apis/databases/collections'
apiVersion De resource-API-versie '2015-11-06'
naam De resourcenaam

Meer informatie over het instellen van namen en typen voor onderliggende resources in JSON ARM-sjablonen.
tekenreeks (vereist)
properties Eigenschappen voor het maken en bijwerken van Azure Cosmos DB MongoDB-verzameling. MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (vereist)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Naam Description Waarde
opties Een sleutel-waardepaar met opties die moeten worden toegepast op de aanvraag. Dit komt overeen met de headers die met de aanvraag zijn verzonden. CreateUpdateOptions (vereist)
resource De standaard-JSON-indeling van een MongoDB-verzameling MongoDBCollectionResource (vereist)

CreateUpdateOptions

Naam Description Waarde
{aangepaste eigenschap} tekenreeks

MongoDBCollectionResource

Naam Description Waarde
id Naam van de Cosmos DB MongoDB-verzameling tekenreeks (vereist)
Indexen Lijst met indexsleutels MongoIndex[]
shardKey Een sleutel-waardepaar van shardsleutels die moeten worden toegepast op de aanvraag. ShardKeys

MongoIndex

Naam Description Waarde
sleutel Cosmos DB MongoDB-verzamelingsindexsleutels MongoIndexKeys
opties Opties voor cosmos DB MongoDB-verzamelingsindexsleutels MongoIndexOptions

MongoIndexKeys

Naam Description Waarde
keys Lijst met sleutels voor elke MongoDB-verzameling in de Azure Cosmos DB-service tekenreeks[]

MongoIndexOptions

Naam Description Waarde
expireAfterSeconds Verlopen na seconden int
Unieke Is uniek of niet booleaans

ShardKeys

Naam Description Waarde
{aangepaste eigenschap} tekenreeks

Resourcedefinitie van Terraform (AzAPI-provider)

Het resourcetype databaseAccounts/apis/databases/collections kan worden geïmplementeerd met bewerkingen die zijn gericht op:

  • Resourcegroepen

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een resource Microsoft.DocumentDB/databaseAccounts/apis/databases/collections wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2015-11-06"
  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"
        }
      }
    }
  })
}

Eigenschapswaarden

databaseAccounts/apis/databases/verzamelingen

Naam Description Waarde
type Het resourcetype "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2015-11-06"
naam De resourcenaam tekenreeks (vereist)
parent_id De id van de resource die het bovenliggende item voor deze resource is. Id voor resource van type: databases
properties Eigenschappen voor het maken en bijwerken van Azure Cosmos DB MongoDB-verzameling. MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (vereist)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Naam Description Waarde
opties Een sleutel-waardepaar met opties die voor de aanvraag moeten worden toegepast. Dit komt overeen met de headers die met de aanvraag zijn verzonden. CreateUpdateOptions (vereist)
resource De standaard-JSON-indeling van een MongoDB-verzameling MongoDBCollectionResource (vereist)

CreateUpdateOptions

Naam Description Waarde
{aangepaste eigenschap} tekenreeks

MongoDBCollectionResource

Naam Description Waarde
id Naam van de Cosmos DB MongoDB-verzameling tekenreeks (vereist)
Indexen Lijst met indexsleutels MongoIndex[]
shardKey Een sleutel-waardepaar van shardsleutels die moeten worden toegepast op de aanvraag. ShardKeys

MongoIndex

Naam Description Waarde
sleutel Indexsleutels voor Cosmos DB MongoDB-verzameling MongoIndexKeys
opties Opties voor cosmos DB MongoDB-verzamelingsindexsleutels MongoIndexOptions

MongoIndexKeys

Naam Description Waarde
keys Lijst met sleutels voor elke MongoDB-verzameling in de Azure Cosmos DB-service tekenreeks[]

MongoIndexOptions

Naam Description Waarde
expireAfterSeconds Verlopen na seconden int
Unieke Is uniek of niet booleaans

ShardKeys

Naam Description Waarde
{aangepaste eigenschap} tekenreeks