Condividi tramite

Database Microsoft.DocumentDBAccounts

  • Articolo

Definizione di risorsa Bicep

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

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

Formato di risorsa

Per creare una risorsa Microsoft.DocumentDB/databaseAccounts, aggiungere il bicep seguente al modello.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts@2024-05-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  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: 'Small'
    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'
    disableKeyBasedMetadataWriteAccess: bool
    disableLocalAuth: bool
    enableAnalyticalStorage: bool
    enableAutomaticFailover: bool
    enableBurstCapacity: bool
    enableCassandraConnector: bool
    enableFreeTier: bool
    enableMultipleWriteLocations: bool
    enablePartitionMerge: 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: 'PointInTime'
      restoreSource: 'string'
      restoreTimestampInUtc: 'string'
      tablesToRestore: [
        'string'
      ]
    }
    virtualNetworkRules: [
      {
        id: 'string'
        ignoreMissingVNetServiceEndpoint: bool
      }
    ]
  }
}

Oggetti BackupPolicy

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

Per Continuous, usare:

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

Per Periodico, usare:

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

Valori delle proprietà

databaseAccounts

Nome Descrizione valore
name Nome della risorsa stringa (obbligatorio)

Limite di caratteri: 3-44

Caratteri validi:
Lettere minuscole, numeri e trattini.

Deve iniziare con una lettera minuscola o un numero.

Il nome della risorsa deve essere univoco in Azure.
posizione Posizione del gruppo di risorse a cui appartiene la risorsa. string
tags I tag sono un elenco di coppie chiave-valore che descrivono la risorsa. Questi tag possono essere utilizzati nella visualizzazione e nel raggruppamento di questa risorsa (tra gruppi di risorse). È possibile specificare un massimo di 15 tag per una risorsa. Ogni tag deve avere una chiave non superiore a 128 caratteri con un valore che non superi i 256 caratteri. Ad esempio, l'esperienza predefinita per un tipo di modello è impostata con "defaultExperience": "Cassandra". I valori correnti "defaultExperience" includono anche "Table", "Graph", "DocumentDB" e "MongoDB". Dizionario di nomi e valori di tag. Vedere Tag nei modelli
kind Indica il tipo di account del database. Questa impostazione può essere impostata solo in fase di creazione dell'account di database. 'GlobalDocumentDB'
'MongoDB'
'Analizza'
identity Identità per la risorsa. ManagedServiceIdentity
properties Proprietà per creare e aggiornare gli account del database Azure Cosmos DB. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (obbligatorio)

ManagedServiceIdentity

Nome Descrizione Valore
tipo 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 "Nessuno" rimuoverà le identità dal servizio. 'Nessuno'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Elenco di identità utente associate alla risorsa. I riferimenti alla chiave del dizionario identità utente saranno ID risorsa ARM nel formato :'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nome Descrizione Valore
{proprietà personalizzata} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...

Nome Descrizione Valore
analyticalStorageConfiguration Proprietà specifiche dell'archiviazione analitica. AnalyticalStorageConfiguration
apiProperties Proprietà specifiche dell'API. Attualmente, supportato solo per l'API MongoDB. ApiProperties
backupPolicy Oggetto che rappresenta i criteri per l'esecuzione dei backup in un account. BackupPolicy
capabilities Elenco delle funzionalità di Cosmos DB per l'account Funzionalità[]
capacità Oggetto che rappresenta tutte le proprietà correlate all'imposizione della capacità in un account. Capacity
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. Impostazione predefinita
'Restore'
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. string
databaseAccountOfferType Tipo di offerta per il database 'Standard' (obbligatorio)
defaultIdentity Identità predefinita per l'accesso all'insieme di credenziali delle chiavi usato in 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. string
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à Merge partizione nell'account bool
ipRules Elenco di IpRules. IpAddressOrRange[]
isVirtualNetworkFilterEnabled Flag per indicare se abilitare/disabilitare le regole ACL di rete virtuale. bool
keyVaultKeyUri URI dell'insieme di credenziali delle chiavi string
locations Matrice che contiene le posizioni di replica geografica abilitate per l'account Cosmos DB. Location[] (obbligatorio)
minimalTlsVersion Indica la versione minima consentita di Tls. Il valore predefinito è Tls 1.2. Le API Cassandra e Mongo funzionano solo con Tls 1.2. 'Tls'
'Tls11'
'Tls12'
networkAclBypass Indica quali servizi sono autorizzati a ignorare i controlli del firewall. 'AzureServices'
'Nessuno'
networkAclBypassResourceIds Matrice che contiene gli ID risorsa per il bypass Acl di rete per l'account Cosmos DB. string[]
publicNetworkAccess Indica se le richieste dalla rete pubblica sono consentite 'Disabilitato'
'Enabled'
'SecuredByPerimeter'
restoreParameters Parametri per indicare le informazioni sul ripristino. RestoreParameters
virtualNetworkRules Elenco delle regole ACL di rete virtuale configurate per l'account Cosmos DB. VirtualNetworkRule[]

AnalyticalStorageConfiguration

Nome Descrizione Valore
Schematype Descrive i tipi di schema per l'archiviazione analitica. 'FullFidelity'
'WellDefined'

ApiProperties

Nome Descrizione Valore
serverVersion Descrive ServerVersion di un account MongoDB. '3.2'
'3.6'
'4.0'
'4.2'
'5.0'
'6.0'

BackupPolicy

Nome Descrizione Valore
migrationState Oggetto che rappresenta lo stato della migrazione tra i criteri di backup. BackupPolicyMigrationState
tipo Impostare il tipo di oggetto Continuo
Periodico (obbligatorio)

