Microsoft. DocumentDB databaseAccounts 2026-03-15

Definizione di risorsa Bicep

Il tipo di risorsa databaseAccounts può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Esempi di utilizzo

Esempi di Bicep

Esempio di base di distribuzione dell'account CosmosDB (formalmente DocumentDB).

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource databaseAccount 'Microsoft.DocumentDB/databaseAccounts@2021-10-15' = {
  name: resourceName
  location: location
  kind: 'GlobalDocumentDB'
  properties: {
    capabilities: []
    consistencyPolicy: {
      defaultConsistencyLevel: 'BoundedStaleness'
      maxIntervalInSeconds: 10
      maxStalenessPrefix: 200
    }
    databaseAccountOfferType: 'Standard'
    defaultIdentity: 'FirstPartyIdentity'
    disableKeyBasedMetadataWriteAccess: false
    disableLocalAuth: false
    enableAnalyticalStorage: false
    enableAutomaticFailover: false
    enableFreeTier: false
    enableMultipleWriteLocations: false
    ipRules: []
    isVirtualNetworkFilterEnabled: false
    locations: [
      {
        failoverPriority: 0
        isZoneRedundant: false
        locationName: 'West Europe'
      }
    ]
    networkAclBypass: 'None'
    networkAclBypassResourceIds: []
    publicNetworkAccess: 'Enabled'
    virtualNetworkRules: []
  }
}

Moduli verificati di Azure

Per distribuire questo tipo di risorsa, è possibile usare moduli verificati di Azure.

Module Description
Cosmos Database Database Account Modulo di risorse AVM per l'account del database Cosmos DB

Esempi di avvio rapido di Azure

I modelli di avvio rapido di Azure seguenti contengono esempi Bicep per la distribuzione di questo tipo di risorsa.

File bicipite Description
API SQL Azure Cosmos DB account con analytical store Questo template crea un account Azure Cosmos per l'API Core (SQL) con un database e un container configurati con lo store analitico.
Azure Cosmos DB Account con Web App Questo modello implementa un account Azure Cosmos DB, un Piano App Service e crea una Web App nel Piano App Service. Aggiunge inoltre due impostazioni dell'applicazione all'App Web che fanno riferimento all'endpoint dell'account Azure Cosmos DB. In questo modo, le soluzioni distribuite sull'App Web possono connettersi all'endpoint dell'account Azure Cosmos DB utilizzando queste impostazioni.
Crea un account Cosmos DB con Microsoft Defender abilitato Utilizzando questo modello ARM, puoi distribuire un account Azure Cosmos DB con Microsoft Defender per Azure Cosmos DB abilitato. Microsoft Defender per Azure Cosmos DB è un livello di sicurezza nativo di Azure che rileva i tentativi di sfruttare i database negli account Azure Cosmos DB. Microsoft Defender for Azure Cosmos DB rileva potenziali iniezioni SQL, attori malintenzionati noti basati su Microsoft Threat Intelligence, schemi di accesso sospetti e potenziali sfruttamenti del tuo database tramite identità compromesse o insider malevoli.
Crea un account Azure Cosmos DB di livello gratuito Questo template crea un account Azure Cosmos DB free-tier per l'API SQL con un database con throughput condiviso e container.
Crea un account Azure Cosmos DB minimo per l'API Core (SQL Questo template crea un account Azure Cosmos DB per l'API Core (SQL) specificando solo le proprietà minime richieste delle risorse.
Crea un account serverless Azure Cosmos DB per API SQL Questo template crea un account serverless Azure Cosmos DB per l'API Core (SQL).
Crea un account Cosmos Azure zero touch e Azure Web App Questo template crea un account Azure Cosmos, inietta l'endpoint Cosmos DB e inserisce le impostazioni di Azure Web App, poi distribuisce un'app web ASP MVC da GitHub.
Crea un account Azure Cosmos per l'API MongoDB Questo template crea un account Azure Cosmos DB per MongoDB API 4.2 in due regioni utilizzando throughput condiviso e dedicato con due collezioni.
Crea un account Azure Cosmos per l'autoscala API di MongoDB Questo template crea un account Azure Cosmos DB per MongoDB API 4.2 in due regioni utilizzando sia la velocità di scalabilità automatica condivisa che dedicata.
Crea un account Azure Cosmos per Table API Questo template crea un account Azure Cosmos DB per l'API delle Tabelle in due regioni e una singola tabella con throughput provisionato.
Crea un account Azure Cosmos per l'API delle Tabelle con autoscale Questo template crea un account Azure Cosmos DB per Table API in due regioni e una singola tabella con throughput autoscalabile.
Crea un account Azure Cosmos DB per Cassandra API Questo template crea un account Azure Cosmos DB per Cassandra API in due regioni con uno spazio chiave e una tabella con throughput dedicato.
Crea un account Azure Cosmos DB per l'API Core (SQL Questo template crea un account Azure Cosmos per l'API Core (SQL) con un database e un container con throughput e molteplici altre opzioni.
Crea un account Azure Cosmos DB per Gremlin API Questo template crea un account Azure Cosmos DB per l'API Gremlin in due regioni con un database e un grafo utilizzando un throughput dedicato.
Crea un account Azure Cosmos DB per l'autoscala di Gremlin API Questo template crea un account Azure Cosmos DB per l'API Gremlin in due regioni con un database e un grafo utilizzando la velocità di scalabilità automatica.
Crea un account Azure Cosmos DB in più regioni Questo template crea un account Azure Cosmos DB per qualsiasi tipo di API di database con una regione primaria e una secondaria, scegliendo il livello di coerenza e il tipo di failover.
Crea un'API SQL per Azure Cosmos DB account con autoscale Questo template crea un account Azure Cosmos per l'API Core (SQL) con un database e un container con throughput autoscalabile e molte altre opzioni.
Creare un account Azure Cosmos DB con un endpoint privato Questo modello creerà un account Cosmos, una rete virtuale e un endpoint privato che espone l'account Cosmos alla rete virtuale.
Crea un account SQL Azure Cosmos DB con il piano dati RBAC Questo modello creerà un account SQL Cosmos, una definizione di ruolo gestita in modo nativo e un'assegnazione di ruolo gestita in modo nativo per un'identità AAD.
Crea un account Azure CosmosDB Questo modello di Resource Manager ha lo scopo di creare rapidamente un account CosmosDB con i valori minimi necessari
Create autoscale Azure Cosmos DB account per Cassandra API Questo template crea un account Azure Cosmos DB per l'API Cassandra in due regioni con uno spazio chiave e una tabella con throughput autoscalabile.
Create Azure Cosmos DB Core (SQL) API stored procedure Questo template crea un account Azure Cosmos DB per l'API Core (SQL) e un contenitore con una procedura memorizzata, un trigger e una funzione definita dall'utente.
Crea un'app di microservizi Dapr usando App contenitore Creare un'app di microservizi Dapr usando App contenitore.
Crea un'app Servicebus pub-sub Dapr usando Container Apps Creare un'app pub-sub servicebus dapr usando App contenitore.
Distribuisci Esplora dati di Azure database con connessione Cosmos DB Deploy Esplora dati di Azure DB con connessione Cosmos DB.

Formato risorsa

