Database Microsoft.DocumentDBAccounts

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.

Formato risorsa

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts@2024-12-01-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    analyticalStorageConfiguration: {
      schemaType: 'string'
    }
    apiProperties: {
      serverVersion: 'string'
    }
    backupPolicy: {
      migrationState: {
        startTime: 'string'
        status: 'string'
        targetType: 'string'
      }
      type: 'string'
      // For remaining properties, see BackupPolicy objects
    }
    capabilities: [
      {
        name: 'string'
      }
    ]
    capacity: {
      totalThroughputLimit: int
    }
    capacityMode: 'string'
    connectorOffer: 'string'
    consistencyPolicy: {
      defaultConsistencyLevel: 'string'
      maxIntervalInSeconds: int
      maxStalenessPrefix: int
    }
    cors: [
      {
        allowedHeaders: 'string'
        allowedMethods: 'string'
        allowedOrigins: 'string'
        exposedHeaders: 'string'
        maxAgeInSeconds: int
      }
    ]
    createMode: 'string'
    customerManagedKeyStatus: 'string'
    databaseAccountOfferType: 'Standard'
    defaultIdentity: 'string'
    defaultPriorityLevel: 'string'
    diagnosticLogSettings: {
      enableFullTextQuery: 'string'
    }
    disableKeyBasedMetadataWriteAccess: bool
    disableLocalAuth: bool
    enableAnalyticalStorage: bool
    enableAutomaticFailover: bool
    enableBurstCapacity: bool
    enableCassandraConnector: bool
    enableFreeTier: bool
    enableMaterializedViews: bool
    enableMultipleWriteLocations: bool
    enablePartitionMerge: bool
    enablePerRegionPerPartitionAutoscale: bool
    enablePriorityBasedExecution: bool
    ipRules: [
      {
        ipAddressOrRange: 'string'
      }
    ]
    isVirtualNetworkFilterEnabled: bool
    keyVaultKeyUri: 'string'
    locations: [
      {
        failoverPriority: int
        isZoneRedundant: bool
        locationName: 'string'
      }
    ]
    minimalTlsVersion: 'string'
    networkAclBypass: 'string'
    networkAclBypassResourceIds: [
      'string'
    ]
    publicNetworkAccess: 'string'
    restoreParameters: {
      databasesToRestore: [
        {
          collectionNames: [
            'string'
          ]
          databaseName: 'string'
        }
      ]
      gremlinDatabasesToRestore: [
        {
          databaseName: 'string'
          graphNames: [
            'string'
          ]
        }
      ]
      restoreMode: 'string'
      restoreSource: 'string'
      restoreTimestampInUtc: 'string'
      restoreWithTtlDisabled: bool
      sourceBackupLocation: 'string'
      tablesToRestore: [
        'string'
      ]
    }
    virtualNetworkRules: [
      {
        id: 'string'
        ignoreMissingVNetServiceEndpoint: bool
      }
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

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à

AnalyticalStorageConfiguration

ApiProperties

BackupPolicy

BackupPolicyMigrationState

Capacità

Capacità

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

ConsistencyPolicy

ContinuousModeBackupPolicy

ContinuousModeProperties

CorsPolicy

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

DatabaseRestoreResource

DiagnosticLogSettings

GremlinDatabaseRestoreResource

IpAddressOrRange

Ubicazione

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

Microsoft.DocumentDB/databaseAccounts

PeriodicModeBackupPolicy

PeriodicModeProperties

RestoreParameters

Tag

VirtualNetworkRule

Esempi di avvio rapido

Gli esempi di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Definizione di risorsa del modello di Resource Manager

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.

Formato risorsa

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts",
  "apiVersion": "2024-12-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "analyticalStorageConfiguration": {
      "schemaType": "string"
    },
    "apiProperties": {
      "serverVersion": "string"
    },
    "backupPolicy": {
      "migrationState": {
        "startTime": "string",
        "status": "string",
        "targetType": "string"
      },
      "type": "string"
      // For remaining properties, see BackupPolicy objects
    },
    "capabilities": [
      {
        "name": "string"
      }
    ],
    "capacity": {
      "totalThroughputLimit": "int"
    },
    "capacityMode": "string",
    "connectorOffer": "string",
    "consistencyPolicy": {
      "defaultConsistencyLevel": "string",
      "maxIntervalInSeconds": "int",
      "maxStalenessPrefix": "int"
    },
    "cors": [
      {
        "allowedHeaders": "string",
        "allowedMethods": "string",
        "allowedOrigins": "string",
        "exposedHeaders": "string",
        "maxAgeInSeconds": "int"
      }
    ],
    "createMode": "string",
    "customerManagedKeyStatus": "string",
    "databaseAccountOfferType": "Standard",
    "defaultIdentity": "string",
    "defaultPriorityLevel": "string",
    "diagnosticLogSettings": {
      "enableFullTextQuery": "string"
    },
    "disableKeyBasedMetadataWriteAccess": "bool",
    "disableLocalAuth": "bool",
    "enableAnalyticalStorage": "bool",
    "enableAutomaticFailover": "bool",
    "enableBurstCapacity": "bool",
    "enableCassandraConnector": "bool",
    "enableFreeTier": "bool",
    "enableMaterializedViews": "bool",
    "enableMultipleWriteLocations": "bool",
    "enablePartitionMerge": "bool",
    "enablePerRegionPerPartitionAutoscale": "bool",
    "enablePriorityBasedExecution": "bool",
    "ipRules": [
      {
        "ipAddressOrRange": "string"
      }
    ],
    "isVirtualNetworkFilterEnabled": "bool",
    "keyVaultKeyUri": "string",
    "locations": [
      {
        "failoverPriority": "int",
        "isZoneRedundant": "bool",
        "locationName": "string"
      }
    ],
    "minimalTlsVersion": "string",
    "networkAclBypass": "string",
    "networkAclBypassResourceIds": [ "string" ],
    "publicNetworkAccess": "string",
    "restoreParameters": {
      "databasesToRestore": [
        {
          "collectionNames": [ "string" ],
          "databaseName": "string"
        }
      ],
      "gremlinDatabasesToRestore": [
        {
          "databaseName": "string",
          "graphNames": [ "string" ]
        }
      ],
      "restoreMode": "string",
      "restoreSource": "string",
      "restoreTimestampInUtc": "string",
      "restoreWithTtlDisabled": "bool",
      "sourceBackupLocation": "string",
      "tablesToRestore": [ "string" ]
    },
    "virtualNetworkRules": [
      {
        "id": "string",
        "ignoreMissingVNetServiceEndpoint": "bool"
      }
    ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

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à

AnalyticalStorageConfiguration

ApiProperties

BackupPolicy

BackupPolicyMigrationState

Capacità

Capacità

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

ConsistencyPolicy

ContinuousModeBackupPolicy

ContinuousModeProperties

CorsPolicy

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

DatabaseRestoreResource

DiagnosticLogSettings

GremlinDatabaseRestoreResource

IpAddressOrRange

Ubicazione

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

Microsoft.DocumentDB/databaseAccounts

PeriodicModeBackupPolicy

PeriodicModeProperties

RestoreParameters

Tag

VirtualNetworkRule

Modelli di avvio rapido

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

Sagoma	Descrizione
'API SQL dell'account Azure Cosmos DB con l'archivio analitico	Questo modello crea un account Azure Cosmos per l'API Core (SQL) con un database e un contenitore configurati con l'archivio analitico.
account Azure Cosmos DB con app Web	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.
CI/CD con Jenkins nel servizio Azure Container (AKS)	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.
Creare un account Cosmos DB con Microsoft Defender abilitato	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.
Creare un account Azure Cosmos DB di livello gratuito	Questo modello crea un account Azure Cosmos DB di livello gratuito per l'API SQL con un database con velocità effettiva e contenitore condivisi.
Creare un account Azure Cosmos DB minimo per l'API Core (SQL)	Questo modello crea un account Azure Cosmos DB per l'API Core (SQL) specificando solo le proprietà minime necessarie per le risorse.
Creare un account Azure Cosmos DB serverless per l'API SQL	Questo modello crea un account Azure Cosmos DB serverless per l'API Core (SQL).
Creare un account Azure Cosmos senza tocco e un'app Web di 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 Azure Cosmos per l'API MongoDB	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	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 per l'API Tabella	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	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 DB per l'API Cassandra	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 l'API Core (SQL)	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.
Creare un account Azure Cosmos DB per l'API Gremlin	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	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 DB in più aree	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'API SQL dell'account Azure Cosmos DB con scalabilità automatica	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 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.
Creare un account SQL di Azure Cosmos DB con controllo degli accessi in base al ruolo del piano dati	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 CosmosDB	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 di scalabilità automatica per l'API Cassandra	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 stored procedure dell'API Core (SQL) di Azure Cosmos DB	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 Azure Cosmos con l'API SQL e più contenitori	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	Creare un'app di microservizi Dapr usando App contenitore.
Crea un'app pub-sub-servicebus dapr usando app contenitore	Creare un'app pub-sub servicebus dapr usando App contenitore.
Distribuire Azure Data Explorer DB con la connessione di Cosmos DB	Distribuire Azure Data Explorer DB con la connessione Cosmos DB.
'app Web con un database SQL, Azure Cosmos DB, Ricerca di Azure	Questo modello effettua il provisioning di un'app Web, un database SQL, Azure Cosmos DB, Ricerca di Azure e Application Insights.

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, vedere log delle modifiche.

Formato risorsa

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts@2024-12-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  kind = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      analyticalStorageConfiguration = {
        schemaType = "string"
      }
      apiProperties = {
        serverVersion = "string"
      }
      backupPolicy = {
        migrationState = {
          startTime = "string"
          status = "string"
          targetType = "string"
        }
        type = "string"
        // For remaining properties, see BackupPolicy objects
      }
      capabilities = [
        {
          name = "string"
        }
      ]
      capacity = {
        totalThroughputLimit = int
      }
      capacityMode = "string"
      connectorOffer = "string"
      consistencyPolicy = {
        defaultConsistencyLevel = "string"
        maxIntervalInSeconds = int
        maxStalenessPrefix = int
      }
      cors = [
        {
          allowedHeaders = "string"
          allowedMethods = "string"
          allowedOrigins = "string"
          exposedHeaders = "string"
          maxAgeInSeconds = int
        }
      ]
      createMode = "string"
      customerManagedKeyStatus = "string"
      databaseAccountOfferType = "Standard"
      defaultIdentity = "string"
      defaultPriorityLevel = "string"
      diagnosticLogSettings = {
        enableFullTextQuery = "string"
      }
      disableKeyBasedMetadataWriteAccess = bool
      disableLocalAuth = bool
      enableAnalyticalStorage = bool
      enableAutomaticFailover = bool
      enableBurstCapacity = bool
      enableCassandraConnector = bool
      enableFreeTier = bool
      enableMaterializedViews = bool
      enableMultipleWriteLocations = bool
      enablePartitionMerge = bool
      enablePerRegionPerPartitionAutoscale = bool
      enablePriorityBasedExecution = bool
      ipRules = [
        {
          ipAddressOrRange = "string"
        }
      ]
      isVirtualNetworkFilterEnabled = bool
      keyVaultKeyUri = "string"
      locations = [
        {
          failoverPriority = int
          isZoneRedundant = bool
          locationName = "string"
        }
      ]
      minimalTlsVersion = "string"
      networkAclBypass = "string"
      networkAclBypassResourceIds = [
        "string"
      ]
      publicNetworkAccess = "string"
      restoreParameters = {
        databasesToRestore = [
          {
            collectionNames = [
              "string"
            ]
            databaseName = "string"
          }
        ]
        gremlinDatabasesToRestore = [
          {
            databaseName = "string"
            graphNames = [
              "string"
            ]
          }
        ]
        restoreMode = "string"
        restoreSource = "string"
        restoreTimestampInUtc = "string"
        restoreWithTtlDisabled = bool
        sourceBackupLocation = "string"
        tablesToRestore = [
          "string"
        ]
      }
      virtualNetworkRules = [
        {
          id = "string"
          ignoreMissingVNetServiceEndpoint = bool
        }
      ]
    }
  })
}

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à

AnalyticalStorageConfiguration

ApiProperties

BackupPolicy

BackupPolicyMigrationState

Capacità

Capacità

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

ConsistencyPolicy

ContinuousModeBackupPolicy

ContinuousModeProperties

CorsPolicy

DatabaseAccountCreateUpdatePropertiesOrDatabaseAccountGetProperties

DatabaseRestoreResource

DiagnosticLogSettings

GremlinDatabaseRestoreResource

IpAddressOrRange

Ubicazione

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

Microsoft.DocumentDB/databaseAccounts

PeriodicModeBackupPolicy

PeriodicModeProperties

RestoreParameters

Tag

VirtualNetworkRule