你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.DocumentDB databaseAccounts/sqlDatabases 2022-11-15-preview

• 最新
• 2024-12-01-preview
• 2024-11-15
• 2024-09-01-preview
• 2024-08-15
• 2024-05-15
• 2024-05-15-preview
• 2024-02-15-preview
• 2023-11-15
• 2023-11-15-preview
• 2023-09-15
• 2023-09-15-preview
• 2023-04-15
• 2023-03-15
• 2023-03-15-preview
• 2023-03-01-preview
• 2022-11-15
• 2022-11-15-preview
• 2022-08-15
• 2022-08-15-preview
• 2022-05-15
• 2022-05-15-preview
• 2022-02-15-preview
• 2021-11-15-preview
• 2021-10-15
• 2021-10-15-preview
• 2021-07-01-preview
• 2021-06-15
• 2021-05-15
• 2021-04-15
• 2021-04-01-preview
• 2021-03-15
• 2021-03-01-preview
• 2021-01-15
• 2020-09-01
• 2020-06-01-preview
• 2020-04-01
• 2020-03-01
• 2019-12-12
• 2019-08-01

Bicep 资源定义

可以使用目标操作部署 databaseAccounts/sqlDatabases 资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts/sqlDatabases 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2022-11-15-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'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

AutoscaleSettings

名字	描述	价值
maxThroughput	表示最大吞吐量，资源可以纵向扩展。	int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

名字	描述	价值

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

名字	描述	价值
autoscaleSettings	指定自动缩放设置。	AutoscaleSettings
吞吐量	每秒请求单位数。 例如，“throughput”：10000。	int

ManagedServiceIdentity

名字	描述	价值
类型	用于资源的标识类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。	“None” “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned”
userAssignedIdentities	与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名字	描述	价值

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

名字	描述	价值
身份	资源的标识。	ManagedServiceIdentity
位置	资源所属的资源组的位置。	字符串
名字	资源名称	string （必需）
父母	在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源外部的子资源。	类型资源的符号名称：databaseAccounts
性能	用于创建和更新 Azure Cosmos DB SQL 数据库的属性。	SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties（必需）
标签	资源标记	标记名称和值的字典。 请参阅模板 中的 标记

ResourceRestoreParameters

名字	描述	价值
restoreSource	必须从中启动还原的可还原数据库帐户的 ID。 例如：/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}	字符串
restoreTimestampInUtc	帐户必须还原到的时间（ISO-8601 格式）。	字符串

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

名字	描述	价值
选项	要为请求应用的选项的键值对。 这对应于随请求一起发送的标头。	CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
资源	SQL 数据库的标准 JSON 格式	SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource（必需）

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

名字	描述	价值
createMode	用于指示资源创建模式的枚举。	“Default” “还原”
id	Cosmos DB SQL 数据库的名称	string （必需）
restoreParameters	指示有关还原的信息的参数	ResourceRestoreParameters

标签

名字	描述	价值

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件	描述
使用分析存储 Azure Cosmos DB 帐户 SQL API	此模板为 Core （SQL） API 创建一个 Azure Cosmos 帐户，其中包含配置了分析存储的数据库和容器。
创建免费层 Azure Cosmos DB 帐户	此模板使用具有共享吞吐量和容器的数据库为 SQL API 创建免费层 Azure Cosmos DB 帐户。
为 Core （SQL） API 创建 Azure Cosmos DB 帐户	此模板创建一个 Azure Cosmos 帐户，用于 Core （SQL） API，其中包含具有多个其他选项的吞吐量的数据库和容器。
使用自动缩放 创建 Azure Cosmos DB 帐户 SQL API	此模板为 Core （SQL） API 创建一个 Azure Cosmos 帐户，该帐户包含具有多个其他选项的自动缩放吞吐量的数据库和容器。
创建 Azure Cosmos DB Core （SQL） API 存储过程	此模板创建一个用于 Core （SQL） API 的 Azure Cosmos DB 帐户，以及一个包含存储过程、触发器和用户定义的函数的容器。
使用容器应用创建 Dapr 微服务应用	使用容器应用创建 Dapr 微服务应用。
使用容器应用创建 Dapr pub-sub servicebus 应用	使用容器应用创建 Dapr pub-sub servicebus 应用。
使用 Cosmos DB 连接部署 Azure 数据资源管理器 DB	使用 Cosmos DB 连接部署 Azure 数据资源管理器 DB。

ARM 模板资源定义

可以使用目标操作部署 databaseAccounts/sqlDatabases 资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts/sqlDatabases 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases",
  "apiVersion": "2022-11-15-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"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

AutoscaleSettings

名字	描述	价值
maxThroughput	表示最大吞吐量，资源可以纵向扩展。	int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

名字	描述	价值

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

名字	描述	价值
autoscaleSettings	指定自动缩放设置。	AutoscaleSettings
吞吐量	每秒请求单位数。 例如，“throughput”：10000。	int

ManagedServiceIdentity

名字	描述	价值
类型	用于资源的标识类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。	“None” “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned”
userAssignedIdentities	与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名字	描述	价值

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

