Condividi tramite


Microsoft.DocumentDB databaseAccounts/sqlDatabases 2025-04-15

Definizione di risorsa Bicep

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

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

Formato risorsa

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2025-04-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      createMode: 'string'
      id: 'string'
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
        restoreWithTtlDisabled: bool
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Valori delle proprietà

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

Nome Descrizione Valore
ubicazione Posizione del gruppo di risorse a cui appartiene la risorsa. corda
nome Nome della risorsa stringa (obbligatorio)
genitore In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre.

Per altre informazioni, vedere risorsa figlio all'esterno della risorsa padre.
Nome simbolico per la risorsa di tipo: databaseAccounts
proprietà Proprietà per creare e aggiornare il database SQL di Azure Cosmos DB. SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (obbligatorio)
etichette Tag delle risorse Dizionario di nomi e valori di tag. Vedere Tag nei modelli

Impostazioni di scalabilità automatica

Nome Descrizione Valore
maxThroughput Rappresenta la velocità effettiva massima, la risorsa può aumentare le prestazioni. Int

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Nome Descrizione Valore
autoscaleImpostazioni Specifica le impostazioni di scalabilità automatica. Nota: la velocità effettiva o la scalabilità automaticaImpostazioni è obbligatoria, ma non entrambe. impostazione di scalabilità automaticaImpostazioni di scalabilità automatica
Capacità di trasmissione Unità richiesta al secondo. Ad esempio, "velocità effettiva": 10000. Int

Parametri di ripristino delle risorse

Nome Descrizione Valore
ripristina ID dell'account di database ripristinabile da cui deve essere avviato il ripristino. Ad esempio: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} corda
restoreTimestampInUtc Ora di ripristino dell'account (formato ISO-8601). corda
restoreWithTtlDisabled Specifica se l'account ripristinato avrà time-To-Live disabilitato al termine del ripristino. Bool

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

Nome Descrizione Valore
Opzioni Coppia chiave-valore di opzioni da applicare per la richiesta. Corrisponde alle intestazioni inviate con la richiesta. CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
risorsa Formato JSON standard di un database SQL SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource (obbligatorio)

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Nome Descrizione Valore
createMode Enumerazione per indicare la modalità di creazione della risorsa. Impostazione predefinita
'Ripristina'
Id Nome del database SQL di Cosmos DB stringa (obbligatorio)
restoreParameters Parametri per indicare le informazioni sul ripristino Parametri di ripristino delle risorse

Etichette

Nome Descrizione Valore

Esempi di utilizzo

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 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.
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 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'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 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.
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.

Definizione di risorsa del modello di Resource Manager

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

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

Formato risorsa

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases",
  "apiVersion": "2025-04-15",
  "name": "string",
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "createMode": "string",
      "id": "string",
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string",
        "restoreWithTtlDisabled": "bool"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valori delle proprietà

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

Nome Descrizione Valore
versione dell'API Versione dell'API '2025-04-15'
ubicazione Posizione del gruppo di risorse a cui appartiene la risorsa. corda
nome Nome della risorsa stringa (obbligatorio)
proprietà Proprietà per creare e aggiornare il database SQL di Azure Cosmos DB. SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (obbligatorio)
etichette Tag delle risorse Dizionario di nomi e valori di tag. Vedere Tag nei modelli
tipo Tipo di risorsa 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases'

Impostazioni di scalabilità automatica

Nome Descrizione Valore
maxThroughput Rappresenta la velocità effettiva massima, la risorsa può aumentare le prestazioni. Int

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Nome Descrizione Valore
autoscaleImpostazioni Specifica le impostazioni di scalabilità automatica. Nota: la velocità effettiva o la scalabilità automaticaImpostazioni è obbligatoria, ma non entrambe. impostazione di scalabilità automaticaImpostazioni di scalabilità automatica
Capacità di trasmissione Unità richiesta al secondo. Ad esempio, "velocità effettiva": 10000. Int

Parametri di ripristino delle risorse

Nome Descrizione Valore
ripristina ID dell'account di database ripristinabile da cui deve essere avviato il ripristino. Ad esempio: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} corda
restoreTimestampInUtc Ora di ripristino dell'account (formato ISO-8601). corda
restoreWithTtlDisabled Specifica se l'account ripristinato avrà time-To-Live disabilitato al termine del ripristino. Bool

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

