Definição de recursos do bíceps
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 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 de propriedade
Microsoft.DocumentDB/databaseAccounts/sqlDatabases
| Designação |
Descrição |
Valor |
| identidade |
Identidade do recurso. |
ManagedServiceIdentity |
| localização |
O local do grupo de recursos ao qual o recurso pertence. |
cadeia (de caracteres) |
| Designação |
O nome do recurso |
string (obrigatório) |
| elemento principal |
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 para recurso do tipo: databaseAccounts |
| propriedades |
Propriedades para criar e atualizar o banco de dados SQL do Azure Cosmos DB. |
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (obrigatório) |
| Etiquetas |
Tags de recursos |
Dicionário de nomes e valores de tags. Consulte Tags em modelos |
AutoscaleSettings
| Designação |
Descrição |
Valor |
| maxTaxa de transferência |
Representa a taxa de transferência máxima, até a qual o recurso pode ser dimensionado. |
Int |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
| Designação |
Descrição |
Valor |
CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
| Designação |
Descrição |
Valor |
| autoscaleConfigurações |
Especifica as configurações de dimensionamento automático. Nota: A taxa de transferência ou autoscaleSettings é necessária, mas não ambas. |
AutoscaleSettings |
| débito |
Solicite unidades por segundo. Por exemplo, "taxa de transferência": 10000. |
Int |
ManagedServiceIdentity
| Designação |
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 'Nenhum' removerá todas as identidades do serviço. |
'Nenhuma' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
| identidades atribuídas pelo utilizador |
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 ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Designação |
Descrição |
Valor |
ResourceRestoreParameters
| Designação |
Descrição |
Valor |
| restaurarFonte |
A id da conta de banco de dados restaurável a partir da qual a restauração deve ser iniciada. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
cadeia (de caracteres) |
| restoreTimestampInUtc |
Tempo para o qual a conta tem de ser restaurada (formato ISO-8601). |
cadeia (de caracteres) |
| restoreWithTtlDisabled |
Especifica se a conta restaurada terá o Time-To-Live desabilitado após a restauração bem-sucedida. |
Bool |
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties
| Designação |
Descrição |
Valor |
| Opções |
Um par de opções chave-valor a ser aplicado para a solicitação. Isso corresponde aos cabeçalhos enviados com a solicitação. |
CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions |
| recurso |
O formato JSON padrão de um banco de dados SQL |
SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource (obrigatório) |
SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource
| Designação |
Descrição |
Valor |
| createMode |
Enum para indicar o modo de criação de recursos. |
'Inadimplência' 'Restaurar' |
| ID |
Nome do banco de dados SQL do Cosmos DB |
string (obrigatório) |
| restoreParameters |
Parâmetros para indicar as informações sobre a restauração |
ResourceRestoreParameters |
| Designação |
Descrição |
Valor |
Exemplos de uso
Exemplos de início rápido do Azure
Os seguintes modelos início rápido do Azure contêm exemplos de Bicep para implantar esse tipo de recurso.
Definição de recurso de modelo 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 log de alterações.
Para criar um recurso Microsoft.DocumentDB/databaseAccounts/sqlDatabases, adicione o seguinte JSON ao seu 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 de propriedade
Microsoft.DocumentDB/databaseAccounts/sqlDatabases
| Designação |
Descrição |
Valor |
| Versão da API |
A versão api |
'2025-11-01-pré-visualização' |
| identidade |
Identidade do recurso. |
ManagedServiceIdentity |
| localização |
O local do grupo de recursos ao qual o recurso pertence. |
cadeia (de caracteres) |
| Designação |
O nome do recurso |
string (obrigatório) |
| propriedades |
Propriedades para criar e atualizar o banco de dados SQL do Azure Cosmos DB. |
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (obrigatório) |
| Etiquetas |
Tags de recursos |
Dicionário de nomes e valores de tags. Consulte Tags em modelos |
| tipo |
O tipo de recurso |
'Microsoft.DocumentDB/databaseAccounts/sqlDatabases' |
AutoscaleSettings
| Designação |
Descrição |
Valor |
| maxTaxa de transferência |
Representa a taxa de transferência máxima, até a qual o recurso pode ser dimensionado. |
Int |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
| Designação |
Descrição |
Valor |
CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
| Designação |
Descrição |
Valor |
| autoscaleConfigurações |
Especifica as configurações de dimensionamento automático. Nota: A taxa de transferência ou autoscaleSettings é necessária, mas não ambas. |
AutoscaleSettings |
| débito |
Solicite unidades por segundo. Por exemplo, "taxa de transferência": 10000. |
Int |
ManagedServiceIdentity
| Designação |
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 'Nenhum' removerá todas as identidades do serviço. |
'Nenhuma' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
| identidades atribuídas pelo utilizador |
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 ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Designação |
Descrição |
Valor |
ResourceRestoreParameters
| Designação |
Descrição |
Valor |
| restaurarFonte |
A id da conta de banco de dados restaurável a partir da qual a restauração deve ser iniciada. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
cadeia (de caracteres) |
| restoreTimestampInUtc |
Tempo para o qual a conta tem de ser restaurada (formato ISO-8601). |
cadeia (de caracteres) |
| restoreWithTtlDisabled |
Especifica se a conta restaurada terá o Time-To-Live desabilitado após a restauração bem-sucedida. |
Bool |
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties
| Designação |
Descrição |
Valor |
| Opções |
Um par de opções chave-valor a ser aplicado para a solicitação. Isso corresponde aos cabeçalhos enviados com a solicitação. |
CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions |
| recurso |
O formato JSON padrão de um banco de dados SQL |
SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource (obrigatório) |
SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource
| Designação |
Descrição |
Valor |
| createMode |
Enum para indicar o modo de criação de recursos. |
'Inadimplência' 'Restaurar' |
| ID |
Nome do banco de dados SQL do Cosmos DB |
string (obrigatório) |
| restoreParameters |
Parâmetros para indicar as informações sobre a restauração |
ResourceRestoreParameters |
| Designação |
Descrição |
Valor |
Exemplos de uso
Modelos de início rápido do Azure
Os seguintes modelos de início rápido do Azure 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 log de alterações.
Para criar um recurso Microsoft.DocumentDB/databaseAccounts/sqlDatabases, adicione o seguinte Terraform ao seu 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 de propriedade
Microsoft.DocumentDB/databaseAccounts/sqlDatabases
| Designação |
Descrição |
Valor |
| identidade |
Identidade do recurso. |
ManagedServiceIdentity |
| localização |
O local do grupo de recursos ao qual o recurso pertence. |
cadeia (de caracteres) |
| Designação |
O nome do recurso |
string (obrigatório) |
| parent_id |
A ID do recurso que é o pai para este recurso. |
ID para recurso do tipo: databaseAccounts |
| propriedades |
Propriedades para criar e atualizar o banco de dados SQL do Azure Cosmos DB. |
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (obrigatório) |
| Etiquetas |
Tags de recursos |
Dicionário de nomes e valores de tags. |
| tipo |
O tipo de recurso |
"Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2025-11-01-preview" |
AutoscaleSettings
| Designação |
Descrição |
Valor |
| maxTaxa de transferência |
Representa a taxa de transferência máxima, até a qual o recurso pode ser dimensionado. |
Int |
Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties
| Designação |
Descrição |
Valor |
CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
| Designação |
Descrição |
Valor |
| autoscaleConfigurações |
Especifica as configurações de dimensionamento automático. Nota: A taxa de transferência ou autoscaleSettings é necessária, mas não ambas. |
AutoscaleSettings |
| débito |
Solicite unidades por segundo. Por exemplo, "taxa de transferência": 10000. |
Int |
ManagedServiceIdentity
| Designação |
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 'Nenhum' removerá todas as identidades do serviço. |
'Nenhuma' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
| identidades atribuídas pelo utilizador |
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 ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Designação |
Descrição |
Valor |
ResourceRestoreParameters
| Designação |
Descrição |
Valor |
| restaurarFonte |
A id da conta de banco de dados restaurável a partir da qual a restauração deve ser iniciada. Por exemplo: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
cadeia (de caracteres) |
| restoreTimestampInUtc |
Tempo para o qual a conta tem de ser restaurada (formato ISO-8601). |
cadeia (de caracteres) |
| restoreWithTtlDisabled |
Especifica se a conta restaurada terá o Time-To-Live desabilitado após a restauração bem-sucedida. |
Bool |
SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties
| Designação |
Descrição |
Valor |
| Opções |
Um par de opções chave-valor a ser aplicado para a solicitação. Isso corresponde aos cabeçalhos enviados com a solicitação. |
CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions |
| recurso |
O formato JSON padrão de um banco de dados SQL |
SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource (obrigatório) |
SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource
| Designação |
Descrição |
Valor |
| createMode |
Enum para indicar o modo de criação de recursos. |
'Inadimplência' 'Restaurar' |
| ID |
Nome do banco de dados SQL do Cosmos DB |
string (obrigatório) |
| restoreParameters |
Parâmetros para indicar as informações sobre a restauração |
ResourceRestoreParameters |
| Designação |
Descrição |
Valor |
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 = ["*"]
}