Microsoft. DatabaseAccounts/sqlDatabases 2026-03-15

Определение ресурсов Bicep

Тип ресурса databaseAccounts/sqlDatabases можно развернуть с помощью операций, предназначенных для следующих операций:

Для получения списка изменённых свойств в каждой версии API см. журнал изменений.

Примеры использования

Примеры Bicep

Простой пример развертывания базы данных SQL в учетной записи 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
    }
  }
}

Примеры быстрого запуска Azure

Следующие шаблоны быстрого запуска Azure содержат примеры Bicep для развертывания этого типа ресурса.

Файл Bicep Description
Azure Cosmos DB аккаунт SQL API с аналитическим хранилищем Этот шаблон создаёт API Azure Cosmos для Core (SQL) с базой данных и контейнером, настроенными с аналитическим хранилищем.
Создание учетной записи Azure Cosmos DB бесплатного уровня Этот шаблон создаёт бесплатную учетную запись Azure Cosmos DB для SQL API с базой данных с общей пропускной способностью и контейнером.
Создать учетную запись Azure Cosmos DB для Core (SQL) API Этот шаблон создаёт аккаунт Azure Cosmos для Core (SQL) API с базой данных и контейнером с пропускной способностью и множеством других опций.
Создайте SQL API Azure Cosmos DB аккаунта с автомасштабированием Этот шаблон создаёт API Azure Cosmos для Core (SQL) с базой данных и контейнером с автомасштабированием пропускной способности и множеством других опций.
Create Azure Cosmos DB Core (SQL) API хранимых процедур Этот шаблон создаёт учетную запись Azure Cosmos DB для Core (SQL) API и контейнер с сохраненной процедурой, триггером и пользовательской функцией.
создает приложение микрослужб Dapr с помощью приложений контейнеров Создайте приложение микрослужб Dapr с помощью контейнерных приложений.
Создает приложение Dapr pub-sub servicebus с использованием Container Apps Создайте приложение dapr pub-sub servicebus с помощью контейнерных приложений.
Развернуть Azure Data Explorer базу данных с подключением к Cosmos DB Развернуть Azure Data Explorer DB с подключением к Cosmos DB.

Формат ресурса

Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts/sqlDatabases, добавьте следующий Bicep в шаблон.

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

Значения свойств

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

Name Description Ценность
identity Удостоверение ресурса. ManagedServiceIdentity (Управляемый сервисИдентификация)
Расположение Расположение группы ресурсов, к которой принадлежит ресурс. string
name имя ресурса. строка (обязательно)
parent В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса.

Для получения дополнительной информации см. ресурс для детей вне родителей.
Символьное имя ресурса типа: databaseAccounts
properties Свойства для создания и обновления базы данных SQL Azure Cosmos DB. SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (обязательно)
tags Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах

ARMResourcePropertiesTags

Name Description Ценность

АвтомасштабированиеSettings

Name Description Ценность
maxПропускная способность Представляет максимальную пропускную способность, ресурс может масштабироваться до. int

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Name Description Ценность
autoscaleSettings Задает параметры автомасштабирования. Примечание. Требуется либо пропускная способность, либо автомасштабированиеSettings, но не оба. АвтомасштабированиеSettings
пропускная способность Единицы запроса в секунду. Например, "пропускная способность": 10000. int

ManagedServiceIdentity

Name Description Ценность
type Тип удостоверения, используемого для ресурса. Тип SystemAssigned,UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" удаляет все удостоверения из службы. "Нет"
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned
userAssignedIdentities Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Description Ценность

ManagedServiceIdentityUserAssignedIdentities

Name Description Ценность

ResourceRestoreParameters (Параметры восстановления)

Name Description Ценность
restoreSource Идентификатор учетной записи базы данных, из которой необходимо инициировать восстановление. Например: /subscriptions/{subscriptionId}/providers/Microsoft. DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Время восстановления учетной записи (формат ISO-8601). string
restoreWithTtlDisabled Указывает, будет ли восстановленная учетная запись иметь время-To-Live отключена при успешном восстановлении. bool

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

