Partilhar via

Microsoft.DocumentDB databaseAccounts/mongodbDatabases/collections 2024-09-01-preview

  • Artigo

Definição de recursos do bíceps

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

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2024-09-01-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  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'
        restoreWithTtlDisabled: bool
      }
      shardKey: {
        {customized property}: 'string'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propriedade

AutoscaleSettings

Designação Descrição Valor
maxTaxa de transferência Representa a taxa de transferência máxima, até a qual o recurso pode ser dimensionado. Int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Designação Descrição Valor

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Designação Descrição Valor
autoscaleConfigurações Especifica as configurações de dimensionamento automático. Nota: A taxa de transferência ou autoscaleSettings é necessária, mas não ambas. AutoscaleSettings
taxa de transferência Solicite unidades por segundo. Por exemplo, "taxa de transferência": 10000. Int

ManagedServiceIdentity

Designação 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 'Nenhum' removerá todas as identidades do serviço. 'Nenhuma'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities 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 ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Designação Descrição Valor

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Designação Descrição Valor
identidade Identidade do recurso. ManagedServiceIdentity
Localização O local do grupo de recursos ao qual o recurso pertence. string
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/mongodbDatabases
propriedades Propriedades para criar e atualizar a coleção MongoDB do Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

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

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Designação Descrição Valor
analíticoStorageTtl TTL analítico. Int
createMode Enum para indicar o modo de criação de recursos. 'Inadimplência'
'Restaurar'
ID Nome da coleção Cosmos DB MongoDB string (obrigatório)
índices Lista de chaves de índice MongoIndex[]
restoreParameters Parâmetros para indicar as informações sobre a restauração ResourceRestoreParameters
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

ResourceRestoreParameters

Designação Descrição Valor
restaurarFonte A id da conta de banco de dados restaurável a partir 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 tem de ser restaurada (formato ISO-8601). string
restoreWithTtlDisabled Especifica se a conta restaurada terá o Time-To-Live desabilitado após a restauração bem-sucedida. Bool

ShardKeys

Designação Descrição Valor

Etiquetas

Designação 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 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 o de dimensionamento automático da API do MongoDB 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 escala automática compartilhada e dedicada.

Definição de recurso de modelo ARM

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

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections",
  "apiVersion": "2024-09-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "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",
        "restoreWithTtlDisabled": "bool"
      },
      "shardKey": {
        "{customized property}": "string"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propriedade

AutoscaleSettings

Designação Descrição Valor
maxTaxa de transferência Representa a taxa de transferência máxima, até a qual o recurso pode ser dimensionado. Int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Designação Descrição Valor

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Designação Descrição Valor
autoscaleConfigurações Especifica as configurações de dimensionamento automático. Nota: A taxa de transferência ou autoscaleSettings é necessária, mas não ambas. AutoscaleSettings
taxa de transferência Solicite unidades por segundo. Por exemplo, "taxa de transferência": 10000. Int

ManagedServiceIdentity

Designação 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 'Nenhum' removerá todas as identidades do serviço. 'Nenhuma'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities 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 ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Designação Descrição Valor

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Designação Descrição Valor
apiVersion A versão api '2024-09-01-pré-visualização'
identidade Identidade do recurso. ManagedServiceIdentity
Localização O local do grupo de recursos ao qual o recurso pertence. string
Designação O nome do recurso string (obrigatório)
propriedades Propriedades para criar e atualizar a coleção MongoDB do Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos
tipo O tipo de recurso 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections'

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

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

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Designação Descrição Valor
analíticoStorageTtl TTL analítico. Int
createMode Enum para indicar o modo de criação de recursos. 'Inadimplência'
'Restaurar'
ID Nome da coleção Cosmos DB MongoDB string (obrigatório)
índices Lista de chaves de índice MongoIndex[]
restoreParameters Parâmetros para indicar as informações sobre a restauração ResourceRestoreParameters
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

ResourceRestoreParameters

Designação Descrição Valor
restaurarFonte A id da conta de banco de dados restaurável a partir 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 tem de ser restaurada (formato ISO-8601). string
restoreWithTtlDisabled Especifica se a conta restaurada terá o Time-To-Live desabilitado após a restauração bem-sucedida. Bool

ShardKeys

Designação Descrição Valor

Etiquetas

Designação 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 		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 o de 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 escala automática compartilhada e dedicada.

Definição de recursos Terraform (provedor AzAPI)

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

  • 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/mongodbDatabases/collections, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2024-09-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  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"
          restoreWithTtlDisabled = bool
        }
        shardKey = {
          {customized property} = "string"
        }
      }
    }
  })
}

Valores de propriedade

AutoscaleSettings

Designação Descrição Valor
maxTaxa de transferência Representa a taxa de transferência máxima, até a qual o recurso pode ser dimensionado. Int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Designação Descrição Valor

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Designação Descrição Valor
autoscaleConfigurações Especifica as configurações de dimensionamento automático. Nota: A taxa de transferência ou autoscaleSettings é necessária, mas não ambas. AutoscaleSettings
taxa de transferência Solicite unidades por segundo. Por exemplo, "taxa de transferência": 10000. Int

ManagedServiceIdentity

Designação 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 'Nenhum' removerá todas as identidades do serviço. 'Nenhuma'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities 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 ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Designação Descrição Valor

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Designação Descrição Valor
identidade Identidade do recurso. ManagedServiceIdentity
Localização O local do grupo de recursos ao qual o recurso pertence. string
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/mongodbDatabases
propriedades Propriedades para criar e atualizar a coleção MongoDB do Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags.
tipo O tipo de recurso "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2024-09-01-preview"

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

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

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

Designação Descrição Valor
analíticoStorageTtl TTL analítico. Int
createMode Enum para indicar o modo de criação de recursos. 'Inadimplência'
'Restaurar'
ID Nome da coleção Cosmos DB MongoDB string (obrigatório)
índices Lista de chaves de índice MongoIndex[]
restoreParameters Parâmetros para indicar as informações sobre a restauração ResourceRestoreParameters
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

ResourceRestoreParameters

Designação Descrição Valor
restaurarFonte A id da conta de banco de dados restaurável a partir 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 tem de ser restaurada (formato ISO-8601). string
restoreWithTtlDisabled Especifica se a conta restaurada terá o Time-To-Live desabilitado após a restauração bem-sucedida. Bool

ShardKeys

Designação Descrição Valor

Etiquetas

Designação Descrição Valor