Dela via

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

  • Artikel

Bicep-resursdefinition

Resurstypen databaseAccounts/apis/databases/collections kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en resurs för Microsoft.DocumentDB/databaseAccounts/apis/databases/collections lägger du till följande Bicep i mallen.

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

Egenskapsvärden

databaseAccounts/apis/databases/collections

Name Beskrivning Värde
name Resursnamnet

Se hur du anger namn och typer för underordnade resurser i Bicep.		 sträng (krävs)
parent I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen.

Mer information finns i Underordnad resurs utanför överordnad resurs.		 Symboliskt namn för resurs av typen: databaser
properties Egenskaper för att skapa och uppdatera Azure Cosmos DB MongoDB-samlingen. MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (krävs)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Name Beskrivning Värde
alternativ Ett nyckel/värde-par med alternativ som ska tillämpas för begäran. Detta motsvarar de huvuden som skickas med begäran. CreateUpdateOptions (obligatoriskt)
resource JSON-standardformatet för en MongoDB-samling MongoDBCollectionResource (krävs)

CreateUpdateOptions

Name Beskrivning Värde
{anpassad egenskap} sträng

MongoDBCollectionResource

Name Beskrivning Värde
id Namnet på Cosmos DB MongoDB-samlingen sträng (krävs)
Index Lista över indexnycklar MongoIndex[]
shardKey Ett nyckel/värde-par med shardnycklar som ska användas för begäran. ShardKeys

MongoIndex

Name Beskrivning Värde
nyckel Cosmos DB MongoDB-samlingsindexnycklar MongoIndexKeys
alternativ Alternativ för Cosmos DB MongoDB-samlingsindexnyckel MongoIndexOptions

MongoIndexKeys

Name Beskrivning Värde
keys Lista över nycklar för varje MongoDB-samling i Azure Cosmos DB-tjänsten string[]

MongoIndexOptions

Name Beskrivning Värde
expireAfterSeconds Upphör att gälla efter sekunder int
Unik Är unik eller inte boolesk

ShardKeys

Name Beskrivning Värde
{anpassad egenskap} sträng

Resursdefinition för ARM-mall

Resurstypen databaseAccounts/apis/databases/collections kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en resurs för Microsoft.DocumentDB/databaseAccounts/apis/databases/collections lägger du till följande JSON i mallen.

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

Egenskapsvärden

databaseAccounts/apis/databases/collections

Name Beskrivning Värde
typ Resurstypen "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections"
apiVersion Resurs-API-versionen '2016-03-31'
name Resursnamnet

Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar.		 sträng (krävs)
properties Egenskaper för att skapa och uppdatera Azure Cosmos DB MongoDB-samlingen. MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (krävs)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Name Beskrivning Värde
alternativ Ett nyckel/värde-par med alternativ som ska tillämpas för begäran. Detta motsvarar de huvuden som skickas med begäran. CreateUpdateOptions (obligatoriskt)
resource JSON-standardformatet för en MongoDB-samling MongoDBCollectionResource (krävs)

CreateUpdateOptions

Name Beskrivning Värde
{anpassad egenskap} sträng

MongoDBCollectionResource

Name Beskrivning Värde
id Namnet på Cosmos DB MongoDB-samlingen sträng (krävs)
Index Lista över indexnycklar MongoIndex[]
shardKey Ett nyckel/värde-par med shardnycklar som ska användas för begäran. ShardKeys

MongoIndex

Name Beskrivning Värde
nyckel Cosmos DB MongoDB-samlingsindexnycklar MongoIndexKeys
alternativ Alternativ för Cosmos DB MongoDB-samlingsindexnyckel MongoIndexOptions

MongoIndexKeys

Name Beskrivning Värde
keys Lista över nycklar för varje MongoDB-samling i Azure Cosmos DB-tjänsten string[]

MongoIndexOptions

Name Beskrivning Värde
expireAfterSeconds Upphör att gälla efter sekunder int
Unik Är unik eller inte boolesk

ShardKeys

Name Beskrivning Värde
{anpassad egenskap} sträng

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen databaseAccounts/apis/databases/collections kan distribueras med åtgärder som mål:

  • Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en resurs för Microsoft.DocumentDB/databaseAccounts/apis/databases/collections lägger du till följande Terraform i mallen.

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

Egenskapsvärden

databaseAccounts/apis/databases/collections

Name Beskrivning Värde
typ Resurstypen "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2016-03-31"
name Resursnamnet sträng (krävs)
parent_id ID:t för resursen som är överordnad för den här resursen. ID för resurs av typen: databaser
properties Egenskaper för att skapa och uppdatera MongoDB-samlingen för Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (krävs)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Name Beskrivning Värde
alternativ Ett nyckel/värde-par med alternativ som ska användas för begäran. Detta motsvarar rubrikerna som skickas med begäran. CreateUpdateOptions (krävs)
resource JSON-standardformatet för en MongoDB-samling MongoDBCollectionResource (krävs)

CreateUpdateOptions

Name Beskrivning Värde
{anpassad egenskap} sträng

MongoDBCollectionResource

Name Beskrivning Värde
id Namnet på Cosmos DB MongoDB-samlingen sträng (krävs)
Index Lista över indexnycklar MongoIndex[]
shardKey Ett nyckel/värde-par med shardnycklar som ska användas för begäran. ShardKeys

MongoIndex

Name Beskrivning Värde
nyckel Cosmos DB MongoDB-samlingsindexnycklar MongoIndexKeys
alternativ Nyckelalternativ för Cosmos DB MongoDB-samlingsindex MongoIndexOptions

MongoIndexKeys

Name Beskrivning Värde
keys Lista över nycklar för varje MongoDB-samling i Azure Cosmos DB-tjänsten string[]

MongoIndexOptions

Name Beskrivning Värde
expireAfterSeconds Upphör att gälla efter sekunder int
Unik Är unikt eller inte boolesk

ShardKeys

Name Beskrivning Värde
{anpassad egenskap} sträng