通过

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

Microsoft.Sql server/databases 2014-04-01

  • 项目

Bicep 资源定义

可以使用针对以下操作部署服务器/数据库资源类型：

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

资源格式

若要创建 Microsoft.Sql/servers/databases 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Sql/servers/databases@2014-04-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    collation: 'string'
    createMode: 'string'
    edition: 'string'
    elasticPoolName: 'string'
    maxSizeBytes: 'string'
    readScale: 'string'
    recoveryServicesRecoveryPointResourceId: 'string'
    requestedServiceObjectiveId: 'string'
    requestedServiceObjectiveName: 'string'
    restorePointInTime: 'string'
    sampleName: 'AdventureWorksLT'
    sourceDatabaseDeletionDate: 'string'
    sourceDatabaseId: 'string'
    zoneRedundant: bool
  }
}

属性值

servers/databases

名称 说明 值
name 资源名称

了解如何在 Bicep 中为子资源设置名称和类型。		 字符串 (必需)

字符限制：1-128

有效字符：
不得使用：
<>*%&:\/? 或控制字符

不得以句点或空格结尾。
location 资源位置。 字符串 (必需)
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
父级 (parent) 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。

有关详细信息，请参阅 父资源之外的子资源。		 类型为“服务器”的资源的符号名称
properties 表示资源的属性。 DatabaseProperties

DatabaseProperties

名称 说明 值
collation 数据库的排序规则。 如果 createMode 不是 Default，则忽略此值。 字符串
createMode 指定数据库创建模式。

默认值：常规数据库创建。

复制：将数据库创建为现有数据库的副本。 sourceDatabaseId 必须指定为源数据库的资源 ID。

OnlineSecondary/NonReadableSecondary：将数据库创建为现有数据库的 (可读或不可读) 辅助副本 (replica) 。 sourceDatabaseId 必须指定为现有主数据库的资源 ID。

PointInTimeRestore：通过还原现有数据库的时间点备份来创建数据库。 sourceDatabaseId 必须指定为现有数据库的资源 ID，并且必须指定 restorePointInTime。

恢复：通过还原异地复制的备份来创建数据库。 sourceDatabaseId 必须指定为要还原的可恢复数据库资源 ID。

还原：通过还原已删除数据库的备份来创建数据库。 必须指定 sourceDatabaseId。 如果 sourceDatabaseId 是数据库的原始资源 ID，则必须指定 sourceDatabaseDeletionDate。 否则，sourceDatabaseId 必须是可还原的已删除数据库资源 ID，并且 sourceDatabaseDeletionDate 将被忽略。 还可以指定 restorePointInTime 从较早的时间点还原。

RestoreLongTermRetentionBackup：通过从长期保留保管库还原来创建数据库。 recoveryServicesRecoveryPointResourceId 必须指定为恢复点资源 ID。

DataWarehouse 版本不支持 Copy、NonReadableSecondary、OnlineSecondary 和 RestoreLongTermRetentionBackup。		 “Copy”
'Default'
“NonReadableSecondary”
“OnlineSecondary”
“PointInTimeRestore”
“恢复”
“还原”
“RestoreLongTermRetentionBackup”
edition 数据库的版本。 DatabaseEditions 枚举包含所有有效版本。 如果 createMode 为 NonReadableSecondary 或 OnlineSecondary，则忽略此值。

SKU 列表可能因区域和支持产品/服务而异。 若要确定 SKU (包括 AZURE 区域中订阅可用的 SKU 名称、层/版本、系列和容量) ，请使用 Capabilities_ListByLocation REST API 或以下命令之一：

Azure CLI：
az sql db list-editions -l {location} -o table



Azure PowerShell：
Get-AzSqlServerServiceObjective -Location {location}

 “Basic”
“Business”
“BusinessCritical”
“DataWarehouse”
“免费”
“GeneralPurpose”
“超大规模”
“Premium”
“PremiumRS”
“Standard”
“Stretch”
“System”
“System2”
“Web”
elasticPoolName 数据库所位于的弹性池的名称。 如果 elasticPoolName 和 requestedServiceObjectiveName 都更新，则忽略 requestedServiceObjectiveName 的值。 DataWarehouse 版本不支持。 字符串
maxSizeBytes 以字节表示的数据库的最大大小。 如果 createMode 不是 Default，则忽略此值。 若要查看可能的值，请查询 operationId 引用的功能 API (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities) ：“Capabilities_ListByLocation”。 字符串
readScale 条件。 如果数据库是异地辅助数据库，readScale 指示是否允许此数据库的只读连接。 DataWarehouse 版本不支持。 “Disabled”
“已启用”
recoveryServicesRecoveryPointResourceId 条件。 如果 createMode 为 RestoreLongTermRetentionBackup，则此值是必需的。 指定要从其还原的恢复点的资源 ID。 字符串
requestedServiceObjectiveId 数据库的已配置服务级别目标 ID。 这是正在应用于数据库的服务级别目标。 成功更新后，它将匹配 currentServiceObjectiveId 属性的值。 如果 requestedServiceObjectiveId 和 requestedServiceObjectiveName 都已更新，则 requestedServiceObjectiveId 的值将替代 requestedServiceObjectiveName 的值。

