Compartir a través de


Base de datos Microsoft.DocumentDBAccounts 2021-04-01-preview

Definición de recursos de Bicep

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts@2021-04-01-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    apiProperties: {
      serverVersion: 'string'
    }
    backupPolicy: {
      type: 'string'
      // For remaining properties, see BackupPolicy objects
    }
    capabilities: [
      {
        name: 'string'
      }
    ]
    connectorOffer: 'string'
    consistencyPolicy: {
      defaultConsistencyLevel: 'string'
      maxIntervalInSeconds: int
      maxStalenessPrefix: int
    }
    cors: [
      {
        allowedHeaders: 'string'
        allowedMethods: 'string'
        allowedOrigins: 'string'
        exposedHeaders: 'string'
        maxAgeInSeconds: int
      }
    ]
    databaseAccountOfferType: 'Standard'
    defaultIdentity: 'string'
    disableKeyBasedMetadataWriteAccess: bool
    enableAnalyticalStorage: bool
    enableAutomaticFailover: bool
    enableCassandraConnector: bool
    enableFreeTier: bool
    enableMultipleWriteLocations: bool
    ipRules: [
      {
        ipAddressOrRange: 'string'
      }
    ]
    isVirtualNetworkFilterEnabled: bool
    keyVaultKeyUri: 'string'
    locations: [
      {
        failoverPriority: int
        isZoneRedundant: bool
        locationName: 'string'
      }
    ]
    networkAclBypass: 'string'
    networkAclBypassResourceIds: [
      'string'
    ]
    publicNetworkAccess: 'string'
    virtualNetworkRules: [
      {
        id: 'string'
        ignoreMissingVNetServiceEndpoint: bool
      }
    ]
    createMode: 'string'
    // For remaining properties, see DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties objects
  }
  tags: {
    {customized property}: 'string'
  }
}

Objetos DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Establezca la propiedad createMode para especificar el tipo de objeto.

Para Valor predeterminado, use:

{
  createMode: 'Default'
}

Para Restaurar, use:

{
  createMode: 'Restore'
  restoreParameters: {
    databasesToRestore: [
      {
        collectionNames: [
          'string'
        ]
        databaseName: 'string'
      }
    ]
    restoreMode: 'string'
    restoreSource: 'string'
    restoreTimestampInUtc: 'string'
  }
}

Objetos BackupPolicy

Establezca la propiedad type para especificar el tipo de objeto.

Para Continuo, use:

{
  type: 'Continuous'
}

Para Periodic, use:

{
  periodicModeProperties: {
    backupIntervalInMinutes: int
    backupRetentionIntervalInHours: int
    backupStorageRedundancy: 'string'
  }
  type: 'Periodic'
}

Valores de propiedad

Microsoft.DocumentDB/databaseAccounts

Nombre Descripción Importancia
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 / cadena
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 3
Longitud máxima = 50
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 en plantillas.

ApiProperties

Nombre Descripción Importancia
Versión del servidor Describe ServerVersion de una cuenta de MongoDB. '3.2'
'3.6'
'4.0'

Copia de seguridadPolítica

Nombre Descripción Importancia
tipo Establezca en "Continuous" para el tipo ContinuousModeBackupPolicy. Establezca en "Periodic" para el tipo PeriodicModeBackupPolicy. 'Continuo'
'Periódico' (obligatorio)

Capacidad

Nombre Descripción Importancia
nombre Nombre de la funcionalidad de Cosmos DB. Por ejemplo, "name": "EnableCassandra". Los valores actuales también incluyen "EnableTable" y "EnableGremlin". cuerda / cadena

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nombre Descripción Importancia

ConsistencyPolicy (Política de coherencia)

Nombre Descripción Importancia
defaultConsistencyLevel El nivel de coherencia predeterminado y las opciones de configuración de la cuenta de Cosmos DB. 'Obsolescencia acotada'
'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 Importancia
tipo Describe el modo de copias de seguridad. 'Continuous' (obligatorio)

CorsPolicy

