Bicep-resourcedefinitie
Het resourcetype databaseAccounts/sqlDatabases kan worden geïmplementeerd met bewerkingen die zijn gericht op:
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Als u een Resource Microsoft.DocumentDB/databaseAccounts/sqlDatabases wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2025-05-01-preview' = {
  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'
  }
}
Eigenschapswaarden
Microsoft.DocumentDB/databaseAccounts/sqlDatabases
Instellingen voor automatisch schalen
| Naam | 
Beschrijving | 
Waarde | 
| maximale doorvoer | 
Vertegenwoordigt de maximale doorvoer, de resource kan omhoog worden geschaald. | 
Int | 
Componenten1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
| Naam | 
Beschrijving | 
Waarde | 
| autoscale-instellingen | 
Hiermee geeft u de instellingen voor automatisch schalen. Opmerking: doorvoer of autoscaleSettings is vereist, maar niet beide. | 
              Instellingen voor automatisch schalen | 
| Doorvoer | 
Aanvraageenheden per seconde. Bijvoorbeeld 'doorvoer': 10000. | 
Int | 
Beheerde ServiceIdentity
| Naam | 
Beschrijving | 
Waarde | 
| soort | 
Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None worden alle identiteiten uit de service verwijderd. | 
'Geen' 'Systeem toegewezen' 'SystemAssigned, UserAssigned' UserAssigned | 
| gebruikers-toegewezen identiteiten | 
De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen voor de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. | 
              ManagedServiceIdentityUserAssignedIdentities | 
ManagedServiceIdentityUserAssignedIdentities
ResourceRestoreParameters
| Naam | 
Beschrijving | 
Waarde | 
| Bron herstellen | 
De id van het herstelbare databaseaccount van waaruit het herstel moet worden gestart. Bijvoorbeeld: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | 
snaar | 
| herstelTimestampInUtc | 
Tijd waarop het account moet worden hersteld (ISO-8601-indeling). | 
snaar | 
| restoreWithTtlDisabled | 
Hiermee geeft u op of het herstelde account tijd-To-Live uitgeschakeld bij het herstellen. | 
Bool | 
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties
SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource
| Naam | 
Beschrijving | 
Waarde | 
| createMode | 
Opsomming om de modus voor het maken van resources aan te geven. | 
'Standaard' 'Herstellen' | 
| legitimatiebewijs | 
Naam van de Cosmos DB SQL-database | 
tekenreeks (vereist) | 
| Parameters herstellen | 
Parameters om de informatie over de herstelbewerking aan te geven | 
              ResourceRestoreParameters | 
Gebruiksvoorbeelden
Azure-snelstartvoorbeelden
De volgende Azure-quickstartsjablonen bicep-voorbeelden bevatten voor het implementeren van dit resourcetype.
 
Resourcedefinitie van ARM-sjabloon
Het resourcetype databaseAccounts/sqlDatabases kan worden geïmplementeerd met bewerkingen die zijn gericht op:
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Als u een Resource Microsoft.DocumentDB/databaseAccounts/sqlDatabases wilt maken, voegt u de volgende JSON toe aan uw sjabloon.
{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases",
  "apiVersion": "2025-05-01-preview",
  "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"
  }
}
Eigenschapswaarden
Microsoft.DocumentDB/databaseAccounts/sqlDatabases
| Naam | 
Beschrijving | 
Waarde | 
| apiVersion | 
De API-versie | 
'2025-05-01-voorbeschouwing' | 
| identiteit | 
Identiteit voor de resource. | 
              ManagedServiceIdentity- | 
| plaats | 
De locatie van de resourcegroep waartoe de resource behoort. | 
snaar | 
| naam | 
De resourcenaam | 
tekenreeks (vereist) | 
| Eigenschappen | 
Eigenschappen voor het maken en bijwerken van een Azure Cosmos DB SQL-database. | 
              SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (vereist) | 
| Tags | 
Resourcetags | 
Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen | 
| soort | 
Het resourcetype | 
'Microsoft.DocumentDB/databaseAccounts/sqlDatabases' | 
Instellingen voor automatisch schalen
| Naam | 
Beschrijving | 
Waarde | 
| maximale doorvoer | 
Vertegenwoordigt de maximale doorvoer, de resource kan omhoog worden geschaald. | 
Int | 
Componenten1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
| Naam | 
Beschrijving | 
Waarde | 
| autoscale-instellingen | 
Hiermee geeft u de instellingen voor automatisch schalen. Opmerking: doorvoer of autoscaleSettings is vereist, maar niet beide. | 
              Instellingen voor automatisch schalen | 
| Doorvoer | 
Aanvraageenheden per seconde. Bijvoorbeeld 'doorvoer': 10000. | 
Int | 
Beheerde ServiceIdentity
| Naam | 
Beschrijving | 
Waarde | 
| soort | 
Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None worden alle identiteiten uit de service verwijderd. | 
'Geen' 'Systeem toegewezen' 'SystemAssigned, UserAssigned' UserAssigned | 
| gebruikers-toegewezen identiteiten | 
De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen voor de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. | 
              ManagedServiceIdentityUserAssignedIdentities | 