Per creare un Microsoft. Risorsa DocumentDB/databaseAccounts, aggiungi il seguente Bicep al tuo template.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts@2026-03-15' = {
  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
    }
    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'
    disableKeyBasedMetadataWriteAccess: bool
    disableLocalAuth: bool
    enableAnalyticalStorage: bool
    enableAutomaticFailover: bool
    enableBurstCapacity: bool
    enableCassandraConnector: bool
    enableFreeTier: bool
    enableMultipleWriteLocations: bool
    enablePartitionMerge: bool
    enablePerRegionPerPartitionAutoscale: bool
    enablePriorityBasedExecution: bool
    enforceHierarchicalPartitionKeyIdLastLevel: 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'
  }
}

Oggetti BackupPolicy

Impostare la proprietà tipo di per specificare il tipo di oggetto.

Per continuo, usare:

{
  continuousModeProperties: {
    tier: 'string'
  }
  type: 'Continuous'
}

Per periodico, usare:

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

Valori delle proprietà

Microsoft. DocumentDB/databaseAccounts

Name Description Value
identity Identità per la risorsa. ManagedServiceIdentity
kind Indica il tipo di account di database. Questa impostazione può essere impostata solo durante la creazione dell'account di database. 'GlobalDocumentDB'
'MongoDB'
'Parse'
location Posizione del gruppo di risorse a cui appartiene la risorsa. Stringa
nome Nome della risorsa string

Constraints:
Lunghezza minima = 3
Lunghezza massima = 50
Pattern = ^[a-z0-9]+(-[a-z0-9]+)* (obbligatorio)
Proprietà Proprietà per creare e aggiornare account database Azure Cosmos DB. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (obbligatorio)
tags Tag delle risorse Dizionario di nomi e valori di tag. Vedere tag nei modelli

Configurazione AnalyticalStorageConfiguration

Name Description Value
schemaType Descrive i tipi di schema per l'archiviazione analitica. 'Piena fedeltà'
'Ben definito'

ApiProperties

Name Description Value
serverVersion Descrive la versione dell'account MongoDB. '3.2'
'3.6'
'4.0'
'4.2'
'5.0'
'6.0'
'7.0'

ARMResourceProprietàTag

Name Description Value

BackupPolicy

Name Description Value
migrationState Oggetto che rappresenta lo stato della migrazione tra i criteri di backup. BackupPolicyMigrationState
type Impostare su "Continuous" per il tipo ContinuousModeBackupPolicy. Impostare su "Periodico" per il tipo PeriodicModeBackupPolicy. 'Continuous'
'Periodico' (obbligatorio)

BackupPolicyMigrationState

Name Description Value
startTime Ora di avvio della migrazione dei criteri di backup (formato ISO-8601). Stringa
status Descrive lo stato della migrazione tra i tipi di criteri di backup. 'Completato'
'Fallito'
'In corso'
'Invalid'
tipo di obiettivo Descrive il tipo di criteri di backup di destinazione della migrazione dei criteri di backup. 'Continuous'
'Periodico'

Capability

Name Description Value
nome Nome della funzionalità di Cosmos DB. Ad esempio, "name": "EnableCassandra". I valori correnti includono anche "EnableTable" e "EnableGremlin". Stringa

Capacità

Name Description Value
totalThroughputLimit Limite totale di velocità effettiva imposto all'account. Un totaleThroughputLimit di 2000 impone un limite rigoroso di velocità effettiva massima di cui è possibile effettuare il provisioning su tale account per essere 2000. Un totaleThroughputLimit di -1 indica che non sono previsti limiti al provisioning della velocità effettiva. int

Constraints:
Valore minimo = -1

ConsistencyPolicy

Name Description Value
defaultConsistencyLevel Il livello di coerenza predefinito e le impostazioni di configurazione dell'account Cosmos DB. 'BoundedStaleness'
'ConsistentPrefix'
'Eventual'
'Session'
'Forte' (obbligatorio)
maxIntervalInSeconds Se usato con il livello di coerenza decadimento ristretto, questo valore rappresenta la quantità di tempo di decadimento (in secondi) tollerata. L'intervallo accettato per questo valore è 5 - 86400. Obbligatorio quando defaultConsistencyPolicy è impostato su "BoundedStaleness". int

Constraints:
Valore minimo = 5
Valore massimo = 86400
maxStalenessPrefix Se usato con il livello di coerenza decadimento ristretto, questo valore rappresenta il numero di richieste non aggiornati tollerate. L'intervallo accettato per questo valore è 1 - 2.147.483.647. Obbligatorio quando defaultConsistencyPolicy è impostato su "BoundedStaleness". int

Constraints:
Valore minimo = 1
Valore massimo = 2147483647

ContinuousModeBackupPolicy

Name Description Value
continuousModeProperties Valori di configurazione per il backup in modalità continua Proprietà ContinuousMode
type Descrive la modalità di backup. 'Continuo' (obbligatorio)

Proprietà ContinuousMode

Name Description Value
tier Enumerazione per indicare il tipo di modalità di backup Continuos 'Continuous30Days'
'Continuous7Days'

CorsPolicy

Name Description Value
allowedHeaders Intestazioni di richiesta che il dominio di origine può specificare nella richiesta CORS. Stringa
allowedMethods I metodi (verbi di richiesta HTTP) che il dominio di origine può usare per una richiesta CORS. Stringa
allowedOrigins Domini di origine autorizzati a effettuare una richiesta al servizio tramite CORS. stringa (obbligatorio)
exposedHeaders Intestazioni di risposta che possono essere inviate nella risposta alla richiesta CORS ed esposte dal browser all'emittente della richiesta. Stringa
maxAgeInSeconds Periodo massimo di tempo in cui un browser deve memorizzare nella cache la richiesta OPTIONS preliminare. int

