通过

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

Microsoft.Sql server 2021-02-01-preview

  • 项目

Bicep 资源定义

可以使用目标操作部署服务器资源类型：

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

资源格式

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

resource symbolicname 'Microsoft.Sql/servers@2021-02-01-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    administratorLogin: 'string'
    administratorLoginPassword: 'string'
    administrators: {
      administratorType: 'string'
      azureADOnlyAuthentication: bool
      login: 'string'
      principalType: 'string'
      sid: 'string'
      tenantId: 'string'
    }
    federatedClientId: 'string'
    keyId: 'string'
    minimalTlsVersion: 'string'
    primaryUserAssignedIdentityId: 'string'
    publicNetworkAccess: 'string'
    restrictOutboundNetworkAccess: 'string'
    version: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

Microsoft.Sql/servers

名字 描述 价值
身份 服务器的 Azure Active Directory 标识。 ResourceIdentity
位置 资源位置。 string （必需）
名字 资源名称 string （必需）
性能 资源属性。 ServerProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记

ResourceIdentity

名字 描述 价值
类型 标识类型。 将此设置为“SystemAssigned”，以便自动为资源创建和分配 Azure Active Directory 主体。 “None”
“SystemAssigned”
“SystemAssigned，UserAssigned”
“UserAssigned”
userAssignedIdentities 要使用的用户分配标识的资源 ID ResourceIdentityUserAssignedIdentities

ResourceIdentityUserAssignedIdentities

名字 描述 价值

ServerExternalAdministrator

名字 描述 价值
administratorType 服务器管理员的类型。 “ActiveDirectory”
azureADOnlyAuthentication 仅启用 Azure Active Directory 身份验证。 bool
登录 服务器管理员的登录名。 字符串
principalType 服务器管理员的主体类型。 “Application”
“Group”
“User”
sid 服务器管理员的 SID （对象 ID）。 字符串

约束：
最小长度 = 36
最大长度 = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
tenantId 管理员的租户 ID。 字符串

约束：
最小长度 = 36
最大长度 = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

ServerProperties

名字 描述 价值
administratorLogin 服务器的管理员用户名。 创建后，无法更改它。 字符串
administratorLoginPassword 管理员登录密码（创建服务器时需要）。 字符串
管理员 服务器的 Azure Active Directory 标识。 ServerExternalAdministrator
federatedClientId 用于跨租户 CMK 方案的客户端 ID 字符串

约束：
最小长度 = 36
最大长度 = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
keyId 要用于加密的密钥的 CMK URI。 字符串
minimalTlsVersion 最低 TLS 版本。 允许的值：“1.0”、“1.1”、“1.2” 字符串
primaryUserAssignedIdentityId 默认情况下要使用的用户分配标识的资源 ID。 字符串
publicNetworkAccess 是否允许对此服务器使用公共终结点访问。 值是可选的，但如果传入，则必须为“Enabled”或“Disabled” “Disabled”
“Enabled”
restrictOutboundNetworkAccess 是否限制此服务器的出站网络访问。 值是可选的，但如果传入，则必须为“Enabled”或“Disabled” “Disabled”
“Enabled”
版本 服务器的版本。 字符串

TrackedResourceTags

名字 描述 价值

UserIdentity

名字 描述 价值

快速入门示例

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

