Compartilhar via

Banco de dados Microsoft.DocumentDBAccounts/apis/databases/collections 2015-11-06

  • Artigo

Definição de recurso do Bicep

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 de recurso

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

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

Valores de propriedade

databaseAccounts/apis/databases/collections

Nome Descrição Valor
name O nome do recurso

Veja como definir nomes e tipos para recursos filho no Bicep.		 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: bancos de dados
properties Propriedades para criar e atualizar a coleção mongoDB do Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (obrigatório)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Nome Descrição Valor
opções Um par chave-valor de opções 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 do MongoDB MongoDBCollectionResource (obrigatório)

CreateUpdateOptions

Nome Descrição Valor
{propriedade personalizada} string

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 serem aplicadas para a solicitação. ShardKeys

MongoIndex

Nome Descrição Valor
chave Chaves de índice da coleção 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
exclusivo É exclusivo ou não bool

ShardKeys

Nome Descrição Valor
{propriedade personalizada} string

Definição de recurso de modelo do 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 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": "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

databaseAccounts/apis/databases/collections

Nome Descrição Valor
tipo O tipo de recurso 'Microsoft.DocumentDB/databaseAccounts/apis/databases/collections'
apiVersion A versão da API de recursos '2015-11-06'
name O nome do recurso

Veja como definir nomes e tipos para recursos filho em modelos do ARM JSON.		 cadeia de caracteres (obrigatório)
properties Propriedades para criar e atualizar a coleção mongoDB do Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (obrigatório)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Nome Descrição Valor
opções Um par chave-valor de opções 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 do MongoDB MongoDBCollectionResource (obrigatório)

CreateUpdateOptions

Nome Descrição Valor
{propriedade personalizada} string

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 serem aplicadas para a solicitação. ShardKeys

MongoIndex

Nome Descrição Valor
chave Chaves de índice da coleção 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
exclusivo É exclusivo ou não bool

ShardKeys

Nome Descrição Valor
{propriedade personalizada} string

Definição de recurso do 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 de recurso

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

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

Valores de propriedade

databaseAccounts/apis/databases/collections

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2015-11-06"
name O nome do recurso cadeia de caracteres (obrigatório)
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: bancos de dados
properties Propriedades para criar e atualizar a coleção mongoDB do Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (obrigatório)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Nome Descrição Valor
opções Um par chave-valor de opções 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 do MongoDB MongoDBCollectionResource (obrigatório)

CreateUpdateOptions

Nome Descrição Valor
{propriedade personalizada} string

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 serem aplicadas para a solicitação. ShardKeys

MongoIndex

Nome Descrição Valor
chave Chaves de índice da coleção 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
exclusivo É exclusivo ou não bool

ShardKeys

Nome Descrição Valor
{propriedade personalizada} string