Constraints:
Valore minimo = 1
Valore massimo = 2147483647

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Name Description Value
analyticalStorageConfiguration Proprietà specifiche dell'archiviazione analitica. Configurazione AnalyticalStorageConfiguration
apiProperties Proprietà specifiche dell'API. Attualmente, supportato solo per l'API MongoDB. Proprietà API
backupPolicy Oggetto che rappresenta i criteri per l'esecuzione di backup in un account. BackupPolicy
capabilities Elenco delle funzionalità di Cosmos DB per l'account Capability[]
capacity Oggetto che rappresenta tutte le proprietà correlate all'imposizione della capacità in un account. Capacità
connectorOffer Tipo di offerta del connettore cassandra per l'account C* del database Cosmos DB. 'Small'
consistencyPolicy Criteri di coerenza per l'account Cosmos DB. ConsistencyPolicy
cors Criteri CORS per l'account del database Cosmos DB. CorsPolicy[]
createMode Enumerazione per indicare la modalità di creazione dell'account. 'Default'
'Ripristina'
customerManagedKeyStatus Indica lo stato della funzionalità Chiave gestita dal cliente nell'account. In caso di errori, la proprietà fornisce indicazioni per la risoluzione dei problemi. Stringa
databaseAccountOfferType Tipo di offerta per l'account di database Cosmos DB. 'Standard' (obbligatorio)
defaultIdentity Identità predefinita per l'accesso all'insieme di credenziali delle chiavi usato nelle funzionalità come le chiavi gestite dal cliente. L'identità predefinita deve essere impostata in modo esplicito dagli utenti. Può essere "FirstPartyIdentity", "SystemAssignedIdentity" e altro ancora. Stringa
defaultPriorityLevel Enumerazione per indicare il livello di priorità predefinito della richiesta per l'esecuzione basata su priorità. 'High'
'Low'
disableKeyBasedMetadataWriteAccess Disabilitare le operazioni di scrittura sulle risorse dei metadati (database, contenitori, velocità effettiva) tramite chiavi dell'account bool
disableLocalAuth Rifiutare esplicitamente l'autenticazione locale e assicurarsi che solo MSI e AAD possano essere usati esclusivamente per l'autenticazione. bool
enableAnalyticalStorage Flag per indicare se abilitare l'analisi dell'archiviazione. bool
enableAutomaticFailover Abilita il failover automatico dell'area di scrittura nel raro caso in cui l'area non sia disponibile a causa di un'interruzione del servizio. Il failover automatico comporterà una nuova area di scrittura per l'account e viene scelta in base alle priorità di failover configurate per l'account. bool
enableBurstCapacity Flag per indicare l'abilitazione/disabilitazione della funzionalità Anteprima capacità burst nell'account bool
enableCassandraConnector Abilita il connettore cassandra nell'account C* di Cosmos DB bool
enableFreeTier Flag per indicare se il livello gratuito è abilitato. bool
enableMultipleWriteLocations Consente all'account di scrivere in più posizioni bool
enablePartitionMerge Flag per indicare l'abilitazione/disabilitazione della funzionalità di merge partizione nell'account bool
enablePerRegionPerPartitionAutoscale Flag per indicare l'abilitazione/disabilitazione della funzionalità di anteprima della scalabilità automatica per partizione Per-Region nell'account bool
enablePriorityBasedExecution Flag per indicare l'abilitazione/disabilitazione della funzionalità Anteprima esecuzione basata su priorità nell'account bool
enforceHierarchicalPartitionKeyIdLastLevel Flag per indicare l'abilitazione/disabilitazione dell'applicazione gerarchica dell'ID della chiave di partizione sull'account. bool
ipRegole Elenco di IpRules. IpAddressOrRange[]
isVirtualNetworkFilterEnabled Segnala se abilitare/disabilitare le regole ACL di Rete virtuale. bool
keyVaultKeyUri URI dell'insieme di credenziali delle chiavi Stringa
locations Matrice che contiene le posizioni di replica geografica abilitate per l'account Cosmos DB. Posizione[] (richiesto)
minimalTlsVersion Indica la versione minima consentita di Tls. Il valore predefinito è Tls 1.0, ad eccezione dell'API Cassandra e Mongo, che funziona solo con Tls 1.2. 'Tls'
'Tls11'
'Tls12'
networkAclBypass Indica quali servizi sono autorizzati a ignorare i controlli del firewall. 'AzureServices'
'None'
networkAclBypassResourceIds Matrice che contiene gli ID risorsa per il bypass Acl di rete per l'account Cosmos DB. string[]
pubblicoAccesso alla rete Indica se le richieste dalla rete pubblica sono consentite 'Disabilitato'
'Abilitato'
'SecuredByPerimeter'
restoreParameters Parametri per indicare le informazioni sul ripristino. RestoreParameters
virtualNetworkRegole Elenco delle regole Rete virtuale ACL configurate per l'account Cosmos DB. VirtualNetworkRule[]

DatabaseRestoreResource

Name Description Value
collectionNames Nomi delle raccolte disponibili per il ripristino. string[]
databaseName Nome del database disponibile per il ripristino. Stringa

GremlinDatabaseRestoreResource

Name Description Value
databaseName Nome del database gremlin disponibile per il ripristino. Stringa
graphNames Nomi dei grafici disponibili per il ripristino. string[]

IpAddressOrRange

Name Description Value
ipAddressOrRange Un singolo indirizzo IPv4 o un singolo intervallo di indirizzi IPv4 in formato CIDR. Gli indirizzi IP forniti devono essere formattati correttamente e non possono essere contenuti in uno degli intervalli seguenti: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0.0/16, perché non sono applicabili dal filtro di indirizzi IP. Esempio di input validi: "23.40.210.245" o "23.40.210.0/8". Stringa

Posizione

Name Description Value
failoverPriority Priorità di failover dell'area. Una priorità di failover pari a 0 indica un'area di scrittura. Valore massimo per una priorità di failover = (numero totale di aree - 1). I valori di priorità di failover devono essere univoci per ognuna delle aree in cui è presente l'account di database. int

Constraints:
Valore minimo = 0
isZoneRedundant Flag per indicare se questa area è un'area availabilityZone bool
locationName Nome dell'area. Stringa

ManagedServiceIdentity

Name Description Value
type Tipo di identità usata per la risorsa. Il tipo 'SystemAssigned,UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo 'None' rimuoverà tutte le identità dal servizio. 'None'
'Assegnato dal sistema'
'SystemAssigned,UserAssigned'
'UserAssigned'
identità assegnate dall'utente Elenco delle identità utente associate alla risorsa. I riferimenti alla chiave del dizionario delle identità utente saranno id risorsa ARM nel formato :'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Description Value

ManagedServiceIdentityUserAssignedIdentities

Name Description Value

PeriodicModeBackupPolicy

Name Description Value
periodicModeProperties Valori di configurazione per il backup in modalità periodica PeriodicModeProperties
type Descrive la modalità di backup. 'Periodico' (obbligatorio)

PeriodicModeProperties

Name Description Value
backupIntervalInMinutes Intero che rappresenta l'intervallo in minuti tra due backup int

Constraints:
Valore minimo = 0
backupRetentionIntervalInHours Intero che rappresenta l'ora (in ore) di conservazione di ogni backup int

Constraints:
Valore minimo = 0
backupStorageRedundancy Enumerazione per indicare il tipo di residenza dei backup 'Geo'
'Locale'
'Zone'

RestoreParameters

Name Description Value
databasesToRestore Elenco di database specifici disponibili per il ripristino. DatabaseRestoreResource[]
gremlinDatabasesToRestore Elenco di database gremlin specifici disponibili per il ripristino. GremlinDatabaseRestoreResource[]
restoreMode Descrive la modalità di ripristino. 'PointInTime'
restoreSource ID dell'account di database ripristinabile da cui deve essere avviato il ripristino. Ad esempio: /subscriptions/{subscriptionId}/providers/Microsoft. DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} Stringa
restoreTimestampInUtc Ora di ripristino dell'account (formato ISO-8601). Stringa
restoreWithTtlDisabled Specifica se l'account ripristinato avrà time-To-Live disabilitato al termine del ripristino. bool
sourceBackupLocation Percorso di backup di origine per il ripristino. Stringa
tabelle da ripristinare Elenco di tabelle specifiche disponibili per il ripristino. string[]

VirtualNetworkRule

Name Description Value
id ID risorsa di una sottorete, ad esempio: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft. Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. Stringa
ignoreMissingVNetServiceEndpoint Creare una regola del firewall prima che la rete virtuale disponga dell'endpoint servizio di rete virtuale abilitato. bool

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa databaseAccounts può essere distribuito con operazioni destinate a:

Esempi di utilizzo

Modelli di avvio rapido di Azure

I modelli di avvio rapido di Azure seguenti distribuire questo tipo di risorsa.

Modello Description
API SQL Azure Cosmos DB account con analytical store

Pubblica su Azure
Questo template crea un account Azure Cosmos per l'API Core (SQL) con un database e un container configurati con lo store analitico.
Azure Cosmos DB Account con Web App

