Compartir a través de

Base de datos Microsoft.DocumentDBAccounts/mongodbDatabases/collections 2024-02-15-preview

  • Artículo

Definición de recursos de Bicep

El tipo de recurso databaseAccounts/mongodbDatabases/collections se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2024-02-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'
        restoreWithTtlDisabled: bool
      }
      shardKey: {
        {customized property}: 'string'
      }
    }
  }
}

Valores de propiedad

databaseAccounts/mongodbDatabases/collections

Nombre Descripción Value
name El nombre del recurso

Vea cómo establecer nombres y tipos para recursos secundarios en Bicep.		 string (obligatorio)
ubicación Ubicación del grupo de recursos al que pertenece el recurso. string
etiquetas Las etiquetas son una lista de pares clave-valor que describen el recurso. Estas etiquetas pueden utilizarse para visualizar y agrupar este recurso a través de grupos de recursos. Se puede proporcionar un máximo de 15 etiquetas para un recurso. Cada etiqueta debe tener una clave no superior a 128 caracteres y un valor no superior a 256 caracteres. Por ejemplo, la experiencia predeterminada para un tipo de plantilla se establece con "defaultExperience": "Cassandra". Los valores actuales "defaultExperience" también incluyen "Table", "Graph", "DocumentDB" y "MongoDB". Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas.
primario En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario.

Para más información, consulte Recurso secundario fuera del recurso primario.		 Nombre simbólico del recurso de tipo: mongodbDatabases
identidad Identidad del recurso. ManagedServiceIdentity
properties Propiedades para crear y actualizar la colección de MongoDB de Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (obligatorio)

ManagedServiceIdentity

Nombre Descripción Value
type Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned", UserAssigned incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades del servicio. 'Ninguno'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Lista de identidades de usuario asociadas al recurso. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nombre Descripción Valor
{propiedad personalizada} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Este objeto no contiene ninguna propiedad que se establezca durante la implementación. Todas las propiedades son ReadOnly.

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Nombre Descripción Value
opciones Par clave-valor de opciones que se aplicarán a la solicitud. Esto corresponde a los encabezados enviados con la solicitud. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...
resource Formato JSON estándar de una colección de MongoDB MongoDBCollectionResourceOrMongoDBCollectionGetPrope... (obligatorio)

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...

Nombre Descripción Valor
autoscaleSettings Especifica la configuración de escalado automático. Nota: Se requiere el rendimiento o el escalado automáticoConfiguración, pero no ambos. AutoscaleSettings
throughput Unidades de solicitud por segundo. Por ejemplo, "rendimiento": 10000. int

AutoscaleSettings

Nombre Descripción Valor
maxThroughput Representa el rendimiento máximo, el recurso se puede escalar verticalmente. int

MongoDBCollectionResourceOrMongoDBCollectionGetPrope...

Nombre Descripción Valor
analyticalStorageTtl TTL analítico. int
createMode Enumeración para indicar el modo de creación de recursos. 'Default'
'PointInTimeRestore'
'Restaurar'
id Nombre de la colección mongoDB de Cosmos DB string (obligatorio)
índices Lista de claves de índice MongoIndex[]
restoreParameters Parámetros para indicar la información sobre la restauración ResourceRestoreParameters
shardKey Par clave-valor de claves de partición que se aplicará para la solicitud. ShardKeys

MongoIndex

Nombre Descripción Valor
key Claves de índice de colección de MongoDB de Cosmos DB MongoIndexKeys
opciones Opciones de clave de índice de colección de MongoDB de Cosmos DB MongoIndexOptions

MongoIndexKeys

Nombre Descripción Valor
claves Lista de claves para cada colección de MongoDB en el servicio Azure Cosmos DB string[]

MongoIndexOptions

Nombre Descripción Valor
expireAfterSeconds Expirar después de segundos int
unique Es único o no bool

ResourceRestoreParameters

Nombre Descripción Valor
restoreSource Identificador de la cuenta de base de datos restaurable desde la que se debe iniciar la restauración. Por ejemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Hora a la que se debe restaurar la cuenta (formato ISO-8601). string
restoreWithTtlDisabled Especifica si la cuenta restaurada tendrá deshabilitado el período de vida tras la restauración correcta. bool

ShardKeys

Nombre Descripción Valor
{propiedad personalizada} string

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla Descripción
Creación de una cuenta de Azure Cosmos para mongoDB API

Implementación en Azure 		Esta plantilla crea una cuenta de Azure Cosmos DB para MongoDB API 4.2 en dos regiones mediante el rendimiento compartido y dedicado con dos colecciones.
Creación de una cuenta de Azure Cosmos para la escalabilidad automática de mongoDB API

