База данных Microsoft.DocumentDBAccounts/sqlDatabases

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

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

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

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

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2026-04-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'
  }
}

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

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

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

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

ARMResourcePropertiesTags

Имя Описание Ценность

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

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

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

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

Управляемая служебная идентичность

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

ManagedServiceIdentityUserAssignedIdentities

Имя Описание Ценность

ManagedServiceIdentityUserAssignedIdentities

Имя Описание Ценность

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

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

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

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

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

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

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

Примеры 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-файл Описание
API SQL учетной записи Azure Cosmos DB с аналитическим хранилищем Этот шаблон создает учетную запись Azure Cosmos для API Core (SQL) с базой данных и контейнером, настроенным с помощью аналитического хранилища.
Создание учетной записи Azure Cosmos DB уровня "Бесплатный" Этот шаблон создает бесплатную учетную запись Azure Cosmos DB для API SQL с базой данных с общей пропускной способностью и контейнером.
создание учетной записи Azure Cosmos DB для API Core (SQL) Этот шаблон создает учетную запись Azure Cosmos для API Core (SQL) с базой данных и контейнером с пропускной способностью с несколькими другими параметрами.
создание API SQL учетной записи Azure Cosmos DB с автомасштабированием Этот шаблон создает учетную запись Azure Cosmos для API Core (SQL) с базой данных и контейнером с пропускной способностью автомасштабирования с несколькими другими параметрами.
Создание хранимых процедур API Azure Cosmos DB Core (SQL) Этот шаблон создает учетную запись Azure Cosmos DB для API Core (SQL) и контейнер с хранимой процедурой, триггером и определяемой пользователем функцией.
создает приложение микрослужб Dapr с помощью приложений контейнеров Создайте приложение микрослужб Dapr с помощью контейнерных приложений.
Создает приложение dapr pub-sub servicebus с помощью приложений контейнеров Создайте приложение dapr pub-sub servicebus с помощью контейнерных приложений.
Развертывание базы данных Azure Data Explorer с помощью подключения Cosmos DB Разверните базу данных Azure Data Explorer с подключением Cosmos DB.

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

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

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

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

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases",
  "apiVersion": "2026-04-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"
  }
}

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

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

Имя Описание Ценность
apiVersion Версия API «2026-04-01-превью»
тождество Удостоверение ресурса. ManagedServiceIdentity (Управляемый сервисИдентификация)
местоположение Расположение группы ресурсов, к которой принадлежит ресурс. струна
имя Имя ресурса строка (обязательно)
свойства Свойства для создания и обновления базы данных SQL Azure Cosmos DB. SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах
тип Тип ресурса "Microsoft.DocumentDB/databaseAccounts/sqlDatabases"

ARMResourcePropertiesTags

Имя Описание Ценность

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

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

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

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

Управляемая служебная идентичность

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

ManagedServiceIdentityUserAssignedIdentities

Имя Описание Ценность

ManagedServiceIdentityUserAssignedIdentities

Имя Описание Ценность

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

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

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

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

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

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

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

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

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

Шаблон Описание
API SQL учетной записи Azure Cosmos DB с аналитическим хранилищем

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

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

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

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

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

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

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

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

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

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

  • Группы ресурсов

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2026-04-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
        }
      }
    }
  }
}

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

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

Имя Описание Ценность
тождество Удостоверение ресурса. ManagedServiceIdentity (Управляемый сервисИдентификация)
местоположение Расположение группы ресурсов, к которой принадлежит ресурс. струна
имя Имя ресурса строка (обязательно)
идентификатор_родителя Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: databaseAccounts
свойства Свойства для создания и обновления базы данных SQL Azure Cosmos DB. SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов.
тип Тип ресурса «Microsoft. DocumentDB/databaseAccounts/sqlDatabases@2026-04-01-preview"

ARMResourcePropertiesTags

Имя Описание Ценность

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

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

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

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

Управляемая служебная идентичность

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

ManagedServiceIdentityUserAssignedIdentities

Имя Описание Ценность

ManagedServiceIdentityUserAssignedIdentities

Имя Описание Ценность

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

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

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

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

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

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

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

Примеры 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    = ["*"]
}