Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

Definição de recurso do Bicep

O tipo de recurso databaseAccounts/apis/databases/collections pode ser implantado com operações direcionadas:

Grupos de recursos - Consulte comandos de implantação do grupo de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.DocumentDB/databaseAccounts/apis/databases/collections, adicione o Bicep a seguir ao seu modelo.

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

Valores de propriedade

CreateUpdateOptions

Nome	Descrição	Valor

Nome	Descrição	Valor
nome	O nome do recurso	cadeia de caracteres (obrigatório)
pai	No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai. Para obter mais informações, consulte recurso filho fora do recurso pai.	Nome simbólico para o recurso do tipo: databaseAccounts/apis/databases
Propriedades	Propriedades para criar e atualizar a coleção mongoDB do Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties (obrigatório)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

Nome	Descrição	Valor
Opções	Um par de opções chave-valor a ser aplicado à solicitação. Isso corresponde aos cabeçalhos enviados com a solicitação.	CreateUpdateOptions (obrigatório)
recurso	O formato JSON padrão de uma coleção do MongoDB	MongoDBCollectionResource (obrigatório)

MongoDBCollectionResource

Nome	Descrição	Valor
id	Nome da coleção Do MongoDB do Cosmos DB	cadeia de caracteres (obrigatório)
Índices	Lista de chaves de índice	MongoIndex []
shardKey	Um par chave-valor de chaves de fragmento a ser aplicado para a solicitação.	shardKeys

MongoIndex

Nome	Descrição	Valor
chave	Chaves de índice da coleção do MongoDB do Cosmos DB	MongoIndexKeys
Opções	Opções de chave de índice da coleção do MongoDB do Cosmos DB	MongoIndexOptions

MongoIndexKeys

Nome	Descrição	Valor
Chaves	Lista de chaves para cada coleção do MongoDB no serviço do Azure Cosmos DB	string[]

MongoIndexOptions

Nome	Descrição	Valor
expireAfterSeconds	Expirar após segundos	int
único	É exclusivo ou não	Bool

ShardKeys

Nome	Descrição	Valor

Definição de recurso de modelo do ARM

O tipo de recurso databaseAccounts/apis/databases/collections pode ser implantado com operações direcionadas:

Grupos de recursos - Consulte comandos de implantação do grupo de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.DocumentDB/databaseAccounts/apis/databases/collections, adicione o JSON a seguir ao modelo.

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

Valores de propriedade

CreateUpdateOptions

Nome	Descrição	Valor