Microsoft. DocumentDB databaseAccounts/sqlDatabases 2026-03-15

Définition de ressource Bicep

Le type de ressource databaseAccounts/sqlDatabases peut être déployé avec des opérations qui ciblent :

  • Resource groups - Voir c1resource groups

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Exemples d’utilisation

Exemples de Bicep

Exemple de base de déploiement de SQL Database dans un compte Cosmos DB.

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

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

resource sqlDatabase 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-10-15' = {
  name: resourceName
  parent: databaseAccount
  properties: {
    options: {
      throughput: 400
    }
    resource: {
      id: resourceName
    }
  }
}

Exemples de démarrage rapide Azure

Les modèles de démarrage rapide Azure suivants contiennent des exemples Bicep pour le déploiement de ce type de ressource.

Lime biceps Description
API SQL Azure Cosmos DB compte avec stockage analytique Ce modèle crée un compte Azure Cosmos pour l’API Core (SQL) avec une base de données et un conteneur configurés avec un stockage analytique.
Créez un compte Azure Cosmos DB de niveau gratuit Ce modèle crée un compte Azure Cosmos DB de niveau gratuit pour l’API SQL avec une base de données à débit partagé et conteneur.
Créez un compte Azure Cosmos DB pour l’API Core (SQL Ce modèle crée un compte Azure Cosmos pour l’API Core (SQL) avec une base de données et un conteneur avec débit et plusieurs autres options.
Créez une API SQL de compte Azure Cosmos DB avec autoscale Ce modèle crée un compte Azure Cosmos pour l’API Core (SQL) avec une base de données et un conteneur avec débit autoscale et plusieurs autres options.
0 Ce modèle crée un compte Azure Cosmos DB pour l’API Core (SQL) ainsi qu’un conteneur avec une procédure stockée, un déclencheur et une fonction définie par l’utilisateur.
Crée une application de microservices Dapr à l’aide de Container Apps Créez une application de microservices Dapr à l’aide de Container Apps.
Crée une application de bus de service pub-sub Dapr en utilisant des applications conteneur Créez une application Dapr pub-sub servicebus à l’aide de Container Apps.
Déployer Azure Data Explorer base de données avec connexion Cosmos DB Déployez Azure Data Explorer DB avec une connexion Cosmos DB.

Format de ressource

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/sqlDatabases, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2026-03-15' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  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'
  }
}

Valeurs de la propriété

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

Name Description Valeur
identity Identité de la ressource. ManagedServiceIdentity
location Emplacement du groupe de ressources auquel appartient la ressource. string
nom Nom de la ressource chaîne (obligatoire)
parent Dans Bicep, vous pouvez spécifier la ressource parente d’une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente.

Pour plus d’informations, voir Ressource enfant externe pour les parents.
Nom symbolique de la ressource de type : databaseAccounts
Propriétés Propriétés permettant de créer et de mettre à jour une base de données SQL Azure Cosmos DB. SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (obligatoire)
tags Étiquettes de ressources Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

ARMResourcePropriétéTags

Name Description Valeur

Mise à l’échelle automatique

Name Description Valeur
maxThroughput Représente le débit maximal, la ressource peut effectuer un scale-up. int

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Name Description Valeur
autoscaleParamètres Spécifie les paramètres de mise à l’échelle automatique. Remarque : Le débit ou la mise à l’échelle automatiqueSettings est requis, mais pas les deux. de mise à l’échelle automatique
débit Unités de requête par seconde. Par exemple, « débit » : 1 0000. int

ManagedServiceIdentity

Name Description Valeur
type Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service. « Aucun »
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ». ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Description Valeur

ManagedServiceIdentityUserAssignedIdentities

Name Description Valeur

ResourceRestoreParameters