SKU 列表可能因区域和支持产品/服务而异。 若要确定 Azure 区域中订阅可用的服务目标 ID，请使用 Capabilities_ListByLocation REST API。		 字符串

约束：
最小长度 = 36
最大长度 = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
requestedServiceObjectiveName 数据库的已配置服务级别目标的名称。 这是正在应用于数据库的服务级别目标。 成功更新后，它将匹配 serviceLevelObjective 属性的值。

SKU 列表可能因区域和支持产品/服务而异。 若要确定 SKU (包括 AZURE 区域中订阅可用的 SKU 名称、层/版本、系列和容量) ，请使用 Capabilities_ListByLocation REST API 或以下命令之一：

Azure CLI：
az sql db list-editions -l {location} -o table



Azure PowerShell：
Get-AzSqlServerServiceObjective -Location {location}

 “Basic”
“DS100”
“DS1000”
“DS1200”
“DS1500”
“DS200”
“DS2000”
“DS300”
“DS400”
“DS500”
“DS600”
“DW100”
“DW1000”
“DW10000c”
“DW1000c”
“DW1200”
“DW1500”
“DW15000c”
“DW1500c”
“DW200”
“DW2000”
“DW2000c”
“DW2500c”
“DW300”
“DW3000”
“DW30000c”
“DW3000c”
“DW400”
“DW500”
“DW5000c”
“DW600”
“DW6000”
“DW6000c”
“DW7500c”
“ElasticPool”
“免费”
“P1”
“P11”
“P15”
“P2”
“P3”
“P4”
“P6”
“PRS1”
“PRS2”
“PRS4”
“PRS6”
'S0'
'S1'
'S12'
'S2'
'S3'
'S4'
'S6'
'S7'
'S9'
“System”
“System0”
“System1”
“System2”
“System2L”
“System3”
“System3L”
“System4”
“System4L”
restorePointInTime 条件。 如果 createMode 为 PointInTimeRestore，则此值是必需的。 如果 createMode 为 Restore，则此值是可选的。 指定要还原以创建新数据库的源数据库的时间点 (ISO8601 格式) 。 必须大于或等于源数据库的最早RestoreDate 值。 字符串
sampleName 指示创建此数据库时要应用的示例架构的名称。 如果 createMode 不是 Default，则忽略此值。 DataWarehouse 版本不支持。 “AdventureWorksLT”
sourceDatabaseDeletionDate 条件。 如果 createMode 为 Restore，而 sourceDatabaseId 是已删除数据库 (的原始资源 ID，而不是) 当前可还原的已删除数据库 ID，则此值是必需的。 指定删除数据库的时间。 字符串
sourceDatabaseId 条件。 如果 createMode 为 Copy、NonReadableSecondary、OnlineSecondary、PointInTimeRestore、Recovery 或 Restore，则此值是必需的。 指定源数据库的资源 ID。 如果 createMode 为 NonReadableSecondary 或 OnlineSecondary，则源数据库的名称必须与正在创建的新数据库相同。 字符串
zoneRedundant 此数据库是否为区域冗余，这意味着此数据库的副本将分布在多个可用性区域。 bool

快速入门模板

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

模板 说明
将 Django 应用与 SQL 数据库配合使用

部署到 Azure		 此模板使用 Azure Linux CustomScript 扩展来部署应用程序。 此示例创建一个 Ubuntu VM，执行 Python、Django 和 Apache 的无提示安装，然后创建一个简单的 Django 应用。 该模板还创建一个SQL 数据库，其中包含一个示例表，其中包含一些示例数据，这些数据使用查询显示在 Web 浏览器中
Azure 中的 EPiserverCMS

部署到 Azure		 此模板允许在 Azure 中创建 EpiServerCMS 部署所需的资源
使用 Azure SQL 数据库自动缩放 LANSA Windows VM 规模集

部署到 Azure		 该模板部署一个 Windows VMSS，其中包含规模集中的所需 VM 数，以及要安装到每个 VM 中的 LANSA MSI。 部署 VM 规模集后，将使用自定义脚本扩展安装 LANSA MSI)
部署 Octopus 使用试用许可证部署 3.0

部署到 Azure		 此模板允许你使用试用许可证部署单个 Octopus Deploy 3.0 服务器。 这会部署在单个 Windows Server 2012R2 VM (Standard D2) 和 SQL DB (S1 层) 到为资源组指定的位置。
Orchard CMS 视频门户 Web 应用

部署到 Azure		 此模板提供了一种在启用和配置 Azure 媒体服务模块的情况下，在 Azure 应用服务 Web 应用 上部署 Orchard CMS 的简单方法。
可缩放的 Umbraco CMS Web 应用

部署到 Azure		 此模板提供了一种在 Azure 应用服务 Web 应用 上部署 umbraco CMS Web 应用的简单方法。
简单的 Umbraco CMS Web 应用

部署到 Azure		 此模板提供了一种在 Azure 应用服务 Web 应用 上部署 umbraco CMS Web 应用的简单方法。
企业治理 - AppService、SQL DB、AD、OMS、Runbook

