Base de datos Microsoft.DocumentDBAccounts/mongodbDatabases/collections 2023-03-01-preview

• más reciente
• 2024-12-01-preview
• 2024-11-15
• 2024-09-01-preview
• 2024-08-15
• 2024-05-15
• 2024-05-15-preview
• 2024-02-15-preview
• 2023-11-15
• 2023-11-15-preview
• 2023-09-15
• 2023-09-15-preview
• 2023-04-15
• 2023-03-15
• 2023-03-15-preview
• 2023-03-01-preview
• 2022-11-15
• 2022-11-15-preview
• 2022-08-15
• 2022-08-15-preview
• 2022-05-15
• 2022-05-15-preview
• 2022-02-15-preview
• 2021-11-15-preview
• 2021-10-15
• 2021-10-15-preview
• 2021-07-01-preview
• 2021-06-15
• 2021-05-15
• 2021-04-15
• 2021-04-01-preview
• 2021-03-15
• 2021-03-01-preview
• 2021-01-15
• 2020-09-01
• 2020-06-01-preview
• 2020-04-01
• 2020-03-01
• 2019-12-12
• 2019-08-01

Definición de recursos de Bicep

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

• grupos de recursos: consulte comandos de implementación de grupos de recursos

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

Formato de recurso

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2023-03-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'
      }
      shardKey: {
        {customized property}: 'string'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propiedad

AutoscaleSettings

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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nombre	Descripción	Valor

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Nombre	Descripción	Valor
autoscaleSettings	Especifica la configuración de escalabilidad automática.	AutoscaleSettings
Rendimiento	Unidades de solicitud por segundo. Por ejemplo, "rendimiento": 10000.	Int

ManagedServiceIdentity

Nombre	Descripción	Valor
tipo	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

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Nombre	Descripción	Valor
identidad	Identidad del recurso.	managedServiceIdentity
ubicación	Ubicación del grupo de recursos al que pertenece el recurso.	cuerda
nombre	El nombre del recurso	string (obligatorio)
padre	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 obtener más información, consulte recurso secundario fuera del recurso primario.	Nombre simbólico del recurso de tipo: databaseAccounts/mongodbDatabases
Propiedades	Propiedades para crear y actualizar la colección de MongoDB de Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (obligatorio)
Etiquetas	Etiquetas de recursos	Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

Nombre	Descripción	Valor
Opciones	Par clave-valor de opciones que se aplicarán a la solicitud. Esto corresponde a los encabezados enviados con la solicitud.	CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
recurso	El formato JSON estándar de una colección de MongoDB	MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (obligatorio)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

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'
identificación	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
llave	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
Llaves	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
único	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}	cuerda
restoreTimestampInUtc	Hora a la que se debe restaurar la cuenta (formato ISO-8601).	cuerda

ShardKeys

Nombre	Descripción	Valor

Etiquetas

Nombre	Descripción	Valor

Ejemplos de inicio rápido

En los ejemplos de inicio rápido siguientes se implementa este tipo de recurso.

Archivo de Bicep	Descripción
Creación de una cuenta de Azure Cosmos para mongoDB API	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 el escalado automático de mongoDB API	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:

• grupos de recursos: consulte comandos de implementación de grupos de recursos

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

Formato de recurso

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections",
  "apiVersion": "2023-03-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"
      },
      "shardKey": {
        "{customized property}": "string"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propiedad

AutoscaleSettings

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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nombre	Descripción	Valor

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Nombre	Descripción	Valor
autoscaleSettings	Especifica la configuración de escalabilidad automática.	AutoscaleSettings
Rendimiento	Unidades de solicitud por segundo. Por ejemplo, "rendimiento": 10000.	Int

ManagedServiceIdentity

Nombre	Descripción	Valor
tipo	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

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Nombre	Descripción	Valor
apiVersion	La versión de api	'2023-03-01-preview'
identidad	Identidad del recurso.	managedServiceIdentity
ubicación	Ubicación del grupo de recursos al que pertenece el recurso.	cuerda
nombre	El nombre del recurso	string (obligatorio)
Propiedades	Propiedades para crear y actualizar la colección de MongoDB de Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (obligatorio)
Etiquetas	Etiquetas de recursos	Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas
tipo	El tipo de recurso	'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections'

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

Nombre	Descripción	Valor
Opciones	Par clave-valor de opciones que se aplicarán a la solicitud. Esto corresponde a los encabezados enviados con la solicitud.	CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
recurso	El formato JSON estándar de una colección de MongoDB	MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (obligatorio)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

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'
identificación	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
llave	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
Llaves	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
único	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}	cuerda
restoreTimestampInUtc	Hora a la que se debe restaurar la cuenta (formato ISO-8601).	cuerda

ShardKeys

Nombre	Descripción	Valor

Etiquetas

Nombre	Descripción	Valor

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	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 el escalado automático de mongoDB API	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/collections se puede implementar con operaciones destinadas a:

• grupos de recursos de

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

Formato de recurso

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@2023-03-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"
        }
        shardKey = {
          {customized property} = "string"
        }
      }
    }
  })
}

Valores de propiedad

AutoscaleSettings

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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nombre	Descripción	Valor

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

Nombre	Descripción	Valor
autoscaleSettings	Especifica la configuración de escalabilidad automática.	AutoscaleSettings
Rendimiento	Unidades de solicitud por segundo. Por ejemplo, "rendimiento": 10000.	Int

ManagedServiceIdentity

Nombre	Descripción	Valor
tipo	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

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

Nombre	Descripción	Valor
identidad	Identidad del recurso.	managedServiceIdentity
ubicación	Ubicación del grupo de recursos al que pertenece el recurso.	cuerda
nombre	El nombre del recurso	string (obligatorio)
parent_id	Identificador del recurso que es el elemento primario de este recurso.	Identificador del recurso de tipo: databaseAccounts/mongodbDatabases
Propiedades	Propiedades para crear y actualizar la colección de MongoDB de Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (obligatorio)
Etiquetas	Etiquetas de recursos	Diccionario de nombres y valores de etiqueta.
tipo	El tipo de recurso	"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2023-03-01-preview"

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

Nombre	Descripción	Valor
Opciones	Par clave-valor de opciones que se aplicarán a la solicitud. Esto corresponde a los encabezados enviados con la solicitud.	CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
recurso	El formato JSON estándar de una colección de MongoDB	MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (obligatorio)

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

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'
identificación	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
llave	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
Llaves	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
único	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}	cuerda
restoreTimestampInUtc	Hora a la que se debe restaurar la cuenta (formato ISO-8601).	cuerda

ShardKeys

Nombre	Descripción	Valor

Etiquetas

Nombre	Descripción	Valor