Name Description Ценность
options Пара параметров с ключом-значением, применяемая для запроса. Это соответствует заголовкам, отправленным запросом. CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
resource Стандартный формат JSON базы данных SQL SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource (обязательно)

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Name Description Ценность
createMode Перечисление, указывающее режим создания учетной записи. 'Default'
"Восстановить"
id Имя базы данных SQL Cosmos DB строка (обязательно)
restoreParameters Параметры для указания сведений о восстановлении ResourceRestoreParameters (Параметры восстановления)

Определение ресурса ARM-шаблона

Тип ресурса databaseAccounts/sqlDatabases можно развернуть с помощью операций, предназначенных для следующих операций:

Примеры использования

Шаблоны быстрого запуска Azure

Следующие шаблоны быстрого запуска Azure развернуть этот тип ресурса.

Template Description
Azure Cosmos DB аккаунт SQL API с аналитическим хранилищем

Развертывание в Azure
Этот шаблон создаёт API Azure Cosmos для Core (SQL) с базой данных и контейнером, настроенными с аналитическим хранилищем.
Создание учетной записи Azure Cosmos DB бесплатного уровня

Развертывание в Azure
Этот шаблон создаёт бесплатную учетную запись Azure Cosmos DB для SQL API с базой данных с общей пропускной способностью и контейнером.
Создать учетную запись Azure Cosmos DB для Core (SQL) API

Развертывание в Azure
Этот шаблон создаёт аккаунт Azure Cosmos для Core (SQL) API с базой данных и контейнером с пропускной способностью и множеством других опций.
Создайте SQL API Azure Cosmos DB аккаунта с автомасштабированием

Развертывание в Azure
Этот шаблон создаёт API Azure Cosmos для Core (SQL) с базой данных и контейнером с автомасштабированием пропускной способности и множеством других опций.
Create Azure Cosmos DB Core (SQL) API хранимых процедур

Развертывание в Azure
Этот шаблон создаёт учетную запись Azure Cosmos DB для Core (SQL) API и контейнер с сохраненной процедурой, триггером и пользовательской функцией.
создает приложение микрослужб Dapr с помощью приложений контейнеров

Развертывание в Azure
Создайте приложение микрослужб Dapr с помощью контейнерных приложений.
Создает приложение Dapr pub-sub servicebus с использованием Container Apps

Развертывание в Azure
Создайте приложение dapr pub-sub servicebus с помощью контейнерных приложений.
Развернуть Azure Data Explorer базу данных с подключением к Cosmos DB

Развертывание в Azure
Развернуть Azure Data Explorer DB с подключением к Cosmos DB.

Формат ресурса

Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts/sqlDatabases, добавьте следующий код JSON в шаблон.

{
  "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"
  }
}

Значения свойств

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

Name Description Ценность
apiVersion Версия API '2026-03-15'
identity Удостоверение ресурса. ManagedServiceIdentity (Управляемый сервисИдентификация)
Расположение Расположение группы ресурсов, к которой принадлежит ресурс. string
name имя ресурса. строка (обязательно)
properties Свойства для создания и обновления базы данных SQL Azure Cosmos DB. SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (обязательно)
tags Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах
type Тип ресурса "Microsoft.DocumentDB/databaseAccounts/sqlDatabases"

ARMResourcePropertiesTags

Name Description Ценность

АвтомасштабированиеSettings

Name Description Ценность
maxПропускная способность Представляет максимальную пропускную способность, ресурс может масштабироваться до. int

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Name Description Ценность
autoscaleSettings Задает параметры автомасштабирования. Примечание. Требуется либо пропускная способность, либо автомасштабированиеSettings, но не оба. АвтомасштабированиеSettings
пропускная способность Единицы запроса в секунду. Например, "пропускная способность": 10000. int

ManagedServiceIdentity