Implementación en Azure 		Esta plantilla crea una cuenta de Azure Cosmos DB para MongoDB API 4.2 en dos regiones mediante el rendimiento de escalado automático compartido y dedicado.

Definición de recursos de plantilla de ARM

El tipo de recurso databaseAccounts/mongodbDatabases/collections se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections, agregue el siguiente json a la plantilla.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections",
  "apiVersion": "2024-02-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",
        "restoreWithTtlDisabled": "bool"
      },
      "shardKey": {
        "{customized property}": "string"
      }
    }
  }
}

Valores de propiedad

databaseAccounts/mongodbDatabases/collections

Nombre Descripción Value
type Tipo de recurso 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections'
apiVersion La versión de la API de recursos "2024-02-15-preview"
name El nombre del recurso

Vea cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM JSON.		 string (obligatorio)
ubicación Ubicación del grupo de recursos al que pertenece el recurso. string
etiquetas Las etiquetas son una lista de pares clave-valor que describen el recurso. Estas etiquetas pueden utilizarse para visualizar y agrupar este recurso a través de grupos de recursos. Se puede proporcionar un máximo de 15 etiquetas para un recurso. Cada etiqueta debe tener una clave no superior a 128 caracteres y un valor no superior a 256 caracteres. Por ejemplo, la experiencia predeterminada para un tipo de plantilla se establece con "defaultExperience": "Cassandra". Los valores actuales "defaultExperience" también incluyen "Table", "Graph", "DocumentDB" y "MongoDB". Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas.
identidad Identidad del recurso. ManagedServiceIdentity
properties Propiedades para crear y actualizar la colección de MongoDB de Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (obligatorio)

ManagedServiceIdentity

Nombre Descripción Value
type Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned", UserAssigned incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades del servicio. 'Ninguno'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Lista de identidades de usuario asociadas al recurso. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nombre Descripción Valor
{propiedad personalizada} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Este objeto no contiene ninguna propiedad que se establezca durante la implementación. Todas las propiedades son ReadOnly.

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Nombre Descripción Value
opciones Par clave-valor de opciones que se aplicarán a la solicitud. Esto corresponde a los encabezados enviados con la solicitud. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...
resource Formato JSON estándar de una colección de MongoDB MongoDBCollectionResourceOrMongoDBCollectionGetPrope... (obligatorio)

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...

Nombre Descripción Valor
autoscaleSettings Especifica la configuración de escalado automático. Nota: Se requiere el rendimiento o el escalado automáticoConfiguración, pero no ambos. AutoscaleSettings
throughput Unidades de solicitud por segundo. Por ejemplo, "rendimiento": 10000. int

AutoscaleSettings

Nombre Descripción Valor
maxThroughput Representa el rendimiento máximo, el recurso se puede escalar verticalmente. int

MongoDBCollectionResourceOrMongoDBCollectionGetPrope...

Nombre Descripción Valor
analyticalStorageTtl TTL analítico. int
createMode Enumeración para indicar el modo de creación de recursos. 'Default'
'PointInTimeRestore'
'Restaurar'
id Nombre de la colección mongoDB de Cosmos DB string (obligatorio)
índices Lista de claves de índice MongoIndex[]
restoreParameters Parámetros para indicar la información sobre la restauración ResourceRestoreParameters
shardKey Par clave-valor de las claves de partición que se aplicarán a la solicitud. ShardKeys

MongoIndex

Nombre Descripción Valor
key Claves de índice de colección de MongoDB de Cosmos DB MongoIndexKeys
opciones Opciones de clave de índice de colección de MongoDB de Cosmos DB MongoIndexOptions

MongoIndexKeys

Nombre Descripción Valor
claves Lista de claves para cada colección de MongoDB en el servicio Azure Cosmos DB string[]

MongoIndexOptions

Nombre Descripción Valor
expireAfterSeconds Expirar después de segundos int
unique Es único o no bool

ResourceRestoreParameters

Nombre Descripción Valor
restoreSource Identificador de la cuenta de base de datos restaurable desde la que se debe iniciar la restauración. Por ejemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Hora a la que se debe restaurar la cuenta (formato ISO-8601). string
restoreWithTtlDisabled Especifica si la cuenta restaurada tendrá deshabilitado el período de vida tras la restauración correcta. bool

ShardKeys

Nombre Descripción Valor
{propiedad personalizada} string

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla Descripción
Creación de una cuenta de Azure Cosmos para mongoDB API

Implementación en Azure 		Esta plantilla crea una cuenta de Azure Cosmos DB para MongoDB API 4.2 en dos regiones mediante el rendimiento compartido y dedicado con dos colecciones.
Creación de una cuenta de Azure Cosmos para la escalabilidad automática de mongoDB API