Name Description Valeur
restoreSource ID du compte de base de données pouvant être restauré à partir duquel la restauration doit être lancée. Par exemple : /subscriptions/{subscriptionId}/providers/Microsoft. DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Heure à laquelle le compte doit être restauré (format ISO-8601). string
restoreWithTtlDisabled Spécifie si le compte restauré aura le délai d'To-Live désactivé lors de la restauration réussie. bool

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

Name Description Valeur
options Paire clé-valeur d’options à appliquer pour la requête. Cela correspond aux en-têtes envoyés avec la requête. CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
resource Format JSON standard d’une base de données SQL SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource (obligatoire)

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Name Description Valeur
createMode Énumération pour indiquer le mode de création de compte. 'Default'
« Restaurer »
pièce d'identité Nom de la base de données SQL Cosmos DB chaîne (obligatoire)
restoreParameters Paramètres pour indiquer les informations relatives à la restauration ResourceRestoreParameters

Définition de ressource de modèle ARM

Le type de ressource databaseAccounts/sqlDatabases peut être déployé avec des opérations qui ciblent :

Exemples d’utilisation

modèles de démarrage rapide Azure

Les modèles de démarrage rapide Azure suivants déployer ce type de ressource.

Modèle Description
API SQL Azure Cosmos DB compte avec stockage analytique

Déployer sur Azure
Ce modèle crée un compte Azure Cosmos pour l’API Core (SQL) avec une base de données et un conteneur configurés avec un stockage analytique.
Créez un compte Azure Cosmos DB de niveau gratuit

Déployer sur Azure
Ce modèle crée un compte Azure Cosmos DB de niveau gratuit pour l’API SQL avec une base de données à débit partagé et conteneur.
Créez un compte Azure Cosmos DB pour l’API Core (SQL

Déployer sur Azure
Ce modèle crée un compte Azure Cosmos pour l’API Core (SQL) avec une base de données et un conteneur avec débit et plusieurs autres options.
Créez une API SQL de compte Azure Cosmos DB avec autoscale

Déployer sur Azure
Ce modèle crée un compte Azure Cosmos pour l’API Core (SQL) avec une base de données et un conteneur avec débit autoscale et plusieurs autres options.
0

Déployer sur Azure
Ce modèle crée un compte Azure Cosmos DB pour l’API Core (SQL) ainsi qu’un conteneur avec une procédure stockée, un déclencheur et une fonction définie par l’utilisateur.
Crée une application de microservices Dapr à l’aide de Container Apps

Déployer sur Azure
Créez une application de microservices Dapr à l’aide de Container Apps.
Crée une application de bus de service pub-sub Dapr en utilisant des applications conteneur

Déployer sur Azure
Créez une application Dapr pub-sub servicebus à l’aide de Container Apps.
Déployer Azure Data Explorer base de données avec connexion Cosmos DB

Déployer sur Azure
Déployez Azure Data Explorer DB avec une connexion Cosmos DB.

Format de ressource

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/sqlDatabases, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases",
  "apiVersion": "2026-03-15",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "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"
  }
}

Valeurs de la propriété

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

Name Description Valeur
apiVersion Version de l’API '2026-03-15'
identity Identité de la ressource. ManagedServiceIdentity
location Emplacement du groupe de ressources auquel appartient la ressource. string
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés permettant de créer et de mettre à jour une base de données SQL Azure Cosmos DB. SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (obligatoire)
tags Étiquettes de ressources Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type Type de ressource 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases'

ARMResourcePropriétéTags

Name Description Valeur

Mise à l’échelle automatique

Name Description Valeur
maxThroughput Représente le débit maximal, la ressource peut effectuer un scale-up. int

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Name Description Valeur
autoscaleParamètres Spécifie les paramètres de mise à l’échelle automatique. Remarque : Le débit ou la mise à l’échelle automatiqueSettings est requis, mais pas les deux. de mise à l’échelle automatique
débit Unités de requête par seconde. Par exemple, « débit » : 1 0000. int

ManagedServiceIdentity

