Definição de recurso do Bicep
O tipo de recurso databaseAccounts/sqlDatabases pode ser implantado com operações direcionadas:
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Para criar um recurso Microsoft.DocumentDB/databaseAccounts/sqlDatabases, adicione o seguinte Bicep ao seu modelo.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2025-11-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'
}
}
Valores da propriedade
Microsoft.DocumentDB/databaseAccounts/sqlDatabases
| Nome |
Descrição |
Valor |
| identidade |
Identidade do recurso. |
ManagedServiceIdentity |
| local |
O local do grupo de recursos ao qual o recurso pertence. |
cadeia |
| nome |
O nome do recurso |
cadeia de caracteres (obrigatório) |
| pai |
No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.
Para obter mais informações, consulte recurso filho fora do recurso pai. |
Nome simbólico do recurso do tipo: databaseAccounts |
| Propriedades |
Propriedades para criar e atualizar o banco de dados SQL do Azure Cosmos DB. |
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (obrigatório) |
| Tags |
Marcas de recurso |
Dicionário de nomes e valores de marca. Consulte Marcas em modelos |
Configurações de dimensionamento automático
| Nome |
Descrição |
Valor |
| maxThroughput |
Representa a taxa de transferência máxima, o recurso pode ser escalado verticalmente. |
int |
Componentes1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
| Nome |
Descrição |
Valor |
| configurações de dimensionamento automático |
Especifica as configurações de Dimensionamento Automático. Observação: a taxa de transferência ou o dimensionamento automáticoSettings são necessários, mas não ambos. |
autoscaleSettings |
| taxa de transferência |
Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": 10000. |
int |
ManagedServiceIdentity
| Nome |
Descrição |
Valor |
| tipo |
O tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá as identidades do serviço. |
'Nenhum'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' |
| Identidades Atribuídas pelo Usuário |
A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
Parâmetros de restauração de recursos
| Nome |
Descrição |
Valor |
| fonte de restauração |
A ID da conta de banco de dados restaurável da qual a restauração deve ser iniciada. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
cadeia |
| restoreTimestampInUtc |
Tempo para o qual a conta precisa ser restaurada (formato ISO-8601). |
cadeia |
| restoreWithTtlDisabled |
Especifica se a conta restaurada terá o TempoTo-Live desabilitado após a restauração bem-sucedida. |
Bool |
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties
SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource
| Nome |
Descrição |
Valor |
| Modo de criação |
Enumerar para indicar o modo de criação de recursos. |
'Padrão'
'Restaurar' |
| id |
Nome do banco de dados SQL do Cosmos DB |
cadeia de caracteres (obrigatório) |
| restoreParameters |
Parâmetros para indicar as informações sobre a restauração |
ResourceRestoreParameters |
Exemplos de uso
Exemplos de Início Rápido do Azure
Os modelos de Início Rápido do Azure a seguir contêm exemplos de Bicep para implantar esse tipo de recurso.
Definição de recurso de modelo do ARM
O tipo de recurso databaseAccounts/sqlDatabases pode ser implantado com operações direcionadas:
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Para criar um recurso Microsoft.DocumentDB/databaseAccounts/sqlDatabases, adicione o JSON a seguir ao modelo.
{
"type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases",
"apiVersion": "2025-11-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"
}
}
Valores da propriedade
Microsoft.DocumentDB/databaseAccounts/sqlDatabases
| Nome |
Descrição |
Valor |
| apiVersion |
A versão da API |
'2025-11-01-preview' |
| identidade |
Identidade do recurso. |
ManagedServiceIdentity |
| local |
O local do grupo de recursos ao qual o recurso pertence. |
cadeia |
| nome |
O nome do recurso |
cadeia de caracteres (obrigatório) |
| Propriedades |
Propriedades para criar e atualizar o banco de dados SQL do Azure Cosmos DB. |
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (obrigatório) |
| Tags |
Marcas de recurso |
Dicionário de nomes e valores de marca. Consulte Marcas em modelos |
| tipo |
O tipo de recurso |
'Microsoft.DocumentDB/databaseAccounts/sqlDatabases' |
Configurações de dimensionamento automático
| Nome |
Descrição |
Valor |
| maxThroughput |
Representa a taxa de transferência máxima, o recurso pode ser escalado verticalmente. |
int |
Componentes1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
| Nome |
Descrição |
Valor |
| configurações de dimensionamento automático |
Especifica as configurações de Dimensionamento Automático. Observação: a taxa de transferência ou o dimensionamento automáticoSettings são necessários, mas não ambos. |
autoscaleSettings |
| taxa de transferência |
Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": 10000. |
int |
ManagedServiceIdentity
| Nome |
Descrição |
Valor |
| tipo |
O tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá as identidades do serviço. |
'Nenhum'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' |
| Identidades Atribuídas pelo Usuário |
A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
Parâmetros de restauração de recursos
| Nome |
Descrição |
Valor |
| fonte de restauração |
A ID da conta de banco de dados restaurável da qual a restauração deve ser iniciada. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
cadeia |
| restoreTimestampInUtc |
Tempo para o qual a conta precisa ser restaurada (formato ISO-8601). |
cadeia |
| restoreWithTtlDisabled |
Especifica se a conta restaurada terá o TempoTo-Live desabilitado após a restauração bem-sucedida. |
Bool |
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties
SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource
| Nome |
Descrição |
Valor |
| Modo de criação |
Enumerar para indicar o modo de criação de recursos. |
'Padrão'
'Restaurar' |
| id |
Nome do banco de dados SQL do Cosmos DB |
cadeia de caracteres (obrigatório) |
| restoreParameters |
Parâmetros para indicar as informações sobre a restauração |
ResourceRestoreParameters |
Exemplos de uso
Modelos de início rápido do Azure
Os modelos de Início Rápido do Azure a seguir implantar esse tipo de recurso.
O tipo de recurso databaseAccounts/sqlDatabases pode ser implantado com operações direcionadas:
Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.
Para criar um recurso Microsoft.DocumentDB/databaseAccounts/sqlDatabases, adicione o Terraform a seguir ao modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2025-11-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
}
}
}
}
}
Valores da propriedade
Microsoft.DocumentDB/databaseAccounts/sqlDatabases
| Nome |
Descrição |
Valor |
| identidade |
Identidade do recurso. |
ManagedServiceIdentity |
| local |
O local do grupo de recursos ao qual o recurso pertence. |
cadeia |
| nome |
O nome do recurso |
cadeia de caracteres (obrigatório) |
| parent_id |
A ID do recurso que é o pai desse recurso. |
ID do recurso do tipo: databaseAccounts |
| Propriedades |
Propriedades para criar e atualizar o banco de dados SQL do Azure Cosmos DB. |
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (obrigatório) |
| Tags |
Marcas de recurso |
Dicionário de nomes e valores de marca. |
| tipo |
O tipo de recurso |
"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2025-11-01-preview" |
Configurações de dimensionamento automático
| Nome |
Descrição |
Valor |
| maxThroughput |
Representa a taxa de transferência máxima, o recurso pode ser escalado verticalmente. |
int |
Componentes1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
| Nome |
Descrição |
Valor |
| configurações de dimensionamento automático |
Especifica as configurações de Dimensionamento Automático. Observação: a taxa de transferência ou o dimensionamento automáticoSettings são necessários, mas não ambos. |
autoscaleSettings |
| taxa de transferência |
Unidades de solicitação por segundo. Por exemplo, "taxa de transferência": 10000. |
int |
ManagedServiceIdentity
| Nome |
Descrição |
Valor |
| tipo |
O tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá as identidades do serviço. |
'Nenhum'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' |
| Identidades Atribuídas pelo Usuário |
A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
Parâmetros de restauração de recursos
| Nome |
Descrição |
Valor |
| fonte de restauração |
A ID da conta de banco de dados restaurável da qual a restauração deve ser iniciada. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
cadeia |
| restoreTimestampInUtc |
Tempo para o qual a conta precisa ser restaurada (formato ISO-8601). |
cadeia |
| restoreWithTtlDisabled |
Especifica se a conta restaurada terá o TempoTo-Live desabilitado após a restauração bem-sucedida. |
Bool |
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties
SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource
| Nome |
Descrição |
Valor |
| Modo de criação |
Enumerar para indicar o modo de criação de recursos. |
'Padrão'
'Restaurar' |
| id |
Nome do banco de dados SQL do Cosmos DB |
cadeia de caracteres (obrigatório) |
| restoreParameters |
Parâmetros para indicar as informações sobre a restauração |
ResourceRestoreParameters |
Exemplos de uso
Um exemplo básico de implantação do Banco de Dados SQL em uma conta do 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 = ["*"]
}