Implementación en Azure 		Esta plantilla crea una cuenta de Azure Cosmos DB para MongoDB API 4.2 en dos regiones mediante el rendimiento de escalabilidad automática compartida y dedicada.

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso databaseAccounts/mongodbDatabases/collections se puede implementar con operaciones destinadas a:

  • Grupos de recursos

Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2024-02-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"
          restoreWithTtlDisabled = bool
        }
        shardKey = {
          {customized property} = "string"
        }
      }
    }
  })
}

Valores de propiedad

databaseAccounts/mongodbDatabases/collections

Nombre Descripción Value
type Tipo de recurso "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2024-02-15-preview"
name El nombre del recurso string (obligatorio)
ubicación Ubicación del grupo de recursos al que pertenece el recurso. string
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: mongodbDatabases
etiquetas Las etiquetas son una lista de pares clave-valor que describen el recurso. Estas etiquetas pueden utilizarse para visualizar y agrupar este recurso a través de grupos de recursos. Se puede proporcionar un máximo de 15 etiquetas para un recurso. Cada etiqueta debe tener una clave no superior a 128 caracteres y un valor no superior a 256 caracteres. Por ejemplo, la experiencia predeterminada para un tipo de plantilla se establece con "defaultExperience": "Cassandra". Los valores actuales "defaultExperience" también incluyen "Table", "Graph", "DocumentDB" y "MongoDB". Diccionario de nombres y valores de etiqueta.
identidad Identidad del recurso. ManagedServiceIdentity
properties Propiedades para crear y actualizar la colección de MongoDB de Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (obligatorio)

ManagedServiceIdentity

Nombre Descripción Value
type Tipo de identidad que se usa para el recurso. El tipo "SystemAssigned", UserAssigned incluye una identidad creada implícitamente y un conjunto de identidades asignadas por el usuario. El tipo "None" quitará las identidades del servicio. "SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned"
identity_ids Lista de identidades de usuario asociadas al recurso. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato : '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Matriz de identificadores de identidad de usuario.

ManagedServiceIdentityUserAssignedIdentities

Nombre Descripción Valor
{propiedad personalizada} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Este objeto no contiene ninguna propiedad que se establezca durante la implementación. Todas las propiedades son ReadOnly.

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

Nombre Descripción Value
opciones Par clave-valor de opciones que se aplicarán a la solicitud. Esto corresponde a los encabezados enviados con la solicitud. CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...
resource Formato JSON estándar de una colección de MongoDB MongoDBCollectionResourceOrMongoDBCollectionGetPrope... (obligatorio)

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...

Nombre Descripción Valor
autoscaleSettings Especifica la configuración de escalado automático. Nota: Se requiere el rendimiento o el escalado automáticoConfiguración, pero no ambos. AutoscaleSettings
throughput Unidades de solicitud por segundo. Por ejemplo, "rendimiento": 10000. int

AutoscaleSettings

Nombre Descripción Valor
maxThroughput Representa el rendimiento máximo, el recurso se puede escalar verticalmente. int

MongoDBCollectionResourceOrMongoDBCollectionGetPrope...

Nombre Descripción Valor
analyticalStorageTtl TTL analítico. int
createMode Enumeración para indicar el modo de creación de recursos. "Valor predeterminado"
"PointInTimeRestore"
"Restaurar"
id Nombre de la colección mongoDB de Cosmos DB string (obligatorio)
índices Lista de claves de índice MongoIndex[]
restoreParameters Parámetros para indicar la información sobre la restauración ResourceRestoreParameters
shardKey Par clave-valor de claves de partición que se aplicará para la solicitud. ShardKeys

MongoIndex

Nombre Descripción Valor
key Claves de índice de colección de MongoDB de Cosmos DB MongoIndexKeys
opciones Opciones de clave de índice de colección de MongoDB de Cosmos DB MongoIndexOptions

MongoIndexKeys

Nombre Descripción Valor
claves Lista de claves para cada colección de MongoDB en el servicio Azure Cosmos DB string[]

MongoIndexOptions

Nombre Descripción Valor
expireAfterSeconds Expirar después de segundos int
unique Es único o no bool

ResourceRestoreParameters

Nombre Descripción Valor
restoreSource Identificador de la cuenta de base de datos restaurable desde la que se debe iniciar la restauración. Por ejemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Hora a la que se debe restaurar la cuenta (formato ISO-8601). string
restoreWithTtlDisabled Especifica si la cuenta restaurada tendrá deshabilitado el período de vida tras la restauración correcta. bool

ShardKeys

Nombre Descripción Valor
{propiedad personalizada} string