Pubblica su Azure
Questo modello implementa un account Azure Cosmos DB, un Piano App Service e crea una Web App nel Piano App Service. Aggiunge inoltre due impostazioni dell'applicazione all'App Web che fanno riferimento all'endpoint dell'account Azure Cosmos DB. In questo modo, le soluzioni distribuite sull'App Web possono connettersi all'endpoint dell'account Azure Cosmos DB utilizzando queste impostazioni.
CI/CD con Jenkins nel servizio Azure Container (AKS)

Pubblica su Azure
I contenitori semplificano la compilazione e la distribuzione continua delle applicazioni. Orchestrando la distribuzione di tali contenitori usando Kubernetes nel servizio Azure Container, è possibile ottenere cluster replicabili e gestibili di contenitori. Configurando una compilazione continua per produrre immagini e orchestrazioni del contenitore, è possibile aumentare la velocità e l'affidabilità della distribuzione.
Crea un account Cosmos DB con Microsoft Defender abilitato

Pubblica su Azure
Utilizzando questo modello ARM, puoi distribuire un account Azure Cosmos DB con Microsoft Defender per Azure Cosmos DB abilitato. Microsoft Defender per Azure Cosmos DB è un livello di sicurezza nativo di Azure che rileva i tentativi di sfruttare i database negli account Azure Cosmos DB. Microsoft Defender for Azure Cosmos DB rileva potenziali iniezioni SQL, attori malintenzionati noti basati su Microsoft Threat Intelligence, schemi di accesso sospetti e potenziali sfruttamenti del tuo database tramite identità compromesse o insider malevoli.
Crea un account Azure Cosmos DB di livello gratuito

Pubblica su Azure
Questo template crea un account Azure Cosmos DB free-tier per l'API SQL con un database con throughput condiviso e container.
Crea un account Azure Cosmos DB minimo per l'API Core (SQL

Pubblica su Azure
Questo template crea un account Azure Cosmos DB per l'API Core (SQL) specificando solo le proprietà minime richieste delle risorse.
Crea un account serverless Azure Cosmos DB per API SQL

Pubblica su Azure
Questo template crea un account serverless Azure Cosmos DB per l'API Core (SQL).
Crea un account Cosmos Azure zero touch e Azure Web App

Pubblica su Azure
Questo template crea un account Azure Cosmos, inietta l'endpoint Cosmos DB e inserisce le impostazioni di Azure Web App, poi distribuisce un'app web ASP MVC da GitHub.
Crea un account Azure Cosmos per l'API MongoDB

Pubblica su Azure
Questo template crea un account Azure Cosmos DB per MongoDB API 4.2 in due regioni utilizzando throughput condiviso e dedicato con due collezioni.
Crea un account Azure Cosmos per l'autoscala API di MongoDB

Pubblica su Azure
Questo template crea un account Azure Cosmos DB per MongoDB API 4.2 in due regioni utilizzando sia la velocità di scalabilità automatica condivisa che dedicata.
Crea un account Azure Cosmos per Table API

Pubblica su Azure
Questo template crea un account Azure Cosmos DB per l'API delle Tabelle in due regioni e una singola tabella con throughput provisionato.
Crea un account Azure Cosmos per l'API delle Tabelle con autoscale

Pubblica su Azure
Questo template crea un account Azure Cosmos DB per Table API in due regioni e una singola tabella con throughput autoscalabile.
Crea un account Azure Cosmos DB per Cassandra API

Pubblica su Azure
Questo template crea un account Azure Cosmos DB per Cassandra API in due regioni con uno spazio chiave e una tabella con throughput dedicato.
Crea un account Azure Cosmos DB per l'API Core (SQL

Pubblica su Azure
Questo template crea un account Azure Cosmos per l'API Core (SQL) con un database e un container con throughput e molteplici altre opzioni.
Crea un account Azure Cosmos DB per Gremlin API

Pubblica su Azure
Questo template crea un account Azure Cosmos DB per l'API Gremlin in due regioni con un database e un grafo utilizzando un throughput dedicato.
Crea un account Azure Cosmos DB per l'autoscala di Gremlin API

Pubblica su Azure
Questo template crea un account Azure Cosmos DB per l'API Gremlin in due regioni con un database e un grafo utilizzando la velocità di scalabilità automatica.
Crea un account Azure Cosmos DB in più regioni

Pubblica su Azure
Questo template crea un account Azure Cosmos DB per qualsiasi tipo di API di database con una regione primaria e una secondaria, scegliendo il livello di coerenza e il tipo di failover.
Crea un'API SQL per Azure Cosmos DB account con autoscale

Pubblica su Azure
Questo template crea un account Azure Cosmos per l'API Core (SQL) con un database e un container con throughput autoscalabile e molte altre opzioni.
Creare un account Azure Cosmos DB con un endpoint privato

Pubblica su Azure
Questo modello creerà un account Cosmos, una rete virtuale e un endpoint privato che espone l'account Cosmos alla rete virtuale.
Crea un account SQL Azure Cosmos DB con il piano dati RBAC

Pubblica su Azure
Questo modello creerà un account SQL Cosmos, una definizione di ruolo gestita in modo nativo e un'assegnazione di ruolo gestita in modo nativo per un'identità AAD.
Crea un account Azure CosmosDB

Pubblica su Azure
Questo modello di Resource Manager ha lo scopo di creare rapidamente un account CosmosDB con i valori minimi necessari
Create autoscale Azure Cosmos DB account per Cassandra API

Pubblica su Azure
Questo template crea un account Azure Cosmos DB per l'API Cassandra in due regioni con uno spazio chiave e una tabella con throughput autoscalabile.
Create Azure Cosmos DB Core (SQL) API stored procedure

Pubblica su Azure
Questo template crea un account Azure Cosmos DB per l'API Core (SQL) e un contenitore con una procedura memorizzata, un trigger e una funzione definita dall'utente.
Create Azure Cosmos con API SQL e più container

Pubblica su Azure
Il modello crea un contenitore Cosmos con un'API SQL e consente di aggiungere contenitori mulitple.
Crea un'app di microservizi Dapr usando App contenitore

Pubblica su Azure
Creare un'app di microservizi Dapr usando App contenitore.
Crea un'app Servicebus pub-sub Dapr usando Container Apps

Pubblica su Azure
Creare un'app pub-sub servicebus dapr usando App contenitore.
Distribuisci Esplora dati di Azure database con connessione Cosmos DB

Pubblica su Azure
Deploy Esplora dati di Azure DB con connessione Cosmos DB.
Web App con database SQL, Azure Cosmos DB Azure Ricerca

Pubblica su Azure
Questo modello prevede una Web App, un Database SQL, Azure Cosmos DB, Azure Search e Application Insights.

Formato risorsa

Per creare un Microsoft. Risorsa DocumentDB/databaseAccounts, aggiungi il seguente JSON al tuo template.

{
  "type": "Microsoft.DocumentDB/databaseAccounts",
  "apiVersion": "2026-03-15",
  "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"
    },
    "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",
    "disableKeyBasedMetadataWriteAccess": "bool",
    "disableLocalAuth": "bool",
    "enableAnalyticalStorage": "bool",
    "enableAutomaticFailover": "bool",
    "enableBurstCapacity": "bool",
    "enableCassandraConnector": "bool",
    "enableFreeTier": "bool",
    "enableMultipleWriteLocations": "bool",
    "enablePartitionMerge": "bool",
    "enablePerRegionPerPartitionAutoscale": "bool",
    "enablePriorityBasedExecution": "bool",
    "enforceHierarchicalPartitionKeyIdLastLevel": "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"
  }
}

Oggetti BackupPolicy

