Base de datos Microsoft.DocumentDBAccounts/apis/databases/collections

• Más reciente
• 2016-03-31
• 2016-03-19
• 2015-11-06
• 2015-04-08
• 2015-04-01

Definición de recursos de Bicep

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

• Grupos de recursos: consulte los comandos de implementación del grupo 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/apis/databases/collections, agregue el siguiente bicep a la plantilla.

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

Valores de propiedad

databaseAccounts/apis/databases/collections

Nombre	Descripción	Value
name	El nombre del recurso Vea cómo establecer nombres y tipos para recursos secundarios en Bicep.	string (obligatorio)
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: bases de datos
properties	Propiedades para crear y actualizar la colección de MongoDB de Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (obligatorio)

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

CreateUpdateOptions

Nombre	Descripción	Valor
{propiedad personalizada}		string

MongoDBCollectionResource

Nombre	Descripción	Value
id	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
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

ShardKeys

Nombre	Descripción	Valor
{propiedad personalizada}		string

Definición de recursos de plantilla de ARM

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

• Grupos de recursos: consulte los comandos de implementación del grupo 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/apis/databases/collections, agregue el siguiente json a la plantilla.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections",
  "apiVersion": "2016-03-31",
  "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

databaseAccounts/apis/databases/collections

Nombre	Descripción	Value
type	Tipo de recurso	'Microsoft.DocumentDB/databaseAccounts/apis/databases/collections'
apiVersion	La versión de la API de recursos	'2016-03-31'
name	El nombre del recurso Consulte cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM json.	string (obligatorio)
properties	Propiedades para crear y actualizar la colección mongoDB de Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (obligatorio)

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

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

CreateUpdateOptions

Nombre	Descripción	Valor
{propiedad personalizada}		string

MongoDBCollectionResource

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

ShardKeys

Nombre	Descripción	Valor
{propiedad personalizada}		string

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2016-03-31"
  name = "string"
  parent_id = "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

databaseAccounts/apis/databases/collections

Nombre	Descripción	Value
type	Tipo de recurso	"Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2016-03-31"
name	El nombre del recurso	string (obligatorio)
parent_id	Identificador del recurso que es el elemento primario de este recurso.	Identificador del recurso de tipo: bases de datos
properties	Propiedades para crear y actualizar la colección de MongoDB de Azure Cosmos DB.	MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (obligatorio)

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

CreateUpdateOptions

Nombre	Descripción	Valor
{propiedad personalizada}		string

MongoDBCollectionResource

Nombre	Descripción	Value
id	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
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

ShardKeys

Nombre	Descripción	Valor
{propiedad personalizada}		string