Nombre Descripción Importancia
allowedHeaders Encabezados de solicitud que el dominio de origen puede especificar en la solicitud CORS. cuerda / cadena
allowedMethods Los métodos (verbos de solicitud HTTP) que el dominio de origen puede usar para una solicitud CORS. cuerda / cadena
allowedOrigins Los dominios de origen que pueden realizar una solicitud en el servicio a través de CORS. string (obligatorio)
Encabezados expuestos 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 / cadena
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 Importancia
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. Copia de seguridadPolítica
Capacidades Lista de funcionalidades de Cosmos DB para la cuenta Funcionalidad[]
conectorOferta 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 (Política de coherencia)
cors Directiva DE CORS para la cuenta de base de datos de Cosmos DB. CorsPolicy[]
createMode Establezca en "Default" para el tipo DefaultRequestDatabaseAccountCreateUpdateProperties. Establezca en "Restore" para el tipo RestoreReqeustDatabaseAccountCreateUpdateProperties. 'Valor predeterminado'
'Restore' (obligatorio)
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 / cadena
disableKeyBasedMetadataWriteAccess Deshabilitar las operaciones de escritura en recursos de metadatos (bases de datos, contenedores, rendimiento) mediante claves de cuenta 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
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
enableMultipleWriteLocations Permite que la cuenta escriba en varias ubicaciones Bool
ipRules (Reglas de ip) 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 / cadena
ubicaciones Matriz que contiene las ubicaciones de georeplicación habilitadas para la cuenta de Cosmos DB. Ubicación[] (obligatorio)
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. cadena[]
publicNetworkAccess Indica si se permiten solicitudes de la red pública 'Deshabilitado'
'Habilitado'
virtualNetworkRules Lista de reglas de ACL de red virtual configuradas para la cuenta de Cosmos DB. virtualNetworkRule[]

DatabaseRestoreResource

Nombre Descripción Importancia
collectionNames Nombres de las colecciones disponibles para la restauración. cadena[]
nombreDeBaseDeDatos Nombre de la base de datos disponible para la restauración. cuerda / cadena

DefaultRequestDatabaseAccountCreateUpdateProperties

Nombre Descripción Importancia
createMode Enumeración para indicar el modo de creación de la cuenta. 'Default' (obligatorio)

IpAddressOrRange

Nombre Descripción Importancia
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 / cadena

Ubicación

Nombre Descripción Importancia
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
isZoneRedundante Marca para indicar si esta región es una región availabilityZone o no Bool
locationName Nombre de la región. cuerda / cadena

ManagedServiceIdentity

Nombre Descripción Importancia
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'
'Asignado por el usuario'
identidades asignadas por el usuario 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 Importancia

PeriodicModeBackupPolicy

Nombre Descripción Importancia
periodicModeProperties Valores de configuración para la copia de seguridad en modo periódico PeriodicModeProperties
tipo Describe el modo de copias de seguridad. 'Periódico' (obligatorio)

PeriodicModeProperties

Nombre Descripción Importancia
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'

Restaurar Parámetros

Nombre Descripción Importancia
databasesToRestore Lista de bases de datos específicas disponibles para la restauración. DatabaseRestoreResource[]
restoreMode Describe el modo de restauración. 'PuntoEnTiempo'
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 / cadena
restoreTimestampInUtc Hora a la que se debe restaurar la cuenta (formato ISO-8601). cuerda / cadena

RestoreReqeustDatabaseAccountCreateUpdateProperties

Nombre Descripción Importancia
createMode Enumeración para indicar el modo de creación de la cuenta. 'Restore' (obligatorio)
restoreParameters Parámetros para indicar la información sobre la restauración. restoreParameters

Etiquetas

Nombre Descripción Importancia

VirtualNetworkRule

Nombre Descripción Importancia
identificación Identificador de recurso de una subred, por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. cuerda / cadena
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 uso

Módulos comprobados de Azure

Los siguientes módulos comprobados de Azure se pueden usar para implementar este tipo de recurso.

Módulo Descripción
Cuenta de base de datos de CosmosDB Módulo de recursos de AVM para la cuenta de base de datos de CosmosDB

Ejemplos de inicio rápido de Azure

Las siguientes plantillas de inicio rápido de Azure contienen ejemplos de Bicep para implementar este tipo de recurso.