部署到 Azure		 企业云采用（无论大小）都需要负责任且高效的治理模型才能从其云部署中获取价值。 CloudWise (解决方案) 的代号，是 Azure 合作伙伴快速入门中提供的复合解决方案，是客户、系统集成商和合作伙伴的采用支持者，可提供可自助的自动化治理和运营解决方案，重点是优化成本、提高应用程序 () 可靠性、降低业务风险。 该解决方案突出了可见性和控制的核心治理支柱。
使用 ILB ASE 的 eShop 网站

部署到 Azure		 应用服务环境是 Azure 应用服务的一项高级服务计划选项，可提供完全隔离的专用环境来安全地大规模运行 Azure 应用服务应用，包括 Web 应用、移动应用和 API 应用。
使用Azure SQL专用终结点的 Web 应用

部署到 Azure		 此模板演示如何创建使用指向 Azure SQL 服务器的专用终结点的 Web 应用
具有高可用性的远程桌面服务

部署到 Azure		 此 ARM 模板示例代码将部署具有高可用性的 远程桌面服务 2019 会话集合 实验室。 目标是使用 Windows Server 2019 为远程桌面服务部署完全冗余、高度可用的解决方案。
在 Azure 上部署体育分析体系结构

部署到 Azure		 创建启用了 ADLS Gen 2 的 Azure 存储帐户，创建一个Azure 数据工厂实例，其中包含存储帐户的链接服务 (Azure SQL数据库（如果已部署) ），以及一个 Azure Databricks 实例。 将为部署模板的用户的 AAD 标识和 ADF 实例的托管标识授予存储帐户上的存储 Blob 数据参与者角色。 还有一些选项可用于部署 Azure 密钥保管库 实例、Azure SQL数据库和 Azure 事件中心 (，用于流式处理用例) 。 部署 Azure 密钥保管库时，将为部署模板的用户授予数据工厂托管标识和 AAD 标识密钥保管库机密用户角色。
具有 SQL 数据库 的 Web 应用、Azure Cosmos DB、Azure 搜索

部署到 Azure		 此模板预配 Web 应用、SQL 数据库、Azure Cosmos DB、Azure 搜索和 Application Insights。
使用 Azure DMS 迁移到Azure SQL数据库

部署到 Azure		 Azure 数据库迁移服务 (DMS) 旨在简化将本地数据库迁移到 Azure 的过程。 DMS 将简化将现有本地SQL Server和 Oracle 数据库迁移到 Azure 虚拟机中Azure SQL数据库、Azure SQL 托管实例或 Microsoft SQL Server。 此模板将部署 Azure 数据库迁移服务的实例、一个安装了 SQL Server 的 Azure VM，该 VM 将充当其上具有预创建数据库的源服务器，以及一个目标Azure SQL数据库服务器，该服务器将具有要从源服务器迁移到目标服务器的数据库的预创建架构。 该模板还将部署支持源 VM、DMS 服务和目标服务器所需的资源，例如 NIC、vnet 等。
在 VNET 中使用自定义 Ambari + Hive 元存储 DB 的 HDInsight

部署到 Azure		 此模板允许在现有虚拟网络中创建 HDInsight 群集，其中包含同时充当自定义 Ambari DB 和 Hive 元存储的新 SQL 数据库。 必须具有现有的 SQL Sever、存储帐户和 VNET。
部署 HDInsight 群集和 SQL 数据库

部署到 Azure		 使用此模板可以创建 HDInsight 群集和用于测试 Sqoop 的SQL 数据库。
专用终结点示例

部署到 Azure		 此模板演示如何创建指向 Azure SQL 服务器的专用终结点
将审核写入事件中心的Azure SQL服务器

部署到 Azure		 此模板允许部署启用了审核的Azure SQL服务器，以便将审核日志写入事件中心
将审核写入 Log Analytics 的Azure SQL服务器

部署到 Azure		 此模板允许部署启用了审核的Azure SQL服务器，以便将审核日志写入 Log Analytics (OMS 工作区)
具有透明加密的专用 SQL 池

部署到 Azure		 (以前使用透明数据加密的 SQL DW) 创建SQL Server和专用 SQL 池。
创建SQL Server和数据库

部署到 Azure		 此模板允许你创建 SQL 数据库 和 服务器。
使用 TDE 预配SQL 数据库

部署到 Azure		 此模板预配一个SQL Server，其中为 Azure 流量打开了防火墙，以及一个具有透明数据加密 (TDE) 的 SQL 数据库。
部署新的 SQL 弹性池

部署到 Azure		 通过此模板，可以部署一个新的 SQL 弹性池，其中包含新的关联SQL Server和要分配给它的新 SQL 数据库。
使用故障转移组创建Azure SQL服务器和数据库

部署到 Azure		 创建两个Azure SQL服务器、一个数据库和一个故障转移组。
使用Azure SQL后端应用服务环境

部署到 Azure		 此模板创建一个应用服务环境，其中包含Azure SQL后端、专用终结点以及通常在专用/隔离环境中使用的关联资源。
使用SQL 数据库预配移动应用

部署到 Azure		 此模板预配移动应用、SQL 数据库和通知中心。 它在移动应用中为数据库和通知中心配置连接字符串。
具有托管标识、SQL Server和 ΑΙ 的 Web 应用