BackupPolicyMigrationState

Nome Descrizione Valore
startTime Ora in cui è stata avviata la migrazione dei criteri di backup (formato ISO-8601). string
status Descrive lo stato della migrazione tra i tipi di criteri di backup. 'Completed'
'Failed'
'InProgress'
'Invalid'
targetType Descrive il tipo di criteri di backup di destinazione della migrazione dei criteri di backup. 'Continuous'
'Periodico'

ContinuousModeBackupPolicy

Nome Descrizione Valore
tipo Descrive la modalità di backup. 'Continuous' (obbligatorio)
continuousModeProperties Valori di configurazione per il backup in modalità continua ContinuousModeProperties

ContinuousModeProperties

Nome Descrizione Valore
Livello Enumerazione per indicare il tipo di modalità di backup continuo 'Continuous30Days'
'Continuous7Days'

PeriodicModeBackupPolicy

Nome Descrizione Valore
tipo Descrive la modalità di backup. 'Periodico' (obbligatorio)
periodicModeProperties Valori di configurazione per il backup in modalità periodica PeriodicModeProperties

PeriodicModeProperties

Nome Descrizione Valore
backupIntervalInMinutes Intero che rappresenta l'intervallo in minuti tra due backup INT

Vincoli:
Valore minimo = 0
backupRetentionIntervalInHours Intero che rappresenta l'ora (in ore) che ogni backup viene mantenuto INT

Vincoli:
Valore minimo = 0
backupStorageRedundancy Enumerazione per indicare il tipo di residenza di backup 'Geo'
'Local'
'Zone'

Funzionalità

Nome Descrizione valore
name Nome della funzionalità Cosmos DB. Ad esempio, "name": "EnableCassandra". I valori correnti includono anche "EnableTable" e "EnableGremlin". string

Capacità

Nome Descrizione Valore
totalThroughputLimit Limite di velocità effettiva totale imposto all'account. Un totaleThroughputLimit del 2000 impone un limite rigoroso di velocità effettiva massima che può essere effettuato il provisioning su tale account per essere 2000. Un totaleThroughputLimit di -1 indica nessun limite al provisioning della velocità effettiva. INT

CoerenzaPolicy

Nome Descrizione Valore
defaultConsistencyLevel Livello di coerenza e impostazioni di configurazione predefinite dell'account Cosmos DB. 'BoundedStaleness'
'ConsistentPrefix'
'Finale'
'Session'
'Strong' (obbligatorio)
maxIntervalInSeconds Se usato con il livello di coerenza non vincolato, questo valore rappresenta la quantità di tempo di stalezza (in secondi) tollerata. L'intervallo accettato per questo valore è 5 - 86400. Obbligatorio quando defaultConsistencyPolicy è impostato su 'BoundedStaleness'. INT

Vincoli:
Valore minimo = 5
Valore massimo = 86400
maxStalenessPrefix Se usato con il livello di coerenza non vincolato, questo valore rappresenta il numero di richieste non aggiornate tollerate. L'intervallo consentito per questo valore è compreso tra 1 e 2.147.483.647. Obbligatorio quando defaultConsistencyPolicy è impostato su 'BoundedStaleness'. INT

Vincoli:
Valore minimo = 1
Valore massimo = 2147483647

CorsPolicy

Nome Descrizione Valore
allowedHeaders le intestazioni di richiesta che possono essere specificate dal dominio di origine nella richiesta CORS. string
allowedMethods i metodi (verbi di richiesta HTTP) che possono essere usati dal dominio di origine per una richiesta CORS. string
allowedOrigins I domini di origine consentiti per effettuare una richiesta al servizio tramite CORS. stringa (obbligatoria)
exposedHeaders le intestazioni di risposta che possono essere inviate in risposta alla richiesta CORS ed esposte all'emittente della richiesta dal browser. string
maxAgeInSeconds la quantità di tempo massima in cui la richiesta preliminare OPTIONS deve essere memorizzata nella cache di un browser. INT

Vincoli:
Valore minimo = 1
Valore massimo = 2147483647

IpAddressOrRange

Nome Descrizione Valore
ipAddressOrRange Un singolo indirizzo IPv4 o un singolo intervallo di indirizzi IPv4 in formato CIDR. Gli INDIRIZZI IP forniti devono essere ben formattati e non possono essere contenuti in uno degli intervalli seguenti: 10.0.0.0/8, 100.64.0.0.0/10, 172.16.0.0/12, 192.168.0.0/16, poiché non sono applicabili dal filtro indirizzi IP. Esempio di input validi: "23.40.210.245" o "23.40.210.0/8". string

Location

Nome Descrizione Valore
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 ogni area in cui è presente l'account del database. INT

Vincoli:
Valore minimo = 0
isZoneRedundant Flag per indicare se questa area è un'area AvailabilityZone bool
locationName Il nome dell'area. string

RestoreParameters

Nome Descrizione Valore
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 del database ripristinabile da cui deve essere avviato il ripristino. Ad esempio: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Ora in cui è necessario ripristinare l'account (formato ISO-8601). string
tablesToRestore Elenco di tabelle specifiche disponibili per il ripristino. string[]

DatabaseRestoreResource

Nome Descrizione Valore
collectionNames Nomi delle raccolte disponibili per il ripristino. string[]
databaseName Nome del database disponibile per il ripristino. string

GremlinDatabaseRestoreResource

Nome Descrizione Valore
databaseName Nome del database gremlin disponibile per il ripristino. string
graphNames Nomi dei grafici disponibili per il ripristino. string[]