Archivo de Bicep Descripción
API de SQL de la cuenta de Azure Cosmos DB con 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 aplicación web 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.
Creación de una cuenta de Cosmos DB con Microsoft Defender habilitado 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 una aplicación web de Azure 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 la escalabilidad automática 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 la escalabilidad automática 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 escalabilidad automática 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.
Creación de 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 Azure Cosmos DB de escalabilidad automática 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 de Dapr mediante Container Apps Cree una aplicación de microservicios de Dapr mediante Container Apps.
Crea una aplicación de bus de servicio pub-sub servicebus de Dapr mediante Container Apps Cree una aplicación pub-sub servicebus de Dapr mediante Container Apps.
Implementación de Azure Data Explorer DB con 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:

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": "2021-04-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "apiProperties": {
      "serverVersion": "string"
    },
    "backupPolicy": {
      "type": "string"
      // For remaining properties, see BackupPolicy objects
    },
    "capabilities": [
      {
        "name": "string"
      }
    ],
    "connectorOffer": "string",
    "consistencyPolicy": {
      "defaultConsistencyLevel": "string",
      "maxIntervalInSeconds": "int",
      "maxStalenessPrefix": "int"
    },
    "cors": [
      {
        "allowedHeaders": "string",
        "allowedMethods": "string",
        "allowedOrigins": "string",
        "exposedHeaders": "string",
        "maxAgeInSeconds": "int"
      }
    ],
    "databaseAccountOfferType": "Standard",
    "defaultIdentity": "string",
    "disableKeyBasedMetadataWriteAccess": "bool",
    "enableAnalyticalStorage": "bool",
    "enableAutomaticFailover": "bool",
    "enableCassandraConnector": "bool",
    "enableFreeTier": "bool",
    "enableMultipleWriteLocations": "bool",
    "ipRules": [
      {
        "ipAddressOrRange": "string"
      }
    ],
    "isVirtualNetworkFilterEnabled": "bool",
    "keyVaultKeyUri": "string",
    "locations": [
      {
        "failoverPriority": "int",
        "isZoneRedundant": "bool",
        "locationName": "string"
      }
    ],
    "networkAclBypass": "string",
    "networkAclBypassResourceIds": [ "string" ],
    "publicNetworkAccess": "string",
    "virtualNetworkRules": [
      {
        "id": "string",
        "ignoreMissingVNetServiceEndpoint": "bool"
      }
    ],
    "createMode": "string"
    // For remaining properties, see DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties objects
  },
  "tags": {
    "{customized property}": "string"
  }
}

Objetos DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Establezca la propiedad createMode para especificar el tipo de objeto.

Para Valor predeterminado, use:

{
  "createMode": "Default"
}

Para Restaurar, use:

{
  "createMode": "Restore",
  "restoreParameters": {
    "databasesToRestore": [
      {
        "collectionNames": [ "string" ],
        "databaseName": "string"
      }
    ],
    "restoreMode": "string",
    "restoreSource": "string",
    "restoreTimestampInUtc": "string"
  }
}

Objetos BackupPolicy

Establezca la propiedad type para especificar el tipo de objeto.

Para Continuo, use:

{
  "type": "Continuous"
}

Para Periodic, use:

{
  "periodicModeProperties": {
    "backupIntervalInMinutes": "int",
    "backupRetentionIntervalInHours": "int",
    "backupStorageRedundancy": "string"
  },
  "type": "Periodic"
}

Valores de propiedad

Microsoft.DocumentDB/databaseAccounts

Nombre Descripción Importancia
apiVersion La versión de api '2021-04-01-preestreno'
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 / cadena
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 3
Longitud máxima = 50
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 en plantillas.
tipo El tipo de recurso 'Microsoft.DocumentDB/databaseAccounts'

ApiProperties

Nombre Descripción Importancia
Versión del servidor Describe ServerVersion de una cuenta de MongoDB. '3.2'
'3.6'
'4.0'

Copia de seguridadPolítica

Nombre Descripción Importancia
tipo Establezca en "Continuous" para el tipo ContinuousModeBackupPolicy. Establezca en "Periodic" para el tipo PeriodicModeBackupPolicy. 'Continuo'
'Periódico' (obligatorio)

Capacidad

Nombre Descripción Importancia
nombre Nombre de la funcionalidad de Cosmos DB. Por ejemplo, "name": "EnableCassandra". Los valores actuales también incluyen "EnableTable" y "EnableGremlin". cuerda / cadena

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nombre Descripción Importancia

ConsistencyPolicy (Política de coherencia)

Nombre Descripción Importancia
defaultConsistencyLevel El nivel de coherencia predeterminado y las opciones de configuración de la cuenta de Cosmos DB. 'Obsolescencia acotada'
'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 Importancia
tipo Describe el modo de copias de seguridad. 'Continuous' (obligatorio)

CorsPolicy