Impostare la proprietà tipo di per specificare il tipo di oggetto.

Per continuo, usare:

{
  "continuousModeProperties": {
    "tier": "string"
  },
  "type": "Continuous"
}

Per periodico, usare:

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

Valori delle proprietà

Microsoft. DocumentDB/databaseAccounts

Name Description Value
apiVersion Versione dell'API '2026-03-15'
identity Identità per la risorsa. ManagedServiceIdentity
kind Indica il tipo di account di database. Questa impostazione può essere impostata solo durante la creazione dell'account di database. 'GlobalDocumentDB'
'MongoDB'
'Parse'
location Posizione del gruppo di risorse a cui appartiene la risorsa. Stringa
nome Nome della risorsa string

Constraints:
Lunghezza minima = 3
Lunghezza massima = 50
Pattern = ^[a-z0-9]+(-[a-z0-9]+)* (obbligatorio)
Proprietà Proprietà per creare e aggiornare account database Azure Cosmos DB. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (obbligatorio)
tags Tag delle risorse Dizionario di nomi e valori di tag. Vedere tag nei modelli
type Tipo di risorsa 'Microsoft. DocumentDB/account di database'

Configurazione AnalyticalStorageConfiguration

Name Description Value
schemaType Descrive i tipi di schema per l'archiviazione analitica. 'Piena fedeltà'
'Ben definito'

ApiProperties

Name Description Value
serverVersion Descrive la versione dell'account MongoDB. '3.2'
'3.6'
'4.0'
'4.2'
'5.0'
'6.0'
'7.0'

ARMResourceProprietàTag

Name Description Value

BackupPolicy

Name Description Value
migrationState Oggetto che rappresenta lo stato della migrazione tra i criteri di backup. BackupPolicyMigrationState
type Impostare su "Continuous" per il tipo ContinuousModeBackupPolicy. Impostare su "Periodico" per il tipo PeriodicModeBackupPolicy. 'Continuous'
'Periodico' (obbligatorio)

BackupPolicyMigrationState

Name Description Value
startTime Ora di avvio della migrazione dei criteri di backup (formato ISO-8601). Stringa
status Descrive lo stato della migrazione tra i tipi di criteri di backup. 'Completato'
'Fallito'
'In corso'
'Invalid'
tipo di obiettivo Descrive il tipo di criteri di backup di destinazione della migrazione dei criteri di backup. 'Continuous'
'Periodico'

Capability

Name Description Value
nome Nome della funzionalità di Cosmos DB. Ad esempio, "name": "EnableCassandra". I valori correnti includono anche "EnableTable" e "EnableGremlin". Stringa

Capacità

Name Description Value
totalThroughputLimit Limite totale di velocità effettiva imposto all'account. Un totaleThroughputLimit di 2000 impone un limite rigoroso di velocità effettiva massima di cui è possibile effettuare il provisioning su tale account per essere 2000. Un totaleThroughputLimit di -1 indica che non sono previsti limiti al provisioning della velocità effettiva. int

Constraints:
Valore minimo = -1

ConsistencyPolicy

Name Description Value
defaultConsistencyLevel Il livello di coerenza predefinito e le impostazioni di configurazione dell'account Cosmos DB. 'BoundedStaleness'
'ConsistentPrefix'
'Eventual'
'Session'
'Forte' (obbligatorio)
maxIntervalInSeconds Se usato con il livello di coerenza decadimento ristretto, questo valore rappresenta la quantità di tempo di decadimento (in secondi) tollerata. L'intervallo accettato per questo valore è 5 - 86400. Obbligatorio quando defaultConsistencyPolicy è impostato su "BoundedStaleness". int

Constraints:
Valore minimo = 5
Valore massimo = 86400
maxStalenessPrefix Se usato con il livello di coerenza decadimento ristretto, questo valore rappresenta il numero di richieste non aggiornati tollerate. L'intervallo accettato per questo valore è 1 - 2.147.483.647. Obbligatorio quando defaultConsistencyPolicy è impostato su "BoundedStaleness". int

Constraints:
Valore minimo = 1
Valore massimo = 2147483647

ContinuousModeBackupPolicy

Name Description Value
continuousModeProperties Valori di configurazione per il backup in modalità continua Proprietà ContinuousMode
type Descrive la modalità di backup. 'Continuo' (obbligatorio)

Proprietà ContinuousMode

Name Description Value
tier Enumerazione per indicare il tipo di modalità di backup Continuos 'Continuous30Days'
'Continuous7Days'

CorsPolicy

Name Description Value
allowedHeaders Intestazioni di richiesta che il dominio di origine può specificare nella richiesta CORS. Stringa
allowedMethods I metodi (verbi di richiesta HTTP) che il dominio di origine può usare per una richiesta CORS. Stringa
allowedOrigins Domini di origine autorizzati a effettuare una richiesta al servizio tramite CORS. stringa (obbligatorio)
exposedHeaders Intestazioni di risposta che possono essere inviate nella risposta alla richiesta CORS ed esposte dal browser all'emittente della richiesta. Stringa
maxAgeInSeconds Periodo massimo di tempo in cui un browser deve memorizzare nella cache la richiesta OPTIONS preliminare. int

