Compartilhar via

Microsoft.DocumentDB databaseAccounts/mongodbDatabases/collections 2021-10-15

  • Artigo

Definição de recurso do Bicep

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

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/mongodbDatabases/collections, adicione o Bicep a seguir ao modelo.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2021-10-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      analyticalStorageTtl: int
      id: 'string'
      indexes: [
        {
          key: {
            keys: [
              'string'
            ]
          }
          options: {
            expireAfterSeconds: int
            unique: bool
          }
        }
      ]
      shardKey: {
        {customized property}: 'string'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propriedade

AutoscaleSettings

Nome Descrição Valor
maxThroughput Representa a taxa de transferência máxima, o recurso pode ser escalado verticalmente. int

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Nome Descrição Valor
autoscaleSettings Especifica as configurações de Dimensionamento Automático. autoscaleSettings
throughput Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": 10000. int

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Nome Descrição Valor
localização O local do grupo de recursos ao qual o recurso pertence. corda
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 do recurso do tipo: databaseAccounts/mongodbDatabases
Propriedades Propriedades para criar e atualizar a coleção mongoDB do Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (obrigatório)
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

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. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
recurso O formato JSON padrão de uma coleção do MongoDB MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (obrigatório)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Nome Descrição Valor
analyticalStorageTtl TTL analítico. int
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

Tags

Nome Descrição Valor

Exemplos de início rápido

Os exemplos de início rápido a seguir implantam esse tipo de recurso.

Arquivo Bicep Descrição
Criar uma conta do Azure Cosmos para a API do MongoDB Esse modelo cria uma conta do Azure Cosmos DB para a API 4.2 do MongoDB em duas regiões usando a taxa de transferência compartilhada e dedicada com duas coleções.
Criar uma conta do Azure Cosmos para o dimensionamento automático da API do MongoDB Esse modelo cria uma conta do Azure Cosmos DB para a API 4.2 do MongoDB em duas regiões usando a taxa de transferência de dimensionamento automático compartilhada e dedicada.

Definição de recurso de modelo do ARM

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

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/mongodbDatabases/collections, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections",
  "apiVersion": "2021-10-15",
  "name": "string",
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "analyticalStorageTtl": "int",
      "id": "string",
      "indexes": [
        {
          "key": {
            "keys": [ "string" ]
          },
          "options": {
            "expireAfterSeconds": "int",
            "unique": "bool"
          }
        }
      ],
      "shardKey": {
        "{customized property}": "string"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propriedade

AutoscaleSettings

Nome Descrição Valor
maxThroughput Representa a taxa de transferência máxima, o recurso pode ser escalado verticalmente. int

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Nome Descrição Valor
autoscaleSettings Especifica as configurações de Dimensionamento Automático. autoscaleSettings
throughput Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": 10000. int

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Nome Descrição Valor
apiVersion A versão da API '2021-10-15'
localização O local do grupo de recursos ao qual o recurso pertence. corda
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Propriedades para criar e atualizar a coleção mongoDB do Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (obrigatório)
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos
tipo O tipo de recurso 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections'

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

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. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
recurso O formato JSON padrão de uma coleção do MongoDB MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (obrigatório)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Nome Descrição Valor
analyticalStorageTtl TTL analítico. int
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

Tags

Nome Descrição Valor

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo Descrição
Criar uma conta do Azure Cosmos para a API do MongoDB

Implantar no Azure 		Esse modelo cria uma conta do Azure Cosmos DB para a API 4.2 do MongoDB em duas regiões usando a taxa de transferência compartilhada e dedicada com duas coleções.
Criar uma conta do Azure Cosmos para o dimensionamento automático da API do MongoDB

Implantar no Azure 		Esse modelo cria uma conta do Azure Cosmos DB para a API 4.2 do MongoDB em duas regiões usando a taxa de transferência de dimensionamento automático compartilhada e dedicada.

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso databaseAccounts/mongodbDatabases/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 de log de alterações.

Formato de recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2021-10-15"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        analyticalStorageTtl = int
        id = "string"
        indexes = [
          {
            key = {
              keys = [
                "string"
              ]
            }
            options = {
              expireAfterSeconds = int
              unique = bool
            }
          }
        ]
        shardKey = {
          {customized property} = "string"
        }
      }
    }
  })
}

Valores de propriedade

AutoscaleSettings

Nome Descrição Valor
maxThroughput Representa a taxa de transferência máxima, o recurso pode ser escalado verticalmente. int

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Nome Descrição Valor
autoscaleSettings Especifica as configurações de Dimensionamento Automático. autoscaleSettings
throughput Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": 10000. int

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Nome Descrição Valor
localização O local do grupo de recursos ao qual o recurso pertence. corda
nome 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: databaseAccounts/mongodbDatabases
Propriedades Propriedades para criar e atualizar a coleção mongoDB do Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (obrigatório)
Tags Marcas de recurso Dicionário de nomes e valores de marca.
tipo O tipo de recurso "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2021-10-15"

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

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. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
recurso O formato JSON padrão de uma coleção do MongoDB MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (obrigatório)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Nome Descrição Valor
analyticalStorageTtl TTL analítico. int
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

Tags

Nome Descrição Valor