Nombre Descripción Importancia
allowedHeaders Encabezados de solicitud que el dominio de origen puede especificar en la solicitud CORS. cuerda / cadena
allowedMethods Los métodos (verbos de solicitud HTTP) que el dominio de origen puede usar para una solicitud CORS. cuerda / cadena
allowedOrigins Los dominios de origen que pueden realizar una solicitud en el servicio a través de CORS. string (obligatorio)
Encabezados expuestos 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 / cadena
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 Importancia
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. Copia de seguridadPolítica
Capacidades Lista de funcionalidades de Cosmos DB para la cuenta Funcionalidad[]
conectorOferta 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 (Política de coherencia)
cors Directiva DE CORS para la cuenta de base de datos de Cosmos DB. CorsPolicy[]
createMode Establezca en "Default" para el tipo DefaultRequestDatabaseAccountCreateUpdateProperties. Establezca en "Restore" para el tipo RestoreReqeustDatabaseAccountCreateUpdateProperties. 'Valor predeterminado'
'Restore' (obligatorio)
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 / cadena
disableKeyBasedMetadataWriteAccess Deshabilitar las operaciones de escritura en recursos de metadatos (bases de datos, contenedores, rendimiento) mediante claves de cuenta 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
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
enableMultipleWriteLocations Permite que la cuenta escriba en varias ubicaciones Bool
ipRules (Reglas de ip) 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 / cadena
ubicaciones Matriz que contiene las ubicaciones de georeplicación habilitadas para la cuenta de Cosmos DB. Ubicación[] (obligatorio)
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. cadena[]
publicNetworkAccess Indica si se permiten solicitudes de la red pública 'Deshabilitado'
'Habilitado'
virtualNetworkRules Lista de reglas de ACL de red virtual configuradas para la cuenta de Cosmos DB. virtualNetworkRule[]

DatabaseRestoreResource

Nombre Descripción Importancia
collectionNames Nombres de las colecciones disponibles para la restauración. cadena[]
nombreDeBaseDeDatos Nombre de la base de datos disponible para la restauración. cuerda / cadena

DefaultRequestDatabaseAccountCreateUpdateProperties

Nombre Descripción Importancia
createMode Enumeración para indicar el modo de creación de la cuenta. 'Default' (obligatorio)

IpAddressOrRange

Nombre Descripción Importancia
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 / cadena

Ubicación

Nombre Descripción Importancia
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
isZoneRedundante Marca para indicar si esta región es una región availabilityZone o no Bool
locationName Nombre de la región. cuerda / cadena

ManagedServiceIdentity

Nombre Descripción Importancia
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'
'Asignado por el usuario'
identidades asignadas por el usuario 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 Importancia

PeriodicModeBackupPolicy

Nombre Descripción Importancia
periodicModeProperties Valores de configuración para la copia de seguridad en modo periódico PeriodicModeProperties
tipo Describe el modo de copias de seguridad. 'Periódico' (obligatorio)

PeriodicModeProperties

Nombre Descripción Importancia
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'

Restaurar Parámetros

Nombre Descripción Importancia
databasesToRestore Lista de bases de datos específicas disponibles para la restauración. DatabaseRestoreResource[]
restoreMode Describe el modo de restauración. 'PuntoEnTiempo'
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 / cadena
restoreTimestampInUtc Hora a la que se debe restaurar la cuenta (formato ISO-8601). cuerda / cadena

RestoreReqeustDatabaseAccountCreateUpdateProperties

Nombre Descripción Importancia
createMode Enumeración para indicar el modo de creación de la cuenta. 'Restore' (obligatorio)
restoreParameters Parámetros para indicar la información sobre la restauración. restoreParameters

Etiquetas

Nombre Descripción Importancia

VirtualNetworkRule

Nombre Descripción Importancia
identificación Identificador de recurso de una subred, por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. cuerda / cadena
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 uso

Plantillas de inicio rápido de Azure

Las siguientes plantillas de inicio rápido de Azure implementan este tipo de recurso.

Plantilla Descripción
API de SQL de la cuenta de Azure Cosmos DB con almacén analítico

Implementación en Azure
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 aplicación web

Implementación en Azure
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)

Implementación en Azure
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.
Creación de una cuenta de Cosmos DB con Microsoft Defender habilitado

Implementación en Azure
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

Implementación en Azure
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

Implementación en Azure
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

Implementación en Azure
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 una aplicación web de Azure

Implementación en Azure
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

Implementación en Azure
Esta plantilla crea una cuenta de Azure Cosmos DB para MongoDB API 4.2 en dos regiones mediante el rendimiento compartido y dedicado con dos colecciones.
Creación de una cuenta de Azure Cosmos para la escalabilidad automática de mongoDB API