Bicep 文件 描述
Azure SQL Server，其中审核写入到 Log Analytics 使用此模板，可以部署启用了审核的 Azure SQL Server，以便将审核日志写入 Log Analytics （OMS 工作区）
创建 SQL Server 和数据库 使用此模板可以创建 SQL 数据库和服务器。
使用透明加密 专用 SQL 池 使用透明数据加密创建 SQL Server 和专用 SQL 池（以前为 SQL DW）。
在 Azure 体系结构 上部署体育分析 创建启用了 ADLS Gen 2 的 Azure 存储帐户、存储帐户的链接服务的 Azure 数据工厂实例（如果已部署的 Azure SQL 数据库）和 Azure Databricks 实例。 将为部署模板的用户的 AAD 标识以及 ADF 实例的托管标识授予存储帐户上的存储 Blob 数据参与者角色。 还有一些选项可用于部署 Azure Key Vault 实例、Azure SQL 数据库和 Azure 事件中心（用于流式处理用例）。 部署 Azure Key Vault 后，将为部署模板的用户提供数据工厂托管标识和 AAD 标识，并被授予 Key Vault 机密用户角色。
专用终结点示例 此模板演示如何创建指向 Azure SQL Server 的专用终结点
使用 SQL 数据库 预配 Web 应用 此模板预配 Web 应用、SQL 数据库、自动缩放设置、警报规则和 App Insights。 它在数据库的 Web 应用中配置连接字符串。
使用 Azure SQL 在 Linux 上 Sonarqube Docker Web 应用 此模板使用官方 Sonarqube 映像在 Azure 应用服务 Web 应用 Linux 容器中部署 Sonarqube，并由 Azure SQL Server 提供支持。
SQL 逻辑服务器 使用此模板可以创建 SQL 逻辑服务器。
使用托管标识、SQL Server 和 ΑΙ Web 应用 为应用 + 数据 + 托管标识 + 监视部署 Azure 基础结构的简单示例

ARM 模板资源定义

可以使用目标操作部署服务器资源类型：

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

资源格式

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

