Partilhar via

Banco de dados Microsoft.DocumentDBcontas/apis/bancos de dados/coleções 2015-11-06

  • Artigo

Definição de recursos do bíceps

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

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

Formato do recurso

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

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

Designação Descrição Valor

Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

Designação Descrição Valor
Designação O nome do recurso string (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 recurso do tipo: databaseAccounts/apis/databases
propriedades Propriedades para criar e atualizar a coleção MongoDB do Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties (obrigatório)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

Designação Descrição Valor
Opções Um par de opções chave-valor a ser aplicado para a 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 MongoDB MongoDBCollectionResource (obrigatório)

MongoDBCollectionResource

Designação Descrição Valor
ID Nome da coleção Cosmos DB MongoDB string (obrigatório)
índices Lista de chaves de índice MongoIndex[]
Chave de fragmento Um par chave-valor de chaves de estilhaços a ser aplicado para a solicitação. ShardKeys

MongoIndex

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

MongoIndexKeys

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

MongoIndexOptions

Designação Descrição Valor
expirarAfterSeconds Expirar após segundos Int
único É único ou não Bool

ShardKeys

Designação Descrição Valor

Definição de recurso de modelo ARM

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

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

Formato do recurso

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

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

Designação Descrição Valor

Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

Designação Descrição Valor
apiVersion A versão api '2015-11-06'
Designação O nome do recurso string (obrigatório)
propriedades Propriedades para criar e atualizar a coleção MongoDB do Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties (obrigatório)
tipo O tipo de recurso 'Microsoft.DocumentDB/databaseAccounts/apis/databases/collections'

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

Designação Descrição Valor
Opções Um par de opções chave-valor a ser aplicado para a 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 MongoDB MongoDBCollectionResource (obrigatório)

MongoDBCollectionResource

Designação Descrição Valor
ID Nome da coleção Cosmos DB MongoDB string (obrigatório)
índices Lista de chaves de índice MongoIndex[]
Chave de fragmento Um par chave-valor de chaves de estilhaços a ser aplicado para a solicitação. ShardKeys

MongoIndex

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

MongoIndexKeys

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

MongoIndexOptions

Designação Descrição Valor
expirarAfterSeconds Expirar após segundos Int
único É único ou não Bool

ShardKeys

Designação Descrição Valor

Definição de recursos Terraform (provedor AzAPI)

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

  • Grupos de recursos

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

Formato do recurso

Para criar um recurso Microsoft.DocumentDB/databaseAccounts/apis/databases/collections, adicione o seguinte Terraform ao seu modelo.

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

Valores de propriedade

CreateUpdateOptions

Designação Descrição Valor

Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

Designação Descrição Valor
Designação O nome do recurso string (obrigatório)
parent_id A ID do recurso que é o pai para este recurso. ID para recurso do tipo: databaseAccounts/apis/databases
propriedades Propriedades para criar e atualizar a coleção MongoDB do Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties (obrigatório)
tipo O tipo de recurso "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2015-11-06"

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

Designação Descrição Valor
Opções Um par de opções chave-valor a ser aplicado para a 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 MongoDB MongoDBCollectionResource (obrigatório)

MongoDBCollectionResource

Designação Descrição Valor
ID Nome da coleção Cosmos DB MongoDB string (obrigatório)
índices Lista de chaves de índice MongoIndex[]
Chave de fragmento Um par chave-valor de chaves de estilhaços a ser aplicado para a solicitação. ShardKeys

MongoIndex

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

MongoIndexKeys

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

MongoIndexOptions

Designação Descrição Valor
expirarAfterSeconds Expirar após segundos Int
único É único ou não Bool

ShardKeys

Designação Descrição Valor