Name Description Valeur
type Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service. « Aucun »
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ». ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Description Valeur

ManagedServiceIdentityUserAssignedIdentities

Name Description Valeur

ResourceRestoreParameters

Name Description Valeur
restoreSource ID du compte de base de données pouvant être restauré à partir duquel la restauration doit être lancée. Par exemple : /subscriptions/{subscriptionId}/providers/Microsoft. DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Heure à laquelle le compte doit être restauré (format ISO-8601). string
restoreWithTtlDisabled Spécifie si le compte restauré aura le délai d'To-Live désactivé lors de la restauration réussie. bool

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

Name Description Valeur
options Paire clé-valeur d’options à appliquer pour la requête. Cela correspond aux en-têtes envoyés avec la requête. CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
resource Format JSON standard d’une base de données SQL SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource (obligatoire)

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Name Description Valeur
createMode Énumération pour indiquer le mode de création de compte. 'Default'
« Restaurer »
pièce d'identité Nom de la base de données SQL Cosmos DB chaîne (obligatoire)
restoreParameters Paramètres pour indiquer les informations relatives à la restauration ResourceRestoreParameters

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource databaseAccounts/sqlDatabases peut être déployé avec des opérations qui ciblent :

  • Groupes de ressources Pour une liste des propriétés modifiées dans chaque version d’API, voir journal des modifications.

Exemples d’utilisation

Échantillons Terraform

Exemple de base de déploiement de SQL Database dans un compte 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    = ["*"]
}

Format de ressource

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/sqlDatabases, ajoutez la terraform suivante à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2026-03-15"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "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
        }
      }
    }
  }
}

Valeurs de la propriété

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

Name Description Valeur
identity Identité de la ressource. ManagedServiceIdentity
location Emplacement du groupe de ressources auquel appartient la ressource. string
nom Nom de la ressource chaîne (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID de ressource de type : databaseAccounts
Propriétés Propriétés permettant de créer et de mettre à jour une base de données SQL Azure Cosmos DB. SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (obligatoire)
tags Étiquettes de ressources Dictionnaire de noms et de valeurs d’étiquettes.
type Type de ressource « Microsoft. DocumentDB/comptesBasede de données/sqlDatabases@2026-03-15"

ARMResourcePropriétéTags

Name Description Valeur

Mise à l’échelle automatique

Name Description Valeur
maxThroughput Représente le débit maximal, la ressource peut effectuer un scale-up. int

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Name Description Valeur
autoscaleParamètres Spécifie les paramètres de mise à l’échelle automatique. Remarque : Le débit ou la mise à l’échelle automatiqueSettings est requis, mais pas les deux. de mise à l’échelle automatique
débit Unités de requête par seconde. Par exemple, « débit » : 1 0000. int

ManagedServiceIdentity

Name Description Valeur
type Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service. « Aucun »
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ». ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Description Valeur

ManagedServiceIdentityUserAssignedIdentities

Name Description Valeur

ResourceRestoreParameters

Name Description Valeur
restoreSource ID du compte de base de données pouvant être restauré à partir duquel la restauration doit être lancée. Par exemple : /subscriptions/{subscriptionId}/providers/Microsoft. DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Heure à laquelle le compte doit être restauré (format ISO-8601). string
restoreWithTtlDisabled Spécifie si le compte restauré aura le délai d'To-Live désactivé lors de la restauration réussie. bool

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

Name Description Valeur
options Paire clé-valeur d’options à appliquer pour la requête. Cela correspond aux en-têtes envoyés avec la requête. CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
resource Format JSON standard d’une base de données SQL SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource (obligatoire)

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Name Description Valeur
createMode Énumération pour indiquer le mode de création de compte. 'Default'
« Restaurer »
pièce d'identité Nom de la base de données SQL Cosmos DB chaîne (obligatoire)
restoreParameters Paramètres pour indiquer les informations relatives à la restauration ResourceRestoreParameters