Compartilhar via

Banco de dados Microsoft.DocumentDBAccounts/mongodbDatabases/collections 2022-11-15-preview

  • 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 das propriedades alteradas em cada versão da API, consulte log de alterações.

Formato de recurso

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2022-11-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      analyticalStorageTtl: int
      createMode: 'string'
      id: 'string'
      indexes: [
        {
          key: {
            keys: [
              'string'
            ]
          }
          options: {
            expireAfterSeconds: int
            unique: bool
          }
        }
      ]
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
      }
      shardKey: {
        {customized property}: 'string'
      }
    }
  }
}

Valores de propriedade

databaseAccounts/mongodbDatabases/collections

Name Descrição Valor
name O nome do recurso

Veja como definir nomes e tipos para recursos filho no Bicep.		 cadeia de caracteres (obrigatório)
local O local do grupo de recursos ao qual o recurso pertence. string
marcas As marcas são uma lista de pares chave-valor que descrevem o recurso. Essas marcas podem ser usadas para exibir e agrupar esse recurso (entre grupos de recursos). Um máximo de 15 marcas pode ser fornecido para um recurso. Cada marca deve ter uma chave com no máximo 128 caracteres e um valor com no máximo 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB". Dicionário de nomes e valores de marcas. Confira Marcas em modelos
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: mongodbDatabases
identidade Identidade do recurso. ManagedServiceIdentity
properties Propriedades para criar e atualizar a coleção do MongoDB do Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (obrigatório)

ManagedServiceIdentity

Name Descrição Valor
tipo O tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá todas as identidades do serviço. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities A lista de identidades de usuário associadas ao recurso. As referências de chave de dicionário de identidade do usuário serão IDs de recurso do ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Descrição Valor
{propriedade personalizada} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Esse objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Name Descrição Valor
opções Um par chave-valor de opções a serem aplicadas à solicitação. Isso corresponde aos cabeçalhos enviados com a solicitação. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...
recurso O formato JSON padrão de uma coleção do MongoDB MongoDBCollectionResourceOrMongoDBCollectionGetPrope... (obrigatório)

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...

Name 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

AutoscaleSettings

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

MongoDBCollectionResourceOrMongoDBCollectionGetPrope...

Name Descrição Valor
analyticalStorageTtl TTL analítico. INT
createMode Enumeração para indicar o modo de criação de recursos. 'Padrão'
'Restore'
id Nome da coleção MongoDB do Cosmos DB cadeia de caracteres (obrigatório)
índices Lista de chaves de índice MongoIndex[]
restoreParameters Parâmetros para indicar as informações sobre a restauração ResourceRestoreParameters
shardKey Um par chave-valor de chaves de fragmento a serem aplicadas à solicitação. ShardKeys

MongoIndex

Name 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

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

MongoIndexOptions

Name Descrição Valor
expireAfterSeconds Expirar após segundos INT
exclusivo É exclusivo ou não bool

ResourceRestoreParameters

Name Descrição Valor
restoreSource A ID da conta de banco de dados restaurável da qual a restauração deve ser iniciada. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Hora em que a conta precisa ser restaurada (formato ISO-8601). string

ShardKeys

Name Descrição Valor
{propriedade personalizada} string

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		 Este 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 dimensionamento automático da API do MongoDB

Implantar no Azure		 Este 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 das propriedades alteradas em cada versão da API, consulte 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": "2022-11-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "analyticalStorageTtl": "int",
      "createMode": "string",
      "id": "string",
      "indexes": [
        {
          "key": {
            "keys": [ "string" ]
          },
          "options": {
            "expireAfterSeconds": "int",
            "unique": "bool"
          }
        }
      ],
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string"
      },
      "shardKey": {
        "{customized property}": "string"
      }
    }
  }
}

Valores de propriedade

databaseAccounts/mongodbDatabases/collections

Name Descrição Valor
tipo O tipo de recurso 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections'
apiVersion A versão da API do recurso '2022-11-15-preview'
name O nome do recurso

Veja como definir nomes e tipos para recursos filho em modelos do ARM JSON.		 cadeia de caracteres (obrigatório)
local O local do grupo de recursos ao qual o recurso pertence. string
marcas As marcas são uma lista de pares chave-valor que descrevem o recurso. Essas marcas podem ser usadas para exibir e agrupar esse recurso (entre grupos de recursos). Um máximo de 15 marcas pode ser fornecido para um recurso. Cada marca deve ter uma chave com no máximo 128 caracteres e um valor com no máximo 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB". Dicionário de nomes e valores de marcas. Confira Marcas em modelos
identidade Identidade do recurso. ManagedServiceIdentity
properties Propriedades para criar e atualizar a coleção do MongoDB do Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (obrigatório)

ManagedServiceIdentity

