Delen via

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

Bicep-resourcedefinitie

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

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

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

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

Eigenschapswaarden

Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

Naam Beschrijving Waarde
naam De resourcenaam tekenreeks (vereist)
ouder 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 de bovenliggende resourcevoor meer informatie.		 Symbolische naam voor resource van het type: databaseAccounts/apis/databases
Eigenschappen Eigenschappen voor het maken en bijwerken van azure Cosmos DB MongoDB-verzameling. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties (vereist)

CreateUpdateOpties

Naam Beschrijving Waarde

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

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

MongoDBCollectionResource

Naam Beschrijving Waarde
legitimatiebewijs Naam van de Cosmos DB MongoDB-verzameling tekenreeks (vereist)
Indexen Lijst met indexsleutels MongoIndex
scherf Sleutel Een sleutel-waardepaar van shardsleutels die moeten worden toegepast voor de aanvraag. Scherf Sleutels

Mongo-index

Naam Beschrijving Waarde
sleutel Indexsleutels voor Cosmos DB MongoDB-verzameling MongoIndexKeys
Opties Indexopties voor cosmos DB MongoDB-verzameling MongoIndexOptions-

MongoIndexKeys

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

MongoIndexOpties

Naam Beschrijving Waarde
vervaltAfterSeconds Verlopen na seconden Int
uniek Is uniek of niet Bool

Scherf Sleutels

Naam Beschrijving Waarde

Resourcedefinitie van ARM-sjabloon

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

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

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

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

Eigenschapswaarden

Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

Naam Beschrijving Waarde
apiVersion De API-versie '2016-03-31'
naam De resourcenaam tekenreeks (vereist)
Eigenschappen Eigenschappen voor het maken en bijwerken van azure Cosmos DB MongoDB-verzameling. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties (vereist)
soort Het resourcetype 'Microsoft.DocumentDB/databaseAccounts/apis/databases/collections'

CreateUpdateOpties

Naam Beschrijving Waarde

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

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

MongoDBCollectionResource

Naam Beschrijving Waarde
legitimatiebewijs Naam van de Cosmos DB MongoDB-verzameling tekenreeks (vereist)
Indexen Lijst met indexsleutels MongoIndex
scherf Sleutel Een sleutel-waardepaar van shardsleutels die moeten worden toegepast voor de aanvraag. Scherf Sleutels

Mongo-index

Naam Beschrijving Waarde
sleutel Indexsleutels voor Cosmos DB MongoDB-verzameling MongoIndexKeys
Opties Indexopties voor cosmos DB MongoDB-verzameling MongoIndexOptions-

MongoIndexKeys

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

MongoIndexOpties

Naam Beschrijving Waarde
vervaltAfterSeconds Verlopen na seconden Int
uniek Is uniek of niet Bool

Scherf Sleutels

Naam Beschrijving Waarde

Gebruiksvoorbeelden

Resourcedefinitie van Terraform (AzAPI-provider)

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

  • resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

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

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

Eigenschapswaarden

Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

Naam Beschrijving Waarde
naam De resourcenaam tekenreeks (vereist)
ouder_id De id van de resource die het bovenliggende item voor deze resource is. Id voor resource van het type: databaseAccounts/apis/databases
Eigenschappen Eigenschappen voor het maken en bijwerken van azure Cosmos DB MongoDB-verzameling. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties (vereist)
soort Het resourcetype "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2016-03-31"

CreateUpdateOpties

Naam Beschrijving Waarde

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

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

MongoDBCollectionResource

Naam Beschrijving Waarde
legitimatiebewijs Naam van de Cosmos DB MongoDB-verzameling tekenreeks (vereist)
Indexen Lijst met indexsleutels MongoIndex
scherf Sleutel Een sleutel-waardepaar van shardsleutels die moeten worden toegepast voor de aanvraag. Scherf Sleutels

Mongo-index

Naam Beschrijving Waarde
sleutel Indexsleutels voor Cosmos DB MongoDB-verzameling MongoIndexKeys
Opties Indexopties voor cosmos DB MongoDB-verzameling MongoIndexOptions-

MongoIndexKeys

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

MongoIndexOpties

Naam Beschrijving Waarde
vervaltAfterSeconds Verlopen na seconden Int
uniek Is uniek of niet Bool

Scherf Sleutels

Naam Beschrijving Waarde