Implementación en Azure
Esta plantilla crea una cuenta de Azure Cosmos DB para MongoDB API 4.2 en dos regiones mediante el rendimiento de escalado automático compartido y dedicado.
Creación de una cuenta de Azure Cosmos para Table API

Implementación en Azure
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

Implementación en Azure
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

Implementación en Azure
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

Implementación en Azure
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

Implementación en Azure
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 la escalabilidad automática de Gremlin API

Implementación en Azure
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

Implementación en Azure
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 escalabilidad automática

Implementación en Azure
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

Implementación en Azure
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

Implementación en Azure
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.
Creación de una cuenta de Azure CosmosDB

Implementación en Azure
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 Azure Cosmos DB de escalabilidad automática para Cassandra API

Implementación en Azure
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)

Implementación en Azure
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

Implementación en Azure
La plantilla crea un contenedor de Cosmos con una API de SQL y permite agregar contenedores mulitple.
Crea una aplicación de microservicios de Dapr mediante Container Apps

Implementación en Azure
Cree una aplicación de microservicios de Dapr mediante Container Apps.
Crea una aplicación de bus de servicio pub-sub servicebus de Dapr mediante Container Apps

Implementación en Azure
Cree una aplicación pub-sub servicebus de Dapr mediante Container Apps.
Implementación de Azure Data Explorer DB con conexión de Cosmos DB

Implementación en Azure
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

Implementación en Azure
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@2021-04-01-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    kind = "string"
    properties = {
      apiProperties = {
        serverVersion = "string"
      }
      backupPolicy = {
        type = "string"
        // For remaining properties, see BackupPolicy objects
      }
      capabilities = [
        {
          name = "string"
        }
      ]
      connectorOffer = "string"
      consistencyPolicy = {
        defaultConsistencyLevel = "string"
        maxIntervalInSeconds = int
        maxStalenessPrefix = int
      }
      cors = [
        {
          allowedHeaders = "string"
          allowedMethods = "string"
          allowedOrigins = "string"
          exposedHeaders = "string"
          maxAgeInSeconds = int
        }
      ]
      databaseAccountOfferType = "Standard"
      defaultIdentity = "string"
      disableKeyBasedMetadataWriteAccess = bool
      enableAnalyticalStorage = bool
      enableAutomaticFailover = bool
      enableCassandraConnector = bool
      enableFreeTier = bool
      enableMultipleWriteLocations = bool
      ipRules = [
        {
          ipAddressOrRange = "string"
        }
      ]
      isVirtualNetworkFilterEnabled = bool
      keyVaultKeyUri = "string"
      locations = [
        {
          failoverPriority = int
          isZoneRedundant = bool
          locationName = "string"
        }
      ]
      networkAclBypass = "string"
      networkAclBypassResourceIds = [
        "string"
      ]
      publicNetworkAccess = "string"
      virtualNetworkRules = [
        {
          id = "string"
          ignoreMissingVNetServiceEndpoint = bool
        }
      ]
      createMode = "string"
      // For remaining properties, see DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties objects
    }
  }
}

Objetos DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Establezca la propiedad createMode para especificar el tipo de objeto.

Para Valor predeterminado, use:

{
  createMode = "Default"
}

Para Restaurar, use:

{
  createMode = "Restore"
  restoreParameters = {
    databasesToRestore = [
      {
        collectionNames = [
          "string"
        ]
        databaseName = "string"
      }
    ]
    restoreMode = "string"
    restoreSource = "string"
    restoreTimestampInUtc = "string"
  }
}

Objetos BackupPolicy

Establezca la propiedad type para especificar el tipo de objeto.

Para Continuo, use:

{
  type = "Continuous"
}

Para Periodic, use:

{
  periodicModeProperties = {
    backupIntervalInMinutes = int
    backupRetentionIntervalInHours = int
    backupStorageRedundancy = "string"
  }
  type = "Periodic"
}

Valores de propiedad

Microsoft.DocumentDB/databaseAccounts

Nombre Descripción Importancia
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 / cadena
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 3
Longitud máxima = 50
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@2021-04-01-preview"

ApiProperties

Nombre Descripción Importancia
Versión del servidor Describe ServerVersion de una cuenta de MongoDB. '3.2'
'3.6'
'4.0'

Copia de seguridadPolítica

Nombre Descripción Importancia
tipo Establezca en "Continuous" para el tipo ContinuousModeBackupPolicy. Establezca en "Periodic" para el tipo PeriodicModeBackupPolicy. 'Continuo'
'Periódico' (obligatorio)

Capacidad