Name Description Ценность
type Тип удостоверения, используемого для ресурса. Тип SystemAssigned,UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" удаляет все удостоверения из службы. "Нет"
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned
userAssignedIdentities Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Description Ценность

ManagedServiceIdentityUserAssignedIdentities

Name Description Ценность

ResourceRestoreParameters (Параметры восстановления)

Name Description Ценность
restoreSource Идентификатор учетной записи базы данных, из которой необходимо инициировать восстановление. Например: /subscriptions/{subscriptionId}/providers/Microsoft. DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Время восстановления учетной записи (формат ISO-8601). string
restoreWithTtlDisabled Указывает, будет ли восстановленная учетная запись иметь время-To-Live отключена при успешном восстановлении. bool

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

Name Description Ценность
options Пара параметров с ключом-значением, применяемая для запроса. Это соответствует заголовкам, отправленным запросом. CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
resource Стандартный формат JSON базы данных SQL SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource (обязательно)

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Name Description Ценность
createMode Перечисление, указывающее режим создания учетной записи. 'Default'
"Восстановить"
id Имя базы данных SQL Cosmos DB строка (обязательно)
restoreParameters Параметры для указания сведений о восстановлении ResourceRestoreParameters (Параметры восстановления)

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса databaseAccounts/sqlDatabases можно развернуть с помощью операций, предназначенных для следующих операций:

Примеры использования

Примеры Terraform

Простой пример развертывания базы данных SQL в учетной записи 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    = ["*"]
}

Формат ресурса

Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts/sqlDatabases, добавьте следующий объект Terraform в шаблон.

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
        }
      }
    }
  }
}

Значения свойств

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

Name Description Ценность
identity Удостоверение ресурса. ManagedServiceIdentity (Управляемый сервисИдентификация)
Расположение Расположение группы ресурсов, к которой принадлежит ресурс. string
name имя ресурса. строка (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: databaseAccounts
properties Свойства для создания и обновления базы данных SQL Azure Cosmos DB. SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (обязательно)
tags Теги ресурсов Словарь имен и значений тегов.
type Тип ресурса «Microsoft. DocumentDB/databaseAccounts/sqlDatabases@2026-03-15"

ARMResourcePropertiesTags

Name Description Ценность

АвтомасштабированиеSettings

Name Description Ценность
maxПропускная способность Представляет максимальную пропускную способность, ресурс может масштабироваться до. int

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

Name Description Ценность
autoscaleSettings Задает параметры автомасштабирования. Примечание. Требуется либо пропускная способность, либо автомасштабированиеSettings, но не оба. АвтомасштабированиеSettings
пропускная способность Единицы запроса в секунду. Например, "пропускная способность": 10000. int

ManagedServiceIdentity

Name Description Ценность
type Тип удостоверения, используемого для ресурса. Тип SystemAssigned,UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" удаляет все удостоверения из службы. "Нет"
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned
userAssignedIdentities Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Description Ценность

ManagedServiceIdentityUserAssignedIdentities

Name Description Ценность

ResourceRestoreParameters (Параметры восстановления)

Name Description Ценность
restoreSource Идентификатор учетной записи базы данных, из которой необходимо инициировать восстановление. Например: /subscriptions/{subscriptionId}/providers/Microsoft. DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} string
restoreTimestampInUtc Время восстановления учетной записи (формат ISO-8601). string
restoreWithTtlDisabled Указывает, будет ли восстановленная учетная запись иметь время-To-Live отключена при успешном восстановлении. bool

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

Name Description Ценность
options Пара параметров с ключом-значением, применяемая для запроса. Это соответствует заголовкам, отправленным запросом. CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
resource Стандартный формат JSON базы данных SQL SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource (обязательно)

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

Name Description Ценность
createMode Перечисление, указывающее режим создания учетной записи. 'Default'
"Восстановить"
id Имя базы данных SQL Cosmos DB строка (обязательно)
restoreParameters Параметры для указания сведений о восстановлении ResourceRestoreParameters (Параметры восстановления)