Base de dados Microsoft.DocumentDBContas/apis/bases de dados/coleções 2016-03-31

  • Artigo

Definição de recurso do Bicep

O tipo de recurso databaseAccounts/apis/databases/collections pode ser implementado com operações que visam:

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo 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@2016-03-31' = {
  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 subordinados no Bicep.		 cadeia (obrigatório)
principal No Bicep, pode especificar o recurso principal de um recurso subordinado. Só tem de adicionar esta propriedade quando o recurso subordinado for declarado fora do recurso principal.

Para obter mais informações, veja Recurso subordinado fora do recurso principal.		 Nome simbólico para recurso do tipo: bases de dados
propriedades Propriedades para criar e atualizar a coleção do MongoDB do Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (obrigatório)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Nome Descrição Valor
opções Um par de opções chave-valor a aplicar ao pedido. Isto corresponde aos cabeçalhos enviados com o pedido. CreateUpdateOptions (obrigatório)
recurso O formato JSON padrão de uma coleção do MongoDB MongoDBCollectionResource (obrigatório)

CreateUpdateOptions

Nome Descrição Valor
{customized property} string

MongoDBCollectionResource

Nome Descrição Valor
ID Nome da coleção do MongoDB do Cosmos DB cadeia (obrigatório)
índices Lista de chaves de índice MongoIndex[]
shardKey Um par chave-valor de chaves de partição horizontal a aplicar ao pedido. ShardKeys

MongoIndex

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

MongoIndexKeys

Nome Descrição Valor
keys Lista de chaves para cada coleção do MongoDB no serviço 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
{customized property} string

Definição de recurso do modelo arm

O tipo de recurso databaseAccounts/apis/databases/collections pode ser implementado com operações que visam:

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo 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": "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

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 '2016-03-31'
name O nome do recurso

Veja como definir nomes e tipos para recursos subordinados em modelos arm JSON.		 cadeia (obrigatório)
propriedades Propriedades para criar e atualizar a coleção do MongoDB do Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (obrigatório)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Nome Descrição Valor
opções Um par de opções chave-valor a aplicar ao pedido. Isto corresponde aos cabeçalhos enviados com o pedido. CreateUpdateOptions (obrigatório)
recurso O formato JSON padrão de uma coleção do MongoDB MongoDBCollectionResource (obrigatório)

CreateUpdateOptions

Nome Descrição Valor
{customized property} string

MongoDBCollectionResource

Nome Descrição Valor
ID Nome da coleção do MongoDB do Cosmos DB cadeia (obrigatório)
índices Lista de chaves de índice MongoIndex[]
shardKey Um par chave-valor de chaves de partição horizontal a aplicar ao pedido. ShardKeys

MongoIndex

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

MongoIndexKeys

Nome Descrição Valor
keys Lista de chaves para cada coleção do MongoDB no serviço 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
{customized property} string

Definição de recurso terraform (fornecedor AzAPI)

O tipo de recurso databaseAccounts/apis/databases/collections pode ser implementado com operações que visam:

  • Grupos de recursos

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo 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@2016-03-31"
  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@2016-03-31"
name O nome do recurso cadeia (obrigatório)
parent_id O ID do recurso que é o principal para este recurso. ID do recurso do tipo: bases de dados
propriedades Propriedades para criar e atualizar a coleção do MongoDB do Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (obrigatório)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Nome Descrição Valor
opções Um par de opções chave-valor a aplicar ao pedido. Isto corresponde aos cabeçalhos enviados com o pedido. CreateUpdateOptions (obrigatório)
recurso O formato JSON padrão de uma coleção do MongoDB MongoDBCollectionResource (obrigatório)

CreateUpdateOptions

Nome Descrição Valor
{customized property} string

MongoDBCollectionResource

Nome Descrição Valor
ID Nome da coleção do MongoDB do Cosmos DB cadeia (obrigatório)
índices Lista de chaves de índice MongoIndex[]
shardKey Um par chave-valor de chaves de partição horizontal a aplicar ao pedido. ShardKeys

MongoIndex

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

MongoIndexKeys

Nome Descrição Valor
keys Lista de chaves para cada coleção do MongoDB no serviço 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
{customized property} string