{
  "type": "Microsoft.Sql/servers",
  "apiVersion": "2021-02-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "administratorLogin": "string",
    "administratorLoginPassword": "string",
    "administrators": {
      "administratorType": "string",
      "azureADOnlyAuthentication": "bool",
      "login": "string",
      "principalType": "string",
      "sid": "string",
      "tenantId": "string"
    },
    "federatedClientId": "string",
    "keyId": "string",
    "minimalTlsVersion": "string",
    "primaryUserAssignedIdentityId": "string",
    "publicNetworkAccess": "string",
    "restrictOutboundNetworkAccess": "string",
    "version": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

Microsoft.Sql/servers

名字 描述 价值
apiVersion API 版本 '2021-02-01-preview'
身份 服务器的 Azure Active Directory 标识。 ResourceIdentity
位置 资源位置。 string （必需）
名字 资源名称 string （必需）
性能 资源属性。 ServerProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 “Microsoft.Sql/servers”

ResourceIdentity

名字 描述 价值
类型 标识类型。 将此设置为“SystemAssigned”，以便自动为资源创建和分配 Azure Active Directory 主体。 “None”
“SystemAssigned”
“SystemAssigned，UserAssigned”
“UserAssigned”
userAssignedIdentities 要使用的用户分配标识的资源 ID ResourceIdentityUserAssignedIdentities

ResourceIdentityUserAssignedIdentities

名字 描述 价值

ServerExternalAdministrator

名字 描述 价值
administratorType 服务器管理员的类型。 “ActiveDirectory”
azureADOnlyAuthentication 仅启用 Azure Active Directory 身份验证。 bool
登录 服务器管理员的登录名。 字符串
principalType 服务器管理员的主体类型。 “Application”
“Group”
“User”
sid 服务器管理员的 SID （对象 ID）。 字符串

约束：
最小长度 = 36
最大长度 = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
tenantId 管理员的租户 ID。 字符串

约束：
最小长度 = 36
最大长度 = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

ServerProperties

名字 描述 价值
administratorLogin 服务器的管理员用户名。 创建后，无法更改它。 字符串
administratorLoginPassword 管理员登录密码（创建服务器时需要）。 字符串
管理员 服务器的 Azure Active Directory 标识。 ServerExternalAdministrator
federatedClientId 用于跨租户 CMK 方案的客户端 ID 字符串

约束：
最小长度 = 36
最大长度 = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
keyId 要用于加密的密钥的 CMK URI。 字符串
minimalTlsVersion 最低 TLS 版本。 允许的值：“1.0”、“1.1”、“1.2” 字符串
primaryUserAssignedIdentityId 默认情况下要使用的用户分配标识的资源 ID。 字符串
publicNetworkAccess 是否允许对此服务器使用公共终结点访问。 值是可选的，但如果传入，则必须为“Enabled”或“Disabled” “Disabled”
“Enabled”
restrictOutboundNetworkAccess 是否限制此服务器的出站网络访问。 值是可选的，但如果传入，则必须为“Enabled”或“Disabled” “Disabled”
“Enabled”
版本 服务器的版本。 字符串

TrackedResourceTags

名字 描述 价值

UserIdentity

名字 描述 价值

快速入门模板

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

模板 描述
使用 Azure SQL 后端 应用服务环境

部署到 Azure 		此模板创建具有 Azure SQL 后端的应用服务环境以及专用终结点以及通常用于专用/隔离环境中的关联资源。
使用 Azure SQL 数据库 自动缩放 LANSA Windows VM ScaleSet

部署到 Azure 		该模板部署具有规模集中所需 VM 计数的 Windows VMSS，以及要安装到每个 VM 中的 LANSA MSI。 部署 VM 规模集后，将使用自定义脚本扩展安装 LANSA MSI）
Azure SQL Server，其中审核写入 Blob 存储

部署到 Azure 		使用此模板可以部署启用了审核的 Azure SQL Server，以便将审核日志写入 Blob 存储
将审核写入到事件中心 的 Azure SQL Server

部署到 Azure 		使用此模板可以部署启用了审核的 Azure SQL Server，以便将审核日志写入事件中心
Azure SQL Server，其中审核写入到 Log Analytics

部署到 Azure 		使用此模板，可以部署启用了审核的 Azure SQL Server，以便将审核日志写入 Log Analytics （OMS 工作区）
创建 SQL Server 和数据库

部署到 Azure 		使用此模板可以创建 SQL 数据库和服务器。
使用模板创建 Web 应用 + Redis 缓存 + SQL DB

部署到 Azure 		此模板使用 Redis 缓存和 SQL 数据库创建 Azure Web 应用。
使用数据加密保护程序创建 Azure SQL Server

部署到 Azure 		此模板创建 Azure SQL Server，使用存储在给定 Key Vault 中的给定密钥激活数据加密保护程序
使用故障转移组创建 Azure SQL Server 和数据库

部署到 Azure 		创建两个 Azure SQL 服务器、一个数据库和一个故障转移组。
创建、配置 Web 应用程序并将其部署到 Azure VM

部署到 Azure 		使用 SQL Azure 数据库创建和配置 Windows VM，并使用 PowerShell DSC 将 Web 应用程序部署到环境
使用透明加密 专用 SQL 池

部署到 Azure 		使用透明数据加密创建 SQL Server 和专用 SQL 池（以前为 SQL DW）。
部署 HDInsight 群集和 SQL 数据库

部署到 Azure 		使用此模板可以创建 HDInsight 群集和用于测试 Sqoop 的 SQL 数据库。
部署新的 SQL 弹性池

部署到 Azure 		使用此模板，可以使用新的关联 SQL Server 和新的 SQL 数据库来部署新的 SQL 弹性池来分配给它。
使用试用许可证部署 Octopus Deploy 3.0

部署到 Azure 		使用此模板，可以使用试用许可证部署单个 Octopus Deploy 3.0 服务器。 这将在单个 Windows Server 2012R2 VM（标准 D2）和 SQL DB （S1 层）上部署到为资源组指定的位置。
在 Azure 体系结构 上部署体育分析

部署到 Azure 		创建启用了 ADLS Gen 2 的 Azure 存储帐户、存储帐户的链接服务的 Azure 数据工厂实例（如果已部署的 Azure SQL 数据库）和 Azure Databricks 实例。 将为部署模板的用户的 AAD 标识以及 ADF 实例的托管标识授予存储帐户上的存储 Blob 数据参与者角色。 还有一些选项可用于部署 Azure Key Vault 实例、Azure SQL 数据库和 Azure 事件中心（用于流式处理用例）。 部署 Azure Key Vault 后，将为部署模板的用户提供数据工厂托管标识和 AAD 标识，并被授予 Key Vault 机密用户角色。
使用 SQL 数据库 Django 应用

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

部署到 Azure 		企业（小型或大型）的云采用需要负责任的高效治理模型才能从其云部署中派生价值。 CloudWise（解决方案的代码名称）是 Azure 合作伙伴快速入门中提供的复合解决方案，是客户、系统集成商和合作伙伴的采用启用器，它提供可自助、自动化的治理和运营解决方案，侧重于优化成本、提高应用程序的可靠性、降低业务风险。 该解决方案重点介绍了可见性和控制的核心治理支柱。
在 Azure 中 EPiserverCMS

部署到 Azure 		使用此模板，可以在 Azure 中创建 EpiServerCMS 部署所需的资源
使用 ILB ASE eShop 网站

部署到 Azure 		应用服务环境是 Azure 应用服务的高级服务计划选项，它提供完全隔离和专用的环境，用于大规模安全地运行 Azure 应用服务应用，包括 Web 应用、移动应用和 API 应用。
肯蒂科·xperience

部署到 Azure 		此模板有助于在 Microsoft Azure 中托管 Kentico Xperience 环境所需的资源部署。
使用 Azure DMS 迁移到 Azure SQL 数据库

部署到 Azure 		Azure 数据库迁移服务（DMS）旨在简化将本地数据库迁移到 Azure 的过程。 DMS 将简化将现有本地 SQL Server 和 Oracle 数据库迁移到 Azure SQL 数据库、Azure SQL 托管实例或 Azure 虚拟机中Microsoft SQL Server。 此模板将部署一个 Azure 数据库迁移服务的实例，一个安装了 SQL Server 的 Azure VM，它将充当源服务器，其中包含预先创建的数据库，目标 Azure SQL DB 服务器将具有要从源服务器迁移到目标服务器的预先创建的数据库架构。 该模板还将部署所需的资源，例如 NIC、vnet 等，以支持源 VM、DMS 服务和目标服务器。
Orchard CMS 视频门户 Web 应用

部署到 Azure 		此模板提供了在已启用和配置 Azure 媒体服务模块的 Azure 应用服务 Web 应用上部署 Orchard CMS 的简单方法。
专用终结点示例

部署到 Azure 		此模板演示如何创建指向 Azure SQL Server 的专用终结点
使用 SQL 数据库 预配移动应用

部署到 Azure 		此模板预配移动应用、SQL 数据库和通知中心。 它在移动应用中为数据库和通知中心配置连接字符串。
使用 TDE 预配 SQL 数据库

部署到 Azure 		此模板预配了一个 SQL Server，其中为 Azure 流量打开了防火墙，以及一个具有透明数据加密（TDE）的 SQL 数据库。
使用 SQL 数据库 预配 Web 应用

部署到 Azure 		此模板预配 Web 应用、SQL 数据库、自动缩放设置、警报规则和 App Insights。 它在数据库的 Web 应用中配置连接字符串。
具有高可用性的远程桌面服务

部署到 Azure 		此 ARM 模板示例代码将部署具有高可用性的 远程桌面服务 2019 会话集合 实验室。 目标是使用 Windows Server 2019 为远程桌面服务部署完全冗余且高度可用的解决方案。
可缩放的 Umbraco CMS Web 应用

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

部署到 Azure 		此模板提供了在 Azure 应用服务 Web 应用上部署 umbraco CMS Web 应用的简单方法。
使用 Azure SQL 在 Linux 上 Sonarqube Docker Web 应用

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

部署到 Azure 		使用此模板可以创建 SQL 逻辑服务器。
使用仅限 Azure AD 的身份验证 SQL Server

部署到 Azure 		使用此模板可以在 Azure 中创建 SQL Server，并启用 Azure AD 管理员集和仅 Azure AD 身份验证功能。
使用 SQL 数据库、Azure Cosmos DB、Azure 搜索 Web 应用

部署到 Azure 		此模板预配 Web 应用、SQL 数据库、Azure Cosmos DB、Azure 搜索和 Application Insights。
使用托管标识、SQL Server 和 ΑΙ Web 应用

部署到 Azure 		为应用 + 数据 + 托管标识 + 监视部署 Azure 基础结构的简单示例
使用 Azure SQL 专用终结点的 WebApp

部署到 Azure 		此模板演示如何创建使用指向 Azure SQL Server 的专用终结点的 Web 应用

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

可以使用目标操作部署服务器资源类型：

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/servers@2021-02-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      administratorLogin = "string"
      administratorLoginPassword = "string"
      administrators = {
        administratorType = "string"
        azureADOnlyAuthentication = bool
        login = "string"
        principalType = "string"
        sid = "string"
        tenantId = "string"
      }
      federatedClientId = "string"
      keyId = "string"
      minimalTlsVersion = "string"
      primaryUserAssignedIdentityId = "string"
      publicNetworkAccess = "string"
      restrictOutboundNetworkAccess = "string"
      version = "string"
    }
  })
}