ManagedServiceIdentityUserAssignedIdentities
ResourceRestoreParameters
| Naam | 
Beschrijving | 
Waarde | 
| Bron herstellen | 
De id van het herstelbare databaseaccount van waaruit het herstel moet worden gestart. Bijvoorbeeld: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | 
snaar | 
| herstelTimestampInUtc | 
Tijd waarop het account moet worden hersteld (ISO-8601-indeling). | 
snaar | 
| restoreWithTtlDisabled | 
Hiermee geeft u op of het herstelde account tijd-To-Live uitgeschakeld bij het herstellen. | 
Bool | 
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties
SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource
| Naam | 
Beschrijving | 
Waarde | 
| createMode | 
Opsomming om de modus voor het maken van resources aan te geven. | 
'Standaard' 'Herstellen' | 
| legitimatiebewijs | 
Naam van de Cosmos DB SQL-database | 
tekenreeks (vereist) | 
| Parameters herstellen | 
Parameters om de informatie over de herstelbewerking aan te geven | 
              ResourceRestoreParameters | 
Gebruiksvoorbeelden
Azure-snelstartsjablonen
De volgende Azure-quickstartsjablonen dit resourcetype implementeren.
 
Het resourcetype databaseAccounts/sqlDatabases kan worden geïmplementeerd met bewerkingen die zijn gericht op:
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Als u een Resource Microsoft.DocumentDB/databaseAccounts/sqlDatabases wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.
resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2025-05-01-preview"
  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
        }
      }
    }
  }
}
Eigenschapswaarden
Microsoft.DocumentDB/databaseAccounts/sqlDatabases
| Naam | 
Beschrijving | 
Waarde | 
| identiteit | 
Identiteit voor de resource. | 
              ManagedServiceIdentity- | 
| plaats | 
De locatie van de resourcegroep waartoe de resource behoort. | 
snaar | 
| naam | 
De resourcenaam | 
tekenreeks (vereist) | 
| ouder_id | 
De id van de resource die het bovenliggende item voor deze resource is. | 
Id voor resource van het type: databaseAccounts | 
| Eigenschappen | 
Eigenschappen voor het maken en bijwerken van een Azure Cosmos DB SQL-database. | 
              SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (vereist) | 
| Tags | 
Resourcetags | 
Woordenlijst met tagnamen en -waarden. | 
| soort | 
Het resourcetype | 
"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2025-05-01-preview" | 
Instellingen voor automatisch schalen
| Naam | 
Beschrijving | 
Waarde | 
| maximale doorvoer | 
Vertegenwoordigt de maximale doorvoer, de resource kan omhoog worden geschaald. | 
Int | 
Componenten1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
| Naam | 
Beschrijving | 
Waarde | 
| autoscale-instellingen | 
Hiermee geeft u de instellingen voor automatisch schalen. Opmerking: doorvoer of autoscaleSettings is vereist, maar niet beide. | 
              Instellingen voor automatisch schalen | 
| Doorvoer | 
Aanvraageenheden per seconde. Bijvoorbeeld 'doorvoer': 10000. | 
Int | 
Beheerde ServiceIdentity
| Naam | 
Beschrijving | 
Waarde | 
| soort | 
Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een impliciet gemaakte identiteit als een set door de gebruiker toegewezen identiteiten. Met het type None worden alle identiteiten uit de service verwijderd. | 
'Geen' 'Systeem toegewezen' 'SystemAssigned, UserAssigned' UserAssigned | 
| gebruikers-toegewezen identiteiten | 
De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen voor de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. | 
              ManagedServiceIdentityUserAssignedIdentities | 
ManagedServiceIdentityUserAssignedIdentities
ResourceRestoreParameters
| Naam | 
Beschrijving | 
Waarde | 
| Bron herstellen | 
De id van het herstelbare databaseaccount van waaruit het herstel moet worden gestart. Bijvoorbeeld: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} | 
snaar | 
| herstelTimestampInUtc | 
Tijd waarop het account moet worden hersteld (ISO-8601-indeling). | 
snaar | 
| restoreWithTtlDisabled | 
Hiermee geeft u op of het herstelde account tijd-To-Live uitgeschakeld bij het herstellen. | 
Bool | 
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties
SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource
| Naam | 
Beschrijving | 
Waarde | 
| createMode | 
Opsomming om de modus voor het maken van resources aan te geven. | 
'Standaard' 'Herstellen' | 
| legitimatiebewijs | 
Naam van de Cosmos DB SQL-database | 
tekenreeks (vereist) | 
| Parameters herstellen | 
Parameters om de informatie over de herstelbewerking aan te geven | 
              ResourceRestoreParameters | 
Gebruiksvoorbeelden
Een eenvoudig voorbeeld van het implementeren van SQL Database binnen een Cosmos DB-account.
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    = ["*"]
}