部署到 Azure		 为应用 + 数据 + 托管标识 + 监视部署 Azure 基础结构的简单示例
使用模板创建 Web 应用 + Redis 缓存 + SQL DB

部署到 Azure		 此模板使用 Redis 缓存和SQL 数据库创建 Azure Web 应用。
使用SQL 数据库预配 Web 应用

部署到 Azure		 此模板预配 Web 应用、SQL 数据库、自动缩放设置、警报规则和 App Insights。 它在 Web 应用中为数据库配置连接字符串。
创建、配置 Web 应用程序并将其部署到 Azure VM

部署到 Azure		 使用 SQL Azure 数据库创建和配置 Windows VM，并使用 PowerShell DSC 将 Web 应用程序部署到环境
具有 Azure SQL 的 Linux 上的 Sonarqube Docker Web 应用

部署到 Azure		 此模板使用官方 Sonarqube 映像在 Azure 应用服务 Web 应用 Linux 容器中部署 Sonarqube，并由 Azure SQL 服务器提供支持。

ARM 模板资源定义

可以使用针对以下操作部署服务器/数据库资源类型：

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

资源格式

若要创建 Microsoft.Sql/servers/databases 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Sql/servers/databases",
  "apiVersion": "2014-04-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "collation": "string",
    "createMode": "string",
    "edition": "string",
    "elasticPoolName": "string",
    "maxSizeBytes": "string",
    "readScale": "string",
    "recoveryServicesRecoveryPointResourceId": "string",
    "requestedServiceObjectiveId": "string",
    "requestedServiceObjectiveName": "string",
    "restorePointInTime": "string",
    "sampleName": "AdventureWorksLT",
    "sourceDatabaseDeletionDate": "string",
    "sourceDatabaseId": "string",
    "zoneRedundant": "bool"
  }
}

属性值

servers/databases

名称 说明 Value
type 资源类型 “Microsoft.Sql/servers/databases”
apiVersion 资源 API 版本 '2014-04-01'
name 资源名称

了解如何在 JSON ARM 模板中为子资源设置名称和类型。		 字符串 (必需)

字符限制：1-128

有效字符：
不得使用：
<>*%&:\/? 或控制字符

不得以句点或空格结尾。
location 资源位置。 字符串 (必需)
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
properties 表示资源的属性。 DatabaseProperties

DatabaseProperties

名称 说明 值
collation 数据库的排序规则。 如果 createMode 不是 Default，则忽略此值。 字符串
createMode 指定数据库创建模式。

默认值：常规数据库创建。

复制：将数据库创建为现有数据库的副本。 sourceDatabaseId 必须指定为源数据库的资源 ID。

OnlineSecondary/NonReadableSecondary：将数据库创建为现有数据库的 (可读或不可读) 辅助副本 (replica) 。 sourceDatabaseId 必须指定为现有主数据库的资源 ID。

PointInTimeRestore：通过还原现有数据库的时间点备份来创建数据库。 sourceDatabaseId 必须指定为现有数据库的资源 ID，并且必须指定 restorePointInTime。

恢复：通过还原异地复制的备份来创建数据库。 sourceDatabaseId 必须指定为要还原的可恢复数据库资源 ID。

还原：通过还原已删除数据库的备份来创建数据库。 必须指定 sourceDatabaseId。 如果 sourceDatabaseId 是数据库的原始资源 ID，则必须指定 sourceDatabaseDeletionDate。 否则，sourceDatabaseId 必须是可还原的已删除数据库资源 ID，并且 sourceDatabaseDeletionDate 将被忽略。 还可以指定 restorePointInTime 从较早的时间点还原。

RestoreLongTermRetentionBackup：通过从长期保留保管库还原来创建数据库。 recoveryServicesRecoveryPointResourceId 必须指定为恢复点资源 ID。

DataWarehouse 版本不支持 Copy、NonReadableSecondary、OnlineSecondary 和 RestoreLongTermRetentionBackup。		 “Copy”
'Default'
“NonReadableSecondary”
“OnlineSecondary”
“PointInTimeRestore”
“恢复”
“还原”
“RestoreLongTermRetentionBackup”
edition 数据库的版本。 DatabaseEditions 枚举包含所有有效版本。 如果 createMode 为 NonReadableSecondary 或 OnlineSecondary，则忽略此值。

SKU 列表可能因区域和支持产品/服务而异。 若要确定 SKU (包括 AZURE 区域中订阅可用的 SKU 名称、层/版本、系列和容量) ，请使用 Capabilities_ListByLocation REST API 或以下命令之一：

Azure CLI：
az sql db list-editions -l {location} -o table



Azure PowerShell：
Get-AzSqlServerServiceObjective -Location {location}

 “Basic”