VirtualNetworkRule

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

Modelli di avvio rapido

I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Modello Descrizione
CI/CD con Jenkins nel servizio Azure Container

Distribuisci in 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 gestibili e gestibili di contenitori. Configurando una compilazione continua per produrre le immagini e l'orchestrazione dei contenitori, è possibile aumentare la velocità e l'affidabilità della distribuzione.
App Web con un database SQL, Azure Cosmos DB, Ricerca di Azure

Distribuisci in Azure		 Questo modello effettua il provisioning di un'app Web, un database SQL, Azure Cosmos DB, Ricerca di Azure e Application Insights.
Creare un account Azure Cosmos DB per l'API Cassandra

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos DB per l'API Cassandra in due aree con un keyspace e una tabella con velocità effettiva dedicata.
Creare un account Azure Cosmos DB per la scalabilità automatica per l'API Cassandra

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos DB per l'API Cassandra in due aree con un keyspace e una tabella con velocità effettiva di scalabilità automatica.
Creare un account Azure CosmosDB

Distribuisci in Azure		 Questo modello di Resource Manager ha lo scopo di creare rapidamente un account CosmosDB con i valori minimi necessari
Creare un account Azure Cosmos DB in più aree

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos DB per qualsiasi tipo di API di database con un'area primaria e secondaria con la scelta del livello di coerenza e del tipo di failover.
Creare un account Azure Cosmos DB di livello gratuito

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos DB di livello gratuito per l'API SQL con un database con velocità effettiva condivisa e contenitore.
Creare un account Azure Cosmos DB per l'API Gremlin

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos DB per l'API Gremlin in due aree con un database e un grafo usando la velocità effettiva dedicata.
Creare un account Azure Cosmos DB per la scalabilità automatica dell'API Gremlin

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos DB per l'API Gremlin in due aree con un database e un grafo usando la velocità effettiva di scalabilità automatica.
Creare un account Azure Cosmos per l'API MongoDB

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos DB per l'API MongoDB 4.2 in due aree usando la velocità effettiva condivisa e dedicata con due raccolte.
Creare un account Azure Cosmos per la scalabilità automatica dell'API MongoDB

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos DB per l'API MongoDB 4.2 in due aree usando la velocità effettiva di scalabilità automatica condivisa e dedicata.
Creare un account Azure Cosmos DB con un endpoint privato

Distribuisci in Azure		 Questo modello creerà un account Cosmos, una rete virtuale e un endpoint privato che espone l'account Cosmos alla rete virtuale.
Creare un account Azure Cosmos DB per l'API Core (SQL)

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos per l'API Core (SQL) con un database e un contenitore con velocità effettiva con più altre opzioni.
API SQL dell'account Azure Cosmos DB con archivio analitico

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos per l'API Core (SQL) con un database e un contenitore configurati con l'archivio analitico.
Creare un'API SQL dell'account Azure Cosmos DB con scalabilità automatica

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos per l'API Core (SQL) con un database e un contenitore con velocità effettiva con scalabilità automatica con più altre opzioni.
Creare stored procedure dell'API Core (SQL) di Azure Cosmos DB

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos DB per l'API Core (SQL) e un contenitore con una stored procedure, un trigger e una funzione definita dall'utente.
Creare un account Azure Cosmos DB minimo per l'API Core (SQL)

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos DB per l'API Core (SQL) specificando solo le proprietà minime necessarie per le risorse.
Creare Azure Cosmos con l'API SQL e più contenitori

Distribuisci in Azure		 Il modello crea un contenitore Cosmos con un'API SQL e consente di aggiungere contenitori mulitple.
Creare un account SQL di Azure Cosmos DB con il controllo degli accessi in base al ruolo del piano dati

Distribuisci in 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.
Creare un account Azure Cosmos DB serverless per l'API SQL

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos DB serverless per l'API Core (SQL).
Creare un account Azure Cosmos per l'API Tabella

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos DB per l'API Tabella in due aree e una singola tabella con velocità effettiva con provisioning.
Creare un account Azure Cosmos per l'API Tabella con scalabilità automatica

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos DB per l'API Tabella in due aree e una singola tabella con velocità effettiva di scalabilità automatica.
Creare un account Azure Cosmos senza tocco e un'app Web di Azure

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos, inserisce l'endpoint e le chiavi di Cosmos DB nelle impostazioni dell'app Web di Azure e quindi distribuisce un'app Web ASP MVC da GitHub.
Creare un account Cosmos DB con Microsoft Defender abilitato

Distribuisci in Azure		 Usando questo modello di Resource Manager, è possibile 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 per Azure Cosmos DB rileva potenziali attacchi SQL injection, attori malintenzionati noti basati su Microsoft Threat Intelligence, modelli di accesso sospetti e potenziali sfruttamento del database tramite identità compromesse o utenti malintenzionati.
Distribuire Azure Data Explorer DB con connessione Cosmos DB

Distribuisci in Azure		 Distribuire Azure Data Explorer DB con la connessione Cosmos DB.
Account Azure Cosmos DB con app Web

Distribuisci in Azure		 Questo modello distribuisce un account Azure Cosmos DB, un piano di servizio app e crea un'app Web nel piano di servizio app. Aggiunge anche due impostazioni dell'applicazione all'app Web che fanno riferimento all'endpoint dell'account Azure Cosmos DB. In questo modo le soluzioni distribuite nell'app Web possono connettersi all'endpoint dell'account Azure Cosmos DB usando tali impostazioni.

Definizione di risorsa del modello di Resource Manager

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

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

