Compartir a través de

Base de datos Microsoft.DocumentDBAccounts/apis/databases/collections 2015-11-06

  • Artículo

Definición de recursos de Bicep

El tipo de recurso databaseAccounts/apis/databases/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 recurso

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2015-11-06' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    options: {
      {customized property}: 'string'
    }
    resource: {
      id: 'string'
      indexes: [
        {
          key: {
            keys: [
              'string'
            ]
          }
          options: {
            expireAfterSeconds: int
            unique: bool
          }
        }
      ]
      shardKey: {
        {customized property}: 'string'
      }
    }
  }
}

Valores de propiedad

CreateUpdateOptions

Nombre Descripción Valor

Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

Nombre Descripción Valor
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/apis/databases
Propiedades Propiedades para crear y actualizar la colección de MongoDB de Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties (obligatorio)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

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. CreateUpdateOptions (obligatorio)
recurso El formato JSON estándar de una colección de MongoDB MongoDBCollectionResource (obligatorio)

MongoDBCollectionResource

Nombre Descripción Valor
identificación Nombre de la colección mongoDB de Cosmos DB string (obligatorio)
Índices Lista de claves de índice mongoIndex []
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

ShardKeys

Nombre Descripción Valor

Definición de recursos de plantilla de ARM

El tipo de recurso databaseAccounts/apis/databases/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 recurso

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections",
  "apiVersion": "2015-11-06",
  "name": "string",
  "properties": {
    "options": {
      "{customized property}": "string"
    },
    "resource": {
      "id": "string",
      "indexes": [
        {
          "key": {
            "keys": [ "string" ]
          },
          "options": {
            "expireAfterSeconds": "int",
            "unique": "bool"
          }
        }
      ],
      "shardKey": {
        "{customized property}": "string"
      }
    }
  }
}

Valores de propiedad

CreateUpdateOptions

Nombre Descripción Valor

Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

Nombre Descripción Valor
apiVersion La versión de api '2015-11-06'
nombre El nombre del recurso string (obligatorio)
Propiedades Propiedades para crear y actualizar la colección de MongoDB de Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties (obligatorio)
tipo El tipo de recurso 'Microsoft.DocumentDB/databaseAccounts/apis/databases/collections'

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

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. CreateUpdateOptions (obligatorio)
recurso El formato JSON estándar de una colección de MongoDB MongoDBCollectionResource (obligatorio)

MongoDBCollectionResource

Nombre Descripción Valor
identificación Nombre de la colección mongoDB de Cosmos DB string (obligatorio)
Índices Lista de claves de índice mongoIndex []
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

ShardKeys

Nombre Descripción Valor

Definición de recursos de Terraform (proveedor AzAPI)

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2015-11-06"
  name = "string"
  body = jsonencode({
    properties = {
      options = {
        {customized property} = "string"
      }
      resource = {
        id = "string"
        indexes = [
          {
            key = {
              keys = [
                "string"
              ]
            }
            options = {
              expireAfterSeconds = int
              unique = bool
            }
          }
        ]
        shardKey = {
          {customized property} = "string"
        }
      }
    }
  })
}

Valores de propiedad

CreateUpdateOptions

Nombre Descripción Valor

Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

Nombre Descripción Valor
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/apis/databases
Propiedades Propiedades para crear y actualizar la colección de MongoDB de Azure Cosmos DB. MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties (obligatorio)
tipo El tipo de recurso "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2015-11-06"

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

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. CreateUpdateOptions (obligatorio)
recurso El formato JSON estándar de una colección de MongoDB MongoDBCollectionResource (obligatorio)

MongoDBCollectionResource

Nombre Descripción Valor
identificación Nombre de la colección mongoDB de Cosmos DB string (obligatorio)
Índices Lista de claves de índice mongoIndex []
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

ShardKeys

Nombre Descripción Valor