DatabaseAccounts de Microsoft.DocumentDB
- 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
- 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 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, agregue el siguiente bicep a la plantilla.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts@2024-12-01-preview' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
kind: 'string'
location: 'string'
name: 'string'
properties: {
analyticalStorageConfiguration: {
schemaType: 'string'
}
apiProperties: {
serverVersion: 'string'
}
backupPolicy: {
migrationState: {
startTime: 'string'
status: 'string'
targetType: 'string'
}
type: 'string'
// For remaining properties, see BackupPolicy objects
}
capabilities: [
{
name: 'string'
}
]
capacity: {
totalThroughputLimit: int
}
capacityMode: 'string'
connectorOffer: 'string'
consistencyPolicy: {
defaultConsistencyLevel: 'string'
maxIntervalInSeconds: int
maxStalenessPrefix: int
}
cors: [
{
allowedHeaders: 'string'
allowedMethods: 'string'
allowedOrigins: 'string'
exposedHeaders: 'string'
maxAgeInSeconds: int
}
]
createMode: 'string'
customerManagedKeyStatus: 'string'
databaseAccountOfferType: 'Standard'
defaultIdentity: 'string'
defaultPriorityLevel: 'string'
diagnosticLogSettings: {
enableFullTextQuery: 'string'
}
disableKeyBasedMetadataWriteAccess: bool
disableLocalAuth: bool
enableAnalyticalStorage: bool
enableAutomaticFailover: bool
enableBurstCapacity: bool
enableCassandraConnector: bool
enableFreeTier: bool
enableMaterializedViews: bool
enableMultipleWriteLocations: bool
enablePartitionMerge: bool
enablePerRegionPerPartitionAutoscale: bool
enablePriorityBasedExecution: bool
ipRules: [
{
ipAddressOrRange: 'string'
}
]
isVirtualNetworkFilterEnabled: bool
keyVaultKeyUri: 'string'
locations: [
{
failoverPriority: int
isZoneRedundant: bool
locationName: 'string'
}
]
minimalTlsVersion: 'string'
networkAclBypass: 'string'
networkAclBypassResourceIds: [
'string'
]
publicNetworkAccess: 'string'
restoreParameters: {
databasesToRestore: [
{
collectionNames: [
'string'
]
databaseName: 'string'
}
]
gremlinDatabasesToRestore: [
{
databaseName: 'string'
graphNames: [
'string'
]
}
]
restoreMode: 'string'
restoreSource: 'string'
restoreTimestampInUtc: 'string'
restoreWithTtlDisabled: bool
sourceBackupLocation: 'string'
tablesToRestore: [
'string'
]
}
virtualNetworkRules: [
{
id: 'string'
ignoreMissingVNetServiceEndpoint: bool
}
]
}
tags: {
{customized property}: 'string'
}
}
Objetos BackupPolicy
Establezca el tipo propiedad para especificar el tipo de objeto.
Para continuous, use:
{
continuousModeProperties: {
tier: 'string'
}
type: 'Continuous'
}
Para Periódica, use:
{
periodicModeProperties: {
backupIntervalInMinutes: int
backupRetentionIntervalInHours: int
backupStorageRedundancy: 'string'
}
type: 'Periodic'
}
Valores de propiedad
AnalyticalStorageConfiguration
Nombre | Descripción | Valor |
---|---|---|
schemaType | Describe los tipos de esquema para el almacenamiento analítico. | 'FullFidelity' 'WellDefined' |
ApiProperties
Nombre | Descripción | Valor |
---|---|---|
serverVersion | Describe la versión de la cuenta de MongoDB. | '3.2' '3.6' '4.0' '4.2' '5.0' '6.0' '7.0' |
BackupPolicy
Nombre | Descripción | Valor |
---|---|---|
migrationState | Objeto que representa el estado de la migración entre las directivas de copia de seguridad. | |
tipo | Establezca en "Continuous" para el tipo ContinuousModeBackupPolicy. Establezca en "Periodic" para el tipo PeriodicModeBackupPolicy. | 'Continuo' 'Periódico' (obligatorio) |
BackupPolicyMigrationState
Nombre | Descripción | Valor |
---|---|---|
startTime | Hora en la que se inició la migración de directivas de copia de seguridad (formato ISO-8601). | cuerda |
estado | Describe el estado de la migración entre los tipos de directiva de copia de seguridad. | "Completado" 'Error' 'InProgress' 'No válido' |
targetType | Describe el tipo de directiva de copia de seguridad de destino de la migración de directivas de copia de seguridad. | 'Continuo' 'Periódico' |
Capacidad
Nombre | Descripción | Valor |
---|---|---|
nombre | Nombre de la funcionalidad de Cosmos DB. Por ejemplo, "name": "EnableCassandra". Los valores actuales también incluyen "EnableTable" y "EnableGremlin". | cuerda |
Capacidad
Nombre | Descripción | Valor |
---|---|---|
totalThroughputLimit | Límite total de rendimiento impuesto en la cuenta. TotalThroughputLimit de 2000 impone un límite estricto de rendimiento máximo que se puede aprovisionar en esa cuenta para ser 2000. TotalThroughputLimit de -1 indica que no hay límites en el aprovisionamiento del rendimiento. | Int Restricciones: Valor mínimo = -1 |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
Nombre | Descripción | Valor |
---|
ConsistencyPolicy
Nombre | Descripción | Valor |
---|---|---|
defaultConsistencyLevel | El nivel de coherencia predeterminado y las opciones de configuración de la cuenta de Cosmos DB. | 'BoundedStaleness' 'ConsistentPrefix' 'Eventual' 'Sesión' 'Fuerte' (obligatorio) |
maxIntervalInSeconds | Cuando se usa con el nivel de coherencia obsolescencia limitada, este valor representa la cantidad de tiempo de obsolescencia (en segundos) tolerada. El intervalo aceptado para este valor es 5 - 86400. Obligatorio cuando defaultConsistencyPolicy se establece en "BoundedStaleness". | Int Restricciones: Valor mínimo = 5 Valor máximo = 86400 |
maxStalenessPrefix | Cuando se usa con el nivel de coherencia obsolescencia limitada, este valor representa el número de solicitudes obsoletas toleradas. El intervalo aceptado para este valor es de 1 a 2.147.483.647. Obligatorio cuando defaultConsistencyPolicy se establece en "BoundedStaleness". | Int Restricciones: Valor mínimo = 1 Valor máximo = 2147483647 |
ContinuousModeBackupPolicy
Nombre | Descripción | Valor |
---|---|---|
continuousModeProperties | Valores de configuración para la copia de seguridad en modo continuo | ContinuousModeProperties |
tipo | Describe el modo de copias de seguridad. | 'Continuous' (obligatorio) |
ContinuousModeProperties
Nombre | Descripción | Valor |
---|---|---|
nivel | Enumeración para indicar el tipo de modo de copia de seguridad continuos | 'Continuous30Days' "Continuous7Days" |
CorsPolicy
Nombre | Descripción | Valor |
---|---|---|
allowedHeaders | Encabezados de solicitud que el dominio de origen puede especificar en la solicitud CORS. | cuerda |
allowedMethods | Los métodos (verbos de solicitud HTTP) que el dominio de origen puede usar para una solicitud CORS. | cuerda |
allowedOrigins | Los dominios de origen que pueden realizar una solicitud en el servicio a través de CORS. | string (obligatorio) |
exposedHeaders | Encabezados de respuesta que se pueden enviar en la respuesta a la solicitud CORS y que expone el explorador al emisor de la solicitud. | cuerda |
maxAgeInSeconds | Tiempo máximo durante el que un explorador debe almacenar en caché la solicitud OPTIONS preparatoria. | Int Restricciones: Valor mínimo = 1 Valor máximo = 2147483647 |
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties
Nombre | Descripción | Valor |
---|---|---|
analyticalStorageConfiguration | Propiedades específicas del almacenamiento analítico. | AnalyticalStorageConfiguration |
apiProperties | Propiedades específicas de la API. Actualmente, solo se admite para la API de MongoDB. | ApiProperties |
backupPolicy | Objeto que representa la directiva para realizar copias de seguridad en una cuenta. | BackupPolicy |
Capacidades | Lista de funcionalidades de Cosmos DB para la cuenta | funcionalidad[] |
capacidad | Objeto que representa todas las propiedades relacionadas con el cumplimiento de la capacidad en una cuenta. | capacidad de |
capacityMode | Indica capacityMode de la cuenta de Cosmos DB. | 'Ninguno' "Aprovisionado" "Sin servidor" |
connectorOffer | Tipo de oferta del conector cassandra para la cuenta de C* de base de datos de Cosmos DB. | 'Pequeño' |
consistencyPolicy | Directiva de coherencia para la cuenta de Cosmos DB. | ConsistencyPolicy |
cors | Directiva DE CORS para la cuenta de base de datos de Cosmos DB. | CorsPolicy[] |
createMode | Enumeración para indicar el modo de creación de la cuenta. | 'Valor predeterminado' 'Restaurar' |
customerManagedKeyStatus | Indica el estado de la característica Clave administrada por el cliente en la cuenta. En caso de que haya errores, la propiedad proporciona instrucciones de solución de problemas. | cuerda |
databaseAccountOfferType | Tipo de oferta para la base de datos | 'Estándar' (obligatorio) |
defaultIdentity | La identidad predeterminada para acceder al almacén de claves que se usa en características como claves administradas por el cliente. Los usuarios deben establecer explícitamente la identidad predeterminada. Puede ser "FirstPartyIdentity", "SystemAssignedIdentity" y mucho más. | cuerda |
defaultPriorityLevel | Enumeración para indicar el nivel de prioridad predeterminado de solicitud para la ejecución basada en prioridad. | "Alto" "Bajo" |
diagnosticLogSettings | Objeto que representa la configuración del registro de diagnóstico diferente para la cuenta de Cosmos DB. | DiagnosticLogSettings |
disableKeyBasedMetadataWriteAccess | Deshabilitar las operaciones de escritura en recursos de metadatos (bases de datos, contenedores, rendimiento) mediante claves de cuenta | Bool |
disableLocalAuth | No participar en la autenticación local y asegurarse de que solo se puede usar MSI y AAD exclusivamente para la autenticación. | Bool |
enableAnalyticalStorage | Marca para indicar si se va a habilitar el análisis de almacenamiento. | Bool |
enableAutomaticFailover | Habilita la conmutación automática por error de la región de escritura en el caso poco frecuente de que la región no esté disponible debido a una interrupción. La conmutación automática por error dará lugar a una nueva región de escritura para la cuenta y se elige en función de las prioridades de conmutación por error configuradas para la cuenta. | Bool |
enableBurstCapacity | Marca para indicar la habilitación o deshabilitación de la característica De vista previa de capacidad de ráfaga en la cuenta | Bool |
enableCassandraConnector | Habilita el conector cassandra en la cuenta de C* de Cosmos DB | Bool |
enableFreeTier | Marca para indicar si el nivel Gratis está habilitado. | Bool |
enableMaterializedViews | Marca para indicar si se habilita MaterializedViews en la cuenta de Cosmos DB | Bool |
enableMultipleWriteLocations | Permite que la cuenta escriba en varias ubicaciones | Bool |
enablePartitionMerge | Marca para indicar la habilitación o deshabilitación de la característica De combinación de particiones en la cuenta | Bool |
enablePerRegionPerPartitionAutoscale | Marca para indicar la habilitación o deshabilitación de Per-Region característica de vista previa de escalabilidad automática por partición en la cuenta | Bool |
enablePriorityBasedExecution | Marca para indicar la habilitación o deshabilitación de la característica Vista previa de ejecución basada en prioridad en la cuenta | Bool |
ipRules | Lista de IpRules. | ipAddressOrRange[] |
isVirtualNetworkFilterEnabled | Marca para indicar si se deben habilitar o deshabilitar las reglas de ACL de red virtual. | Bool |
keyVaultKeyUri | Identificador URI del almacén de claves | cuerda |
Ubicaciones | Matriz que contiene las ubicaciones de georeplicación habilitadas para la cuenta de Cosmos DB. | Ubicación[] (obligatorio) |
minimalTlsVersion | Indica la versión mínima permitida de Tls. El valor predeterminado es Tls 1.0, excepto cassandra y mongo API, que solo funcionan con Tls 1.2. | 'Tls' 'Tls11' 'Tls12' |
networkAclBypass | Indica qué servicios pueden omitir las comprobaciones de firewall. | "AzureServices" 'Ninguno' |
networkAclBypassResourceIds | Matriz que contiene los identificadores de recurso para la omisión de Acl de red para la cuenta de Cosmos DB. | string[] |
publicNetworkAccess | Indica si se permiten solicitudes de la red pública | 'Deshabilitado' 'Habilitado' "SecuredByPerimeter" |
restoreParameters | Parámetros para indicar la información sobre la restauración. | restoreParameters |
virtualNetworkRules | Lista de reglas de ACL de red virtual configuradas para la cuenta de Cosmos DB. | virtualNetworkRule[] |
DatabaseRestoreResource
Nombre | Descripción | Valor |
---|---|---|
collectionNames | Nombres de las colecciones disponibles para la restauración. | string[] |
databaseName | Nombre de la base de datos disponible para la restauración. | cuerda |
DiagnosticLogSettings
Nombre | Descripción | Valor |
---|---|---|
enableFullTextQuery | Describir el nivel de detalle con el que se van a registrar las consultas. | 'False' 'Ninguno' 'True' |
GremlinDatabaseRestoreResource
Nombre | Descripción | Valor |
---|---|---|
databaseName | Nombre de la base de datos gremlin disponible para la restauración. | cuerda |
graphNames | Los nombres de los gráficos disponibles para la restauración. | string[] |
IpAddressOrRange
Nombre | Descripción | Valor |
---|---|---|
ipAddressOrRange | Una sola dirección IPv4 o un único intervalo de direcciones IPv4 en formato CIDR. Las direcciones IP proporcionadas deben tener un formato correcto y no se pueden incluir en uno de los siguientes intervalos: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, ya que el filtro de direcciones IP no los puede aplicar. Ejemplo de entradas válidas: "23.40.210.245" o "23.40.210.0/8". | cuerda |
Ubicación
Nombre | Descripción | Valor |
---|---|---|
failoverPriority | Prioridad de conmutación por error de la región. Una prioridad de conmutación por error de 0 indica una región de escritura. Valor máximo de una prioridad de conmutación por error = (número total de regiones - 1). Los valores de prioridad de conmutación por error deben ser únicos para cada una de las regiones en las que existe la cuenta de base de datos. | Int Restricciones: Valor mínimo = 0 |
isZoneRedundant | Marca para indicar si esta región es una región availabilityZone o no | Bool |
locationName | Nombre de la región. | cuerda |
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
Nombre | Descripción | Valor |
---|---|---|
identidad | Identidad del recurso. | managedServiceIdentity |
amable | Indica el tipo de cuenta de base de datos. Esto solo se puede establecer en la creación de la cuenta de base de datos. | 'GlobalDocumentDB' "MongoDB" 'Análisis' |
ubicación | Ubicación del grupo de recursos al que pertenece el recurso. | cuerda |
nombre | El nombre del recurso | cuerda Restricciones: Longitud mínima = 3 Longitud máxima = 3 Patrón = ^[a-z0-9]+(-[a-z0-9]+)* (obligatorio) |
Propiedades | Propiedades para crear y actualizar cuentas de base de datos de Azure Cosmos DB. | DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (obligatorio) |
Etiquetas | Etiquetas de recursos | Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas |
PeriodicModeBackupPolicy
PeriodicModeProperties
Nombre | Descripción | Valor |
---|---|---|
backupIntervalInMinutes | Entero que representa el intervalo en minutos entre dos copias de seguridad. | Int Restricciones: Valor mínimo = 0 |
backupRetentionIntervalInHours | Entero que representa el tiempo (en horas) que cada copia de seguridad se conserva. | Int Restricciones: Valor mínimo = 0 |
backupStorageRedundancy | Enumeración para indicar el tipo de residencia de copia de seguridad | 'Geo' 'Local' 'Zona' |
RestoreParameters
Nombre | Descripción | Valor |
---|---|---|
databasesToRestore | Lista de bases de datos específicas disponibles para la restauración. | DatabaseRestoreResource[] |
gremlinDatabasesToRestore | Lista de bases de datos de gremlin específicas disponibles para la restauración. | gremlinDatabaseRestoreResource[] |
restoreMode | Describe el modo de restauración. | 'PointInTime' |
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 |
restoreWithTtlDisabled | Especifica si la cuenta restaurada tendrá tiempoTo-Live deshabilitado tras la restauración correcta. | Bool |
sourceBackupLocation | Ubicación de copia de seguridad de origen para la restauración. | cuerda |
tablesToRestore | Lista de tablas específicas disponibles para la restauración. | string[] |
Etiquetas
Nombre | Descripción | Valor |
---|
VirtualNetworkRule
Nombre | Descripción | Valor |
---|---|---|
identificación | Identificador de recurso de una subred, por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. | cuerda |
ignoreMissingVNetServiceEndpoint | Cree una regla de firewall antes de que la red virtual tenga habilitado el punto de conexión de servicio de red virtual. | Bool |
Ejemplos de inicio rápido
En los ejemplos de inicio rápido siguientes se implementa este tipo de recurso.
Archivo de Bicep | Descripción |
---|---|
API de SQL de la cuenta de Azure Cosmos DB con de almacén analítico | Esta plantilla crea una cuenta de Azure Cosmos para Core (SQL) API con una base de datos y un contenedor configurados con el almacén analítico. |
cuenta de Azure Cosmos DB con Web App | Esta plantilla implementa una cuenta de Azure Cosmos DB, un plan de App Service y crea una aplicación web en el plan de App Service. También agrega dos configuraciones de aplicación a la aplicación web que hacen referencia al punto de conexión de la cuenta de Azure Cosmos DB. De este modo, las soluciones implementadas en la aplicación web pueden conectarse al punto de conexión de la cuenta de Azure Cosmos DB mediante esa configuración. |
Crear una cuenta de Cosmos DB con la habilitada para Microsoft Defender | Con esta plantilla de ARM, puede implementar una cuenta de Azure Cosmos DB con Microsoft Defender para Azure Cosmos DB habilitado. Microsoft Defender para Azure Cosmos DB es una capa nativa de seguridad de Azure que detecta intentos de aprovechar las bases de datos de las cuentas de Azure Cosmos DB. Microsoft Defender para Azure Cosmos DB detecta posibles inyecciones de SQL, actores malintencionados conocidos basados en inteligencia sobre amenazas de Microsoft, patrones de acceso sospechosos y posibles vulnerabilidades de la base de datos a través de identidades comprometidas o usuarios internos malintencionados. |
Creación de una cuenta de Azure Cosmos DB de nivel gratuito | Esta plantilla crea una cuenta de Azure Cosmos DB de nivel gratuito para SQL API con una base de datos con rendimiento compartido y contenedor. |
Creación de una cuenta mínima de Azure Cosmos DB para Core (SQL) API | Esta plantilla crea una cuenta de Azure Cosmos DB para core (SQL) API, al tiempo que solo especifica las propiedades mínimas de recursos necesarias. |
Creación de una cuenta de Azure Cosmos DB sin servidor para sql API | Esta plantilla crea una cuenta de Azure Cosmos DB sin servidor para core (SQL). |
Creación de una cuenta de Azure Cosmos táctil cero y azure Web App | Esta plantilla crea una cuenta de Azure Cosmos, inserta el punto de conexión y las claves de Cosmos DB en la configuración de Azure Web App y, a continuación, implementa una aplicación web asp MVC desde GitHub. |
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. |
Creación de una cuenta de Azure Cosmos para Table API | Esta plantilla crea una cuenta de Azure Cosmos DB para Table API en dos regiones y una sola tabla con rendimiento aprovisionado. |
Creación de una cuenta de Azure Cosmos para Table API con escalabilidad automática | Esta plantilla crea una cuenta de Azure Cosmos DB para Table API en dos regiones y una sola tabla con rendimiento de escalado automático. |
Creación de una cuenta de Azure Cosmos DB para cassandra API | Esta plantilla crea una cuenta de Azure Cosmos DB para Cassandra API en dos regiones con un espacio de claves y una tabla con rendimiento dedicado. |
Creación de una cuenta de Azure Cosmos DB para Core (SQL) API | Esta plantilla crea una cuenta de Azure Cosmos para Core (SQL) API con una base de datos y un contenedor con rendimiento con varias otras opciones. |
Creación de una cuenta de Azure Cosmos DB para gremlin API | Esta plantilla crea una cuenta de Azure Cosmos DB para Gremlin API en dos regiones con una base de datos y un grafo mediante el rendimiento dedicado. |
Creación de una cuenta de Azure Cosmos DB para el escalado automático de Gremlin API | Esta plantilla crea una cuenta de Azure Cosmos DB para Gremlin API en dos regiones con una base de datos y un grafo mediante el rendimiento de escalabilidad automática. |
Creación de una cuenta de Azure Cosmos DB en varias regiones | Esta plantilla crea una cuenta de Azure Cosmos DB para cualquier tipo de API de base de datos con una región primaria y secundaria que elija el nivel de coherencia y el tipo de conmutación por error. |
Creación de una API de SQL de cuenta de Azure Cosmos DB con de escalado automático | Esta plantilla crea una cuenta de Azure Cosmos para Core (SQL) API con una base de datos y un contenedor con rendimiento de escalabilidad automática con varias otras opciones. |
Creación de una cuenta de Azure Cosmos DB con un punto de conexión privado | Esta plantilla creará una cuenta de Cosmos, una red virtual y un punto de conexión privado que exponga la cuenta de Cosmos a la red virtual. |
Creación de una cuenta de SQL de Azure Cosmos DB con RBAC del plano de datos | Esta plantilla creará una cuenta de SQL Cosmos, una definición de roles mantenida de forma nativa y una asignación de roles mantenida de forma nativa para una identidad de AAD. |
Crear una cuenta de Azure CosmosDB | Esta plantilla de ARM está intención de crear rápidamente una cuenta de CosmosDB con los valores mínimos necesarios. |
Creación de una cuenta de Escalado automático de Azure Cosmos DB para Cassandra API | Esta plantilla crea una cuenta de Azure Cosmos DB para Cassandra API en dos regiones con un espacio de claves y una tabla con rendimiento de escalabilidad automática. |
Creación de procedimientos almacenados de la API de Azure Cosmos DB Core (SQL) | Esta plantilla crea una cuenta de Azure Cosmos DB para Core (SQL) API y un contenedor con un procedimiento almacenado, desencadenador y función definida por el usuario. |
Crea una aplicación de microservicios Dapr mediante Container Apps | Cree una aplicación de microservicios de Dapr mediante Container Apps. |
Crea una aplicación dapr pub-sub servicebus mediante Container Apps | Cree una aplicación pub-sub servicebus de Dapr mediante Container Apps. |
Implementación de Azure Data Explorer DB con de conexión de Cosmos DB | Implemente Azure Data Explorer DB con conexión de Cosmos DB. |
Definición de recursos de plantilla de ARM
El tipo de recurso databaseAccounts 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, agregue el siguiente JSON a la plantilla.
{
"type": "Microsoft.DocumentDB/databaseAccounts",
"apiVersion": "2024-12-01-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"kind": "string",
"location": "string",
"properties": {
"analyticalStorageConfiguration": {
"schemaType": "string"
},
"apiProperties": {
"serverVersion": "string"
},
"backupPolicy": {
"migrationState": {
"startTime": "string",
"status": "string",
"targetType": "string"
},
"type": "string"
// For remaining properties, see BackupPolicy objects
},
"capabilities": [
{
"name": "string"
}
],
"capacity": {
"totalThroughputLimit": "int"
},
"capacityMode": "string",
"connectorOffer": "string",
"consistencyPolicy": {
"defaultConsistencyLevel": "string",
"maxIntervalInSeconds": "int",
"maxStalenessPrefix": "int"
},
"cors": [
{
"allowedHeaders": "string",
"allowedMethods": "string",
"allowedOrigins": "string",
"exposedHeaders": "string",
"maxAgeInSeconds": "int"
}
],
"createMode": "string",
"customerManagedKeyStatus": "string",
"databaseAccountOfferType": "Standard",
"defaultIdentity": "string",
"defaultPriorityLevel": "string",
"diagnosticLogSettings": {
"enableFullTextQuery": "string"
},
"disableKeyBasedMetadataWriteAccess": "bool",
"disableLocalAuth": "bool",
"enableAnalyticalStorage": "bool",
"enableAutomaticFailover": "bool",
"enableBurstCapacity": "bool",
"enableCassandraConnector": "bool",
"enableFreeTier": "bool",
"enableMaterializedViews": "bool",
"enableMultipleWriteLocations": "bool",
"enablePartitionMerge": "bool",
"enablePerRegionPerPartitionAutoscale": "bool",
"enablePriorityBasedExecution": "bool",
"ipRules": [
{
"ipAddressOrRange": "string"
}
],
"isVirtualNetworkFilterEnabled": "bool",
"keyVaultKeyUri": "string",
"locations": [
{
"failoverPriority": "int",
"isZoneRedundant": "bool",
"locationName": "string"
}
],
"minimalTlsVersion": "string",
"networkAclBypass": "string",
"networkAclBypassResourceIds": [ "string" ],
"publicNetworkAccess": "string",
"restoreParameters": {
"databasesToRestore": [
{
"collectionNames": [ "string" ],
"databaseName": "string"
}
],
"gremlinDatabasesToRestore": [
{
"databaseName": "string",
"graphNames": [ "string" ]
}
],
"restoreMode": "string",
"restoreSource": "string",
"restoreTimestampInUtc": "string",
"restoreWithTtlDisabled": "bool",
"sourceBackupLocation": "string",
"tablesToRestore": [ "string" ]
},
"virtualNetworkRules": [
{
"id": "string",
"ignoreMissingVNetServiceEndpoint": "bool"
}
]
},
"tags": {
"{customized property}": "string"
}
}
Objetos BackupPolicy
Establezca el tipo propiedad para especificar el tipo de objeto.
Para continuous, use:
{
"continuousModeProperties": {
"tier": "string"
},
"type": "Continuous"
}
Para Periódica, use:
{
"periodicModeProperties": {
"backupIntervalInMinutes": "int",
"backupRetentionIntervalInHours": "int",
"backupStorageRedundancy": "string"
},
"type": "Periodic"
}
Valores de propiedad
AnalyticalStorageConfiguration
Nombre | Descripción | Valor |
---|---|---|
schemaType | Describe los tipos de esquema para el almacenamiento analítico. | 'FullFidelity' 'WellDefined' |
ApiProperties
Nombre | Descripción | Valor |
---|---|---|
serverVersion | Describe la versión de la cuenta de MongoDB. | '3.2' '3.6' '4.0' '4.2' '5.0' '6.0' '7.0' |
BackupPolicy
Nombre | Descripción | Valor |
---|---|---|
migrationState | Objeto que representa el estado de la migración entre las directivas de copia de seguridad. | |
tipo | Establezca en "Continuous" para el tipo ContinuousModeBackupPolicy. Establezca en "Periodic" para el tipo PeriodicModeBackupPolicy. | 'Continuo' 'Periódico' (obligatorio) |
BackupPolicyMigrationState
Nombre | Descripción | Valor |
---|---|---|
startTime | Hora en la que se inició la migración de directivas de copia de seguridad (formato ISO-8601). | cuerda |
estado | Describe el estado de la migración entre los tipos de directiva de copia de seguridad. | "Completado" 'Error' 'InProgress' 'No válido' |
targetType | Describe el tipo de directiva de copia de seguridad de destino de la migración de directivas de copia de seguridad. | 'Continuo' 'Periódico' |
Capacidad
Nombre | Descripción | Valor |
---|---|---|
nombre | Nombre de la funcionalidad de Cosmos DB. Por ejemplo, "name": "EnableCassandra". Los valores actuales también incluyen "EnableTable" y "EnableGremlin". | cuerda |
Capacidad
Nombre | Descripción | Valor |
---|---|---|
totalThroughputLimit | Límite total de rendimiento impuesto en la cuenta. TotalThroughputLimit de 2000 impone un límite estricto de rendimiento máximo que se puede aprovisionar en esa cuenta para ser 2000. TotalThroughputLimit de -1 indica que no hay límites en el aprovisionamiento del rendimiento. | Int Restricciones: Valor mínimo = -1 |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
Nombre | Descripción | Valor |
---|
ConsistencyPolicy
Nombre | Descripción | Valor |
---|---|---|
defaultConsistencyLevel | El nivel de coherencia predeterminado y las opciones de configuración de la cuenta de Cosmos DB. | 'BoundedStaleness' 'ConsistentPrefix' 'Eventual' 'Sesión' 'Fuerte' (obligatorio) |
maxIntervalInSeconds | Cuando se usa con el nivel de coherencia obsolescencia limitada, este valor representa la cantidad de tiempo de obsolescencia (en segundos) tolerada. El intervalo aceptado para este valor es 5 - 86400. Obligatorio cuando defaultConsistencyPolicy se establece en "BoundedStaleness". | Int Restricciones: Valor mínimo = 5 Valor máximo = 86400 |
maxStalenessPrefix | Cuando se usa con el nivel de coherencia obsolescencia limitada, este valor representa el número de solicitudes obsoletas toleradas. El intervalo aceptado para este valor es de 1 a 2.147.483.647. Obligatorio cuando defaultConsistencyPolicy se establece en "BoundedStaleness". | Int Restricciones: Valor mínimo = 1 Valor máximo = 2147483647 |
ContinuousModeBackupPolicy
Nombre | Descripción | Valor |
---|---|---|
continuousModeProperties | Valores de configuración para la copia de seguridad en modo continuo | ContinuousModeProperties |
tipo | Describe el modo de copias de seguridad. | 'Continuous' (obligatorio) |
ContinuousModeProperties
Nombre | Descripción | Valor |
---|---|---|
nivel | Enumeración para indicar el tipo de modo de copia de seguridad continuos | 'Continuous30Days' "Continuous7Days" |
CorsPolicy
Nombre | Descripción | Valor |
---|---|---|
allowedHeaders | Encabezados de solicitud que el dominio de origen puede especificar en la solicitud CORS. | cuerda |
allowedMethods | Los métodos (verbos de solicitud HTTP) que el dominio de origen puede usar para una solicitud CORS. | cuerda |
allowedOrigins | Los dominios de origen que pueden realizar una solicitud en el servicio a través de CORS. | string (obligatorio) |
exposedHeaders | Encabezados de respuesta que se pueden enviar en la respuesta a la solicitud CORS y que expone el explorador al emisor de la solicitud. | cuerda |
maxAgeInSeconds | Tiempo máximo durante el que un explorador debe almacenar en caché la solicitud OPTIONS preparatoria. | Int Restricciones: Valor mínimo = 1 Valor máximo = 2147483647 |
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties
Nombre | Descripción | Valor |
---|---|---|
analyticalStorageConfiguration | Propiedades específicas del almacenamiento analítico. | AnalyticalStorageConfiguration |
apiProperties | Propiedades específicas de la API. Actualmente, solo se admite para la API de MongoDB. | ApiProperties |
backupPolicy | Objeto que representa la directiva para realizar copias de seguridad en una cuenta. | BackupPolicy |
Capacidades | Lista de funcionalidades de Cosmos DB para la cuenta | funcionalidad[] |
capacidad | Objeto que representa todas las propiedades relacionadas con el cumplimiento de la capacidad en una cuenta. | capacidad de |
capacityMode | Indica capacityMode de la cuenta de Cosmos DB. | 'Ninguno' "Aprovisionado" "Sin servidor" |
connectorOffer | Tipo de oferta del conector cassandra para la cuenta de C* de base de datos de Cosmos DB. | 'Pequeño' |
consistencyPolicy | Directiva de coherencia para la cuenta de Cosmos DB. | ConsistencyPolicy |
cors | Directiva DE CORS para la cuenta de base de datos de Cosmos DB. | CorsPolicy[] |
createMode | Enumeración para indicar el modo de creación de la cuenta. | 'Valor predeterminado' 'Restaurar' |
customerManagedKeyStatus | Indica el estado de la característica Clave administrada por el cliente en la cuenta. En caso de que haya errores, la propiedad proporciona instrucciones de solución de problemas. | cuerda |
databaseAccountOfferType | Tipo de oferta para la base de datos | 'Estándar' (obligatorio) |
defaultIdentity | La identidad predeterminada para acceder al almacén de claves que se usa en características como claves administradas por el cliente. Los usuarios deben establecer explícitamente la identidad predeterminada. Puede ser "FirstPartyIdentity", "SystemAssignedIdentity" y mucho más. | cuerda |
defaultPriorityLevel | Enumeración para indicar el nivel de prioridad predeterminado de solicitud para la ejecución basada en prioridad. | "Alto" "Bajo" |
diagnosticLogSettings | Objeto que representa la configuración del registro de diagnóstico diferente para la cuenta de Cosmos DB. | DiagnosticLogSettings |
disableKeyBasedMetadataWriteAccess | Deshabilitar las operaciones de escritura en recursos de metadatos (bases de datos, contenedores, rendimiento) mediante claves de cuenta | Bool |
disableLocalAuth | No participar en la autenticación local y asegurarse de que solo se puede usar MSI y AAD exclusivamente para la autenticación. | Bool |
enableAnalyticalStorage | Marca para indicar si se va a habilitar el análisis de almacenamiento. | Bool |
enableAutomaticFailover | Habilita la conmutación automática por error de la región de escritura en el caso poco frecuente de que la región no esté disponible debido a una interrupción. La conmutación automática por error dará lugar a una nueva región de escritura para la cuenta y se elige en función de las prioridades de conmutación por error configuradas para la cuenta. | Bool |
enableBurstCapacity | Marca para indicar la habilitación o deshabilitación de la característica De vista previa de capacidad de ráfaga en la cuenta | Bool |
enableCassandraConnector | Habilita el conector cassandra en la cuenta de C* de Cosmos DB | Bool |
enableFreeTier | Marca para indicar si el nivel Gratis está habilitado. | Bool |
enableMaterializedViews | Marca para indicar si se habilita MaterializedViews en la cuenta de Cosmos DB | Bool |
enableMultipleWriteLocations | Permite que la cuenta escriba en varias ubicaciones | Bool |
enablePartitionMerge | Marca para indicar la habilitación o deshabilitación de la característica De combinación de particiones en la cuenta | Bool |
enablePerRegionPerPartitionAutoscale | Marca para indicar la habilitación o deshabilitación de Per-Region característica de vista previa de escalabilidad automática por partición en la cuenta | Bool |
enablePriorityBasedExecution | Marca para indicar la habilitación o deshabilitación de la característica Vista previa de ejecución basada en prioridad en la cuenta | Bool |
ipRules | Lista de IpRules. | ipAddressOrRange[] |
isVirtualNetworkFilterEnabled | Marca para indicar si se deben habilitar o deshabilitar las reglas de ACL de red virtual. | Bool |
keyVaultKeyUri | Identificador URI del almacén de claves | cuerda |
Ubicaciones | Matriz que contiene las ubicaciones de georeplicación habilitadas para la cuenta de Cosmos DB. | Ubicación[] (obligatorio) |
minimalTlsVersion | Indica la versión mínima permitida de Tls. El valor predeterminado es Tls 1.0, excepto cassandra y mongo API, que solo funcionan con Tls 1.2. | 'Tls' 'Tls11' 'Tls12' |
networkAclBypass | Indica qué servicios pueden omitir las comprobaciones de firewall. | "AzureServices" 'Ninguno' |
networkAclBypassResourceIds | Matriz que contiene los identificadores de recurso para la omisión de Acl de red para la cuenta de Cosmos DB. | string[] |
publicNetworkAccess | Indica si se permiten solicitudes de la red pública | 'Deshabilitado' 'Habilitado' "SecuredByPerimeter" |
restoreParameters | Parámetros para indicar la información sobre la restauración. | restoreParameters |
virtualNetworkRules | Lista de reglas de ACL de red virtual configuradas para la cuenta de Cosmos DB. | virtualNetworkRule[] |
DatabaseRestoreResource
Nombre | Descripción | Valor |
---|---|---|
collectionNames | Nombres de las colecciones disponibles para la restauración. | string[] |
databaseName | Nombre de la base de datos disponible para la restauración. | cuerda |
DiagnosticLogSettings
Nombre | Descripción | Valor |
---|---|---|
enableFullTextQuery | Describir el nivel de detalle con el que se van a registrar las consultas. | 'False' 'Ninguno' 'True' |
GremlinDatabaseRestoreResource
Nombre | Descripción | Valor |
---|---|---|
databaseName | Nombre de la base de datos gremlin disponible para la restauración. | cuerda |
graphNames | Los nombres de los gráficos disponibles para la restauración. | string[] |
IpAddressOrRange
Nombre | Descripción | Valor |
---|---|---|
ipAddressOrRange | Una sola dirección IPv4 o un único intervalo de direcciones IPv4 en formato CIDR. Las direcciones IP proporcionadas deben tener un formato correcto y no se pueden incluir en uno de los siguientes intervalos: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, ya que el filtro de direcciones IP no los puede aplicar. Ejemplo de entradas válidas: "23.40.210.245" o "23.40.210.0/8". | cuerda |
Ubicación
Nombre | Descripción | Valor |
---|---|---|
failoverPriority | Prioridad de conmutación por error de la región. Una prioridad de conmutación por error de 0 indica una región de escritura. Valor máximo de una prioridad de conmutación por error = (número total de regiones - 1). Los valores de prioridad de conmutación por error deben ser únicos para cada una de las regiones en las que existe la cuenta de base de datos. | Int Restricciones: Valor mínimo = 0 |
isZoneRedundant | Marca para indicar si esta región es una región availabilityZone o no | Bool |
locationName | Nombre de la región. | cuerda |
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
Nombre | Descripción | Valor |
---|---|---|
apiVersion | La versión de api | '2024-12-01-preview' |
identidad | Identidad del recurso. | managedServiceIdentity |
amable | Indica el tipo de cuenta de base de datos. Esto solo se puede establecer en la creación de la cuenta de base de datos. | 'GlobalDocumentDB' "MongoDB" 'Análisis' |
ubicación | Ubicación del grupo de recursos al que pertenece el recurso. | cuerda |
nombre | El nombre del recurso | cuerda Restricciones: Longitud mínima = 3 Longitud máxima = 3 Patrón = ^[a-z0-9]+(-[a-z0-9]+)* (obligatorio) |
Propiedades | Propiedades para crear y actualizar cuentas de base de datos de Azure Cosmos DB. | DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (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' |
PeriodicModeBackupPolicy
PeriodicModeProperties
Nombre | Descripción | Valor |
---|---|---|
backupIntervalInMinutes | Entero que representa el intervalo en minutos entre dos copias de seguridad. | Int Restricciones: Valor mínimo = 0 |
backupRetentionIntervalInHours | Entero que representa el tiempo (en horas) que cada copia de seguridad se conserva. | Int Restricciones: Valor mínimo = 0 |
backupStorageRedundancy | Enumeración para indicar el tipo de residencia de copia de seguridad | 'Geo' 'Local' 'Zona' |
RestoreParameters
Nombre | Descripción | Valor |
---|---|---|
databasesToRestore | Lista de bases de datos específicas disponibles para la restauración. | DatabaseRestoreResource[] |
gremlinDatabasesToRestore | Lista de bases de datos de gremlin específicas disponibles para la restauración. | gremlinDatabaseRestoreResource[] |
restoreMode | Describe el modo de restauración. | 'PointInTime' |
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 |
restoreWithTtlDisabled | Especifica si la cuenta restaurada tendrá tiempoTo-Live deshabilitado tras la restauración correcta. | Bool |
sourceBackupLocation | Ubicación de copia de seguridad de origen para la restauración. | cuerda |
tablesToRestore | Lista de tablas específicas disponibles para la restauración. | string[] |
Etiquetas
Nombre | Descripción | Valor |
---|
VirtualNetworkRule
Nombre | Descripción | Valor |
---|---|---|
identificación | Identificador de recurso de una subred, por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. | cuerda |
ignoreMissingVNetServiceEndpoint | Cree una regla de firewall antes de que la red virtual tenga habilitado el punto de conexión de servicio de red virtual. | Bool |
Plantillas de inicio rápido
Las siguientes plantillas de inicio rápido implementan este tipo de recurso.
Plantilla | Descripción |
---|---|
API de SQL de la cuenta de Azure Cosmos DB con de almacén analítico |
Esta plantilla crea una cuenta de Azure Cosmos para Core (SQL) API con una base de datos y un contenedor configurados con el almacén analítico. |
cuenta de Azure Cosmos DB con Web App |
Esta plantilla implementa una cuenta de Azure Cosmos DB, un plan de App Service y crea una aplicación web en el plan de App Service. También agrega dos configuraciones de aplicación a la aplicación web que hacen referencia al punto de conexión de la cuenta de Azure Cosmos DB. De este modo, las soluciones implementadas en la aplicación web pueden conectarse al punto de conexión de la cuenta de Azure Cosmos DB mediante esa configuración. |
CI/CD mediante Jenkins en Azure Container Service (AKS) |
Los contenedores facilitan la compilación e implementación continua de las aplicaciones. Mediante la orquestación de la implementación de esos contenedores mediante Kubernetes en Azure Container Service, puede lograr clústeres replicables y administrables de contenedores. Al configurar una compilación continua para generar las imágenes de contenedor y la orquestación, puede aumentar la velocidad y confiabilidad de la implementación. |
Crear una cuenta de Cosmos DB con la habilitada para Microsoft Defender |
Con esta plantilla de ARM, puede implementar una cuenta de Azure Cosmos DB con Microsoft Defender para Azure Cosmos DB habilitado. Microsoft Defender para Azure Cosmos DB es una capa nativa de seguridad de Azure que detecta intentos de aprovechar las bases de datos de las cuentas de Azure Cosmos DB. Microsoft Defender para Azure Cosmos DB detecta posibles inyecciones de SQL, actores malintencionados conocidos basados en inteligencia sobre amenazas de Microsoft, patrones de acceso sospechosos y posibles vulnerabilidades de la base de datos a través de identidades comprometidas o usuarios internos malintencionados. |
Creación de una cuenta de Azure Cosmos DB de nivel gratuito |
Esta plantilla crea una cuenta de Azure Cosmos DB de nivel gratuito para SQL API con una base de datos con rendimiento compartido y contenedor. |
Creación de una cuenta mínima de Azure Cosmos DB para Core (SQL) API |
Esta plantilla crea una cuenta de Azure Cosmos DB para core (SQL) API, al tiempo que solo especifica las propiedades mínimas de recursos necesarias. |
Creación de una cuenta de Azure Cosmos DB sin servidor para sql API |
Esta plantilla crea una cuenta de Azure Cosmos DB sin servidor para core (SQL). |
Creación de una cuenta de Azure Cosmos táctil cero y azure Web App |
Esta plantilla crea una cuenta de Azure Cosmos, inserta el punto de conexión y las claves de Cosmos DB en la configuración de Azure Web App y, a continuación, implementa una aplicación web asp MVC desde GitHub. |
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. |
Creación de una cuenta de Azure Cosmos para Table API |
Esta plantilla crea una cuenta de Azure Cosmos DB para Table API en dos regiones y una sola tabla con rendimiento aprovisionado. |
Creación de una cuenta de Azure Cosmos para Table API con escalabilidad automática |
Esta plantilla crea una cuenta de Azure Cosmos DB para Table API en dos regiones y una sola tabla con rendimiento de escalado automático. |
Creación de una cuenta de Azure Cosmos DB para cassandra API |
Esta plantilla crea una cuenta de Azure Cosmos DB para Cassandra API en dos regiones con un espacio de claves y una tabla con rendimiento dedicado. |
Creación de una cuenta de Azure Cosmos DB para Core (SQL) API |
Esta plantilla crea una cuenta de Azure Cosmos para Core (SQL) API con una base de datos y un contenedor con rendimiento con varias otras opciones. |
Creación de una cuenta de Azure Cosmos DB para gremlin API |
Esta plantilla crea una cuenta de Azure Cosmos DB para Gremlin API en dos regiones con una base de datos y un grafo mediante el rendimiento dedicado. |
Creación de una cuenta de Azure Cosmos DB para el escalado automático de Gremlin API |
Esta plantilla crea una cuenta de Azure Cosmos DB para Gremlin API en dos regiones con una base de datos y un grafo mediante el rendimiento de escalabilidad automática. |
Creación de una cuenta de Azure Cosmos DB en varias regiones |
Esta plantilla crea una cuenta de Azure Cosmos DB para cualquier tipo de API de base de datos con una región primaria y secundaria que elija el nivel de coherencia y el tipo de conmutación por error. |
Creación de una API de SQL de cuenta de Azure Cosmos DB con de escalado automático |
Esta plantilla crea una cuenta de Azure Cosmos para Core (SQL) API con una base de datos y un contenedor con rendimiento de escalabilidad automática con varias otras opciones. |
Creación de una cuenta de Azure Cosmos DB con un punto de conexión privado |
Esta plantilla creará una cuenta de Cosmos, una red virtual y un punto de conexión privado que exponga la cuenta de Cosmos a la red virtual. |
Creación de una cuenta de SQL de Azure Cosmos DB con RBAC del plano de datos |
Esta plantilla creará una cuenta de SQL Cosmos, una definición de roles mantenida de forma nativa y una asignación de roles mantenida de forma nativa para una identidad de AAD. |
Crear una cuenta de Azure CosmosDB |
Esta plantilla de ARM está intención de crear rápidamente una cuenta de CosmosDB con los valores mínimos necesarios. |
Creación de una cuenta de Escalado automático de Azure Cosmos DB para Cassandra API |
Esta plantilla crea una cuenta de Azure Cosmos DB para Cassandra API en dos regiones con un espacio de claves y una tabla con rendimiento de escalabilidad automática. |
Creación de procedimientos almacenados de la API de Azure Cosmos DB Core (SQL) |
Esta plantilla crea una cuenta de Azure Cosmos DB para Core (SQL) API y un contenedor con un procedimiento almacenado, desencadenador y función definida por el usuario. |
Creación de Azure Cosmos con SQL API y varios contenedores |
La plantilla crea un contenedor de Cosmos con una API de SQL y permite agregar contenedores mulitple. |
Crea una aplicación de microservicios Dapr mediante Container Apps |
Cree una aplicación de microservicios de Dapr mediante Container Apps. |
Crea una aplicación dapr pub-sub servicebus mediante Container Apps |
Cree una aplicación pub-sub servicebus de Dapr mediante Container Apps. |
Implementación de Azure Data Explorer DB con de conexión de Cosmos DB |
Implemente Azure Data Explorer DB con conexión de Cosmos DB. |
Aplicación web con una instancia de SQL Database, Azure Cosmos DB, Azure Search |
Esta plantilla aprovisiona una aplicación web, una instancia de SQL Database, Azure Cosmos DB, Azure Search y Application Insights. |
Definición de recursos de Terraform (proveedor AzAPI)
El tipo de recurso databaseAccounts 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, agregue el siguiente Terraform a la plantilla.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts@2024-12-01-preview"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
kind = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
analyticalStorageConfiguration = {
schemaType = "string"
}
apiProperties = {
serverVersion = "string"
}
backupPolicy = {
migrationState = {
startTime = "string"
status = "string"
targetType = "string"
}
type = "string"
// For remaining properties, see BackupPolicy objects
}
capabilities = [
{
name = "string"
}
]
capacity = {
totalThroughputLimit = int
}
capacityMode = "string"
connectorOffer = "string"
consistencyPolicy = {
defaultConsistencyLevel = "string"
maxIntervalInSeconds = int
maxStalenessPrefix = int
}
cors = [
{
allowedHeaders = "string"
allowedMethods = "string"
allowedOrigins = "string"
exposedHeaders = "string"
maxAgeInSeconds = int
}
]
createMode = "string"
customerManagedKeyStatus = "string"
databaseAccountOfferType = "Standard"
defaultIdentity = "string"
defaultPriorityLevel = "string"
diagnosticLogSettings = {
enableFullTextQuery = "string"
}
disableKeyBasedMetadataWriteAccess = bool
disableLocalAuth = bool
enableAnalyticalStorage = bool
enableAutomaticFailover = bool
enableBurstCapacity = bool
enableCassandraConnector = bool
enableFreeTier = bool
enableMaterializedViews = bool
enableMultipleWriteLocations = bool
enablePartitionMerge = bool
enablePerRegionPerPartitionAutoscale = bool
enablePriorityBasedExecution = bool
ipRules = [
{
ipAddressOrRange = "string"
}
]
isVirtualNetworkFilterEnabled = bool
keyVaultKeyUri = "string"
locations = [
{
failoverPriority = int
isZoneRedundant = bool
locationName = "string"
}
]
minimalTlsVersion = "string"
networkAclBypass = "string"
networkAclBypassResourceIds = [
"string"
]
publicNetworkAccess = "string"
restoreParameters = {
databasesToRestore = [
{
collectionNames = [
"string"
]
databaseName = "string"
}
]
gremlinDatabasesToRestore = [
{
databaseName = "string"
graphNames = [
"string"
]
}
]
restoreMode = "string"
restoreSource = "string"
restoreTimestampInUtc = "string"
restoreWithTtlDisabled = bool
sourceBackupLocation = "string"
tablesToRestore = [
"string"
]
}
virtualNetworkRules = [
{
id = "string"
ignoreMissingVNetServiceEndpoint = bool
}
]
}
})
}
Objetos BackupPolicy
Establezca el tipo propiedad para especificar el tipo de objeto.
Para continuous, use:
{
continuousModeProperties = {
tier = "string"
}
type = "Continuous"
}
Para Periódica, use:
{
periodicModeProperties = {
backupIntervalInMinutes = int
backupRetentionIntervalInHours = int
backupStorageRedundancy = "string"
}
type = "Periodic"
}
Valores de propiedad
AnalyticalStorageConfiguration
Nombre | Descripción | Valor |
---|---|---|
schemaType | Describe los tipos de esquema para el almacenamiento analítico. | 'FullFidelity' 'WellDefined' |
ApiProperties
Nombre | Descripción | Valor |
---|---|---|
serverVersion | Describe la versión de la cuenta de MongoDB. | '3.2' '3.6' '4.0' '4.2' '5.0' '6.0' '7.0' |
BackupPolicy
Nombre | Descripción | Valor |
---|---|---|
migrationState | Objeto que representa el estado de la migración entre las directivas de copia de seguridad. | |
tipo | Establezca en "Continuous" para el tipo ContinuousModeBackupPolicy. Establezca en "Periodic" para el tipo PeriodicModeBackupPolicy. | 'Continuo' 'Periódico' (obligatorio) |
BackupPolicyMigrationState
Nombre | Descripción | Valor |
---|---|---|
startTime | Hora en la que se inició la migración de directivas de copia de seguridad (formato ISO-8601). | cuerda |
estado | Describe el estado de la migración entre los tipos de directiva de copia de seguridad. | "Completado" 'Error' 'InProgress' 'No válido' |
targetType | Describe el tipo de directiva de copia de seguridad de destino de la migración de directivas de copia de seguridad. | 'Continuo' 'Periódico' |
Capacidad
Nombre | Descripción | Valor |
---|---|---|
nombre | Nombre de la funcionalidad de Cosmos DB. Por ejemplo, "name": "EnableCassandra". Los valores actuales también incluyen "EnableTable" y "EnableGremlin". | cuerda |
Capacidad
Nombre | Descripción | Valor |
---|---|---|
totalThroughputLimit | Límite total de rendimiento impuesto en la cuenta. TotalThroughputLimit de 2000 impone un límite estricto de rendimiento máximo que se puede aprovisionar en esa cuenta para ser 2000. TotalThroughputLimit de -1 indica que no hay límites en el aprovisionamiento del rendimiento. | Int Restricciones: Valor mínimo = -1 |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
Nombre | Descripción | Valor |
---|
ConsistencyPolicy
Nombre | Descripción | Valor |
---|---|---|
defaultConsistencyLevel | El nivel de coherencia predeterminado y las opciones de configuración de la cuenta de Cosmos DB. | 'BoundedStaleness' 'ConsistentPrefix' 'Eventual' 'Sesión' 'Fuerte' (obligatorio) |
maxIntervalInSeconds | Cuando se usa con el nivel de coherencia obsolescencia limitada, este valor representa la cantidad de tiempo de obsolescencia (en segundos) tolerada. El intervalo aceptado para este valor es 5 - 86400. Obligatorio cuando defaultConsistencyPolicy se establece en "BoundedStaleness". | Int Restricciones: Valor mínimo = 5 Valor máximo = 86400 |
maxStalenessPrefix | Cuando se usa con el nivel de coherencia obsolescencia limitada, este valor representa el número de solicitudes obsoletas toleradas. El intervalo aceptado para este valor es de 1 a 2.147.483.647. Obligatorio cuando defaultConsistencyPolicy se establece en "BoundedStaleness". | Int Restricciones: Valor mínimo = 1 Valor máximo = 2147483647 |
ContinuousModeBackupPolicy
Nombre | Descripción | Valor |
---|---|---|
continuousModeProperties | Valores de configuración para la copia de seguridad en modo continuo | ContinuousModeProperties |
tipo | Describe el modo de copias de seguridad. | 'Continuous' (obligatorio) |
ContinuousModeProperties
Nombre | Descripción | Valor |
---|---|---|
nivel | Enumeración para indicar el tipo de modo de copia de seguridad continuos | 'Continuous30Days' "Continuous7Days" |
CorsPolicy
Nombre | Descripción | Valor |
---|---|---|
allowedHeaders | Encabezados de solicitud que el dominio de origen puede especificar en la solicitud CORS. | cuerda |
allowedMethods | Los métodos (verbos de solicitud HTTP) que el dominio de origen puede usar para una solicitud CORS. | cuerda |
allowedOrigins | Los dominios de origen que pueden realizar una solicitud en el servicio a través de CORS. | string (obligatorio) |
exposedHeaders | Encabezados de respuesta que se pueden enviar en la respuesta a la solicitud CORS y que expone el explorador al emisor de la solicitud. | cuerda |
maxAgeInSeconds | Tiempo máximo durante el que un explorador debe almacenar en caché la solicitud OPTIONS preparatoria. | Int Restricciones: Valor mínimo = 1 Valor máximo = 2147483647 |
DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties
Nombre | Descripción | Valor |
---|---|---|
analyticalStorageConfiguration | Propiedades específicas del almacenamiento analítico. | AnalyticalStorageConfiguration |
apiProperties | Propiedades específicas de la API. Actualmente, solo se admite para la API de MongoDB. | ApiProperties |
backupPolicy | Objeto que representa la directiva para realizar copias de seguridad en una cuenta. | BackupPolicy |
Capacidades | Lista de funcionalidades de Cosmos DB para la cuenta | funcionalidad[] |
capacidad | Objeto que representa todas las propiedades relacionadas con el cumplimiento de la capacidad en una cuenta. | capacidad de |
capacityMode | Indica capacityMode de la cuenta de Cosmos DB. | 'Ninguno' "Aprovisionado" "Sin servidor" |
connectorOffer | Tipo de oferta del conector cassandra para la cuenta de C* de base de datos de Cosmos DB. | 'Pequeño' |
consistencyPolicy | Directiva de coherencia para la cuenta de Cosmos DB. | ConsistencyPolicy |
cors | Directiva DE CORS para la cuenta de base de datos de Cosmos DB. | CorsPolicy[] |
createMode | Enumeración para indicar el modo de creación de la cuenta. | 'Valor predeterminado' 'Restaurar' |
customerManagedKeyStatus | Indica el estado de la característica Clave administrada por el cliente en la cuenta. En caso de que haya errores, la propiedad proporciona instrucciones de solución de problemas. | cuerda |
databaseAccountOfferType | Tipo de oferta para la base de datos | 'Estándar' (obligatorio) |
defaultIdentity | La identidad predeterminada para acceder al almacén de claves que se usa en características como claves administradas por el cliente. Los usuarios deben establecer explícitamente la identidad predeterminada. Puede ser "FirstPartyIdentity", "SystemAssignedIdentity" y mucho más. | cuerda |
defaultPriorityLevel | Enumeración para indicar el nivel de prioridad predeterminado de solicitud para la ejecución basada en prioridad. | "Alto" "Bajo" |
diagnosticLogSettings | Objeto que representa la configuración del registro de diagnóstico diferente para la cuenta de Cosmos DB. | DiagnosticLogSettings |
disableKeyBasedMetadataWriteAccess | Deshabilitar las operaciones de escritura en recursos de metadatos (bases de datos, contenedores, rendimiento) mediante claves de cuenta | Bool |
disableLocalAuth | No participar en la autenticación local y asegurarse de que solo se puede usar MSI y AAD exclusivamente para la autenticación. | Bool |
enableAnalyticalStorage | Marca para indicar si se va a habilitar el análisis de almacenamiento. | Bool |
enableAutomaticFailover | Habilita la conmutación automática por error de la región de escritura en el caso poco frecuente de que la región no esté disponible debido a una interrupción. La conmutación automática por error dará lugar a una nueva región de escritura para la cuenta y se elige en función de las prioridades de conmutación por error configuradas para la cuenta. | Bool |
enableBurstCapacity | Marca para indicar la habilitación o deshabilitación de la característica De vista previa de capacidad de ráfaga en la cuenta | Bool |
enableCassandraConnector | Habilita el conector cassandra en la cuenta de C* de Cosmos DB | Bool |
enableFreeTier | Marca para indicar si el nivel Gratis está habilitado. | Bool |
enableMaterializedViews | Marca para indicar si se habilita MaterializedViews en la cuenta de Cosmos DB | Bool |
enableMultipleWriteLocations | Permite que la cuenta escriba en varias ubicaciones | Bool |
enablePartitionMerge | Marca para indicar la habilitación o deshabilitación de la característica De combinación de particiones en la cuenta | Bool |
enablePerRegionPerPartitionAutoscale | Marca para indicar la habilitación o deshabilitación de Per-Region característica de vista previa de escalabilidad automática por partición en la cuenta | Bool |
enablePriorityBasedExecution | Marca para indicar la habilitación o deshabilitación de la característica Vista previa de ejecución basada en prioridad en la cuenta | Bool |
ipRules | Lista de IpRules. | ipAddressOrRange[] |
isVirtualNetworkFilterEnabled | Marca para indicar si se deben habilitar o deshabilitar las reglas de ACL de red virtual. | Bool |
keyVaultKeyUri | Identificador URI del almacén de claves | cuerda |
Ubicaciones | Matriz que contiene las ubicaciones de georeplicación habilitadas para la cuenta de Cosmos DB. | Ubicación[] (obligatorio) |
minimalTlsVersion | Indica la versión mínima permitida de Tls. El valor predeterminado es Tls 1.0, excepto cassandra y mongo API, que solo funcionan con Tls 1.2. | 'Tls' 'Tls11' 'Tls12' |
networkAclBypass | Indica qué servicios pueden omitir las comprobaciones de firewall. | "AzureServices" 'Ninguno' |
networkAclBypassResourceIds | Matriz que contiene los identificadores de recurso para la omisión de Acl de red para la cuenta de Cosmos DB. | string[] |
publicNetworkAccess | Indica si se permiten solicitudes de la red pública | 'Deshabilitado' 'Habilitado' "SecuredByPerimeter" |
restoreParameters | Parámetros para indicar la información sobre la restauración. | restoreParameters |
virtualNetworkRules | Lista de reglas de ACL de red virtual configuradas para la cuenta de Cosmos DB. | virtualNetworkRule[] |
DatabaseRestoreResource
Nombre | Descripción | Valor |
---|---|---|
collectionNames | Nombres de las colecciones disponibles para la restauración. | string[] |
databaseName | Nombre de la base de datos disponible para la restauración. | cuerda |
DiagnosticLogSettings
Nombre | Descripción | Valor |
---|---|---|
enableFullTextQuery | Describir el nivel de detalle con el que se van a registrar las consultas. | 'False' 'Ninguno' 'True' |
GremlinDatabaseRestoreResource
Nombre | Descripción | Valor |
---|---|---|
databaseName | Nombre de la base de datos gremlin disponible para la restauración. | cuerda |
graphNames | Los nombres de los gráficos disponibles para la restauración. | string[] |
IpAddressOrRange
Nombre | Descripción | Valor |
---|---|---|
ipAddressOrRange | Una sola dirección IPv4 o un único intervalo de direcciones IPv4 en formato CIDR. Las direcciones IP proporcionadas deben tener un formato correcto y no se pueden incluir en uno de los siguientes intervalos: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, ya que el filtro de direcciones IP no los puede aplicar. Ejemplo de entradas válidas: "23.40.210.245" o "23.40.210.0/8". | cuerda |
Ubicación
Nombre | Descripción | Valor |
---|---|---|
failoverPriority | Prioridad de conmutación por error de la región. Una prioridad de conmutación por error de 0 indica una región de escritura. Valor máximo de una prioridad de conmutación por error = (número total de regiones - 1). Los valores de prioridad de conmutación por error deben ser únicos para cada una de las regiones en las que existe la cuenta de base de datos. | Int Restricciones: Valor mínimo = 0 |
isZoneRedundant | Marca para indicar si esta región es una región availabilityZone o no | Bool |
locationName | Nombre de la región. | cuerda |
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
Nombre | Descripción | Valor |
---|---|---|
identidad | Identidad del recurso. | managedServiceIdentity |
amable | Indica el tipo de cuenta de base de datos. Esto solo se puede establecer en la creación de la cuenta de base de datos. | 'GlobalDocumentDB' "MongoDB" 'Análisis' |
ubicación | Ubicación del grupo de recursos al que pertenece el recurso. | cuerda |
nombre | El nombre del recurso | cuerda Restricciones: Longitud mínima = 3 Longitud máxima = 3 Patrón = ^[a-z0-9]+(-[a-z0-9]+)* (obligatorio) |
Propiedades | Propiedades para crear y actualizar cuentas de base de datos de Azure Cosmos DB. | DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (obligatorio) |
Etiquetas | Etiquetas de recursos | Diccionario de nombres y valores de etiqueta. |
tipo | El tipo de recurso | "Microsoft.DocumentDB/databaseAccounts@2024-12-01-preview" |
PeriodicModeBackupPolicy
PeriodicModeProperties
Nombre | Descripción | Valor |
---|---|---|
backupIntervalInMinutes | Entero que representa el intervalo en minutos entre dos copias de seguridad. | Int Restricciones: Valor mínimo = 0 |
backupRetentionIntervalInHours | Entero que representa el tiempo (en horas) que cada copia de seguridad se conserva. | Int Restricciones: Valor mínimo = 0 |
backupStorageRedundancy | Enumeración para indicar el tipo de residencia de copia de seguridad | 'Geo' 'Local' 'Zona' |
RestoreParameters
Nombre | Descripción | Valor |
---|---|---|
databasesToRestore | Lista de bases de datos específicas disponibles para la restauración. | DatabaseRestoreResource[] |
gremlinDatabasesToRestore | Lista de bases de datos de gremlin específicas disponibles para la restauración. | gremlinDatabaseRestoreResource[] |
restoreMode | Describe el modo de restauración. | 'PointInTime' |
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 |
restoreWithTtlDisabled | Especifica si la cuenta restaurada tendrá tiempoTo-Live deshabilitado tras la restauración correcta. | Bool |
sourceBackupLocation | Ubicación de copia de seguridad de origen para la restauración. | cuerda |
tablesToRestore | Lista de tablas específicas disponibles para la restauración. | string[] |
Etiquetas
Nombre | Descripción | Valor |
---|
VirtualNetworkRule
Nombre | Descripción | Valor |
---|---|---|
identificación | Identificador de recurso de una subred, por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. | cuerda |
ignoreMissingVNetServiceEndpoint | Cree una regla de firewall antes de que la red virtual tenga habilitado el punto de conexión de servicio de red virtual. | Bool |