Nombre Descripción Importancia
nombre Nombre de la funcionalidad de Cosmos DB. Por ejemplo, "name": "EnableCassandra". Los valores actuales también incluyen "EnableTable" y "EnableGremlin". cuerda / cadena

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nombre Descripción Importancia

ConsistencyPolicy (Política de coherencia)

Nombre Descripción Importancia
defaultConsistencyLevel El nivel de coherencia predeterminado y las opciones de configuración de la cuenta de Cosmos DB. 'Obsolescencia acotada'
'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 Importancia
tipo Describe el modo de copias de seguridad. 'Continuous' (obligatorio)

CorsPolicy

Nombre Descripción Importancia
allowedHeaders Encabezados de solicitud que el dominio de origen puede especificar en la solicitud CORS. cuerda / cadena
allowedMethods Los métodos (verbos de solicitud HTTP) que el dominio de origen puede usar para una solicitud CORS. cuerda / cadena
allowedOrigins Los dominios de origen que pueden realizar una solicitud en el servicio a través de CORS. string (obligatorio)
Encabezados expuestos 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 / cadena
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 Importancia
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. Copia de seguridadPolítica
Capacidades Lista de funcionalidades de Cosmos DB para la cuenta Funcionalidad[]
conectorOferta 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 (Política de coherencia)
cors Directiva DE CORS para la cuenta de base de datos de Cosmos DB. CorsPolicy[]
createMode Establezca en "Default" para el tipo DefaultRequestDatabaseAccountCreateUpdateProperties. Establezca en "Restore" para el tipo RestoreReqeustDatabaseAccountCreateUpdateProperties. 'Valor predeterminado'
'Restore' (obligatorio)
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 / cadena
disableKeyBasedMetadataWriteAccess Deshabilitar las operaciones de escritura en recursos de metadatos (bases de datos, contenedores, rendimiento) mediante claves de cuenta 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
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
enableMultipleWriteLocations Permite que la cuenta escriba en varias ubicaciones Bool
ipRules (Reglas de ip) 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 / cadena
ubicaciones Matriz que contiene las ubicaciones de georeplicación habilitadas para la cuenta de Cosmos DB. Ubicación[] (obligatorio)
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. cadena[]
publicNetworkAccess Indica si se permiten solicitudes de la red pública 'Deshabilitado'
'Habilitado'
virtualNetworkRules Lista de reglas de ACL de red virtual configuradas para la cuenta de Cosmos DB. virtualNetworkRule[]

DatabaseRestoreResource

Nombre Descripción Importancia
collectionNames Nombres de las colecciones disponibles para la restauración. cadena[]
nombreDeBaseDeDatos Nombre de la base de datos disponible para la restauración. cuerda / cadena

DefaultRequestDatabaseAccountCreateUpdateProperties

Nombre Descripción Importancia
createMode Enumeración para indicar el modo de creación de la cuenta. 'Default' (obligatorio)

IpAddressOrRange

Nombre Descripción Importancia
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 / cadena

Ubicación

Nombre Descripción Importancia
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
isZoneRedundante Marca para indicar si esta región es una región availabilityZone o no Bool
locationName Nombre de la región. cuerda / cadena

ManagedServiceIdentity

Nombre Descripción Importancia
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'
'Asignado por el usuario'
identidades asignadas por el usuario 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 Importancia

PeriodicModeBackupPolicy

Nombre Descripción Importancia
periodicModeProperties Valores de configuración para la copia de seguridad en modo periódico PeriodicModeProperties
tipo Describe el modo de copias de seguridad. 'Periódico' (obligatorio)

PeriodicModeProperties

Nombre Descripción Importancia
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'

Restaurar Parámetros

Nombre Descripción Importancia
databasesToRestore Lista de bases de datos específicas disponibles para la restauración. DatabaseRestoreResource[]
restoreMode Describe el modo de restauración. 'PuntoEnTiempo'
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 / cadena
restoreTimestampInUtc Hora a la que se debe restaurar la cuenta (formato ISO-8601). cuerda / cadena

RestoreReqeustDatabaseAccountCreateUpdateProperties

Nombre Descripción Importancia
createMode Enumeración para indicar el modo de creación de la cuenta. 'Restore' (obligatorio)
restoreParameters Parámetros para indicar la información sobre la restauración. restoreParameters

Etiquetas

Nombre Descripción Importancia

VirtualNetworkRule

Nombre Descripción Importancia
identificación Identificador de recurso de una subred, por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. cuerda / cadena
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