Constraints:
Valore minimo = 1
Valore massimo = 2147483647

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Name Description Value
analyticalStorageConfiguration Proprietà specifiche dell'archiviazione analitica. Configurazione AnalyticalStorageConfiguration
apiProperties Proprietà specifiche dell'API. Attualmente, supportato solo per l'API MongoDB. Proprietà API
backupPolicy Oggetto che rappresenta i criteri per l'esecuzione di backup in un account. BackupPolicy
capabilities Elenco delle funzionalità di Cosmos DB per l'account Capability[]
capacity Oggetto che rappresenta tutte le proprietà correlate all'imposizione della capacità in un account. Capacità
connectorOffer Tipo di offerta del connettore cassandra per l'account C* del database Cosmos DB. 'Small'
consistencyPolicy Criteri di coerenza per l'account Cosmos DB. ConsistencyPolicy
cors Criteri CORS per l'account del database Cosmos DB. CorsPolicy[]
createMode Enumerazione per indicare la modalità di creazione dell'account. 'Default'
'Ripristina'
customerManagedKeyStatus Indica lo stato della funzionalità Chiave gestita dal cliente nell'account. In caso di errori, la proprietà fornisce indicazioni per la risoluzione dei problemi. Stringa
databaseAccountOfferType Tipo di offerta per l'account di database Cosmos DB. 'Standard' (obbligatorio)
defaultIdentity Identità predefinita per l'accesso all'insieme di credenziali delle chiavi usato nelle funzionalità come le chiavi gestite dal cliente. L'identità predefinita deve essere impostata in modo esplicito dagli utenti. Può essere "FirstPartyIdentity", "SystemAssignedIdentity" e altro ancora. Stringa
defaultPriorityLevel Enumerazione per indicare il livello di priorità predefinito della richiesta per l'esecuzione basata su priorità. 'High'
'Low'
disableKeyBasedMetadataWriteAccess Disabilitare le operazioni di scrittura sulle risorse dei metadati (database, contenitori, velocità effettiva) tramite chiavi dell'account bool
disableLocalAuth Rifiutare esplicitamente l'autenticazione locale e assicurarsi che solo MSI e AAD possano essere usati esclusivamente per l'autenticazione. bool
enableAnalyticalStorage Flag per indicare se abilitare l'analisi dell'archiviazione. bool
enableAutomaticFailover Abilita il failover automatico dell'area di scrittura nel raro caso in cui l'area non sia disponibile a causa di un'interruzione del servizio. Il failover automatico comporterà una nuova area di scrittura per l'account e viene scelta in base alle priorità di failover configurate per l'account. bool
enableBurstCapacity Flag per indicare l'abilitazione/disabilitazione della funzionalità Anteprima capacità burst nell'account bool
enableCassandraConnector Abilita il connettore cassandra nell'account C* di Cosmos DB bool
enableFreeTier Flag per indicare se il livello gratuito è abilitato. bool
enableMultipleWriteLocations Consente all'account di scrivere in più posizioni bool
enablePartitionMerge Flag per indicare l'abilitazione/disabilitazione della funzionalità di merge partizione nell'account bool
enablePerRegionPerPartitionAutoscale Flag per indicare l'abilitazione/disabilitazione della funzionalità di anteprima della scalabilità automatica per partizione Per-Region nell'account bool
enablePriorityBasedExecution Flag per indicare l'abilitazione/disabilitazione della funzionalità Anteprima esecuzione basata su priorità nell'account bool
enforceHierarchicalPartitionKeyIdLastLevel Flag per indicare l'abilitazione/disabilitazione dell'applicazione gerarchica dell'ID della chiave di partizione sull'account. bool
ipRegole Elenco di IpRules. IpAddressOrRange[]
isVirtualNetworkFilterEnabled Segnala se abilitare/disabilitare le regole ACL di Rete virtuale. bool
keyVaultKeyUri URI dell'insieme di credenziali delle chiavi Stringa
locations Matrice che contiene le posizioni di replica geografica abilitate per l'account Cosmos DB. Posizione[] (richiesto)
minimalTlsVersion Indica la versione minima consentita di Tls. Il valore predefinito è Tls 1.0, ad eccezione dell'API Cassandra e Mongo, che funziona solo con Tls 1.2. 'Tls'
'Tls11'
'Tls12'
networkAclBypass Indica quali servizi sono autorizzati a ignorare i controlli del firewall. 'AzureServices'
'None'
networkAclBypassResourceIds Matrice che contiene gli ID risorsa per il bypass Acl di rete per l'account Cosmos DB. string[]
pubblicoAccesso alla rete Indica se le richieste dalla rete pubblica sono consentite 'Disabilitato'
'Abilitato'
'SecuredByPerimeter'
restoreParameters Parametri per indicare le informazioni sul ripristino. RestoreParameters
virtualNetworkRegole Elenco delle regole Rete virtuale ACL configurate per l'account Cosmos DB. VirtualNetworkRule[]

DatabaseRestoreResource

Name Description Value
collectionNames Nomi delle raccolte disponibili per il ripristino. string[]
databaseName Nome del database disponibile per il ripristino. Stringa

GremlinDatabaseRestoreResource

Name Description Value
databaseName Nome del database gremlin disponibile per il ripristino. Stringa
graphNames Nomi dei grafici disponibili per il ripristino. string[]

IpAddressOrRange

Name Description Value
ipAddressOrRange Un singolo indirizzo IPv4 o un singolo intervallo di indirizzi IPv4 in formato CIDR. Gli indirizzi IP forniti devono essere formattati correttamente e non possono essere contenuti in uno degli intervalli seguenti: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0.0/16, perché non sono applicabili dal filtro di indirizzi IP. Esempio di input validi: "23.40.210.245" o "23.40.210.0/8". Stringa

Posizione

Name Description Value
failoverPriority Priorità di failover dell'area. Una priorità di failover pari a 0 indica un'area di scrittura. Valore massimo per una priorità di failover = (numero totale di aree - 1). I valori di priorità di failover devono essere univoci per ognuna delle aree in cui è presente l'account di database. int

Constraints:
Valore minimo = 0
isZoneRedundant Flag per indicare se questa area è un'area availabilityZone bool
locationName Nome dell'area. Stringa

ManagedServiceIdentity

Name Description Value
type Tipo di identità usata per la risorsa. Il tipo 'SystemAssigned,UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo 'None' rimuoverà tutte le identità dal servizio. 'None'
'Assegnato dal sistema'
'SystemAssigned,UserAssigned'
'UserAssigned'
identità assegnate dall'utente Elenco delle identità utente associate alla risorsa. I riferimenti alla chiave del dizionario delle identità utente saranno id risorsa ARM nel formato :'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Description Value

ManagedServiceIdentityUserAssignedIdentities

Name Description Value

PeriodicModeBackupPolicy

Name Description Value
periodicModeProperties Valori di configurazione per il backup in modalità periodica PeriodicModeProperties
type Descrive la modalità di backup. 'Periodico' (obbligatorio)

PeriodicModeProperties

Name Description Value
backupIntervalInMinutes Intero che rappresenta l'intervallo in minuti tra due backup int

Constraints:
Valore minimo = 0
backupRetentionIntervalInHours Intero che rappresenta l'ora (in ore) di conservazione di ogni backup int

Constraints:
Valore minimo = 0
backupStorageRedundancy Enumerazione per indicare il tipo di residenza dei backup 'Geo'
'Locale'
'Zone'

RestoreParameters

Name Description Value
databasesToRestore Elenco di database specifici disponibili per il ripristino. DatabaseRestoreResource[]
gremlinDatabasesToRestore Elenco di database gremlin specifici disponibili per il ripristino. GremlinDatabaseRestoreResource[]
restoreMode Descrive la modalità di ripristino. 'PointInTime'
restoreSource ID dell'account di database ripristinabile da cui deve essere avviato il ripristino. Ad esempio: /subscriptions/{subscriptionId}/providers/Microsoft. DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} Stringa
restoreTimestampInUtc Ora di ripristino dell'account (formato ISO-8601). Stringa
restoreWithTtlDisabled Specifica se l'account ripristinato avrà time-To-Live disabilitato al termine del ripristino. bool
sourceBackupLocation Percorso di backup di origine per il ripristino. Stringa
tabelle da ripristinare Elenco di tabelle specifiche disponibili per il ripristino. string[]

VirtualNetworkRule

Name Description Value
id ID risorsa di una sottorete, ad esempio: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft. Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. Stringa
ignoreMissingVNetServiceEndpoint Creare una regola del firewall prima che la rete virtuale disponga dell'endpoint servizio di rete virtuale abilitato. bool

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa databaseAccounts può essere distribuito con operazioni destinate a:

  • Gruppi di risorse Per un elenco delle proprietà modificate in ogni versione dell'API, vedi il registro modifiche.

Esempi di utilizzo

Esempi di Terraform