Formato di risorsa

Per creare una risorsa Microsoft.DocumentDB/databaseAccounts, aggiungere il codice JSON seguente al modello.

{
  "type": "Microsoft.DocumentDB/databaseAccounts",
  "apiVersion": "2024-05-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "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": "Small",
    "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",
    "disableKeyBasedMetadataWriteAccess": "bool",
    "disableLocalAuth": "bool",
    "enableAnalyticalStorage": "bool",
    "enableAutomaticFailover": "bool",
    "enableBurstCapacity": "bool",
    "enableCassandraConnector": "bool",
    "enableFreeTier": "bool",
    "enableMultipleWriteLocations": "bool",
    "enablePartitionMerge": "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": "PointInTime",
      "restoreSource": "string",
      "restoreTimestampInUtc": "string",
      "tablesToRestore": [ "string" ]
    },
    "virtualNetworkRules": [
      {
        "id": "string",
        "ignoreMissingVNetServiceEndpoint": "bool"
      }
    ]
  }
}

Oggetti BackupPolicy

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

Per Continuous, usare:

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

Per Periodico, usare:

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

Valori delle proprietà

databaseAccounts

Nome Descrizione Valore
tipo Tipo di risorsa 'Microsoft.DocumentDB/databaseAccounts'
apiVersion Versione dell'API della risorsa '2024-05-15'
name Nome della risorsa stringa (obbligatorio)

Limite di caratteri: 3-44

Caratteri validi:
Lettere minuscole, numeri e trattini.

Deve iniziare con una lettera minuscola o un numero.

Il nome della risorsa deve essere univoco in Azure.
posizione Posizione del gruppo di risorse a cui appartiene la risorsa. string
tags I tag sono un elenco di coppie chiave-valore che descrivono la risorsa. Questi tag possono essere utilizzati nella visualizzazione e nel raggruppamento di questa risorsa (tra gruppi di risorse). È possibile specificare un massimo di 15 tag per una risorsa. Ogni tag deve avere una chiave non superiore a 128 caratteri con un valore che non superi i 256 caratteri. Ad esempio, l'esperienza predefinita per un tipo di modello è impostata con "defaultExperience": "Cassandra". I valori correnti "defaultExperience" includono anche "Table", "Graph", "DocumentDB" e "MongoDB". Dizionario di nomi e valori di tag. Vedere Tag nei modelli
kind Indica il tipo di account del database. Questa operazione può essere impostata solo alla creazione dell'account di database. 'GlobalDocumentDB'
'MongoDB'
'Analizza'
identity Identità per la risorsa. ManagedServiceIdentity
properties Proprietà per creare e aggiornare gli account di database di Azure Cosmos DB. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (obbligatorio)

ManagedServiceIdentity

Nome Descrizione Valore
tipo Tipo di identità utilizzata 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 'Nessuno' rimuoverà le identità dal servizio. 'Nessuno'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Elenco delle identità utente associate alla risorsa. I riferimenti alla chiave del dizionario delle identità utente saranno id risorsa ARM nel modulo: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nome Descrizione Valore
{proprietà personalizzata} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...

Nome Descrizione Valore
analyticsStorageConfiguration Proprietà specifiche dell'archiviazione analitica. AnalyticsStorageConfiguration
apiProperties Proprietà specifiche dell'API. Attualmente, supportato solo per l'API MongoDB. ApiProperties
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 Funzionalità[]
capacità Oggetto che rappresenta tutte le proprietà correlate all'imposizione della capacità in un account. Capacity
connectorOffer Tipo di offerta del connettore cassandra per l'account C* del database Cosmos DB. 'Small'
coerenzaPolicy Criteri di coerenza per l'account Cosmos DB. CoerenzaPolicy
CORS Criterio CORS per l'account del database Cosmos DB. CorsPolicy[]
createMode Enumerazione per indicare la modalità di creazione dell'account. Impostazione predefinita
'Restore'
customerManagedKeyStatus Indica lo stato della funzionalità Customer Managed Key nell'account. In caso di errori, la proprietà fornisce indicazioni sulla risoluzione dei problemi. string
databaseAccountOfferType Tipo di offerta per il database 'Standard' (obbligatorio)
defaultIdentity Identità predefinita per l'accesso all'insieme di credenziali delle chiavi usato nelle funzionalità come chiavi gestite dal cliente. L'identità predefinita deve essere impostata in modo esplicito dagli utenti. Può essere "FirstPartyIdentity", "SystemAssignedIdentity" e altro ancora. string
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 nell'evento raro in cui l'area non è disponibile a causa di un'interruzione. Il failover automatico comporta 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 della 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à Merge partizione nell'account bool
ipRules Elenco di IpRules. IpAddressOrRange[]
isVirtualNetworkFilterEnabled Flag per indicare se abilitare/disabilitare le regole ACL di rete virtuale. bool
keyVaultKeyUri URI dell'insieme di credenziali delle chiavi string
locations Matrice che contiene le posizioni di replica geografica abilitate per l'account Cosmos DB. Location[] (obbligatorio)
minimalTlsVersion Indica la versione minima consentita di Tls. Il valore predefinito è Tls 1.2. Le API Cassandra e Mongo funzionano solo con Tls 1.2. 'Tls'
'Tls11'
'Tls12'
networkAclBypass Indica quali servizi sono autorizzati a ignorare i controlli del firewall. 'AzureServices'
'Nessuno'
networkAclBypassResourceIds Matrice che contiene gli ID risorsa per il bypass Acl di rete per l'account Cosmos DB. string[]
publicNetworkAccess Indica se le richieste dalla rete pubblica sono consentite 'Disabilitato'
'Enabled'
'SecuredByPerimeter'
restoreParameters Parametri per indicare le informazioni sul ripristino. RestoreParameters
virtualNetworkRules Elenco delle regole ACL di rete virtuale configurate per l'account Cosmos DB. VirtualNetworkRule[]