名字	描述	价值
apiVersion	API 版本	'2022-11-15-preview'
身份	资源的标识。	ManagedServiceIdentity
位置	资源所属的资源组的位置。	字符串
名字	资源名称	string （必需）
性能	用于创建和更新 Azure Cosmos DB SQL 数据库的属性。	SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties（必需）
标签	资源标记	标记名称和值的字典。 请参阅模板 中的 标记
类型	资源类型	“Microsoft.DocumentDB/databaseAccounts/sqlDatabases”

ResourceRestoreParameters

名字	描述	价值
restoreSource	必须从中启动还原的可还原数据库帐户的 ID。 例如：/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}	字符串
restoreTimestampInUtc	帐户必须还原到的时间（ISO-8601 格式）。	字符串

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

名字	描述	价值
选项	要为请求应用的选项的键值对。 这对应于随请求一起发送的标头。	CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
资源	SQL 数据库的标准 JSON 格式	SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource（必需）

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

名字	描述	价值
createMode	用于指示资源创建模式的枚举。	“Default” “还原”
id	Cosmos DB SQL 数据库的名称	string （必需）
restoreParameters	指示有关还原的信息的参数	ResourceRestoreParameters

标签

名字	描述	价值

快速入门模板

以下快速入门模板部署此资源类型。

模板	描述
使用分析存储 Azure Cosmos DB 帐户 SQL API	此模板为 Core （SQL） API 创建一个 Azure Cosmos 帐户，其中包含配置了分析存储的数据库和容器。
创建免费层 Azure Cosmos DB 帐户	此模板使用具有共享吞吐量和容器的数据库为 SQL API 创建免费层 Azure Cosmos DB 帐户。
为 Core （SQL） API 创建 Azure Cosmos DB 帐户	此模板创建一个 Azure Cosmos 帐户，用于 Core （SQL） API，其中包含具有多个其他选项的吞吐量的数据库和容器。
使用自动缩放 创建 Azure Cosmos DB 帐户 SQL API	此模板为 Core （SQL） API 创建一个 Azure Cosmos 帐户，该帐户包含具有多个其他选项的自动缩放吞吐量的数据库和容器。
创建 Azure Cosmos DB Core （SQL） API 存储过程	此模板创建一个用于 Core （SQL） API 的 Azure Cosmos DB 帐户，以及一个包含存储过程、触发器和用户定义的函数的容器。
使用容器应用创建 Dapr 微服务应用	使用容器应用创建 Dapr 微服务应用。
使用容器应用创建 Dapr pub-sub servicebus 应用	使用容器应用创建 Dapr pub-sub servicebus 应用。
使用 Cosmos DB 连接部署 Azure 数据资源管理器 DB	使用 Cosmos DB 连接部署 Azure 数据资源管理器 DB。

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署 databaseAccounts/sqlDatabases 资源类型：

• 资源组

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts/sqlDatabases 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2022-11-15-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        createMode = "string"
        id = "string"
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
        }
      }
    }
  })
}

属性值

AutoscaleSettings

名字	描述	价值
maxThroughput	表示最大吞吐量，资源可以纵向扩展。	int

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

名字	描述	价值

CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions

名字	描述	价值
autoscaleSettings	指定自动缩放设置。	AutoscaleSettings
吞吐量	每秒请求单位数。 例如，“throughput”：10000。	int

ManagedServiceIdentity

名字	描述	价值
类型	用于资源的标识类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。	“None” “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned”
userAssignedIdentities	与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名字	描述	价值

Microsoft.DocumentDB/databaseAccounts/sqlDatabases

名字	描述	价值
身份	资源的标识。	ManagedServiceIdentity
位置	资源所属的资源组的位置。	字符串
名字	资源名称	string （必需）
parent_id	此资源的父资源的 ID。	类型资源的 ID：databaseAccounts
性能	用于创建和更新 Azure Cosmos DB SQL 数据库的属性。	SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties（必需）
标签	资源标记	标记名称和值的字典。
类型	资源类型	“Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2022-11-15-preview”

ResourceRestoreParameters

名字	描述	价值
restoreSource	必须从中启动还原的可还原数据库帐户的 ID。 例如：/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}	字符串
restoreTimestampInUtc	帐户必须还原到的时间（ISO-8601 格式）。	字符串

SqlDatabaseCreateUpdatePropertiesOrSqlDatabaseGetProperties

名字	描述	价值
选项	要为请求应用的选项的键值对。 这对应于随请求一起发送的标头。	CreateUpdateOptionsOrSqlDatabaseGetPropertiesOptions
资源	SQL 数据库的标准 JSON 格式	SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource（必需）

SqlDatabaseResourceOrSqlDatabaseGetPropertiesResource

名字	描述	价值
createMode	用于指示资源创建模式的枚举。	“Default” “还原”
id	Cosmos DB SQL 数据库的名称	string （必需）
restoreParameters	指示有关还原的信息的参数	ResourceRestoreParameters

标签

名字	描述	价值