Esempio di base di distribuzione dell'account CosmosDB (formalmente DocumentDB).

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "databaseAccount" {
  type      = "Microsoft.DocumentDB/databaseAccounts@2021-10-15"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "GlobalDocumentDB"
    properties = {
      capabilities = [
      ]
      consistencyPolicy = {
        defaultConsistencyLevel = "BoundedStaleness"
        maxIntervalInSeconds    = 10
        maxStalenessPrefix      = 200
      }
      databaseAccountOfferType           = "Standard"
      defaultIdentity                    = "FirstPartyIdentity"
      disableKeyBasedMetadataWriteAccess = false
      disableLocalAuth                   = false
      enableAnalyticalStorage            = false
      enableAutomaticFailover            = false
      enableFreeTier                     = false
      enableMultipleWriteLocations       = false
      ipRules = [
      ]
      isVirtualNetworkFilterEnabled = false
      locations = [
        {
          failoverPriority = 0
          isZoneRedundant  = false
          locationName     = "West Europe"
        },
      ]
      networkAclBypass = "None"
      networkAclBypassResourceIds = [
      ]
      publicNetworkAccess = "Enabled"
      virtualNetworkRules = [
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Formato risorsa

Per creare un Microsoft. Risorsa DocumentDB/databaseAccounts, aggiungi il seguente Terraform al tuo template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts@2026-03-15"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    kind = "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
      }
      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"
      disableKeyBasedMetadataWriteAccess = bool
      disableLocalAuth = bool
      enableAnalyticalStorage = bool
      enableAutomaticFailover = bool
      enableBurstCapacity = bool
      enableCassandraConnector = bool
      enableFreeTier = bool
      enableMultipleWriteLocations = bool
      enablePartitionMerge = bool
      enablePerRegionPerPartitionAutoscale = bool
      enablePriorityBasedExecution = bool
      enforceHierarchicalPartitionKeyIdLastLevel = 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
        }
      ]
    }
  }
}

Oggetti BackupPolicy

Impostare la proprietà tipo di per specificare il tipo di oggetto.

Per continuo, usare:

{
  continuousModeProperties = {
    tier = "string"
  }
  type = "Continuous"
}

Per periodico, usare:

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

Valori delle proprietà

Microsoft. DocumentDB/databaseAccounts

Name Description Value
identity Identità per la risorsa. ManagedServiceIdentity
kind Indica il tipo di account di database. Questa impostazione può essere impostata solo durante la creazione dell'account di database. 'GlobalDocumentDB'
'MongoDB'
'Parse'
location Posizione del gruppo di risorse a cui appartiene la risorsa. Stringa
nome Nome della risorsa string

Constraints:
Lunghezza minima = 3
Lunghezza massima = 50
Pattern = ^[a-z0-9]+(-[a-z0-9]+)* (obbligatorio)
Proprietà Proprietà per creare e aggiornare account database Azure Cosmos DB. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties (obbligatorio)
tags Tag delle risorse Dizionario di nomi e valori di tag.
type Tipo di risorsa "Microsoft. DocumentDB/databaseAccounts@2026-03-15"

Configurazione AnalyticalStorageConfiguration

Name Description Value
schemaType Descrive i tipi di schema per l'archiviazione analitica. 'Piena fedeltà'
'Ben definito'

ApiProperties

Name Description Value
serverVersion Descrive la versione dell'account MongoDB. '3.2'
'3.6'
'4.0'
'4.2'
'5.0'
'6.0'
'7.0'

ARMResourceProprietàTag

Name Description Value

BackupPolicy

Name Description Value
migrationState Oggetto che rappresenta lo stato della migrazione tra i criteri di backup. BackupPolicyMigrationState
type Impostare su "Continuous" per il tipo ContinuousModeBackupPolicy. Impostare su "Periodico" per il tipo PeriodicModeBackupPolicy. 'Continuous'
'Periodico' (obbligatorio)

BackupPolicyMigrationState

Name Description Value
startTime Ora di avvio della migrazione dei criteri di backup (formato ISO-8601). Stringa
status Descrive lo stato della migrazione tra i tipi di criteri di backup. 'Completato'
'Fallito'
'In corso'
'Invalid'
tipo di obiettivo Descrive il tipo di criteri di backup di destinazione della migrazione dei criteri di backup. 'Continuous'
'Periodico'

Capability

Name Description Value
nome Nome della funzionalità di Cosmos DB. Ad esempio, "name": "EnableCassandra". I valori correnti includono anche "EnableTable" e "EnableGremlin". Stringa

Capacità

Name Description Value
totalThroughputLimit Limite totale di velocità effettiva imposto all'account. Un totaleThroughputLimit di 2000 impone un limite rigoroso di velocità effettiva massima di cui è possibile effettuare il provisioning su tale account per essere 2000. Un totaleThroughputLimit di -1 indica che non sono previsti limiti al provisioning della velocità effettiva. int

Constraints:
Valore minimo = -1

ConsistencyPolicy

Name Description Value
defaultConsistencyLevel Il livello di coerenza predefinito e le impostazioni di configurazione dell'account Cosmos DB. 'BoundedStaleness'
'ConsistentPrefix'
'Eventual'
'Session'
'Forte' (obbligatorio)
maxIntervalInSeconds Se usato con il livello di coerenza decadimento ristretto, questo valore rappresenta la quantità di tempo di decadimento (in secondi) tollerata. L'intervallo accettato per questo valore è 5 - 86400. Obbligatorio quando defaultConsistencyPolicy è impostato su "BoundedStaleness". int

Constraints:
Valore minimo = 5
Valore massimo = 86400
maxStalenessPrefix Se usato con il livello di coerenza decadimento ristretto, questo valore rappresenta il numero di richieste non aggiornati tollerate. L'intervallo accettato per questo valore è 1 - 2.147.483.647. Obbligatorio quando defaultConsistencyPolicy è impostato su "BoundedStaleness". int

Constraints:
Valore minimo = 1
Valore massimo = 2147483647

ContinuousModeBackupPolicy

Name Description Value
continuousModeProperties Valori di configurazione per il backup in modalità continua Proprietà ContinuousMode
type Descrive la modalità di backup. 'Continuo' (obbligatorio)

Proprietà ContinuousMode

Name Description Value
tier Enumerazione per indicare il tipo di modalità di backup Continuos 'Continuous30Days'
'Continuous7Days'

CorsPolicy

Name Description Value
allowedHeaders Intestazioni di richiesta che il dominio di origine può specificare nella richiesta CORS. Stringa
allowedMethods I metodi (verbi di richiesta HTTP) che il dominio di origine può usare per una richiesta CORS. Stringa
allowedOrigins Domini di origine autorizzati a effettuare una richiesta al servizio tramite CORS. stringa (obbligatorio)
exposedHeaders Intestazioni di risposta che possono essere inviate nella risposta alla richiesta CORS ed esposte dal browser all'emittente della richiesta. Stringa
maxAgeInSeconds Periodo massimo di tempo in cui un browser deve memorizzare nella cache la richiesta OPTIONS preliminare. int

Constraints:
Valore minimo = 1
Valore massimo = 2147483647

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