AnalyticalStorageConfiguration

Nome Descrizione Valore
Schematype Descrive i tipi di schema per l'archiviazione analitica. 'FullFidelity'
'WellDefined'

ApiProperties

Nome Descrizione Valore
serverVersion Descrive ServerVersion di un account MongoDB. '3.2'
'3.6'
'4.0'
'4.2'
'5.0'
'6.0'

BackupPolicy

Nome Descrizione Valore
migrationState Oggetto che rappresenta lo stato della migrazione tra i criteri di backup. BackupPolicyMigrationState
tipo Impostare il tipo di oggetto Continuo
Periodico (obbligatorio)

BackupPolicyMigrationState

Nome Descrizione Valore
startTime Ora in cui è stata avviata la migrazione dei criteri di backup (formato ISO-8601). string
status Descrive lo stato della migrazione tra i tipi di criteri di backup. 'Completed'
'Failed'
'InProgress'
'Invalid'
targetType Descrive il tipo di criteri di backup di destinazione della migrazione dei criteri di backup. 'Continuous'
'Periodico'

ContinuousModeBackupPolicy

Nome Descrizione Valore
tipo Descrive la modalità di backup. 'Continuous' (obbligatorio)
continuousModeProperties Valori di configurazione per il backup in modalità continua ContinuousModeProperties

ContinuousModeProperties

Nome Descrizione Valore
Livello Enumerazione per indicare il tipo di modalità di backup continua 'Continuous30Days'
'Continuous7Days'

PeriodicModeBackupPolicy

Nome Descrizione Valore
tipo Descrive la modalità di backup. 'Periodico' (obbligatorio)
periodicModeProperties Valori di configurazione per il backup in modalità periodica PeriodicModeProperties

PeriodicModeProperties

Nome Descrizione Valore
backupIntervalInMinutes Intero che rappresenta l'intervallo in minuti tra due backup INT

Vincoli:
Valore minimo = 0
backupRetentionIntervalInHours Intero che rappresenta l'ora (in ore) che ogni backup viene mantenuto INT

Vincoli:
Valore minimo = 0
backupStorageRedundancy Enumerazione per indicare il tipo di residenza di backup 'Geo'
'Local'
'Zone'

Funzionalità

Nome Descrizione valore
name Nome della funzionalità Cosmos DB. Ad esempio, "name": "EnableCassandra". I valori correnti includono anche "EnableTable" e "EnableGremlin". string

Capacità

Nome Descrizione Valore
totalThroughputLimit Limite di velocità effettiva totale imposto all'account. Un totaleThroughputLimit del 2000 impone un limite rigoroso di velocità effettiva massima che può essere effettuato il provisioning su tale account per essere 2000. Un totaleThroughputLimit di -1 indica nessun limite al provisioning della velocità effettiva. INT

CoerenzaPolicy

Nome Descrizione Valore
defaultConsistencyLevel Livello di coerenza e impostazioni di configurazione predefinite dell'account Cosmos DB. 'BoundedStaleness'
'ConsistentPrefix'
'Finale'
'Session'
'Strong' (obbligatorio)
maxIntervalInSeconds Se usato con il livello di coerenza non vincolato, questo valore rappresenta la quantità di tempo di stalezza (in secondi) tollerata. L'intervallo accettato per questo valore è 5 - 86400. Obbligatorio quando defaultConsistencyPolicy è impostato su 'BoundedStaleness'. INT

Vincoli:
Valore minimo = 5
Valore massimo = 86400
maxStalenessPrefix Se usato con il livello di coerenza non vincolato, questo valore rappresenta il numero di richieste non aggiornate tollerate. L'intervallo consentito per questo valore è compreso tra 1 e 2.147.483.647. Obbligatorio quando defaultConsistencyPolicy è impostato su 'BoundedStaleness'. INT

Vincoli:
Valore minimo = 1
Valore massimo = 2147483647

CorsPolicy

Nome Descrizione Valore
allowedHeaders le intestazioni di richiesta che possono essere specificate dal dominio di origine nella richiesta CORS. string
allowedMethods i metodi (verbi di richiesta HTTP) che possono essere usati dal dominio di origine per una richiesta CORS. string
allowedOrigins I domini di origine consentiti per effettuare una richiesta al servizio tramite CORS. stringa (obbligatoria)
exposedHeaders le intestazioni di risposta che possono essere inviate in risposta alla richiesta CORS ed esposte all'emittente della richiesta dal browser. string
maxAgeInSeconds la quantità di tempo massima in cui la richiesta preliminare OPTIONS deve essere memorizzata nella cache di un browser. INT

Vincoli:
Valore minimo = 1
Valore massimo = 2147483647

IpAddressOrRange

Nome Descrizione Valore
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/16, perché non sono applicabili dal filtro indirizzi IP. Esempio di input validi: "23.40.210.245" o "23.40.210.0/8". string

Location

Nome Descrizione Valore
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 ogni area in cui è presente l'account del database. INT

Vincoli:
Valore minimo = 0
isZoneRedundant Flag per indicare se questa area è un'area AvailabilityZone bool
locationName Il nome dell'area. string

RestoreParameters

