Dela via

Microsoft.DocumentDB databaseAccounts/apis/databases/collections 2015-04-08

  • 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 Microsoft.DocumentDB/databaseAccounts/apis/databases/collections-resurs lägger du till följande Bicep i mallen.

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

Egenskapsvärden

CreateUpdateOptions

Namn Beskrivning Värde

Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

Namn Beskrivning Värde
Namn Resursnamnet sträng (krävs)
förälder 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 den överordnade resursen.		 Symboliskt namn för resurs av typen: databaseAccounts/apis/databases
Egenskaper Egenskaper för att skapa och uppdatera Azure Cosmos DB MongoDB-samlingen. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties (krävs)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

Namn 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)
resurs JSON-standardformatet för en MongoDB-samling MongoDBCollectionResource (krävs)

MongoDBCollectionResource

Namn 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

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

MongoIndexKeys

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

MongoIndexOptions

Namn Beskrivning Värde
expireAfterSeconds Upphör att gälla efter sekunder Int
unik Är unik eller inte Bool

ShardKeys

Namn Beskrivning Värde

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 Microsoft.DocumentDB/databaseAccounts/apis/databases/collections-resurs lägger du till följande JSON i mallen.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections",
  "apiVersion": "2015-04-08",
  "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

CreateUpdateOptions

Namn Beskrivning Värde

Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

Namn Beskrivning Värde
apiVersion API-versionen '2015-04-08'
Namn Resursnamnet sträng (krävs)
Egenskaper Egenskaper för att skapa och uppdatera Azure Cosmos DB MongoDB-samlingen. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties (krävs)
typ Resurstypen "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections"

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

Namn 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)
resurs JSON-standardformatet för en MongoDB-samling MongoDBCollectionResource (krävs)

MongoDBCollectionResource

Namn 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

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

MongoIndexKeys

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

MongoIndexOptions

Namn Beskrivning Värde
expireAfterSeconds Upphör att gälla efter sekunder Int
unik Är unik eller inte Bool

ShardKeys

Namn Beskrivning Värde

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 Microsoft.DocumentDB/databaseAccounts/apis/databases/collections-resurs lägger du till följande Terraform i mallen.

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

Egenskapsvärden

CreateUpdateOptions

Namn Beskrivning Värde

Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

Namn Beskrivning Värde
Namn Resursnamnet sträng (krävs)
parent_id ID för resursen som är överordnad för den här resursen. ID för resurs av typen: databaseAccounts/apis/databases
Egenskaper Egenskaper för att skapa och uppdatera Azure Cosmos DB MongoDB-samlingen. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties (krävs)
typ Resurstypen "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2015-04-08"

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

Namn 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)
resurs JSON-standardformatet för en MongoDB-samling MongoDBCollectionResource (krävs)

MongoDBCollectionResource

Namn 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

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

MongoIndexKeys

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

MongoIndexOptions

Namn Beskrivning Värde
expireAfterSeconds Upphör att gälla efter sekunder Int
unik Är unik eller inte Bool

ShardKeys

Namn Beskrivning Värde