“Business”
“BusinessCritical”
“DataWarehouse”
“免费”
“GeneralPurpose”
“超大规模”
“Premium”
“PremiumRS”
“Standard”
“Stretch”
“System”
“System2”
“Web”
elasticPoolName 数据库所位于的弹性池的名称。 如果 elasticPoolName 和 requestedServiceObjectiveName 都更新，则忽略 requestedServiceObjectiveName 的值。 DataWarehouse 版本不支持。 字符串
maxSizeBytes 以字节表示的数据库的最大大小。 如果 createMode 不是 Default，则忽略此值。 若要查看可能的值，请查询 operationId 引用的功能 API (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities) ：“Capabilities_ListByLocation”。 字符串
readScale 条件。 如果数据库是异地辅助数据库，readScale 指示是否允许此数据库的只读连接。 DataWarehouse 版本不支持。 “Disabled”
“已启用”
recoveryServicesRecoveryPointResourceId 条件。 如果 createMode 为 RestoreLongTermRetentionBackup，则此值是必需的。 指定要从其还原的恢复点的资源 ID。 字符串
requestedServiceObjectiveId 数据库的已配置服务级别目标 ID。 这是正在应用于数据库的服务级别目标。 成功更新后，它将匹配 currentServiceObjectiveId 属性的值。 如果 requestedServiceObjectiveId 和 requestedServiceObjectiveName 都已更新，则 requestedServiceObjectiveId 的值将替代 requestedServiceObjectiveName 的值。

SKU 列表可能因区域和支持产品/服务而异。 若要确定 Azure 区域中订阅可用的服务目标 ID，请使用 Capabilities_ListByLocation REST API。		 字符串

约束：
最小长度 = 36
最大长度 = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
requestedServiceObjectiveName 数据库的已配置服务级别目标的名称。 这是正在应用于数据库的服务级别目标。 成功更新后，它将匹配 serviceLevelObjective 属性的值。

SKU 列表可能因区域和支持产品/服务而异。 若要确定 SKU (包括 AZURE 区域中订阅可用的 SKU 名称、层/版本、系列和容量) ，请使用 Capabilities_ListByLocation REST API 或以下命令之一：

Azure CLI：
az sql db list-editions -l {location} -o table



Azure PowerShell：
Get-AzSqlServerServiceObjective -Location {location}

 “Basic”
“DS100”
“DS1000”
“DS1200”
“DS1500”
“DS200”
“DS2000”
“DS300”
“DS400”
“DS500”
“DS600”
“DW100”
“DW1000”
“DW10000c”
“DW1000c”
“DW1200”
“DW1500”
“DW15000c”
“DW1500c”
“DW200”
“DW2000”
“DW2000c”
“DW2500c”
“DW300”
“DW3000”
“DW30000c”
“DW3000c”
“DW400”
“DW500”
“DW5000c”
“DW600”
“DW6000”
“DW6000c”
“DW7500c”
“ElasticPool”
“免费”
“P1”
“P11”
“P15”
“P2”
“P3”
“P4”
“P6”
“PRS1”
“PRS2”
“PRS4”
“PRS6”
“S0”
“S1”
“S12”
“S2”
“S3”
“S4”
“S6”
“S7”
'S9'
“System”
“System0”
“System1”
“System2”
“System2L”
“System3”
“System3L”
“System4”
“System4L”
restorePointInTime 条件。 如果 createMode 为 PointInTimeRestore，则此值是必需的。 如果 createMode 为 Restore，则此值是可选的。 指定要还原以创建新数据库的源数据库的时间点 (ISO8601 格式) 。 必须大于或等于源数据库的 earliestRestoreDate 值。 字符串
sampleName 指示创建此数据库时要应用的示例架构的名称。 如果 createMode 不是 Default，则忽略此值。 DataWarehouse 版本不支持。 “AdventureWorksLT”
sourceDatabaseDeletionDate 条件。 如果 createMode 为 Restore，而 sourceDatabaseId 是已删除数据库 (的原始资源 ID，而不是其当前可还原的已删除数据库 ID) ，则此值是必需的。 指定数据库被删除的时间。 字符串
sourceDatabaseId 条件。 如果 createMode 为 Copy、NonReadableSecondary、OnlineSecondary、PointInTimeRestore、Recovery 或 Restore，则此值是必需的。 指定源数据库的资源 ID。 如果 createMode 是 NonReadableSecondary 或 OnlineSecondary，则源数据库的名称必须与正在创建新数据库的名称相同。 字符串
zoneRedundant 此数据库是否为区域冗余，这意味着此数据库的副本将分布在多个可用性区域。 bool

快速入门模板

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

模板 说明
包含 SQL 数据库的 Django 应用

部署到 Azure		 此模板使用 Azure Linux CustomScript 扩展来部署应用程序。 此示例创建一个 Ubuntu VM，执行 Python、Django 和 Apache 的无提示安装，然后创建一个简单的 Django 应用。 该模板还创建一个SQL 数据库，其中包含一个示例表，其中包含一些示例数据，这些数据使用查询显示在 Web 浏览器中
Azure 中的 EPiserverCMS

部署到 Azure		 此模板允许在 Azure 中创建 EpiServerCMS 部署所需的资源
使用 Azure SQL 数据库自动缩放 LANSA Windows VM 规模集

部署到 Azure		 该模板部署一个 Windows VMSS，其中包含规模集中的所需 VM 数，以及要安装到每个 VM 中的 LANSA MSI。 部署 VM 规模集后，将使用自定义脚本扩展安装 LANSA MSI)
部署 Octopus 使用试用许可证部署 3.0