Nome Descrizione Valore
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 del database ripristinabile da cui deve essere avviato il ripristino. Ad esempio: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Ora in cui è necessario ripristinare l'account (formato ISO-8601). string
tablesToRestore Elenco di tabelle specifiche disponibili per il ripristino. string[]

DatabaseRestoreResource

Nome Descrizione Valore
collectionNames Nomi delle raccolte disponibili per il ripristino. string[]
databaseName Nome del database disponibile per il ripristino. string

GremlinDatabaseRestoreResource

Nome Descrizione Valore
databaseName Nome del database gremlin disponibile per il ripristino. string
graphNames Nomi dei grafici disponibili per il ripristino. string[]

VirtualNetworkRule

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

Modelli di avvio rapido

I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Modello Descrizione
CI/CD con Jenkins nel servizio Azure Container

Distribuisci in 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 gestibili e gestibili di contenitori. Configurando una compilazione continua per produrre le immagini e l'orchestrazione dei contenitori, è possibile aumentare la velocità e l'affidabilità della distribuzione.
App Web con un database SQL, Azure Cosmos DB, Ricerca di Azure

Distribuisci in Azure		 Questo modello effettua il provisioning di un'app Web, un database SQL, Azure Cosmos DB, Ricerca di Azure e Application Insights.
Creare un account Azure Cosmos DB per l'API Cassandra

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos DB per l'API Cassandra in due aree con un keyspace e una tabella con velocità effettiva dedicata.
Creare un account Azure Cosmos DB per la scalabilità automatica per l'API Cassandra

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos DB per l'API Cassandra in due aree con un keyspace e una tabella con velocità effettiva di scalabilità automatica.
Creare un account Azure CosmosDB

Distribuisci in Azure		 Questo modello di Resource Manager ha lo scopo di creare rapidamente un account CosmosDB con i valori minimi necessari
Creare un account Azure Cosmos DB in più aree

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos DB per qualsiasi tipo di API di database con un'area primaria e secondaria con la scelta del livello di coerenza e del tipo di failover.
Creare un account Azure Cosmos DB di livello gratuito

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos DB di livello gratuito per l'API SQL con un database con velocità effettiva condivisa e contenitore.
Creare un account Azure Cosmos DB per l'API Gremlin

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos DB per l'API Gremlin in due aree con un database e un grafo usando la velocità effettiva dedicata.
Creare un account Azure Cosmos DB per la scalabilità automatica dell'API Gremlin

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos DB per l'API Gremlin in due aree con un database e un grafo usando la velocità effettiva di scalabilità automatica.
Creare un account Azure Cosmos per l'API MongoDB

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos DB per l'API MongoDB 4.2 in due aree usando la velocità effettiva condivisa e dedicata con due raccolte.
Creare un account Azure Cosmos per la scalabilità automatica dell'API MongoDB

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos DB per l'API MongoDB 4.2 in due aree usando la velocità effettiva di scalabilità automatica condivisa e dedicata.
Creare un account Azure Cosmos DB con un endpoint privato

Distribuisci in Azure		 Questo modello creerà un account Cosmos, una rete virtuale e un endpoint privato che espone l'account Cosmos alla rete virtuale.
Creare un account Azure Cosmos DB per l'API Core (SQL)

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos per l'API Core (SQL) con un database e un contenitore con velocità effettiva con più altre opzioni.
API SQL dell'account Azure Cosmos DB con archivio analitico

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos per l'API Core (SQL) con un database e un contenitore configurati con l'archivio analitico.
Creare un'API SQL dell'account Azure Cosmos DB con scalabilità automatica

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos per l'API Core (SQL) con un database e un contenitore con velocità effettiva con scalabilità automatica con più altre opzioni.
Creare stored procedure dell'API Core (SQL) di Azure Cosmos DB

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos DB per l'API Core (SQL) e un contenitore con una stored procedure, un trigger e una funzione definita dall'utente.
Creare un account Azure Cosmos DB minimo per l'API Core (SQL)

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos DB per l'API Core (SQL) specificando solo le proprietà minime necessarie per le risorse.
Creare Azure Cosmos con l'API SQL e più contenitori

Distribuisci in Azure		 Il modello crea un contenitore Cosmos con un'API SQL e consente di aggiungere contenitori mulitple.
Creare un account SQL di Azure Cosmos DB con il controllo degli accessi in base al ruolo del piano dati

Distribuisci in 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.
Creare un account Azure Cosmos DB serverless per l'API SQL

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos DB serverless per l'API Core (SQL).
Creare un account Azure Cosmos per l'API Tabella

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos DB per l'API Tabella in due aree e una singola tabella con velocità effettiva con provisioning.
Creare un account Azure Cosmos per l'API Tabella con scalabilità automatica

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos DB per l'API Tabella in due aree e una singola tabella con velocità effettiva di scalabilità automatica.
Creare un account Azure Cosmos senza tocco e un'app Web di Azure

Distribuisci in Azure		 Questo modello crea un account Azure Cosmos, inserisce l'endpoint e le chiavi di Cosmos DB nelle impostazioni dell'app Web di Azure e quindi distribuisce un'app Web ASP MVC da GitHub.
Creare un account Cosmos DB con Microsoft Defender abilitato

Distribuisci in Azure		 Usando questo modello di Resource Manager, è possibile 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 per Azure Cosmos DB rileva potenziali attacchi SQL injection, attori malintenzionati noti basati su Microsoft Threat Intelligence, modelli di accesso sospetti e potenziali sfruttamento del database tramite identità compromesse o utenti malintenzionati.
Distribuire Azure Data Explorer DB con connessione Cosmos DB

