你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.Sql 服务器/数据库
- 最新
- 2023-05-01-preview
- 2023-02-01-preview
- 2022-11-01-preview
- 2022-08-01-preview
- 2022-05-01-preview
- 2022-02-01-preview
- 2021-11-01
- 2021-11-01-preview
- 2021-08-01-preview
- 2021-05-01-preview
- 2021-02-01-preview
- 2020-11-01-preview
- 2020-08-01-preview
- 2020-02-02-preview
- 2019-06-01-preview
- 2017-10-01-preview
- 2017-03-01-preview
- 2014-04-01
Bicep 资源定义
可以使用面向以下操作部署服务器/数据库资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Sql/servers/databases 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Sql/servers/databases@2023-05-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
capacity: int
family: 'string'
name: 'string'
size: 'string'
tier: 'string'
}
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
autoPauseDelay: int
availabilityZone: 'string'
catalogCollation: 'string'
collation: 'string'
createMode: 'string'
elasticPoolId: 'string'
encryptionProtector: 'string'
encryptionProtectorAutoRotation: bool
federatedClientId: 'string'
freeLimitExhaustionBehavior: 'string'
highAvailabilityReplicaCount: int
isLedgerOn: bool
keys: {
{customized property}: {}
}
licenseType: 'string'
longTermRetentionBackupResourceId: 'string'
maintenanceConfigurationId: 'string'
manualCutover: bool
maxSizeBytes: int
minCapacity: json('decimal-as-string')
performCutover: bool
preferredEnclaveType: 'string'
readScale: 'string'
recoverableDatabaseId: 'string'
recoveryServicesRecoveryPointId: 'string'
requestedBackupStorageRedundancy: 'string'
restorableDroppedDatabaseId: 'string'
restorePointInTime: 'string'
sampleName: 'string'
secondaryType: 'string'
sourceDatabaseDeletionDate: 'string'
sourceDatabaseId: 'string'
sourceResourceId: 'string'
useFreeLimit: bool
zoneRedundant: bool
}
}
属性值
servers/databases
| 名称 | 说明 | 值 |
|---|---|---|
| name | 资源名称 了解如何在 Bicep 中设置子资源的名称和类型。 |
字符串 (必需) 字符限制：1-128 有效字符： 不得使用： <>*%&:\/? 或控制字符不得以句点或空格结尾。 |
| location | 资源位置。 | 字符串 (必需) |
| 标记 | 资源标记。 | 标记名称和值的字典。 请参阅 模板中的标记 |
| sku | 数据库 SKU。 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} |
Sku |
| 父级 (parent) | 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源之外的子资源。 |
类型为“服务器”的资源的符号名称 |
| 标识 | 数据库的 Azure Active Directory 标识。 | DatabaseIdentity |
| properties | 资源属性。 | DatabaseProperties |
DatabaseIdentity
| 名称 | 说明 | Value |
|---|---|---|
| type | 标识类型 | “None” “UserAssigned” |
| userAssignedIdentities | 要使用的用户分配标识的资源 ID | DatabaseIdentityUserAssignedIdentities |
DatabaseIdentityUserAssignedIdentities
| 名称 | 说明 | 值 |
|---|---|---|
| {customized property} | DatabaseUserIdentity |
DatabaseUserIdentity
此对象不包含部署期间要设置的任何属性。 所有属性均为 ReadOnly。
DatabaseProperties
| 名称 | 说明 | 值 |
|---|---|---|
| autoPauseDelay | 数据库自动暂停的时间（以分钟为单位）。 值 -1 表示已禁用自动暂停 | int |
| availabilityZone | 指定数据库固定到的可用性区域。 | '1' '2' '3' “NoPreference” |
| catalogCollation | 元数据目录的排序规则。 | “DATABASE_DEFAULT” “SQL_Latin1_General_CP1_CI_AS” |
| collation | 数据库的排序规则。 | 字符串 |
| createMode | 指定数据库创建模式。 默认值：常规数据库创建。 复制：将数据库创建为现有数据库的副本。 sourceDatabaseId 必须指定为源数据库的资源 ID。 辅助数据库：创建数据库作为现有数据库的辅助副本 (replica) 。 sourceDatabaseId 必须指定为现有主数据库的资源 ID。 PointInTimeRestore：通过还原现有数据库的时间点备份来创建数据库。 sourceDatabaseId 必须指定为现有数据库的资源 ID，并且必须指定 restorePointInTime。 恢复：通过还原异地复制的备份来创建数据库。 sourceDatabaseId 必须指定为要还原的可恢复数据库资源 ID。 还原：通过还原已删除数据库的备份来创建数据库。 必须指定 sourceDatabaseId。 如果 sourceDatabaseId 是数据库的原始资源 ID，则必须指定 sourceDatabaseDeletionDate。 否则，sourceDatabaseId 必须是可还原的已删除数据库资源 ID，并且 sourceDatabaseDeletionDate 将被忽略。 还可以将 restorePointInTime 指定为从较早的时间点还原。 RestoreLongTermRetentionBackup：通过从长期保留保管库还原来创建数据库。 recoveryServicesRecoveryPointResourceId 必须指定为恢复点资源 ID。 DataWarehouse 版本不支持 Copy、Secondary 和 RestoreLongTermRetentionBackup。 |
'Copy' 'Default' 'OnlineSecondary' “PointInTimeRestore” “恢复” “还原” “RestoreExternalBackup” “RestoreExternalBackupSecondary” “RestoreLongTermRetentionBackup” “Secondary” |
| elasticPoolId | 包含此数据库的弹性池的资源标识符。 | 字符串 |
| encryptionProtector | 数据库的 Azure 密钥保管库 URI（如果配置了每个数据库客户管理的密钥）。 | 字符串 |
| encryptionProtectorAutoRotation | 用于启用或禁用数据库加密保护程序 AKV 密钥的自动轮换的标志。 | bool |
| federatedClientId | 用于跨租户每个数据库 CMK 方案的客户端 ID | 字符串 约束： 最小长度 = 36 最大长度 = 36 模式 = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| freeLimitExhaustionBehavior | 指定免费数据库的每月可用限制用尽时的行为。 自动暂停：当一个月剩余时间的可用限制用完时，数据库将自动暂停。 BillForUsage：在耗尽免费限制后，数据库将继续联机，任何超额都将计费。 |
“AutoPause” 'BillOverUsage' |
| highAvailabilityReplicaCount | 与用于提供高可用性的数据库关联的次要副本数。 不适用于弹性池中的超大规模数据库。 | int |
| isLedgerOn | 此数据库是否为账本数据库，这意味着数据库中的所有表都是账本表。 注意：创建数据库后，无法更改此属性的值。 | bool |
| 密钥 | 要使用的用户分配标识的资源 ID | DatabasePropertiesKeys |
| LicenseType | 要为此数据库应用的许可证类型。 LicenseIncluded如果需要许可证，或者BasePrice拥有许可证并且符合Azure 混合权益条件。 |
“BasePrice” “LicenseIncluded” |
| longTermRetentionBackupResourceId | 与此数据库的创建操作关联的长期保留备份的资源标识符。 | 字符串 |
| maintenanceConfigurationId | 分配给数据库的维护配置 ID。 此配置定义将发生维护更新的时间段。 | 字符串 |
| manualCutover | 在将数据库更新到超大规模层的操作期间，是否需要执行客户控制的手动直接转换。 此属性仅适用于将数据库从 业务关键/常规用途/高级/标准层缩放到超大规模层时。 指定 manualCutover 时，缩放操作将等待用户输入触发到超大规模数据库的直接转换。 若要触发直接转换，请在缩放操作处于“等待”状态时提供“performCutover”参数。 |
bool |
| maxSizeBytes | 以字节表示的数据库的最大大小。 | int |
| minCapacity | 数据库将始终分配的最小容量（如果未暂停）若要指定十进制值，请使用 json () 函数。 | int 或 json decimal |
| performCutover | 在缩放操作正在进行时，在等待状态期间触发客户控制的手动直接转换。 此属性参数仅适用于随“manualCutover”参数一起启动的缩放操作。 仅当数据库从业务关键/常规用途/高级/标准层缩放到超大规模层时，此属性才适用。 指定了 performCutover 时，缩放操作将触发直接转换并执行对超大规模数据库的角色更改。 |
bool |
| preferredEnclaveType | 对数据库请求的 enclave 类型，即默认或 VBS enclave。 | 'Default' “VBS” |
| readScale | 只读路由的状态。 如果启用，其连接字符串中应用程序意向设置为只读的连接可能会路由到同一区域中的只读次要副本 (replica) 。 不适用于弹性池中的超大规模数据库。 | 'Disabled' 'Enabled' |
| recoverableDatabaseId | 与此数据库的创建操作关联的可恢复数据库的资源标识符。 | 字符串 |
| recoveryServicesRecoveryPointId | 与此数据库的创建操作关联的恢复点的资源标识符。 | 字符串 |
| requestedBackupStorageRedundancy | 用于存储此数据库的备份的存储帐户类型。 | “Geo” “GeoZone” 'Local' “Zone” |
| restorableDroppedDatabaseId | 与此数据库的创建操作关联的可还原已删除数据库的资源标识符。 | 字符串 |
| restorePointInTime | 指定要还原以创建新数据库的源数据库的时间点 (ISO8601 格式) 。 | 字符串 |
| sampleName | 创建此数据库时要应用的示例架构的名称。 | “AdventureWorksLT” “WideWorldImportersFull” 'WideWorldImportersStd' |
| secondaryType | 数据库的辅助类型（如果它是辅助数据库）。 有效值为 Geo、Named 和 Standby。 | “Geo” 'Named' 'Standby' |
| sourceDatabaseDeletionDate | 指定删除数据库的时间。 | 字符串 |
| sourceDatabaseId | 与此数据库的创建操作关联的源数据库的资源标识符。 | 字符串 |
| sourceResourceId | 与此数据库的创建操作关联的源的资源标识符。 此属性仅支持 DataWarehouse 版本，并允许跨订阅还原。 指定 sourceResourceId 时，不得指定 sourceDatabaseId、recoverableDatabaseId、restorableDroppedDatabaseId 和 sourceDatabaseDeletionDate，并且 CreateMode 必须为 PointInTimeRestore、Restore 或 Recover。 当 createMode 为 PointInTimeRestore 时，sourceResourceId 必须是现有数据库或现有 sql 池的资源 ID，并且必须指定 restorePointInTime。 当 createMode 为 Restore 时，sourceResourceId 必须是可还原的已删除数据库或可还原的已删除 sql 池的资源 ID。 当 createMode 为 Recover 时，sourceResourceId 必须是可恢复数据库或可恢复 sql 池的资源 ID。 当源订阅属于不同于目标订阅的租户时，“x-ms-authorization-auxiliary”标头必须包含源租户的身份验证令牌。 有关“x-ms-authorization-auxiliary”标头的详细信息，请参阅 /azure/azure-resource-manager/management/authenticate-multi-tenant |
字符串 |
| useFreeLimit | 数据库是否使用每月免费限制。 在订阅中的一个数据库上允许。 | bool |
| zoneRedundant | 此数据库是否为区域冗余，这意味着此数据库的副本将分布在多个可用性区域。 | bool |
DatabasePropertiesKeys
| 名称 | 说明 | 值 |
|---|---|---|
| {customized property} | DatabaseKey |
DatabaseKey
此对象不包含部署期间要设置的任何属性。 所有属性均为 ReadOnly。
SKU
| 名称 | 说明 | 值 |
|---|---|---|
| 容量 | 特定 SKU 的容量。 | int |
| family | 如果服务针对同一 SKU 具有不同代系的硬件，则可以在此处捕获。 | 字符串 |
| name | SKU 的名称，通常为字母 + 数字代码，例如 P3。 | 字符串 (必需) |
| 大小 | 特定 SKU 的大小 | 字符串 |
| 层 | 特定 SKU 的层或版本，例如基本 SKU、高级 SKU。 | 字符串 |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 说明 |
|---|---|
将 Django 应用与 SQL 数据库配合使用 |
此模板使用 Azure Linux CustomScript 扩展来部署应用程序。 此示例创建一个 Ubuntu VM，执行 Python、Django 和 Apache 的无提示安装，然后创建一个简单的 Django 应用。 该模板还会创建一个SQL 数据库，其中包含一些示例数据的示例表，这些数据使用查询显示在 Web 浏览器中 |
| Azure 中的 EPiserverCMS |
此模板允许你在 Azure 中创建 EpiServerCMS 部署所需的资源 |
| 使用 Azure SQL 数据库自动缩放 LANSA Windows VM ScaleSet |
该模板部署一个 Windows VMSS，其中包含规模集中所需的 VM 计数，以及要安装到每个 VM 中的 LANSA MSI。 部署 VM 规模集后，将使用自定义脚本扩展安装 LANSA MSI) |
| 使用试用许可证部署八达通部署 3.0 |
此模板允许你使用试用许可证部署单个 Octopus Deploy 3.0 服务器。 这会在单个 Windows Server 2012R2 VM (Standard D2) 和 SQL DB (S1 层) 部署到为资源组指定的位置。 |
| Orchard CMS 视频门户 Web 应用 |
此模板提供了一种在启用和配置 Azure 媒体服务模块的情况下在 Azure 应用服务 Web 应用 上部署 Orchard CMS 的简单方法。 |
| 可缩放的 Umbraco CMS Web 应用 |
此模板提供了一种在 Azure 应用服务 Web 应用 上部署 umbraco CMS Web 应用的简单方法。 |
| 简单的 Umbraco CMS Web 应用 |
此模板提供了一种在 Azure 应用服务 Web 应用 上部署 umbraco CMS Web 应用的简单方法。 |
| 企业治理 -AppService，SQL DB，AD，OMS，Runbook |
企业（无论大小）的云采用都需要负责任且高效的治理模型才能从其云部署中获取价值。 CloudWise (解决方案) 的代码名称，是 Azure 合作伙伴快速入门中提供的复合解决方案，是客户、系统集成商和合作伙伴的采用支持者，可提供可自助、自动化的治理和运营解决方案，专注于优化成本、改进应用程序 () 可靠性、降低业务风险。 该解决方案突出了可见性和控制的核心治理支柱。 |
| 使用 ILB ASE 的 eShop 网站 |
应用服务环境是 Azure 应用服务的一项高级服务计划选项，可提供完全隔离的专用环境来安全地大规模运行 Azure 应用服务应用，包括 Web 应用、移动应用和 API 应用。 |
| 使用Azure SQL专用终结点的 Web 应用 |
此模板演示如何创建使用指向 Azure SQL 服务器的专用终结点的 Web 应用 |
| 具有高可用性的远程桌面服务 |
此 ARM 模板示例代码将部署具有高可用性的 远程桌面服务 2019 会话收集 实验室。 目标是使用 Windows Server 2019 为远程桌面服务部署完全冗余、高度可用的解决方案。 |
| 在 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 搜索 |
此模板预配 Web 应用、SQL 数据库、Azure Cosmos DB、Azure 搜索和 Application Insights。 |
| 使用 Azure DMS 迁移到Azure SQL数据库 |
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 |
此模板允许在现有虚拟网络中创建 HDInsight 群集，其中包含同时充当自定义 Ambari DB 和 Hive 元存储的新 SQL 数据库。 必须具有现有的 SQL Sever、存储帐户和 VNET。 |
| 部署 HDInsight 群集和 SQL 数据库 |
使用此模板可以创建 HDInsight 群集和用于测试 Sqoop 的SQL 数据库。 |
| 专用终结点示例 |
此模板演示如何创建指向 Azure SQL 服务器的专用终结点 |
| 将审核写入事件中心的Azure SQL服务器 |
此模板允许部署启用了审核的Azure SQL服务器，以便将审核日志写入事件中心 |
| 将审核写入 Log Analytics 的Azure SQL服务器 |
此模板允许部署启用了审核的Azure SQL服务器，以便将审核日志写入 Log Analytics (OMS 工作区) |
| 具有透明加密的专用 SQL 池 |
(以前使用透明数据加密的 SQL DW) 创建SQL Server和专用 SQL 池。 |
| 创建SQL Server和数据库 |
此模板允许你创建 SQL 数据库 和 服务器。 |
| 使用 TDE 预配SQL 数据库 |
此模板预配一个SQL Server，其中为 Azure 流量打开了防火墙，以及一个具有透明数据加密 (TDE) 的 SQL 数据库。 |
| 部署新的 SQL 弹性池 |
通过此模板，可以部署一个新的 SQL 弹性池，其中包含新的关联SQL Server和要分配给它的新 SQL 数据库。 |
| 使用故障转移组创建Azure SQL服务器和数据库 |
创建两个Azure SQL服务器、一个数据库和一个故障转移组。 |
| 使用Azure SQL后端应用服务环境 |
此模板创建一个应用服务环境，其中包含Azure SQL后端、专用终结点以及通常在专用/隔离环境中使用的关联资源。 |
| 使用SQL 数据库预配移动应用 |
此模板预配移动应用、SQL 数据库和通知中心。 它在移动应用中为数据库和通知中心配置连接字符串。 |
| 具有托管标识、SQL Server和 ΑΙ 的 Web 应用 |
为应用 + 数据 + 托管标识 + 监视部署 Azure 基础结构的简单示例 |
| 使用模板创建 Web 应用 + Redis 缓存 + SQL DB |
此模板使用 Redis 缓存和SQL 数据库创建 Azure Web 应用。 |
| 使用SQL 数据库预配 Web 应用 |
此模板预配 Web 应用、SQL 数据库、自动缩放设置、警报规则和 App Insights。 它在 Web 应用中为数据库配置连接字符串。 |
| 创建、配置 Web 应用程序并将其部署到 Azure VM |
使用 SQL Azure 数据库创建和配置 Windows VM，并使用 PowerShell DSC 将 Web 应用程序部署到环境 |
| 具有 Azure SQL 的 Linux 上的 Sonarqube Docker Web 应用 |
此模板使用官方 Sonarqube 映像并受 Azure SQL 服务器支持，在 Azure 应用服务 Web 应用 Linux 容器中部署 Sonarqube。 |
ARM 模板资源定义
可以使用面向以下操作部署服务器/数据库资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Sql/servers/databases 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.Sql/servers/databases",
"apiVersion": "2023-05-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"capacity": "int",
"family": "string",
"name": "string",
"size": "string",
"tier": "string"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"autoPauseDelay": "int",
"availabilityZone": "string",
"catalogCollation": "string",
"collation": "string",
"createMode": "string",
"elasticPoolId": "string",
"encryptionProtector": "string",
"encryptionProtectorAutoRotation": "bool",
"federatedClientId": "string",
"freeLimitExhaustionBehavior": "string",
"highAvailabilityReplicaCount": "int",
"isLedgerOn": "bool",
"keys": {
"{customized property}": {}
},
"licenseType": "string",
"longTermRetentionBackupResourceId": "string",
"maintenanceConfigurationId": "string",
"manualCutover": "bool",
"maxSizeBytes": "int",
"minCapacity": "[json('decimal-as-string')]",
"performCutover": "bool",
"preferredEnclaveType": "string",
"readScale": "string",
"recoverableDatabaseId": "string",
"recoveryServicesRecoveryPointId": "string",
"requestedBackupStorageRedundancy": "string",
"restorableDroppedDatabaseId": "string",
"restorePointInTime": "string",
"sampleName": "string",
"secondaryType": "string",
"sourceDatabaseDeletionDate": "string",
"sourceDatabaseId": "string",
"sourceResourceId": "string",
"useFreeLimit": "bool",
"zoneRedundant": "bool"
}
}
属性值
servers/databases
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | “Microsoft.Sql/servers/databases” |
| apiVersion | 资源 API 版本 | '2023-05-01-preview' |
| name | 资源名称 了解如何在 JSON ARM 模板中设置子资源的名称和类型。 |
字符串 (必需) 字符限制：1-128 有效字符： 不得使用： <>*%&:\/? 或控制字符不得以句点或空格结尾。 |
| location | 资源位置。 | 字符串 (必需) |
| 标记 | 资源标记。 | 标记名称和值的字典。 请参阅 模板中的标记 |
| sku | 数据库 SKU。 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} |
Sku |
| 标识 | 数据库的 Azure Active Directory 标识。 | DatabaseIdentity |
| properties | 资源属性。 | DatabaseProperties |
DatabaseIdentity
| 名称 | 说明 | Value |
|---|---|---|
| type | 标识类型 | “None” “UserAssigned” |
| userAssignedIdentities | 要使用的用户分配标识的资源 ID | DatabaseIdentityUserAssignedIdentities |
DatabaseIdentityUserAssignedIdentities
| 名称 | 说明 | 值 |
|---|---|---|
| {customized property} | DatabaseUserIdentity |
DatabaseUserIdentity
此对象不包含部署期间要设置的任何属性。 所有属性均为 ReadOnly。
DatabaseProperties
| 名称 | 说明 | 值 |
|---|---|---|
| autoPauseDelay | 数据库自动暂停的时间（以分钟为单位）。 值 -1 表示已禁用自动暂停 | int |
| availabilityZone | 指定数据库固定到的可用性区域。 | '1' '2' '3' “NoPreference” |
| catalogCollation | 元数据目录的排序规则。 | “DATABASE_DEFAULT” “SQL_Latin1_General_CP1_CI_AS” |
| collation | 数据库的排序规则。 | 字符串 |
| createMode | 指定数据库创建模式。 默认值：常规数据库创建。 复制：将数据库创建为现有数据库的副本。 sourceDatabaseId 必须指定为源数据库的资源 ID。 辅助数据库：创建数据库作为现有数据库的辅助副本 (replica) 。 sourceDatabaseId 必须指定为现有主数据库的资源 ID。 PointInTimeRestore：通过还原现有数据库的时间点备份来创建数据库。 sourceDatabaseId 必须指定为现有数据库的资源 ID，并且必须指定 restorePointInTime。 恢复：通过还原异地复制的备份来创建数据库。 sourceDatabaseId 必须指定为要还原的可恢复数据库资源 ID。 还原：通过还原已删除数据库的备份来创建数据库。 必须指定 sourceDatabaseId。 如果 sourceDatabaseId 是数据库的原始资源 ID，则必须指定 sourceDatabaseDeletionDate。 否则，sourceDatabaseId 必须是可还原的已删除数据库资源 ID，并且 sourceDatabaseDeletionDate 将被忽略。 还可以将 restorePointInTime 指定为从较早的时间点还原。 RestoreLongTermRetentionBackup：通过从长期保留保管库还原来创建数据库。 recoveryServicesRecoveryPointResourceId 必须指定为恢复点资源 ID。 DataWarehouse 版本不支持 Copy、Secondary 和 RestoreLongTermRetentionBackup。 |
'Copy' 'Default' 'OnlineSecondary' “PointInTimeRestore” “恢复” “还原” “RestoreExternalBackup” “RestoreExternalBackupSecondary” “RestoreLongTermRetentionBackup” “Secondary” |
| elasticPoolId | 包含此数据库的弹性池的资源标识符。 | 字符串 |
| encryptionProtector | 数据库的 Azure 密钥保管库 URI（如果配置了每个数据库客户管理的密钥）。 | 字符串 |
| encryptionProtectorAutoRotation | 用于启用或禁用数据库加密保护程序 AKV 密钥的自动轮换的标志。 | bool |
| federatedClientId | 用于跨租户每个数据库 CMK 方案的客户端 ID | 字符串 约束： 最小长度 = 36 最大长度 = 36 模式 = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| freeLimitExhaustionBehavior | 指定免费数据库的每月可用限制用尽时的行为。 自动暂停：当一个月剩余时间的可用限制用完时，数据库将自动暂停。 BillForUsage：在耗尽免费限制后，数据库将继续联机，任何超额都将计费。 |
“AutoPause” 'BillOverUsage' |
| highAvailabilityReplicaCount | 与用于提供高可用性的数据库关联的次要副本数。 不适用于弹性池中的超大规模数据库。 | int |
| isLedgerOn | 此数据库是否为账本数据库，这意味着数据库中的所有表都是账本表。 注意：创建数据库后，无法更改此属性的值。 | bool |
| 密钥 | 要使用的用户分配标识的资源 ID | DatabasePropertiesKeys |
| LicenseType | 要为此数据库应用的许可证类型。 LicenseIncluded如果需要许可证，或者BasePrice拥有许可证并且符合Azure 混合权益条件。 |
“BasePrice” “LicenseIncluded” |
| longTermRetentionBackupResourceId | 与此数据库的创建操作关联的长期保留备份的资源标识符。 | 字符串 |
| maintenanceConfigurationId | 分配给数据库的维护配置 ID。 此配置定义将发生维护更新的时间段。 | 字符串 |
| manualCutover | 在将数据库更新到超大规模层的操作期间，是否需要执行客户控制的手动直接转换。 此属性仅适用于将数据库从 业务关键/常规用途/高级/标准层缩放到超大规模层时。 指定 manualCutover 时，缩放操作将等待用户输入触发到超大规模数据库的直接转换。 若要触发直接转换，请在缩放操作处于“等待”状态时提供“performCutover”参数。 |
bool |
| maxSizeBytes | 以字节表示的数据库的最大大小。 | int |
| minCapacity | 数据库将始终分配的最小容量（如果未暂停）若要指定十进制值，请使用 json () 函数。 | int 或 json decimal |
| performCutover | 在缩放操作正在进行时，在等待状态期间触发客户控制的手动直接转换。 此属性参数仅适用于随“manualCutover”参数一起启动的缩放操作。 仅当数据库从业务关键/常规用途/高级/标准层缩放到超大规模层时，此属性才适用。 指定了 performCutover 时，缩放操作将触发直接转换并执行对超大规模数据库的角色更改。 |
bool |
| preferredEnclaveType | 对数据库请求的 enclave 类型，即默认或 VBS enclave。 | 'Default' “VBS” |
| readScale | 只读路由的状态。 如果启用，其连接字符串中应用程序意向设置为只读的连接可能会路由到同一区域中的只读次要副本 (replica) 。 不适用于弹性池中的超大规模数据库。 | 'Disabled' 'Enabled' |
| recoverableDatabaseId | 与此数据库的创建操作关联的可恢复数据库的资源标识符。 | 字符串 |
| recoveryServicesRecoveryPointId | 与此数据库的创建操作关联的恢复点的资源标识符。 | 字符串 |
| requestedBackupStorageRedundancy | 用于存储此数据库的备份的存储帐户类型。 | “Geo” “GeoZone” 'Local' “Zone” |
| restorableDroppedDatabaseId | 与此数据库的创建操作关联的可还原已删除数据库的资源标识符。 | 字符串 |
| restorePointInTime | 指定要还原以创建新数据库的源数据库的时间点 (ISO8601 格式) 。 | 字符串 |
| sampleName | 创建此数据库时要应用的示例架构的名称。 | “AdventureWorksLT” “WideWorldImportersFull” 'WideWorldImportersStd' |
| secondaryType | 数据库的辅助类型（如果它是辅助数据库）。 有效值为 Geo、Named 和 Standby。 | “Geo” 'Named' 'Standby' |
| sourceDatabaseDeletionDate | 指定删除数据库的时间。 | 字符串 |
| sourceDatabaseId | 与此数据库的创建操作关联的源数据库的资源标识符。 | 字符串 |
| sourceResourceId | 与此数据库的创建操作关联的源的资源标识符。 此属性仅支持 DataWarehouse 版本，并允许跨订阅还原。 指定 sourceResourceId 时，不得指定 sourceDatabaseId、recoverableDatabaseId、restorableDroppedDatabaseId 和 sourceDatabaseDeletionDate，并且 CreateMode 必须为 PointInTimeRestore、Restore 或 Recover。 当 createMode 为 PointInTimeRestore 时，sourceResourceId 必须是现有数据库或现有 sql 池的资源 ID，并且必须指定 restorePointInTime。 当 createMode 为 Restore 时，sourceResourceId 必须是可还原的已删除数据库或可还原的已删除 sql 池的资源 ID。 当 createMode 为 Recover 时，sourceResourceId 必须是可恢复数据库或可恢复 sql 池的资源 ID。 当源订阅属于不同于目标订阅的租户时，“x-ms-authorization-auxiliary”标头必须包含源租户的身份验证令牌。 有关“x-ms-authorization-auxiliary”标头的详细信息，请参阅 /azure/azure-resource-manager/management/authenticate-multi-tenant |
字符串 |
| useFreeLimit | 数据库是否使用每月免费限制。 在订阅中的一个数据库上允许。 | bool |
| zoneRedundant | 此数据库是否为区域冗余，这意味着此数据库的副本将分布在多个可用性区域。 | bool |
DatabasePropertiesKeys
| 名称 | 说明 | 值 |
|---|---|---|
| {customized property} | DatabaseKey |
DatabaseKey
此对象不包含部署期间要设置的任何属性。 所有属性均为 ReadOnly。
SKU
| 名称 | 说明 | 值 |
|---|---|---|
| 容量 | 特定 SKU 的容量。 | int |
| family | 如果服务针对同一 SKU 具有不同代系的硬件，则可以在此处捕获。 | 字符串 |
| name | SKU 的名称，通常为字母 + 数字代码，例如 P3。 | 字符串 (必需) |
| 大小 | 特定 SKU 的大小 | 字符串 |
| 层 | 特定 SKU 的层或版本，例如基本 SKU、高级 SKU。 | 字符串 |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 说明 |
|---|---|
| 将 Django 应用与 SQL 数据库配合使用 |
此模板使用 Azure Linux CustomScript 扩展来部署应用程序。 此示例创建一个 Ubuntu VM，执行 Python、Django 和 Apache 的无提示安装，然后创建一个简单的 Django 应用。 该模板还创建一个SQL 数据库，其中包含一个示例表，其中包含一些示例数据，这些数据使用查询显示在 Web 浏览器中 |
| Azure 中的 EPiserverCMS |
此模板允许在 Azure 中创建 EpiServerCMS 部署所需的资源 |
| 使用 Azure SQL 数据库自动缩放 LANSA Windows VM 规模集 |
该模板部署一个 Windows VMSS，其中包含规模集中的所需 VM 数，以及要安装到每个 VM 中的 LANSA MSI。 部署 VM 规模集后，将使用自定义脚本扩展安装 LANSA MSI) |
| 部署 Octopus 使用试用许可证部署 3.0 |
此模板允许你使用试用许可证部署单个 Octopus Deploy 3.0 服务器。 这会部署在单个 Windows Server 2012R2 VM (Standard D2) 和 SQL DB (S1 层) 到为资源组指定的位置。 |
| Orchard CMS 视频门户 Web 应用 |
此模板提供了一种在启用和配置 Azure 媒体服务模块的情况下，在 Azure 应用服务 Web 应用 上部署 Orchard CMS 的简单方法。 |
| 可缩放的 Umbraco CMS Web 应用 |
此模板提供了一种在 Azure 应用服务 Web 应用 上部署 umbraco CMS Web 应用的简单方法。 |
| 简单的 Umbraco CMS Web 应用 |
此模板提供了一种在 Azure 应用服务 Web 应用 上部署 umbraco CMS Web 应用的简单方法。 |
| 企业治理 -AppService，SQL DB，AD，OMS，Runbook |
企业（无论大小）的云采用都需要负责任且高效的治理模型才能从其云部署中获取价值。 CloudWise (解决方案) 的代码名称，是 Azure 合作伙伴快速入门中提供的复合解决方案，是客户、系统集成商和合作伙伴的采用支持者，可提供可自助、自动化的治理和运营解决方案，专注于优化成本、改进应用程序 () 可靠性、降低业务风险。 该解决方案突出了可见性和控制的核心治理支柱。 |
| 使用 ILB ASE 的 eShop 网站 |
应用服务环境是 Azure 应用服务的一项高级服务计划选项，可提供完全隔离的专用环境来安全地大规模运行 Azure 应用服务应用，包括 Web 应用、移动应用和 API 应用。 |
| 使用Azure SQL专用终结点的 Web 应用 |
此模板演示如何创建使用指向 Azure SQL 服务器的专用终结点的 Web 应用 |
| 具有高可用性的远程桌面服务 |
此 ARM 模板示例代码将部署具有高可用性的 远程桌面服务 2019 会话收集 实验室。 目标是使用 Windows Server 2019 为远程桌面服务部署完全冗余、高度可用的解决方案。 |
| 在 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 搜索 |
此模板预配 Web 应用、SQL 数据库、Azure Cosmos DB、Azure 搜索和 Application Insights。 |
| 使用 Azure DMS 迁移到Azure SQL数据库 |
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 |
此模板允许在现有虚拟网络中创建 HDInsight 群集，其中包含同时充当自定义 Ambari DB 和 Hive 元存储的新 SQL 数据库。 必须具有现有的 SQL Sever、存储帐户和 VNET。 |
| 部署 HDInsight 群集和 SQL 数据库 |
使用此模板可以创建 HDInsight 群集和用于测试 Sqoop 的SQL 数据库。 |
| 专用终结点示例 |
此模板演示如何创建指向 Azure SQL 服务器的专用终结点 |
| 将审核写入事件中心的Azure SQL服务器 |
此模板允许部署启用了审核的Azure SQL服务器，以便将审核日志写入事件中心 |
| 将审核写入 Log Analytics 的Azure SQL服务器 |
此模板允许部署启用了审核的Azure SQL服务器，以便将审核日志写入 Log Analytics (OMS 工作区) |
| 具有透明加密的专用 SQL 池 |
(以前使用透明数据加密的 SQL DW) 创建SQL Server和专用 SQL 池。 |
| 创建SQL Server和数据库 |
此模板允许你创建 SQL 数据库 和 服务器。 |
| 使用 TDE 预配SQL 数据库 |
此模板预配一个SQL Server，其中为 Azure 流量打开了防火墙，以及一个具有透明数据加密 (TDE) 的 SQL 数据库。 |
| 部署新的 SQL 弹性池 |
通过此模板，可以部署一个新的 SQL 弹性池，其中包含新的关联SQL Server和要分配给它的新 SQL 数据库。 |
| 使用故障转移组创建Azure SQL服务器和数据库 |
创建两个Azure SQL服务器、一个数据库和一个故障转移组。 |
| 使用Azure SQL后端应用服务环境 |
此模板创建一个应用服务环境，其中包含Azure SQL后端、专用终结点以及通常在专用/隔离环境中使用的关联资源。 |
| 使用SQL 数据库预配移动应用 |
此模板预配移动应用、SQL 数据库和通知中心。 它在移动应用中为数据库和通知中心配置连接字符串。 |
| 具有托管标识、SQL Server和 ΑΙ 的 Web 应用 |
为应用 + 数据 + 托管标识 + 监视部署 Azure 基础结构的简单示例 |
| 使用模板创建 Web 应用 + Redis 缓存 + SQL DB |
此模板使用 Redis 缓存和SQL 数据库创建 Azure Web 应用。 |
| 使用SQL 数据库预配 Web 应用 |
此模板预配 Web 应用、SQL 数据库、自动缩放设置、警报规则和 App Insights。 它在 Web 应用中为数据库配置连接字符串。 |
| 创建、配置 Web 应用程序并将其部署到 Azure VM |
使用 SQL Azure 数据库创建和配置 Windows VM，并使用 PowerShell DSC 将 Web 应用程序部署到环境 |
| 具有 Azure SQL 的 Linux 上的 Sonarqube Docker Web 应用 |
此模板使用官方 Sonarqube 映像在 Azure 应用服务 Web 应用 Linux 容器中部署 Sonarqube，并由 Azure SQL 服务器提供支持。 |
Terraform (AzAPI 提供程序) 资源定义
可以使用针对以下操作部署服务器/数据库资源类型：
- 资源组
有关每个 API 版本中更改的属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Sql/servers/databases 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Sql/servers/databases@2023-05-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "UserAssigned"
identity_ids = []
}
body = jsonencode({
properties = {
autoPauseDelay = int
availabilityZone = "string"
catalogCollation = "string"
collation = "string"
createMode = "string"
elasticPoolId = "string"
encryptionProtector = "string"
encryptionProtectorAutoRotation = bool
federatedClientId = "string"
freeLimitExhaustionBehavior = "string"
highAvailabilityReplicaCount = int
isLedgerOn = bool
keys = {
{customized property} = {}
}
licenseType = "string"
longTermRetentionBackupResourceId = "string"
maintenanceConfigurationId = "string"
manualCutover = bool
maxSizeBytes = int
minCapacity = "decimal-as-string"
performCutover = bool
preferredEnclaveType = "string"
readScale = "string"
recoverableDatabaseId = "string"
recoveryServicesRecoveryPointId = "string"
requestedBackupStorageRedundancy = "string"
restorableDroppedDatabaseId = "string"
restorePointInTime = "string"
sampleName = "string"
secondaryType = "string"
sourceDatabaseDeletionDate = "string"
sourceDatabaseId = "string"
sourceResourceId = "string"
useFreeLimit = bool
zoneRedundant = bool
}
sku = {
capacity = int
family = "string"
name = "string"
size = "string"
tier = "string"
}
})
}
属性值
servers/databases
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | “Microsoft.Sql/servers/databases@2023-05-01-preview” |
| name | 资源名称 | 字符串 (必需) 字符限制：1-128 有效字符： 不得使用： <>*%&:\/? 或控制字符不得以句点或空格结尾。 |
| location | 资源位置。 | 字符串 (必需) |
| parent_id | 此资源的父资源的 ID。 | 类型的资源的 ID： 服务器 |
| 标记 | 资源标记。 | 标记名称和值的字典。 |
| sku | 数据库 SKU。 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} |
Sku |
| 标识 | 数据库的 Azure Active Directory 标识。 | DatabaseIdentity |
| properties | 资源属性。 | DatabaseProperties |
DatabaseIdentity
| 名称 | 说明 | Value |
|---|---|---|
| type | 标识类型 | “UserAssigned” |
| identity_ids | 要使用的用户分配标识的资源 ID | 用户标识 ID 的数组。 |
DatabaseIdentityUserAssignedIdentities
| 名称 | 说明 | 值 |
|---|---|---|
| {customized property} | DatabaseUserIdentity |
DatabaseUserIdentity
此对象不包含部署期间要设置的任何属性。 所有属性均为 ReadOnly。
DatabaseProperties
| 名称 | 说明 | 值 |
|---|---|---|
| autoPauseDelay | 数据库自动暂停的时间（以分钟为单位）。 值 -1 表示已禁用自动暂停 | int |
| availabilityZone | 指定数据库固定到的可用性区域。 | "1" "2" "3" “NoPreference” |
| catalogCollation | 元数据目录的排序规则。 | “DATABASE_DEFAULT” “SQL_Latin1_General_CP1_CI_AS” |
| collation | 数据库的排序规则。 | 字符串 |
| createMode | 指定数据库创建模式。 默认值：常规数据库创建。 复制：将数据库创建为现有数据库的副本。 sourceDatabaseId 必须指定为源数据库的资源 ID。 辅助数据库：创建数据库作为现有数据库的辅助副本 (replica) 。 sourceDatabaseId 必须指定为现有主数据库的资源 ID。 PointInTimeRestore：通过还原现有数据库的时间点备份来创建数据库。 sourceDatabaseId 必须指定为现有数据库的资源 ID，并且必须指定 restorePointInTime。 恢复：通过还原异地复制的备份来创建数据库。 sourceDatabaseId 必须指定为要还原的可恢复数据库资源 ID。 还原：通过还原已删除数据库的备份来创建数据库。 必须指定 sourceDatabaseId。 如果 sourceDatabaseId 是数据库的原始资源 ID，则必须指定 sourceDatabaseDeletionDate。 否则，sourceDatabaseId 必须是可还原的已删除数据库资源 ID，并且 sourceDatabaseDeletionDate 将被忽略。 还可以将 restorePointInTime 指定为从较早的时间点还原。 RestoreLongTermRetentionBackup：通过从长期保留保管库还原来创建数据库。 recoveryServicesRecoveryPointResourceId 必须指定为恢复点资源 ID。 DataWarehouse 版本不支持 Copy、Secondary 和 RestoreLongTermRetentionBackup。 |
“Copy” “Default” “OnlineSecondary” “PointInTimeRestore” “恢复” “还原” “RestoreExternalBackup” “RestoreExternalBackupSecondary” “RestoreLongTermRetentionBackup” “Secondary” |
| elasticPoolId | 包含此数据库的弹性池的资源标识符。 | 字符串 |
| encryptionProtector | 数据库的 Azure 密钥保管库 URI（如果配置了每个数据库客户管理的密钥）。 | 字符串 |
| encryptionProtectorAutoRotation | 用于启用或禁用数据库加密保护程序 AKV 密钥的自动轮换的标志。 | bool |
| federatedClientId | 用于跨租户每个数据库 CMK 方案的客户端 ID | 字符串 约束： 最小长度 = 36 最大长度 = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| freeLimitExhaustionBehavior | 指定免费数据库的每月可用限制用尽时的行为。 AutoPause：当该月剩余时间的可用限制用尽时，数据库将自动暂停。 BillForUsage：在用尽免费限制后，数据库将继续联机，任何超额都将计费。 |
“AutoPause” “BillOverUsage” |
| highAvailabilityReplicaCount | 与数据库关联的用于提供高可用性的辅助副本数。 不适用于弹性池中的超大规模数据库。 | int |
| isLedgerOn | 此数据库是否为账本数据库，这意味着数据库中的所有表都是账本表。 注意：创建数据库后，无法更改此属性的值。 | bool |
| 密钥 | 要使用的用户分配标识的资源 ID | DatabasePropertiesKeys |
| LicenseType | 要为此数据库申请的许可证类型。 LicenseIncluded如果需要许可证，或者BasePrice如果你有许可证并且有资格获得Azure 混合权益。 |
“BasePrice” “LicenseIncluded” |
| longTermRetentionBackupResourceId | 与此数据库的创建操作关联的长期保留备份的资源标识符。 | 字符串 |
| maintenanceConfigurationId | 分配给数据库的维护配置 ID。 此配置定义将发生维护更新的时间段。 | 字符串 |
| manualCutover | 是否需要在“将数据库更新到超大规模”层的操作期间完成客户控制的手动直接转换。 此属性仅适用于将数据库从 业务关键/常规用途/高级/标准层缩放到超大规模层时。 指定 manualCutover 时，缩放操作将等待用户输入触发到超大规模数据库的直接转换。 若要触发直接转换，请在缩放操作处于等待状态时提供“performCutover”参数。 |
bool |
| maxSizeBytes | 以字节表示的数据库的最大大小。 | int |
| minCapacity | 数据库将始终分配的最小容量（如果未暂停）指定十进制值作为字符串。 | int 或 json decimal |
| performCutover | 在缩放操作正在进行时，在等待状态期间触发客户控制的手动直接转换。 此属性参数仅适用于随“manualCutover”参数一起启动的缩放操作。 仅当数据库从业务关键/常规用途/高级/标准层扩展到超大规模层时，此属性才适用。 指定 performCutover 时，缩放操作将触发直接转换并执行对超大规模数据库的角色更改。 |
bool |
| preferredEnclaveType | 对数据库请求的 enclave 类型，即默认或 VBS enclave。 | “Default” “VBS” |
| readScale | 只读路由的状态。 如果启用，则在其连接字符串中将应用程序意向设置为只读的连接可能会路由到同一区域中的只读辅助副本 (replica) 。 不适用于弹性池中的超大规模数据库。 | “Disabled” “已启用” |
| recoverableDatabaseId | 与此数据库的创建操作关联的可恢复数据库的资源标识符。 | 字符串 |
| recoveryServicesRecoveryPointId | 与此数据库的创建操作关联的恢复点的资源标识符。 | 字符串 |
| requestedBackupStorageRedundancy | 用于存储此数据库的备份的存储帐户类型。 | “Geo” “GeoZone” “Local” “区域” |
| restorableDroppedDatabaseId | 与此数据库的创建操作关联的可还原删除数据库的资源标识符。 | 字符串 |
| restorePointInTime | 指定要还原以创建新数据库的源数据库的时间点 (ISO8601 格式) 。 | 字符串 |
| sampleName | 创建此数据库时要应用的示例架构的名称。 | “AdventureWorksLT” “WideWorldImportersFull” “WideWorldImportersStd” |
| secondaryType | 数据库的辅助类型（如果它是辅助数据库）。 有效值为 Geo、Named 和 Standby。 | “Geo” “Named” "Standby" |
| sourceDatabaseDeletionDate | 指定数据库被删除的时间。 | 字符串 |
| sourceDatabaseId | 与此数据库的创建操作关联的源数据库的资源标识符。 | 字符串 |
| sourceResourceId | 与此数据库的创建操作关联的源的资源标识符。 此属性仅支持 DataWarehouse 版本，并允许跨订阅还原。 指定 sourceResourceId 时，不得指定 sourceDatabaseId、recoverableDatabaseId、restoreableDroppedDatabaseId 和 sourceDatabaseDeletionDate，并且 CreateMode 必须为 PointInTimeRestore、Restore 或 Recover。 当 createMode 为 PointInTimeRestore 时，sourceResourceId 必须是现有数据库或现有 sql 池的资源 ID，并且必须指定 restorePointInTime。 当 createMode 为 Restore 时，sourceResourceId 必须是可还原的已删除数据库或可还原的已删除 sql 池的资源 ID。 当 createMode 为“恢复”时，sourceResourceId 必须是可恢复数据库或可恢复 sql 池的资源 ID。 当源订阅属于与目标订阅不同的租户时，“x-ms-authorization-auxiliary”标头必须包含源租户的身份验证令牌。 有关“x-ms-authorization-auxiliary”标头的更多详细信息，请参阅 /azure/azure-resource-manager/management/authenticate-multi-tenant |
字符串 |
| useFreeLimit | 数据库是否使用免费每月限制。 在订阅中的一个数据库上允许。 | bool |
| zoneRedundant | 此数据库是否为区域冗余，这意味着此数据库的副本将分布在多个可用性区域。 | bool |
DatabasePropertiesKeys
| 名称 | 说明 | 值 |
|---|---|---|
| {customized property} | DatabaseKey |
DatabaseKey
此对象不包含在部署期间要设置的任何属性。 所有属性均为 ReadOnly。
SKU
| 名称 | 说明 | 值 |
|---|---|---|
| 容量 | 特定 SKU 的容量。 | int |
| family | 如果服务具有不同代系的硬件（对于同一 SKU），则可以在此处进行捕获。 | 字符串 |
| name | SKU 的名称，通常为字母 + 数字代码，例如 P3。 | 字符串 (必需) |
| 大小 | 特定 SKU 的大小 | 字符串 |
| 层 | 特定 SKU 的层或版本，例如“基本”、“高级”。 | 字符串 |