部署到 Azure		 此模板允许你使用试用许可证部署单个 Octopus Deploy 3.0 服务器。 这会部署在单个 Windows Server 2012R2 VM (Standard D2) 和 SQL DB (S1 层) 到为资源组指定的位置。
Orchard CMS 视频门户 Web 应用

部署到 Azure		 此模板提供了一种在启用和配置 Azure 媒体服务模块的情况下，在 Azure 应用服务 Web 应用 上部署 Orchard CMS 的简单方法。
可缩放的 Umbraco CMS Web 应用

部署到 Azure		 此模板提供了一种在 Azure 应用服务 Web 应用 上部署 umbraco CMS Web 应用的简单方法。
简单的 Umbraco CMS Web 应用

部署到 Azure		 此模板提供了一种在 Azure 应用服务 Web 应用 上部署 umbraco CMS Web 应用的简单方法。
企业治理 - AppService、SQL DB、AD、OMS、Runbook

部署到 Azure		 企业云采用（无论大小）都需要负责任且高效的治理模型才能从其云部署中获取价值。 CloudWise (解决方案) 的代号，是 Azure 合作伙伴快速入门中提供的复合解决方案，是客户、系统集成商和合作伙伴的采用支持者，可提供可自助的自动化治理和运营解决方案，重点是优化成本、提高应用程序 () 可靠性、降低业务风险。 该解决方案突出了可见性和控制的核心治理支柱。
使用 ILB ASE 的 eShop 网站

部署到 Azure		 应用服务环境是 Azure 应用服务的一项高级服务计划选项，可提供完全隔离的专用环境来安全地大规模运行 Azure 应用服务应用，包括 Web 应用、移动应用和 API 应用。
使用Azure SQL专用终结点的 Web 应用

部署到 Azure		 此模板演示如何创建使用指向 Azure SQL 服务器的专用终结点的 Web 应用
具有高可用性的远程桌面服务

部署到 Azure		 此 ARM 模板示例代码将部署具有高可用性的 远程桌面服务 2019 会话集合 实验室。 目标是使用 Windows Server 2019 为远程桌面服务部署完全冗余、高度可用的解决方案。
在 Azure 上部署体育分析体系结构

部署到 Azure		 创建启用了 ADLS Gen 2 的 Azure 存储帐户，创建一个Azure 数据工厂实例，其中包含存储帐户的链接服务 (Azure SQL数据库（如果已部署) ），以及一个 Azure Databricks 实例。 将为部署模板的用户的 AAD 标识和 ADF 实例的托管标识授予存储帐户上的存储 Blob 数据参与者角色。 还有一些选项可用于部署 Azure 密钥保管库 实例、Azure SQL数据库和 Azure 事件中心 (，用于流式处理用例) 。 部署 Azure 密钥保管库时，将为部署模板的用户授予数据工厂托管标识和 AAD 标识密钥保管库机密用户角色。
具有SQL 数据库的 Web 应用、Azure Cosmos DB、Azure 搜索

部署到 Azure		 此模板预配 Web 应用、SQL 数据库、Azure Cosmos DB、Azure 搜索和 Application Insights。
使用 Azure DMS 迁移到 Azure SQL 数据库

部署到 Azure		 Azure 数据库迁移服务 (DMS) 旨在简化将本地数据库迁移到 Azure 的过程。 DMS 将简化将现有本地SQL Server和 Oracle 数据库迁移到 Azure 虚拟机中Azure SQL数据库、Azure SQL 托管实例或 Microsoft SQL Server。 此模板将部署 Azure 数据库迁移服务的实例、一个安装了 SQL Server 的 Azure VM（将充当具有预创建数据库的源服务器）和一个目标Azure SQL数据库服务器（具有要从源服务器迁移到目标服务器的数据库的预创建架构）。 该模板还将部署所需的资源，例如 NIC、vnet 等，以支持源 VM、DMS 服务和目标服务器。
在 VNET 中使用自定义 Ambari + Hive 元存储 DB 的 HDInsight

部署到 Azure		 此模板允许在现有虚拟网络中创建 HDInsight 群集，其中包含同时充当自定义 Ambari DB 和 Hive 元存储的新 SQL 数据库。 必须具有现有的 SQL Sever、存储帐户和 VNET。
部署 HDInsight 群集和 SQL 数据库

部署到 Azure		 此模板允许创建 HDInsight 群集和用于测试 Sqoop 的SQL 数据库。
专用终结点示例

部署到 Azure		 此模板演示如何创建指向 Azure SQL 服务器的专用终结点
将审核写入事件中心的Azure SQL服务器

部署到 Azure		 此模板允许部署启用了审核的 Azure SQL 服务器，以便将审核日志写入事件中心
将审核写入 Log Analytics 的Azure SQL服务器

部署到 Azure		 此模板允许部署启用了审核的 Azure SQL 服务器，以便将审核日志写入 Log Analytics (OMS 工作区)
具有透明加密的专用 SQL 池

部署到 Azure		 (以前使用透明数据加密的 SQL DW) 创建SQL Server和专用 SQL 池。
创建SQL Server和数据库

部署到 Azure		 此模板允许创建SQL 数据库和服务器。
使用 TDE 预配SQL 数据库