Distribuisci in Azure		 Distribuire Azure Data Explorer DB con la connessione Cosmos DB.
Account Azure Cosmos DB con app Web

Distribuisci in Azure		 Questo modello distribuisce un account Azure Cosmos DB, un piano di servizio app e crea un'app Web nel piano di servizio app. Aggiunge anche due impostazioni dell'applicazione all'app Web che fanno riferimento all'endpoint dell'account Azure Cosmos DB. In questo modo le soluzioni distribuite nell'app Web possono connettersi all'endpoint dell'account Azure Cosmos DB usando tali impostazioni.

Definizione della 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, vedere Log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.DocumentDB/databaseAccounts, aggiungere il codice Terraform seguente al modello.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts@2024-05-15"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      analyticalStorageConfiguration = {
        schemaType = "string"
      }
      apiProperties = {
        serverVersion = "string"
      }
      backupPolicy = {
        migrationState = {
          startTime = "string"
          status = "string"
          targetType = "string"
        }
        type = "string"
        // For remaining properties, see BackupPolicy objects
      }
      capabilities = [
        {
          name = "string"
        }
      ]
      capacity = {
        totalThroughputLimit = int
      }
      connectorOffer = "Small"
      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"
      disableKeyBasedMetadataWriteAccess = bool
      disableLocalAuth = bool
      enableAnalyticalStorage = bool
      enableAutomaticFailover = bool
      enableBurstCapacity = bool
      enableCassandraConnector = bool
      enableFreeTier = bool
      enableMultipleWriteLocations = bool
      enablePartitionMerge = 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 = "PointInTime"
        restoreSource = "string"
        restoreTimestampInUtc = "string"
        tablesToRestore = [
          "string"
        ]
      }
      virtualNetworkRules = [
        {
          id = "string"
          ignoreMissingVNetServiceEndpoint = bool
        }
      ]
    }
    kind = "string"
  })
}

Oggetti BackupPolicy

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

Per Continuous, usare:

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

Per Periodico, usare:

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

Valori delle proprietà

databaseAccounts

Nome Descrizione Valore
tipo Tipo di risorsa "Microsoft.DocumentDB/databaseAccounts@2024-05-15"
name Nome della risorsa stringa (obbligatorio)

Limite di caratteri: 3-44

Caratteri validi:
Lettere minuscole, numeri e trattini.

Deve iniziare con una lettera minuscola o un numero.

Il nome della risorsa deve essere univoco in Azure.
posizione Posizione del gruppo di risorse a cui appartiene la risorsa. string
parent_id Per eseguire la distribuzione in un gruppo di risorse, usare l'ID del gruppo di risorse. stringa (obbligatorio)
tags I tag sono un elenco di coppie chiave-valore che descrivono la risorsa. Questi tag possono essere utilizzati nella visualizzazione e nel raggruppamento di questa risorsa (tra gruppi di risorse). È possibile specificare un massimo di 15 tag per una risorsa. Ogni tag deve avere una chiave non superiore a 128 caratteri con un valore che non superi i 256 caratteri. Ad esempio, l'esperienza predefinita per un tipo di modello è impostata con "defaultExperience": "Cassandra". I valori correnti "defaultExperience" includono anche "Table", "Graph", "DocumentDB" e "MongoDB". Dizionario di nomi e valori di tag.
kind Indica il tipo di account del database. Questa impostazione può essere impostata solo in fase di creazione dell'account di database. "GlobalDocumentDB"
"MongoDB"
"Analizza"
identity Identità per la risorsa. ManagedServiceIdentity
properties Proprietà per creare e aggiornare gli account del database Azure Cosmos DB. DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou... (obbligatorio)

ManagedServiceIdentity

Nome Descrizione Valore
tipo 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 "Nessuno" rimuoverà le identità dal servizio. "SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"
identity_ids Elenco di identità utente associate alla risorsa. I riferimenti alla chiave del dizionario identità utente saranno ID risorsa ARM nel formato :'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Matrice di ID identità utente.

ManagedServiceIdentityUserAssignedIdentities

Nome Descrizione Valore
{proprietà personalizzata} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccou...

Nome Descrizione Valore
analyticalStorageConfiguration Proprietà specifiche dell'archiviazione analitica. AnalyticalStorageConfiguration
apiProperties Proprietà specifiche dell'API. Attualmente, supportato solo per l'API MongoDB. ApiProperties
backupPolicy Oggetto che rappresenta i criteri per l'esecuzione dei backup in un account. BackupPolicy
capabilities Elenco delle funzionalità di Cosmos DB per l'account Funzionalità[]
capacità Oggetto che rappresenta tutte le proprietà correlate all'imposizione della capacità in un account. Capacity
connectorOffer Tipo di offerta del connettore cassandra per l'account C* del database Cosmos DB. "Piccolo"
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. string
databaseAccountOfferType Tipo di offerta per il database "Standard" (obbligatorio)
defaultIdentity Identità predefinita per l'accesso all'insieme di credenziali delle chiavi usato in 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. string
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 nell'evento raro in cui l'area non è disponibile a causa di un'interruzione. Il failover automatico comporta 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 della 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à Merge partizione nell'account bool
ipRules Elenco di IpRules. IpAddressOrRange[]
isVirtualNetworkFilterEnabled Flag per indicare se abilitare/disabilitare le regole ACL della rete virtuale. bool
keyVaultKeyUri URI dell'insieme di credenziali delle chiavi string
locations Matrice che contiene le posizioni di georeplicazione abilitate per l'account Cosmos DB. Location[] (obbligatorio)
minimalTlsVersion Indica la versione minima consentita di Tls. Il valore predefinito è Tls 1.2. Le API Cassandra e Mongo funzionano 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 dell'elenco di rete per l'account Cosmos DB. string[]
publicNetworkAccess Indica se le richieste dalla rete pubblica sono consentite "Disabilitato"
"Abilitato"
"SecuredByPerimeter"
restoreParameters Parametri per indicare le informazioni sul ripristino. RestoreParameters
virtualNetworkRules Elenco delle regole ACL di rete virtuale configurate per l'account Cosmos DB. VirtualNetworkRule[]