Name Description Value
analyticalStorageConfiguration Proprietà specifiche dell'archiviazione analitica. Configurazione AnalyticalStorageConfiguration
apiProperties Proprietà specifiche dell'API. Attualmente, supportato solo per l'API MongoDB. Proprietà API
backupPolicy Oggetto che rappresenta i criteri per l'esecuzione di backup in un account. BackupPolicy
capabilities Elenco delle funzionalità di Cosmos DB per l'account Capability[]
capacity Oggetto che rappresenta tutte le proprietà correlate all'imposizione della capacità in un account. Capacità
connectorOffer Tipo di offerta del connettore cassandra per l'account C* del database Cosmos DB. 'Small'
consistencyPolicy Criteri di coerenza per l'account Cosmos DB. ConsistencyPolicy
cors Criteri CORS per l'account del database Cosmos DB. CorsPolicy[]
createMode Enumerazione per indicare la modalità di creazione dell'account. 'Default'
'Ripristina'
customerManagedKeyStatus Indica lo stato della funzionalità Chiave gestita dal cliente nell'account. In caso di errori, la proprietà fornisce indicazioni per la risoluzione dei problemi. Stringa
databaseAccountOfferType Tipo di offerta per l'account di database Cosmos DB. 'Standard' (obbligatorio)
defaultIdentity Identità predefinita per l'accesso all'insieme di credenziali delle chiavi usato nelle funzionalità come le chiavi gestite dal cliente. L'identità predefinita deve essere impostata in modo esplicito dagli utenti. Può essere "FirstPartyIdentity", "SystemAssignedIdentity" e altro ancora. Stringa
defaultPriorityLevel Enumerazione per indicare il livello di priorità predefinito della richiesta per l'esecuzione basata su priorità. 'High'
'Low'
disableKeyBasedMetadataWriteAccess Disabilitare le operazioni di scrittura sulle risorse dei metadati (database, contenitori, velocità effettiva) tramite chiavi dell'account bool
disableLocalAuth Rifiutare esplicitamente l'autenticazione locale e assicurarsi che solo MSI e AAD possano essere usati esclusivamente per l'autenticazione. bool
enableAnalyticalStorage Flag per indicare se abilitare l'analisi dell'archiviazione. bool
enableAutomaticFailover Abilita il failover automatico dell'area di scrittura nel raro caso in cui l'area non sia disponibile a causa di un'interruzione del servizio. Il failover automatico comporterà una nuova area di scrittura per l'account e viene scelta in base alle priorità di failover configurate per l'account. bool
enableBurstCapacity Flag per indicare l'abilitazione/disabilitazione della funzionalità Anteprima capacità burst nell'account bool
enableCassandraConnector Abilita il connettore cassandra nell'account C* di Cosmos DB bool
enableFreeTier Flag per indicare se il livello gratuito è abilitato. bool
enableMultipleWriteLocations Consente all'account di scrivere in più posizioni bool
enablePartitionMerge Flag per indicare l'abilitazione/disabilitazione della funzionalità di merge partizione nell'account bool
enablePerRegionPerPartitionAutoscale Flag per indicare l'abilitazione/disabilitazione della funzionalità di anteprima della scalabilità automatica per partizione Per-Region nell'account bool
enablePriorityBasedExecution Flag per indicare l'abilitazione/disabilitazione della funzionalità Anteprima esecuzione basata su priorità nell'account bool
enforceHierarchicalPartitionKeyIdLastLevel Flag per indicare l'abilitazione/disabilitazione dell'applicazione gerarchica dell'ID della chiave di partizione sull'account. bool
ipRegole Elenco di IpRules. IpAddressOrRange[]
isVirtualNetworkFilterEnabled Segnala se abilitare/disabilitare le regole ACL di Rete virtuale. bool
keyVaultKeyUri URI dell'insieme di credenziali delle chiavi Stringa
locations Matrice che contiene le posizioni di replica geografica abilitate per l'account Cosmos DB. Posizione[] (richiesto)
minimalTlsVersion Indica la versione minima consentita di Tls. Il valore predefinito è Tls 1.0, ad eccezione dell'API Cassandra e Mongo, che funziona solo con Tls 1.2. 'Tls'
'Tls11'
'Tls12'
networkAclBypass Indica quali servizi sono autorizzati a ignorare i controlli del firewall. 'AzureServices'
'None'
networkAclBypassResourceIds Matrice che contiene gli ID risorsa per il bypass Acl di rete per l'account Cosmos DB. string[]
pubblicoAccesso alla rete Indica se le richieste dalla rete pubblica sono consentite 'Disabilitato'
'Abilitato'
'SecuredByPerimeter'
restoreParameters Parametri per indicare le informazioni sul ripristino. RestoreParameters
virtualNetworkRegole Elenco delle regole Rete virtuale ACL configurate per l'account Cosmos DB. VirtualNetworkRule[]

DatabaseRestoreResource

Name Description Value
collectionNames Nomi delle raccolte disponibili per il ripristino. string[]
databaseName Nome del database disponibile per il ripristino. Stringa

GremlinDatabaseRestoreResource

Name Description Value
databaseName Nome del database gremlin disponibile per il ripristino. Stringa
graphNames Nomi dei grafici disponibili per il ripristino. string[]

IpAddressOrRange

Name Description Value
ipAddressOrRange Un singolo indirizzo IPv4 o un singolo intervallo di indirizzi IPv4 in formato CIDR. Gli indirizzi IP forniti devono essere formattati correttamente e non possono essere contenuti in uno degli intervalli seguenti: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0.0/16, perché non sono applicabili dal filtro di indirizzi IP. Esempio di input validi: "23.40.210.245" o "23.40.210.0/8". Stringa

Posizione

Name Description Value
failoverPriority Priorità di failover dell'area. Una priorità di failover pari a 0 indica un'area di scrittura. Valore massimo per una priorità di failover = (numero totale di aree - 1). I valori di priorità di failover devono essere univoci per ognuna delle aree in cui è presente l'account di database. int

Constraints:
Valore minimo = 0
isZoneRedundant Flag per indicare se questa area è un'area availabilityZone bool
locationName Nome dell'area. Stringa

ManagedServiceIdentity

Name Description Value
type Tipo di identità usata per la risorsa. Il tipo 'SystemAssigned,UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo 'None' rimuoverà tutte le identità dal servizio. 'None'
'Assegnato dal sistema'
'SystemAssigned,UserAssigned'
'UserAssigned'
identità assegnate dall'utente Elenco delle identità utente associate alla risorsa. I riferimenti alla chiave del dizionario delle identità utente saranno id risorsa ARM nel formato :'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Description Value

ManagedServiceIdentityUserAssignedIdentities

Name Description Value

PeriodicModeBackupPolicy

Name Description Value
periodicModeProperties Valori di configurazione per il backup in modalità periodica PeriodicModeProperties
type Descrive la modalità di backup. 'Periodico' (obbligatorio)

PeriodicModeProperties

Name Description Value
backupIntervalInMinutes Intero che rappresenta l'intervallo in minuti tra due backup int

Constraints:
Valore minimo = 0
backupRetentionIntervalInHours Intero che rappresenta l'ora (in ore) di conservazione di ogni backup int

Constraints:
Valore minimo = 0
backupStorageRedundancy Enumerazione per indicare il tipo di residenza dei backup 'Geo'
'Locale'
'Zone'

RestoreParameters

Name Description Value
databasesToRestore Elenco di database specifici disponibili per il ripristino. DatabaseRestoreResource[]
gremlinDatabasesToRestore Elenco di database gremlin specifici disponibili per il ripristino. GremlinDatabaseRestoreResource[]
restoreMode Descrive la modalità di ripristino. 'PointInTime'
restoreSource ID dell'account di database ripristinabile da cui deve essere avviato il ripristino. Ad esempio: /subscriptions/{subscriptionId}/providers/Microsoft. DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} Stringa
restoreTimestampInUtc Ora di ripristino dell'account (formato ISO-8601). Stringa
restoreWithTtlDisabled Specifica se l'account ripristinato avrà time-To-Live disabilitato al termine del ripristino. bool
sourceBackupLocation Percorso di backup di origine per il ripristino. Stringa
tabelle da ripristinare Elenco di tabelle specifiche disponibili per il ripristino. string[]

VirtualNetworkRule

Name Description Value
id ID risorsa di una sottorete, ad esempio: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft. Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. Stringa
ignoreMissingVNetServiceEndpoint Creare una regola del firewall prima che la rete virtuale disponga dell'endpoint servizio di rete virtuale abilitato. bool