Name Descrição Valor
tipo O tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá todas as identidades do serviço. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities A lista de identidades de usuário associadas ao recurso. As referências de chave de dicionário de identidade do usuário serão IDs de recurso do ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Descrição Valor
{propriedade personalizada} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Esse objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Name Descrição Valor
opções Um par chave-valor de opções a serem aplicadas à solicitação. Isso corresponde aos cabeçalhos enviados com a solicitação. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...
recurso O formato JSON padrão de uma coleção do MongoDB MongoDBCollectionResourceOrMongoDBCollectionGetPrope... (obrigatório)

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...

Name 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

AutoscaleSettings

Name Descrição Valor
maxThroughput Representa a taxa de transferência máxima, o recurso pode escalar verticalmente. INT

MongoDBCollectionResourceOrMongoDBCollectionGetPrope...

Name Descrição Valor
analyticalStorageTtl TTL analítico. INT
createMode Enumerar para indicar o modo de criação de recursos. 'Padrão'
'Restore'
id Nome da coleção Do MongoDB do Cosmos DB cadeia de caracteres (obrigatório)
índices Lista de chaves de índice MongoIndex[]
restoreParameters Parâmetros para indicar as informações sobre a restauração ResourceRestoreParameters
shardKey Um par chave-valor de chaves de fragmento a serem aplicadas para a solicitação. ShardKeys

MongoIndex

Name 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

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

MongoIndexOptions

Name Descrição Valor
expireAfterSeconds Expirar após segundos INT
exclusivo É exclusivo ou não bool

ResourceRestoreParameters

Name Descrição Valor
restoreSource A ID da conta de banco de dados restaurável da qual a restauração deve ser iniciada. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Tempo para o qual a conta precisa ser restaurada (formato ISO-8601). string

ShardKeys

Name Descrição Valor
{propriedade personalizada} string

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		 Este modelo cria uma conta do Azure Cosmos DB para a API 4.2 do MongoDB em duas regiões usando taxa de transferência compartilhada e dedicada com duas coleções.
Criar uma conta do Azure Cosmos para dimensionamento automático da API do MongoDB

Implantar no Azure		 Este 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 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 log de alterações.

Formato de recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2022-11-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        analyticalStorageTtl = int
        createMode = "string"
        id = "string"
        indexes = [
          {
            key = {
              keys = [
                "string"
              ]
            }
            options = {
              expireAfterSeconds = int
              unique = bool
            }
          }
        ]
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
        }
        shardKey = {
          {customized property} = "string"
        }
      }
    }
  })
}

Valores de propriedade

databaseAccounts/mongodbDatabases/collections

Name Descrição Valor
tipo O tipo de recurso "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2022-11-15-preview"
name O nome do recurso cadeia de caracteres (obrigatório)
local O local do grupo de recursos ao qual o recurso pertence. string
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: mongodbDatabases
marcas As marcas são uma lista de pares chave-valor que descrevem o recurso. Essas marcas podem ser usadas para exibir e agrupar esse recurso (entre grupos de recursos). No máximo 15 marcas podem ser fornecidas para um recurso. Cada marca deve ter uma chave com no máximo 128 caracteres e um valor com no máximo 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB". Dicionário de nomes e valores de marcas.
identidade Identidade do recurso. ManagedServiceIdentity
properties Propriedades para criar e atualizar a coleção mongoDB do Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (obrigatório)

ManagedServiceIdentity

Name Descrição Valor
tipo O tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá as identidades do serviço. "SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"
identity_ids A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Matriz de IDs de identidade do usuário.

ManagedServiceIdentityUserAssignedIdentities

Name Descrição Valor
{propriedade personalizada} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Esse objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

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

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...

Name Descrição Valor
autoscaleSettings Especifica as configurações de dimensionamento automático. Dimensionamento automáticoConfigurações
throughput Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": 10000. INT

Dimensionamento automáticoConfigurações

Name Descrição Valor
maxThroughput Representa a taxa de transferência máxima, o recurso pode escalar verticalmente. INT

MongoDBCollectionResourceOrMongoDBCollectionGetPrope...

Name Descrição Valor
analyticalStorageTtl TTL analítico. INT
createMode Enumerar para indicar o modo de criação de recursos. "Padrão"
"Restaurar"
id Nome da coleção Do MongoDB do Cosmos DB cadeia de caracteres (obrigatório)
índices Lista de chaves de índice MongoIndex[]
restoreParameters Parâmetros para indicar as informações sobre a restauração ResourceRestoreParameters
shardKey Um par chave-valor de chaves de fragmento a serem aplicadas para a solicitação. ShardKeys

MongoIndex

Name 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

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

MongoIndexOptions

Name Descrição Valor
expireAfterSeconds Expirar após segundos INT
exclusivo É exclusivo ou não bool

ResourceRestoreParameters

Name Descrição Valor
restoreSource A ID da conta de banco de dados restaurável da qual a restauração deve ser iniciada. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Tempo para o qual a conta precisa ser restaurada (formato ISO-8601). string

ShardKeys

Name Descrição Valor
{propriedade personalizada} string