Compartir a través de

Base de datos Microsoft.DocumentDBAccounts/mongodbDatabases

  • Artículo

Definición de recursos de Bicep

El tipo de recurso databaseAccounts/mongodbDatabases 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, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2024-05-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      createMode: 'string'
      id: 'string'
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
      }
    }
  }
}

Valores de propiedad

databaseAccounts/mongodbDatabases

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: databaseAccounts
properties Propiedades para crear y actualizar la base de datos de MongoDB de Azure Cosmos DB. MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba... (obligatorio)

MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba...

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. CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...
resource Formato JSON estándar de una base de datos de MongoDB MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie... (obligatorio)

CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...

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

MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie...

Nombre Descripción Valor
createMode Enumeración para indicar el modo de creación de recursos. 'Default'
'Restaurar'
id Nombre de la base de datos de MongoDB de Cosmos DB string (obligatorio)
restoreParameters Parámetros para indicar la información sobre la restauración ResourceRestoreParameters

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

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 plantilla de ARM

El tipo de recurso databaseAccounts/mongodbDatabases 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, agregue el siguiente json a la plantilla.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases",
  "apiVersion": "2024-05-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "createMode": "string",
      "id": "string",
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string"
      }
    }
  }
}

Valores de propiedad

databaseAccounts/mongodbDatabases

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

Consulte 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.
properties Propiedades para crear y actualizar la base de datos de MongoDB de Azure Cosmos DB. MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba... (obligatorio)

MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba...

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

CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...

Nombre Descripción Valor
autoscaleSettings Especifica la configuración de escalabilidad automática. Nota: Se requiere rendimiento o 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

MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie...

Nombre Descripción Valor
createMode Enumeración para indicar el modo de creación de recursos. 'Default'
'Restaurar'
id Nombre de la base de datos de MongoDB de Cosmos DB string (obligatorio)
restoreParameters Parámetros para indicar la información sobre la restauración ResourceRestoreParameters

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

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 Terraform (proveedor AzAPI)

El tipo de recurso databaseAccounts/mongodbDatabases 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, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2024-05-15"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        createMode = "string"
        id = "string"
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
        }
      }
    }
  })
}

Valores de propiedad

databaseAccounts/mongodbDatabases

Nombre Descripción Value
type Tipo de recurso "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2024-05-15"
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: databaseAccounts
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.
properties Propiedades para crear y actualizar la base de datos de MongoDB de Azure Cosmos DB. MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba... (obligatorio)

MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba...

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. CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...
resource Formato JSON estándar de una base de datos de MongoDB MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie... (obligatorio)

CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...

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

MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie...

Nombre Descripción Valor
createMode Enumeración para indicar el modo de creación de recursos. "Valor predeterminado"
"Restaurar"
id Nombre de la base de datos de MongoDB de Cosmos DB string (obligatorio)
restoreParameters Parámetros para indicar la información sobre la restauración ResourceRestoreParameters

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