部署到 Azure		 此模板预配一个SQL Server，其中包含为 Azure 流量打开的防火墙，以及一个具有透明数据加密 (TDE) 的 SQL 数据库。
部署新的 SQL 弹性池

部署到 Azure		 此模板允许部署新的 SQL 弹性池，其中包含其新的关联SQL Server和要分配给它的新 SQL 数据库。
使用故障转移组创建Azure SQL服务器和数据库

部署到 Azure		 创建两个Azure SQL服务器、一个数据库和一个故障转移组。
使用 Azure SQL 后端应用服务环境

部署到 Azure		 此模板创建一个应用服务环境，其中包含Azure SQL后端、专用终结点以及通常在专用/隔离环境中使用的关联资源。
使用SQL 数据库预配移动应用

部署到 Azure		 此模板预配移动应用、SQL 数据库和通知中心。 它在移动应用中为数据库和通知中心配置连接字符串。
具有托管标识、SQL Server和 ΑΙ 的 Web 应用

部署到 Azure		 为应用 + 数据 + 托管标识 + 监视部署 Azure 基础结构的简单示例
使用模板创建 Web 应用 + Redis 缓存 + SQL DB

部署到 Azure		 此模板使用 Redis 缓存和SQL 数据库创建 Azure Web 应用。
使用SQL 数据库预配 Web 应用

部署到 Azure		 此模板预配 Web 应用、SQL 数据库、自动缩放设置、警报规则和 App Insights。 它在 Web 应用中为数据库配置连接字符串。
创建、配置 Web 应用程序并将其部署到 Azure VM

部署到 Azure		 使用 SQL Azure 数据库创建和配置 Windows VM，并使用 PowerShell DSC 将 Web 应用程序部署到环境
具有 Azure SQL 的 Linux 上的 Sonarqube Docker Web 应用

部署到 Azure		 此模板使用官方 Sonarqube 映像并受 Azure SQL 服务器支持，在 Azure 应用服务 Web 应用 Linux 容器中部署 Sonarqube。

Terraform (AzAPI 提供程序) 资源定义

可以使用面向以下操作部署服务器/数据库资源类型：

  • 资源组

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

资源格式

若要创建 Microsoft.Sql/servers/databases 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/servers/databases@2014-04-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      collation = "string"
      createMode = "string"
      edition = "string"
      elasticPoolName = "string"
      maxSizeBytes = "string"
      readScale = "string"
      recoveryServicesRecoveryPointResourceId = "string"
      requestedServiceObjectiveId = "string"
      requestedServiceObjectiveName = "string"
      restorePointInTime = "string"
      sampleName = "AdventureWorksLT"
      sourceDatabaseDeletionDate = "string"
      sourceDatabaseId = "string"
      zoneRedundant = bool
    }
  })
}

属性值

servers/databases

名称 说明 Value
type 资源类型 “Microsoft.Sql/servers/databases@2014-04-01”
name 资源名称 字符串 (必需)

字符限制：1-128

有效字符：
不得使用：
<>*%&:\/? 或控制字符

不得以句点或空格结尾。
location 资源位置。 字符串 (必需)
parent_id 此资源的父资源的 ID。 类型的资源的 ID： 服务器
标记 资源标记。 标记名称和值的字典。
properties 表示资源的属性。 DatabaseProperties

DatabaseProperties

名称 说明 值
collation 数据库的排序规则。 如果 createMode 不是 Default，则忽略此值。 字符串
createMode 指定数据库创建模式。

默认值：常规数据库创建。

复制：将数据库创建为现有数据库的副本。 sourceDatabaseId 必须指定为源数据库的资源 ID。

OnlineSecondary/NonReadableSecondary：将数据库创建为现有数据库的 (可读或不可读) 辅助副本 (replica) 。 sourceDatabaseId 必须指定为现有主数据库的资源 ID。

PointInTimeRestore：通过还原现有数据库的时间点备份来创建数据库。 sourceDatabaseId 必须指定为现有数据库的资源 ID，并且必须指定 restorePointInTime。

恢复：通过还原异地复制的备份来创建数据库。 sourceDatabaseId 必须指定为要还原的可恢复数据库资源 ID。

还原：通过还原已删除数据库的备份来创建数据库。 必须指定 sourceDatabaseId。 如果 sourceDatabaseId 是数据库的原始资源 ID，则必须指定 sourceDatabaseDeletionDate。 否则，sourceDatabaseId 必须是可还原的已删除数据库资源 ID，并且 sourceDatabaseDeletionDate 将被忽略。 还可以将 restorePointInTime 指定为从较早的时间点还原。

RestoreLongTermRetentionBackup：通过从长期保留保管库还原来创建数据库。 recoveryServicesRecoveryPointResourceId 必须指定为恢复点资源 ID。

DataWarehouse 版本不支持 Copy、NonReadableSecondary、OnlineSecondary 和 RestoreLongTermRetentionBackup。		 “Copy”
“Default”
“NonReadableSecondary”
“OnlineSecondary”
“PointInTimeRestore”
“恢复”
“还原”
“RestoreLongTermRetentionBackup”
edition 数据库的版本。 DatabaseEditions 枚举包含所有有效版本。 如果 createMode 为 NonReadableSecondary 或 OnlineSecondary，则忽略此值。