Nome Descrizione Valore
Opzioni Coppia chiave-valore di opzioni da applicare per la richiesta. Corrisponde alle intestazioni inviate con la richiesta. CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
risorsa Formato JSON standard di un database SQL SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource (obbligatorio)

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Nome Descrizione Valore
createMode Enumerazione per indicare la modalità di creazione della risorsa. Impostazione predefinita
'Ripristina'
Id Nome del database SQL di Cosmos DB stringa (obbligatorio)
restoreParameters Parametri per indicare le informazioni sul ripristino Parametri di ripristino delle risorse

Etichette

Nome Descrizione Valore

Esempi di utilizzo

Modelli di avvio rapido di Azure

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

Modello Descrizione
'API SQL dell'account Azure Cosmos DB con l'archivio analitico

Pubblica su 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 account Azure Cosmos DB di livello gratuito

Pubblica su Azure
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 per l'API Core (SQL)

Pubblica su 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.
Creare un'API SQL dell'account Azure Cosmos DB con scalabilità automatica

Pubblica su 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

Pubblica su 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.
Crea un'app di microservizi Dapr usando app contenitore

Pubblica su Azure
Creare un'app di microservizi Dapr usando App contenitore.
Crea un'app pub-sub-servicebus dapr usando app contenitore

Pubblica su Azure
Creare un'app pub-sub servicebus dapr usando App contenitore.
Distribuire Azure Data Explorer DB con la connessione di Cosmos DB

Pubblica su Azure
Distribuire Azure Data Explorer DB con la connessione Cosmos DB.

Definizione di risorsa Terraform (provider AzAPI)

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

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

Formato risorsa

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2025-04-15"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        createMode = "string"
        id = "string"
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
          restoreWithTtlDisabled = bool
        }
      }
    }
  }
}

Valori delle proprietà

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

Nome Descrizione Valore
ubicazione Posizione del gruppo di risorse a cui appartiene la risorsa. corda
nome Nome della risorsa stringa (obbligatorio)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: databaseAccounts
proprietà Proprietà per creare e aggiornare il database SQL di Azure Cosmos DB. SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (obbligatorio)
etichette Tag delle risorse Dizionario di nomi e valori di tag.
tipo Tipo di risorsa "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2025-04-15"

Impostazioni di scalabilità automatica

Nome Descrizione Valore
maxThroughput Rappresenta la velocità effettiva massima, la risorsa può aumentare le prestazioni. Int

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Nome Descrizione Valore
autoscaleImpostazioni Specifica le impostazioni di scalabilità automatica. Nota: la velocità effettiva o la scalabilità automaticaImpostazioni è obbligatoria, ma non entrambe. impostazione di scalabilità automaticaImpostazioni di scalabilità automatica
Capacità di trasmissione Unità richiesta al secondo. Ad esempio, "velocità effettiva": 10000. Int

Parametri di ripristino delle risorse

Nome Descrizione Valore
ripristina ID dell'account di database ripristinabile da cui deve essere avviato il ripristino. Ad esempio: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} corda
restoreTimestampInUtc Ora di ripristino dell'account (formato ISO-8601). corda
restoreWithTtlDisabled Specifica se l'account ripristinato avrà time-To-Live disabilitato al termine del ripristino. Bool

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

Nome Descrizione Valore
Opzioni Coppia chiave-valore di opzioni da applicare per la richiesta. Corrisponde alle intestazioni inviate con la richiesta. CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
risorsa Formato JSON standard di un database SQL SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource (obbligatorio)

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Nome Descrizione Valore
createMode Enumerazione per indicare la modalità di creazione della risorsa. Impostazione predefinita
'Ripristina'
Id Nome del database SQL di Cosmos DB stringa (obbligatorio)
restoreParameters Parametri per indicare le informazioni sul ripristino Parametri di ripristino delle risorse

Etichette

Nome Descrizione Valore

Esempi di utilizzo

Esempi di Terraform

Esempio di base di distribuzione del database SQL all'interno di un account Cosmos DB.

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    = ["*"]
}

resource "azapi_resource" "sqlDatabase" {
  type      = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-10-15"
  parent_id = azapi_resource.databaseAccount.id
  name      = var.resource_name
  body = {
    properties = {
      options = {
        throughput = 400
      }
      resource = {
        id = var.resource_name
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}