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

Microsoft.AzureArcData sqlServer实例

Bicep 资源定义

可以使用目标操作部署 sqlServerInstances 资源类型：

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

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

资源格式

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

resource symbolicname 'Microsoft.AzureArcData/sqlServerInstances@2026-01-01' = {
  location: 'string'
  name: 'string'
  properties: {
    authentication: {
      mode: 'string'
      sqlServerEntraIdentity: [
        {
          clientId: 'string'
          identityType: 'string'
        }
      ]
    }
    backupPolicy: {
      differentialBackupHours: int
      fullBackupDays: int
      retentionPeriodDays: int
      transactionLogBackupMinutes: int
    }
    bestPracticesAssessment: {
      enabled: bool
      schedule: {
        cronTrigger: {
          expression: 'string'
          startTime: 'string'
          timeZone: 'string'
        }
        enabled: bool
      }
    }
    clientConnection: {
      enabled: bool
    }
    cores: 'string'
    databaseMirroringEndpoint: {}
    edition: 'string'
    failoverCluster: {}
    hostType: 'string'
    instanceName: 'string'
    migration: {
      assessment: {
        enabled: bool
        impactedObjectsSummary: {}
        settings: {
          costOptions: {
            computeAndStorageCostOption: 'string'
            sqlLicenseCostOption: 'string'
            windowsLicenseCostOption: 'string'
          }
          currency: 'string'
          discountPercentage: int
          lookbackPeriodInDays: int
          percentile: int
          strategy: 'string'
          targetLocation: 'string'
        }
      }
    }
    monitoring: {
      enabled: bool
    }
    serviceType: 'string'
    upgradeLockedUntil: 'string'
    version: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

Microsoft.AzureArcData/sqlServerInstances

名字	描述	价值
位置	资源所在的地理位置	string （必需）
名字	资源名称	string （必需）
性能	null	SqlServerInstanceProperties
标签	资源标记	标记名称和值的字典。请参阅模板中的标记

身份验证

名字	描述	价值
模式	SqlServer 中的身份验证模式。	“Mixed” “Undefined” “Windows”
sqlServerEntraIdentity	SQL Server 实例的条目身份验证配置。	EntraAuthentication[]

备份策略

名字	描述	价值
differentialBackupHours	差异备份间隔（以小时为单位）。	整数 (int)
fullBackupDays （完整备份日）	指示完整备份之间的天数的值。	int 约束：最小值 = 0 最大值 = 7
保留期间日	此托管实例中所有数据库的保留期。	int 约束：最小值 = 0 最大值 = 35
transactionLogBackupMinutes	指示事务日志备份之间的分钟数的值。	int 约束：最小值 = 0 最大值 = 60

最佳实践评估

名字	描述	价值
启用	指示是否为 SQL Server 实例启用了 SQL 最佳做法评估。	布尔
时间表	计划配置。	Schedule

客户端连接

名字	描述	价值
启用	指示是否为此 SQL Server 实例启用了客户端连接。	布尔

成本选项选择值

名字	描述	价值
computeAndStorageCost选项	选择成本节约选项，例如 With1YearASPAndDevTest。	字符串
sqlLicenseCost选项	是否具有 Azure 混合权益（AHB） SQL。	字符串
windowsLicenseCost选项	是否具有 Azure 混合权益（AHB） Windows 。	字符串

CronTrigger

名字	描述	价值
表达式	表示 CronTab 表达式的 cron 字符串。 crontab 表达式是一种非常紧凑的方式，用于表达重复计划，格式如下：“{分钟} {小时} {天} {月} {星期}。	字符串
startTime	指示触发器的开始时间。默认值是创建触发器的时间。	字符串
timeZone	计划触发器的时区。	字符串

DBMEndpoint

名字	描述	价值

EntraAuthentication

名字	描述	价值
客户端 ID	要查询Microsoft图形 API 的托管标识的客户端 ID。空字符串必须用于系统分配的托管标识。	字符串
身份类型	用于 Entra 身份验证的方法	“SystemAssignedManagedIdentity” “UserAssignedManagedIdentity”

故障转移集群

名字	描述	价值

ImpactedObjectsSuitabilitySummary （受影响对象适用性摘要）

名字	描述	价值

迁移

名字	描述	价值
评估	迁移评估相关的配置。	迁移评估

迁移评估

名字	描述	价值
启用	指示是否为此 SQL Server 实例启用了迁移评估。	布尔
受影响对象摘要	表示 Azure SQL DB 和 SQL MI 目标的每个功能类型的迁移就绪问题/警告摘要	ImpactedObjectsSuitabilitySummary （受影响对象适用性摘要）
settings	影响迁移评估计算的设置 - 如果未设置，则可以使用一些默认值进行配置。	迁移评估设置

迁移评估设置

名字	描述	价值
成本选项	选定的成本选项值。	成本选项选择值
货币	用于计算价格的货币 - 默认美元。	字符串
discountPercentage （折扣百分比）	应用于价格的固定折扣百分比 - 默认 0	整数 (int)
回溯周期在天	检查性能数据的回溯时间 - 默认值为 30（天）。	整数 (int)
百分位数	指示性能样本的百分位值。（默认值为第 95 个百分位数）	整数 (int)
strategy	最大限度地降低成本或迁移到 PaaS。 - 根据推荐策略进行评估	字符串
targetLocation	用于迁移的 Azure SQL SKU 的目标位置。 - 默认美国西部	字符串

监测

名字	描述	价值
启用	指示是否为此 SQL Server 实例启用了监视。	布尔

时间表

名字	描述	价值
克隆触发器	cron 触发器配置。	CronTrigger 的
启用	指示是否启用了计划。	布尔

SqlServerInstanceProperties

名字	描述	价值
身份验证	SQL Server 实例的身份验证相关配置。	身份验证
备份策略	SQL Server 的备份配置文件。	备份策略
最佳实践评估	与 SQL 最佳实践评估相关的配置。	最佳实践评估
client连接	客户端连接相关配置。	客户端连接
核心	托管 SQL Server 实例的操作系统环境（OSE）的总核心数。	字符串
databaseMirroringEndpoint	数据库镜像终结点相关属性。	DBMEndpoint
版	SQL Server 版本。	“商业智能” “Developer” “Enterprise” “评估” “Express” “标准开发商” “Standard” “Web”
failoverCluster 集群	故障转移群集实例属性。	故障转移集群
主机类型	Azure Arc SQL Server 的主机类型	“AWS Kubernetes 服务” “AWS 虚拟机” “AWS VMWare 虚拟机” “Azure Kubernetes 服务” “Azure 虚拟机” “Azure VMWare 虚拟机” “Container” “GCP Kubernetes 服务” “GCP 虚拟机” “GCP VMWare 虚拟机” “其他” “物理服务器” “虚拟机”
实例名称	SQL Server 实例名称。	字符串
迁移	迁移相关配置。	迁移
监测	监视配置。	监视
serviceType 服务	指示资源是否表示主机上安装的 SQL Server 引擎或 SQL Server 组件服务。	“Engine” “PBIRS” “SSAS” “SSIS” “SSRS”
upgradeLockedUntil	此资源的升级操作被锁定，直到它过期。此值指示的过期时间。当它为空时，它不会锁定。	字符串
版本	SQL Server 版本。	“SQL Server 2012” “SQL Server 2014” “SQL Server 2016” “SQL Server 2017” “SQL Server 2019” “SQL Server 2022” “SQL Server 2025” “未知”

TrackedResourceTags

名字	描述	价值

ARM 模板资源定义

可以使用目标操作部署 sqlServerInstances 资源类型：

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

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

资源格式

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

{
  "type": "Microsoft.AzureArcData/sqlServerInstances",
  "apiVersion": "2026-01-01",
  "name": "string",
  "location": "string",
  "properties": {
    "authentication": {
      "mode": "string",
      "sqlServerEntraIdentity": [
        {
          "clientId": "string",
          "identityType": "string"
        }
      ]
    },
    "backupPolicy": {
      "differentialBackupHours": "int",
      "fullBackupDays": "int",
      "retentionPeriodDays": "int",
      "transactionLogBackupMinutes": "int"
    },
    "bestPracticesAssessment": {
      "enabled": "bool",
      "schedule": {
        "cronTrigger": {
          "expression": "string",
          "startTime": "string",
          "timeZone": "string"
        },
        "enabled": "bool"
      }
    },
    "clientConnection": {
      "enabled": "bool"
    },
    "cores": "string",
    "databaseMirroringEndpoint": {
    },
    "edition": "string",
    "failoverCluster": {
    },
    "hostType": "string",
    "instanceName": "string",
    "migration": {
      "assessment": {
        "enabled": "bool",
        "impactedObjectsSummary": {
        },
        "settings": {
          "costOptions": {
            "computeAndStorageCostOption": "string",
            "sqlLicenseCostOption": "string",
            "windowsLicenseCostOption": "string"
          },
          "currency": "string",
          "discountPercentage": "int",
          "lookbackPeriodInDays": "int",
          "percentile": "int",
          "strategy": "string",
          "targetLocation": "string"
        }
      }
    },
    "monitoring": {
      "enabled": "bool"
    },
    "serviceType": "string",
    "upgradeLockedUntil": "string",
    "version": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

Microsoft.AzureArcData/sqlServerInstances

名字	描述	价值
apiVersion	API 版本	'2026-01-01'
位置	资源所在的地理位置	string （必需）
名字	资源名称	string （必需）
性能	null	SqlServerInstanceProperties
标签	资源标记	标记名称和值的字典。请参阅模板中的标记
类型	资源类型	“Microsoft.AzureArcData/sqlServerInstances”

身份验证

名字	描述	价值
模式	SqlServer 中的身份验证模式。	“Mixed” “Undefined” “Windows”
sqlServerEntraIdentity	SQL Server 实例的条目身份验证配置。	EntraAuthentication[]

备份策略

名字	描述	价值
differentialBackupHours	差异备份间隔（以小时为单位）。	整数 (int)
fullBackupDays （完整备份日）	指示完整备份之间的天数的值。	int 约束：最小值 = 0 最大值 = 7
保留期间日	此托管实例中所有数据库的保留期。	int 约束：最小值 = 0 最大值 = 35
transactionLogBackupMinutes	指示事务日志备份之间的分钟数的值。	int 约束：最小值 = 0 最大值 = 60

最佳实践评估

名字	描述	价值
启用	指示是否为 SQL Server 实例启用了 SQL 最佳做法评估。	布尔
时间表	计划配置。	Schedule

客户端连接

名字	描述	价值
启用	指示是否为此 SQL Server 实例启用了客户端连接。	布尔

成本选项选择值

名字	描述	价值
computeAndStorageCost选项	选择成本节约选项，例如 With1YearASPAndDevTest。	字符串
sqlLicenseCost选项	是否具有 Azure 混合权益（AHB） SQL。	字符串
windowsLicenseCost选项	是否具有 Azure 混合权益（AHB） Windows 。	字符串

CronTrigger

名字	描述	价值
表达式	表示 CronTab 表达式的 cron 字符串。 crontab 表达式是一种非常紧凑的方式，用于表达重复计划，格式如下：“{分钟} {小时} {天} {月} {星期}。	字符串
startTime	指示触发器的开始时间。默认值是创建触发器的时间。	字符串
timeZone	计划触发器的时区。	字符串

DBMEndpoint

名字	描述	价值

EntraAuthentication

名字	描述	价值
客户端 ID	要查询Microsoft图形 API 的托管标识的客户端 ID。空字符串必须用于系统分配的托管标识。	字符串
身份类型	用于 Entra 身份验证的方法	“SystemAssignedManagedIdentity” “UserAssignedManagedIdentity”

故障转移集群

名字	描述	价值

ImpactedObjectsSuitabilitySummary （受影响对象适用性摘要）

名字	描述	价值

迁移

名字	描述	价值
评估	迁移评估相关的配置。	迁移评估

迁移评估

名字	描述	价值
启用	指示是否为此 SQL Server 实例启用了迁移评估。	布尔
受影响对象摘要	表示 Azure SQL DB 和 SQL MI 目标的每个功能类型的迁移就绪问题/警告摘要	ImpactedObjectsSuitabilitySummary （受影响对象适用性摘要）
settings	影响迁移评估计算的设置 - 如果未设置，则可以使用一些默认值进行配置。	迁移评估设置

迁移评估设置

名字	描述	价值
成本选项	选定的成本选项值。	成本选项选择值
货币	用于计算价格的货币 - 默认美元。	字符串
discountPercentage （折扣百分比）	应用于价格的固定折扣百分比 - 默认 0	整数 (int)
回溯周期在天	检查性能数据的回溯时间 - 默认值为 30（天）。	整数 (int)
百分位数	指示性能样本的百分位值。（默认值为第 95 个百分位数）	整数 (int)
strategy	最大限度地降低成本或迁移到 PaaS。 - 根据推荐策略进行评估	字符串
targetLocation	用于迁移的 Azure SQL SKU 的目标位置。 - 默认美国西部	字符串

监测

名字	描述	价值
启用	指示是否为此 SQL Server 实例启用了监视。	布尔

时间表

名字	描述	价值
克隆触发器	cron 触发器配置。	CronTrigger 的
启用	指示是否启用了计划。	布尔

SqlServerInstanceProperties

名字	描述	价值
身份验证	SQL Server 实例的身份验证相关配置。	身份验证
备份策略	SQL Server 的备份配置文件。	备份策略
最佳实践评估	与 SQL 最佳实践评估相关的配置。	最佳实践评估
client连接	客户端连接相关配置。	客户端连接
核心	托管 SQL Server 实例的操作系统环境（OSE）的总核心数。	字符串
databaseMirroringEndpoint	数据库镜像终结点相关属性。	DBMEndpoint
版	SQL Server 版本。	“商业智能” “Developer” “Enterprise” “评估” “Express” “标准开发商” “Standard” “Web”
failoverCluster 集群	故障转移群集实例属性。	故障转移集群
主机类型	Azure Arc SQL Server 的主机类型	“AWS Kubernetes 服务” “AWS 虚拟机” “AWS VMWare 虚拟机” “Azure Kubernetes 服务” “Azure 虚拟机” “Azure VMWare 虚拟机” “Container” “GCP Kubernetes 服务” “GCP 虚拟机” “GCP VMWare 虚拟机” “其他” “物理服务器” “虚拟机”
实例名称	SQL Server 实例名称。	字符串
迁移	迁移相关配置。	迁移
监测	监视配置。	监视
serviceType 服务	指示资源是否表示主机上安装的 SQL Server 引擎或 SQL Server 组件服务。	“Engine” “PBIRS” “SSAS” “SSIS” “SSRS”
upgradeLockedUntil	此资源的升级操作被锁定，直到它过期。此值指示的过期时间。当它为空时，它不会锁定。	字符串
版本	SQL Server 版本。	“SQL Server 2012” “SQL Server 2014” “SQL Server 2016” “SQL Server 2017” “SQL Server 2019” “SQL Server 2022” “SQL Server 2025” “未知”

TrackedResourceTags

名字	描述	价值

用法示例

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

可以使用目标操作部署 sqlServerInstances 资源类型：

资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AzureArcData/sqlServerInstances@2026-01-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      authentication = {
        mode = "string"
        sqlServerEntraIdentity = [
          {
            clientId = "string"
            identityType = "string"
          }
        ]
      }
      backupPolicy = {
        differentialBackupHours = int
        fullBackupDays = int
        retentionPeriodDays = int
        transactionLogBackupMinutes = int
      }
      bestPracticesAssessment = {
        enabled = bool
        schedule = {
          cronTrigger = {
            expression = "string"
            startTime = "string"
            timeZone = "string"
          }
          enabled = bool
        }
      }
      clientConnection = {
        enabled = bool
      }
      cores = "string"
      databaseMirroringEndpoint = {
      }
      edition = "string"
      failoverCluster = {
      }
      hostType = "string"
      instanceName = "string"
      migration = {
        assessment = {
          enabled = bool
          impactedObjectsSummary = {
          }
          settings = {
            costOptions = {
              computeAndStorageCostOption = "string"
              sqlLicenseCostOption = "string"
              windowsLicenseCostOption = "string"
            }
            currency = "string"
            discountPercentage = int
            lookbackPeriodInDays = int
            percentile = int
            strategy = "string"
            targetLocation = "string"
          }
        }
      }
      monitoring = {
        enabled = bool
      }
      serviceType = "string"
      upgradeLockedUntil = "string"
      version = "string"
    }
  }
}

属性值

Microsoft.AzureArcData/sqlServerInstances

名字	描述	价值
位置	资源所在的地理位置	string （必需）
名字	资源名称	string （必需）
性能	null	SqlServerInstanceProperties
标签	资源标记	标记名称和值的字典。
类型	资源类型	“Microsoft.AzureArcData/sqlServerInstances@2026-01-01”

身份验证

名字	描述	价值
模式	SqlServer 中的身份验证模式。	“Mixed” “Undefined” “Windows”
sqlServerEntraIdentity	SQL Server 实例的条目身份验证配置。	EntraAuthentication[]

备份策略

名字	描述	价值
differentialBackupHours	差异备份间隔（以小时为单位）。	整数 (int)
fullBackupDays （完整备份日）	指示完整备份之间的天数的值。	int 约束：最小值 = 0 最大值 = 7
保留期间日	此托管实例中所有数据库的保留期。	int 约束：最小值 = 0 最大值 = 35
transactionLogBackupMinutes	指示事务日志备份之间的分钟数的值。	int 约束：最小值 = 0 最大值 = 60

最佳实践评估

名字	描述	价值
启用	指示是否为 SQL Server 实例启用了 SQL 最佳做法评估。	布尔
时间表	计划配置。	Schedule

客户端连接

名字	描述	价值
启用	指示是否为此 SQL Server 实例启用了客户端连接。	布尔

成本选项选择值

名字	描述	价值
computeAndStorageCost选项	选择成本节约选项，例如 With1YearASPAndDevTest。	字符串
sqlLicenseCost选项	是否具有 Azure 混合权益（AHB） SQL。	字符串
windowsLicenseCost选项	是否具有 Azure 混合权益（AHB） Windows 。	字符串

CronTrigger

名字	描述	价值
表达式	表示 CronTab 表达式的 cron 字符串。 crontab 表达式是一种非常紧凑的方式，用于表达重复计划，格式如下：“{分钟} {小时} {天} {月} {星期}。	字符串
startTime	指示触发器的开始时间。默认值是创建触发器的时间。	字符串
timeZone	计划触发器的时区。	字符串

DBMEndpoint

名字	描述	价值

EntraAuthentication

名字	描述	价值
客户端 ID	要查询Microsoft图形 API 的托管标识的客户端 ID。空字符串必须用于系统分配的托管标识。	字符串
身份类型	用于 Entra 身份验证的方法	“SystemAssignedManagedIdentity” “UserAssignedManagedIdentity”

故障转移集群

名字	描述	价值

ImpactedObjectsSuitabilitySummary （受影响对象适用性摘要）

名字	描述	价值

迁移

名字	描述	价值
评估	迁移评估相关的配置。	迁移评估

迁移评估

名字	描述	价值
启用	指示是否为此 SQL Server 实例启用了迁移评估。	布尔
受影响对象摘要	表示 Azure SQL DB 和 SQL MI 目标的每个功能类型的迁移就绪问题/警告摘要	ImpactedObjectsSuitabilitySummary （受影响对象适用性摘要）
settings	影响迁移评估计算的设置 - 如果未设置，则可以使用一些默认值进行配置。	迁移评估设置

迁移评估设置

名字	描述	价值
成本选项	选定的成本选项值。	成本选项选择值
货币	用于计算价格的货币 - 默认美元。	字符串
discountPercentage （折扣百分比）	应用于价格的固定折扣百分比 - 默认 0	整数 (int)
回溯周期在天	检查性能数据的回溯时间 - 默认值为 30（天）。	整数 (int)
百分位数	指示性能样本的百分位值。（默认值为第 95 个百分位数）	整数 (int)
strategy	最大限度地降低成本或迁移到 PaaS。 - 根据推荐策略进行评估	字符串
targetLocation	用于迁移的 Azure SQL SKU 的目标位置。 - 默认美国西部	字符串

监测

名字	描述	价值
启用	指示是否为此 SQL Server 实例启用了监视。	布尔

时间表

名字	描述	价值
克隆触发器	cron 触发器配置。	CronTrigger 的
启用	指示是否启用了计划。	布尔

SqlServerInstanceProperties

名字	描述	价值
身份验证	SQL Server 实例的身份验证相关配置。	身份验证
备份策略	SQL Server 的备份配置文件。	备份策略
最佳实践评估	与 SQL 最佳实践评估相关的配置。	最佳实践评估
client连接	客户端连接相关配置。	客户端连接
核心	托管 SQL Server 实例的操作系统环境（OSE）的总核心数。	字符串
databaseMirroringEndpoint	数据库镜像终结点相关属性。	DBMEndpoint
版	SQL Server 版本。	“商业智能” “Developer” “Enterprise” “评估” “Express” “标准开发商” “Standard” “Web”
failoverCluster 集群	故障转移群集实例属性。	故障转移集群
主机类型	Azure Arc SQL Server 的主机类型	“AWS Kubernetes 服务” “AWS 虚拟机” “AWS VMWare 虚拟机” “Azure Kubernetes 服务” “Azure 虚拟机” “Azure VMWare 虚拟机” “Container” “GCP Kubernetes 服务” “GCP 虚拟机” “GCP VMWare 虚拟机” “其他” “物理服务器” “虚拟机”
实例名称	SQL Server 实例名称。	字符串
迁移	迁移相关配置。	迁移
监测	监视配置。	监视
serviceType 服务	指示资源是否表示主机上安装的 SQL Server 引擎或 SQL Server 组件服务。	“Engine” “PBIRS” “SSAS” “SSIS” “SSRS”
upgradeLockedUntil	此资源的升级操作被锁定，直到它过期。此值指示的过期时间。当它为空时，它不会锁定。	字符串
版本	SQL Server 版本。	“SQL Server 2012” “SQL Server 2014” “SQL Server 2016” “SQL Server 2017” “SQL Server 2019” “SQL Server 2022” “SQL Server 2025” “未知”

TrackedResourceTags

名字	描述	价值

反馈

此页面是否有帮助？

Last updated on 2025-10-08

Microsoft.AzureArcData sqlServer实例

Bicep 资源定义

资源格式

属性值

Microsoft.AzureArcData/sqlServerInstances

身份验证

备份策略

最佳实践评估

客户端连接

成本选项选择值

CronTrigger

DBMEndpoint

EntraAuthentication

故障转移集群

ImpactedObjectsSuitabilitySummary （受影响对象适用性摘要）

迁移

迁移评估

迁移评估设置

监测

时间表

SqlServerInstanceProperties

TrackedResourceTags

ARM 模板资源定义

资源格式

属性值

Microsoft.AzureArcData/sqlServerInstances

身份验证

备份策略

最佳实践评估

客户端连接

成本选项选择值

CronTrigger

DBMEndpoint

EntraAuthentication

故障转移集群

ImpactedObjectsSuitabilitySummary （受影响对象适用性摘要）

迁移

迁移评估

迁移评估设置

监测

时间表

SqlServerInstanceProperties

TrackedResourceTags

用法示例

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

资源格式

属性值

Microsoft.AzureArcData/sqlServerInstances

身份验证

备份策略

最佳实践评估

客户端连接

成本选项选择值

CronTrigger

DBMEndpoint

EntraAuthentication

故障转移集群

ImpactedObjectsSuitabilitySummary （受影响对象适用性摘要）

迁移

迁移评估

迁移评估设置

监测

时间表

SqlServerInstanceProperties

TrackedResourceTags

反馈

其他资源