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

• nejnovější
• 2016-03-31
• 2016-03-19
• 11. 11. 2015
• 04.04.2015
• 04.04.2015

Definice prostředku Bicep

Typ prostředku databaseAccounts/apis/databases/collections je možné nasadit s operacemi, které cílí:

• skupiny prostředků – viz příkazy nasazení skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts/apis/databases/collections, přidejte do šablony následující bicep.

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

Hodnoty vlastností

CreateUpdateOptions

Jméno	Popis	Hodnota

Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

Jméno	Popis	Hodnota
Jméno	Název prostředku	string (povinné)
rodič	V bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost je potřeba přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek. Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek.	Symbolický název prostředku typu: databaseAccounts/apis/databases
vlastnosti	Vlastnosti pro vytvoření a aktualizaci kolekce MongoDB služby Azure Cosmos DB	MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties (povinné)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

Jméno	Popis	Hodnota
volby	Pár možností klíč-hodnota, které se mají použít pro požadavek. Odpovídá hlavičkám odeslaným s požadavkem.	CreateUpdateOptions (povinné)
zdroj	Standardní formát JSON kolekce MongoDB	MongoDBCollectionResource (povinné)

MongoDBCollectionResource

Jméno	Popis	Hodnota
id	Název kolekce MongoDB služby Cosmos DB	string (povinné)
indexy	Seznam klíčů indexu	MongoIndex[]
shardKey	Pár klíč-hodnota klíče horizontálního oddílu, který se má použít pro požadavek.	ShardKeys

MongoIndex

Jméno	Popis	Hodnota
klíč	Klíče indexu kolekce MongoDB služby Cosmos DB	MongoIndexKeys
volby	Možnosti klíče indexu kolekce MongoDB služby Cosmos DB	MongoIndexOptions

MongoIndexKeys

Jméno	Popis	Hodnota
klíče	Seznam klíčů pro každou kolekci MongoDB ve službě Azure Cosmos DB	string[]

MongoIndexOptions

Jméno	Popis	Hodnota
expireAfterSeconds	Vypršení platnosti po sekundách	Int
jedinečný	Je jedinečný nebo ne	Bool

ShardKeys

Jméno	Popis	Hodnota

Definice prostředku šablony ARM

Typ prostředku databaseAccounts/apis/databases/collections je možné nasadit s operacemi, které cílí:

• skupiny prostředků – viz příkazy nasazení skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts/apis/databases/collections, přidejte do šablony následující JSON.

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

Hodnoty vlastností

CreateUpdateOptions

Jméno	Popis	Hodnota

Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

Jméno	Popis	Hodnota
apiVersion	Verze rozhraní API	'2015-04-01'
Jméno	Název prostředku	string (povinné)
vlastnosti	Vlastnosti pro vytvoření a aktualizaci kolekce MongoDB služby Azure Cosmos DB	MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties (povinné)
typ	Typ prostředku	Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

Jméno	Popis	Hodnota
volby	Pár možností klíč-hodnota, které se mají použít pro požadavek. Odpovídá hlavičkám odeslaným s požadavkem.	CreateUpdateOptions (povinné)
zdroj	Standardní formát JSON kolekce MongoDB	MongoDBCollectionResource (povinné)

MongoDBCollectionResource

Jméno	Popis	Hodnota
id	Název kolekce MongoDB služby Cosmos DB	string (povinné)
indexy	Seznam klíčů indexu	MongoIndex[]
shardKey	Pár klíč-hodnota klíče horizontálního oddílu, který se má použít pro požadavek.	ShardKeys

MongoIndex

Jméno	Popis	Hodnota
klíč	Klíče indexu kolekce MongoDB služby Cosmos DB	MongoIndexKeys
volby	Možnosti klíče indexu kolekce MongoDB služby Cosmos DB	MongoIndexOptions

MongoIndexKeys

Jméno	Popis	Hodnota
klíče	Seznam klíčů pro každou kolekci MongoDB ve službě Azure Cosmos DB	string[]

MongoIndexOptions

Jméno	Popis	Hodnota
expireAfterSeconds	Vypršení platnosti po sekundách	Int
jedinečný	Je jedinečný nebo ne	Bool

ShardKeys

Jméno	Popis	Hodnota

Příklady použití

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku databaseAccounts/apis/databases/collections je možné nasadit s operacemi, které cílí:

• skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/databaseAccounts/apis/databases/collections, přidejte do šablony následující Terraform.

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

Hodnoty vlastností

CreateUpdateOptions

Jméno	Popis	Hodnota

Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

Jméno	Popis	Hodnota
Jméno	Název prostředku	string (povinné)
parent_id	ID prostředku, který je nadřazený pro tento prostředek.	ID prostředku typu: databaseAccounts/apis/databases
vlastnosti	Vlastnosti pro vytvoření a aktualizaci kolekce MongoDB služby Azure Cosmos DB	MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties (povinné)
typ	Typ prostředku	Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2015-04-01"

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

Jméno	Popis	Hodnota
volby	Pár možností klíč-hodnota, které se mají použít pro požadavek. Odpovídá hlavičkám odeslaným s požadavkem.	CreateUpdateOptions (povinné)
zdroj	Standardní formát JSON kolekce MongoDB	MongoDBCollectionResource (povinné)

MongoDBCollectionResource

Jméno	Popis	Hodnota
id	Název kolekce MongoDB služby Cosmos DB	string (povinné)
indexy	Seznam klíčů indexu	MongoIndex[]
shardKey	Pár klíč-hodnota klíče horizontálního oddílu, který se má použít pro požadavek.	ShardKeys

MongoIndex

Jméno	Popis	Hodnota
klíč	Klíče indexu kolekce MongoDB služby Cosmos DB	MongoIndexKeys
volby	Možnosti klíče indexu kolekce MongoDB služby Cosmos DB	MongoIndexOptions

MongoIndexKeys

Jméno	Popis	Hodnota
klíče	Seznam klíčů pro každou kolekci MongoDB ve službě Azure Cosmos DB	string[]

MongoIndexOptions

Jméno	Popis	Hodnota
expireAfterSeconds	Vypršení platnosti po sekundách	Int
jedinečný	Je jedinečný nebo ne	Bool

ShardKeys

Jméno	Popis	Hodnota