AnalyticsStorageConfiguration

Nome Descrizione Valore
Schematype Descrive i tipi di schema per l'archiviazione analitica. "FullFidelity"
"WellDefined"

ApiProperties

Nome Descrizione Valore
serverVersion Descrive ServerVersion di un account MongoDB. "3.2"
"3.6"
"4.0"
"4.2"
"5.0"
"6.0"

BackupPolicy

Nome Descrizione Valore
migrationState Oggetto che rappresenta lo stato della migrazione tra i criteri di backup. BackupPolicyMigrationState
tipo Impostare il tipo di oggetto Continuo
Periodico (obbligatorio)

BackupPolicyMigrationState

Nome Descrizione Valore
startTime Ora in cui è stata avviata la migrazione dei criteri di backup (formato ISO-8601). string
status Descrive lo stato della migrazione tra i tipi di criteri di backup. "Completato"
"Failed"
"InProgress"
"Non valido"
targetType Descrive il tipo di criteri di backup di destinazione della migrazione dei criteri di backup. "Continuous"
"Periodico"

ContinuousModeBackupPolicy

Nome Descrizione Valore
tipo Descrive la modalità di backup. "Continuous" (obbligatorio)
continuousModeProperties Valori di configurazione per il backup in modalità continua ContinuousModeProperties

ContinuousModeProperties

Nome Descrizione Valore
Livello Enumerazione per indicare il tipo di modalità di backup continuo "Continuous30Days"
"Continuous7Days"

PeriodicModeBackupPolicy

Nome Descrizione Valore
tipo Descrive la modalità di backup. "Periodico" (obbligatorio)
periodicModeProperties Valori di configurazione per il backup periodico della modalità PeriodicModeProperties

PeriodicModeProperties

Nome Descrizione Valore
backupIntervalInMinutes Intero che rappresenta l'intervallo in minuti tra due backup INT

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

Vincoli:
Valore minimo = 0
backupStorageRedundancy Enumerazione per indicare il tipo di residenza dei backup "Geo"
"Locale"
"Zona"

Funzionalità

Nome Descrizione valore
name Nome della funzionalità di Cosmos DB. Ad esempio, "name": "EnableCassandra". I valori correnti includono anche "EnableTable" e "EnableGremlin". string

Capacità

Nome Descrizione Valore
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

ConsistencyPolicy

Nome Descrizione Valore
defaultConsistencyLevel Impostazioni di configurazione e livello di coerenza predefinite dell'account Cosmos DB. "BoundedStaleness"
"ConsistentPrefix"
"Finale"
"Sessione"
"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

Vincoli:
Valore minimo = 5
Valore massimo = 86400
maxStalenessPrefix Se usato con il livello di coerenza decadimento ristretto, questo valore rappresenta il numero di richieste non aggiornate tollerate. L'intervallo consentito per questo valore è compreso tra 1 e 2.147.483.647. Obbligatorio quando defaultConsistencyPolicy è impostato su "BoundedStaleness". INT

Vincoli:
Valore minimo = 1
Valore massimo = 2147483647

CorsPolicy

Nome Descrizione Valore
allowedHeaders le intestazioni di richiesta che possono essere specificate dal dominio di origine nella richiesta CORS. string
allowedMethods i metodi (verbi di richiesta HTTP) che possono essere usati dal dominio di origine per una richiesta CORS. string
allowedOrigins Domini di origine autorizzati a effettuare una richiesta al servizio tramite CORS. stringa (obbligatorio)
exposedHeaders le intestazioni di risposta che possono essere inviate in risposta alla richiesta CORS ed esposte all'emittente della richiesta dal browser. string
maxAgeInSeconds la quantità di tempo massima in cui la richiesta preliminare OPTIONS deve essere memorizzata nella cache di un browser. INT

Vincoli:
Valore minimo = 1
Valore massimo = 2147483647

IpAddressOrRange

Nome Descrizione Valore
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/16, perché non sono applicabili dal filtro indirizzi IP. Esempio di input validi: "23.40.210.245" o "23.40.210.0/8". string

Location

Nome Descrizione Valore
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 ogni area in cui è presente l'account del database. INT

Vincoli:
Valore minimo = 0
isZoneRedundant Flag per indicare se questa area è un'area AvailabilityZone bool
locationName Il nome dell'area. string

RestoreParameters

Nome Descrizione Valore
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 del database ripristinabile da cui deve essere avviato il ripristino. Ad esempio: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Ora in cui è necessario ripristinare l'account (formato ISO-8601). string
tablesToRestore Elenco di tabelle specifiche disponibili per il ripristino. string[]

DatabaseRestoreResource

Nome Descrizione Valore
collectionNames Nomi delle raccolte disponibili per il ripristino. string[]
databaseName Nome del database disponibile per il ripristino. string

GremlinDatabaseRestoreResource

Nome Descrizione Valore
databaseName Nome del database gremlin disponibile per il ripristino. string
graphNames Nomi dei grafici disponibili per il ripristino. string[]

VirtualNetworkRule

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