SKU 列表可能因地区和支持产品/服务而异。 若要确定 SKU (包括 AZURE 区域中订阅可用的 SKU 名称、层/版本、系列和容量) ，请使用 Capabilities_ListByLocation REST API 或以下命令之一：

Azure CLI：
az sql db list-editions -l {location} -o table



Azure PowerShell：
Get-AzSqlServerServiceObjective -Location {location}

 "Basic"
“业务”
“BusinessCritical”
“DataWarehouse”
"Free"
“GeneralPurpose”
“超大规模”
“Premium”
“PremiumRS”
“Standard”
“Stretch”
“System”
“System2”
“Web”
elasticPoolName 数据库所位于的弹性池的名称。 如果 elasticPoolName 和 requestedServiceObjectiveName 均已更新，则忽略 requestedServiceObjectiveName 的值。 DataWarehouse 版本不支持。 字符串
maxSizeBytes 以字节表示的数据库的最大大小。 如果 createMode 不是 Default，则忽略此值。 若要查看可能的值，请查询 operationId 引用的功能 API (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities) ：“Capabilities_ListByLocation”。 字符串
readScale 条件。 如果数据库是异地辅助数据库，readScale 指示是否允许到此数据库的只读连接。 DataWarehouse 版本不支持。 “Disabled”
“Enabled”
recoveryServicesRecoveryPointResourceId 条件。 如果 createMode 为 RestoreLongTermRetentionBackup，则此值是必需的。 指定要从中还原的恢复点的资源 ID。 字符串
requestedServiceObjectiveId 数据库的已配置服务级别目标 ID。 这是正在应用于数据库的服务级别目标。 成功更新后，它将匹配 currentServiceObjectiveId 属性的值。 如果 requestedServiceObjectiveId 和 requestedServiceObjectiveName 均已更新，则 requestedServiceObjectiveId 的值将替代 requestedServiceObjectiveName 的值。

SKU 列表可能因地区和支持产品/服务而异。 若要确定可用于 Azure 区域中订阅的服务目标 ID，请使用 Capabilities_ListByLocation REST API。		 字符串

约束：
最小长度 = 36
最大长度 = 36
模式 = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
requestedServiceObjectiveName 数据库的已配置服务级别目标的名称。 这是正在应用于数据库的服务级别目标。 成功更新后，它将匹配 serviceLevelObjective 属性的值。

SKU 列表可能因地区和支持产品/服务而异。 若要确定 SKU (包括 AZURE 区域中订阅可用的 SKU 名称、层/版本、系列和容量) ，请使用 Capabilities_ListByLocation REST API 或以下命令之一：

Azure CLI：
az sql db list-editions -l {location} -o table



Azure PowerShell：
Get-AzSqlServerServiceObjective -Location {location}

 "Basic"
“DS100”
“DS1000”
“DS1200”
“DS1500”
“DS200”
“DS2000”
“DS300”
“DS400”
“DS500”
“DS600”
“DW100”
“DW1000”
“DW10000c”
“DW1000c”
“DW1200”
“DW1500”
“DW15000c”
“DW1500c”
“DW200”
“DW2000”
“DW2000c”
“DW2500c”
“DW300”
“DW3000”
“DW30000c”
“DW3000c”
“DW400”
“DW500”
“DW5000c”
“DW600”
“DW6000”
“DW6000c”
“DW7500c”
“ElasticPool”
"Free"
“P1”
“P11”
“P15”
“P2”
“P3”
“P4”
“P6”
“PRS1”
“PRS2”
“PRS4”
“PRS6”
“S0”
“S1”
“S12”
“S2”
“S3”
“S4”
“S6”
“S7”
“S9”
“System”
“System0”
“System1”
“System2”
“System2L”
“System3”
“System3L”
“System4”
“System4L”
restorePointInTime 条件。 如果 createMode 为 PointInTimeRestore，则此值是必需的。 如果 createMode 为 Restore，则此值是可选的。 指定要还原以创建新数据库的源数据库的时间点 (ISO8601 格式) 。 必须大于或等于源数据库的最早RestoreDate 值。 字符串
sampleName 指示创建此数据库时要应用的示例架构的名称。 如果 createMode 不是 Default，则忽略此值。 DataWarehouse 版本不支持。 “AdventureWorksLT”
sourceDatabaseDeletionDate 条件。 如果 createMode 为 Restore，而 sourceDatabaseId 是已删除数据库 (的原始资源 ID，而不是) 当前可还原的已删除数据库 ID，则此值是必需的。 指定删除数据库的时间。 字符串
sourceDatabaseId 条件。 如果 createMode 为 Copy、NonReadableSecondary、OnlineSecondary、PointInTimeRestore、Recovery 或 Restore，则此值是必需的。 指定源数据库的资源 ID。 如果 createMode 为 NonReadableSecondary 或 OnlineSecondary，则源数据库的名称必须与正在创建的新数据库相同。 字符串
zoneRedundant 此数据库是否为区域冗余，这意味着此数据库的副本将分布在多个可用性区域。 bool