属性值

Microsoft.Sql/servers

名字 描述 价值
身份 服务器的 Azure Active Directory 标识。 ResourceIdentity
位置 资源位置。 string （必需）
名字 资源名称 string （必需）
性能 资源属性。 ServerProperties
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.Sql/servers@2021-02-01-preview”

ResourceIdentity

名字 描述 价值
类型 标识类型。 将此设置为“SystemAssigned”，以便自动为资源创建和分配 Azure Active Directory 主体。 “None”
“SystemAssigned”
“SystemAssigned，UserAssigned”
“UserAssigned”
userAssignedIdentities 要使用的用户分配标识的资源 ID ResourceIdentityUserAssignedIdentities

ResourceIdentityUserAssignedIdentities

名字 描述 价值

ServerExternalAdministrator

名字 描述 价值
administratorType 服务器管理员的类型。 “ActiveDirectory”
azureADOnlyAuthentication 仅启用 Azure Active Directory 身份验证。 bool
登录 服务器管理员的登录名。 字符串
principalType 服务器管理员的主体类型。 “Application”
“Group”
“User”
sid 服务器管理员的 SID （对象 ID）。 字符串

约束：
最小长度 = 36
最大长度 = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
tenantId 管理员的租户 ID。 字符串

约束：
最小长度 = 36
最大长度 = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

ServerProperties

名字 描述 价值
administratorLogin 服务器的管理员用户名。 创建后，无法更改它。 字符串
administratorLoginPassword 管理员登录密码（创建服务器时需要）。 字符串
管理员 服务器的 Azure Active Directory 标识。 ServerExternalAdministrator
federatedClientId 用于跨租户 CMK 方案的客户端 ID 字符串

约束：
最小长度 = 36
最大长度 = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
keyId 要用于加密的密钥的 CMK URI。 字符串
minimalTlsVersion 最低 TLS 版本。 允许的值：“1.0”、“1.1”、“1.2” 字符串
primaryUserAssignedIdentityId 默认情况下要使用的用户分配标识的资源 ID。 字符串
publicNetworkAccess 是否允许对此服务器使用公共终结点访问。 值是可选的，但如果传入，则必须为“Enabled”或“Disabled” “Disabled”
“Enabled”
restrictOutboundNetworkAccess 是否限制此服务器的出站网络访问。 值是可选的，但如果传入，则必须为“Enabled”或“Disabled” “Disabled”
“Enabled”
版本 服务器的版本。 字符串

TrackedResourceTags

名字 描述 价值

UserIdentity

名字 描述 价值