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

Microsoft.Resources 部署 2021-04-01

• 最新
• 2022-09-01
• 2021-04-01
• 2021-01-01
• 2020-10-01

Bicep 资源定义

部署资源类型可以部署到：

• 资源组 - 请参阅 资源组部署命令
• 订阅 - 请参阅 订阅部署命令
• 管理组 - 请参阅 管理组部署命令
• 租户 - 请参阅 租户部署命令

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

注解

对于 Bicep，请考虑 使用模块 而不是此资源类型。

资源格式

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

resource symbolicname 'Microsoft.Resources/deployments@2021-04-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  scope: 'string'
  properties: {
    debugSetting: {
      detailLevel: 'string'
    }
    expressionEvaluationOptions: {
      scope: 'string'
    }
    mode: 'string'
    onErrorDeployment: {
      deploymentName: 'string'
      type: 'string'
    }
    parameters: any()
    parametersLink: {
      contentVersion: 'string'
      uri: 'string'
    }
    template: any()
    templateLink: {
      contentVersion: 'string'
      id: 'string'
      queryString: 'string'
      relativePath: 'string'
      uri: 'string'
    }
  }
  resourceGroup: 'string'
  subscriptionId: 'string'
}

属性值

deployments

名称	说明	值
name	资源名称	字符串 (必需) 字符限制：1-64 有效字符： 字母数字、下划线、括号、连字符和句点。
location	用于存储部署数据的位置。	string
标记	部署标记	标记名称和值的字典。 请参阅 模板中的标记
scope	在租户和管理组部署中，向目标提供管理组 ID。 使用格式 Microsoft.Management/managementGroups/{managementGroupID}。	string
properties	部署属性。	DeploymentPropertiesOrDeploymentPropertiesExtended (必需)
resourceGroup	要部署到的资源组的名称。 如果未提供，请使用部署操作的资源组。	字符串
subscriptionId	要部署到的订阅的 ID。 如果未提供，请使用部署操作的订阅。	字符串

DeploymentPropertiesOrDeploymentPropertiesExtended

名称	说明	值
debugSetting	部署的调试设置。	DebugSetting
expressionEvaluationOptions	指定是在父模板还是嵌套模板的范围内计算模板表达式。 仅适用于嵌套模板。 如果未指定，默认值为 outer。	ExpressionEvaluationOptions
mode	用于部署资源的模式。 此值可以是“增量”或“完成”。 在增量模式下，将在不删除模板中未包含的现有资源的情况下部署资源。 在“完成”模式下，部署资源，并删除资源组中未包含在模板中的现有资源。 使用“完成”模式时要小心，因为可能会无意中删除资源。	“Complete” “增量” (必需)
onErrorDeployment	错误行为的部署。	OnErrorDeploymentOrOnErrorDeploymentExtended
parameters	定义模板部署参数的名称和值对。 如果要直接在请求中提供参数值，而不是链接到现有参数文件，请使用此元素。 使用 parametersLink 属性或 parameters 属性，但不能同时使用两者。 它可以是 JObject 或格式正确的 JSON 字符串。	对于 Bicep，可以使用 any () 函数。
parametersLink	参数文件的 URI。 使用此元素链接到现有参数文件。 使用 parametersLink 属性或 parameters 属性，但不能同时使用两者。	ParametersLink
template	模板内容。 如果要直接在请求中传递模板语法，而不是链接到现有模板，请使用此元素。 它可以是 JObject 或格式正确的 JSON 字符串。 使用 templateLink 属性或模板属性，但不能同时使用两者。	对于 Bicep，可以使用 any () 函数。
templateLink	模板的 URI。 使用 templateLink 属性或模板属性，但不能同时使用两者。	TemplateLink

DebugSetting

名称	说明	值
detailLevel	指定要记录用于调试的信息类型。 允许的值是 none、requestContent、responseContent，或者用逗号分隔的 requestContent 和 responseContent。 默认值为 none。 设置此值时，请仔细考虑在部署期间传入的信息类型。 通过记录有关请求或响应的信息，可能会公开通过部署操作检索的机密数据。	字符串

ExpressionEvaluationOptions

名称	说明	值
scope	用于计算嵌套模板中参数、变量和函数的范围。	“Inner” “NotSpecified” “Outer”

OnErrorDeploymentOrOnErrorDeploymentExtended

名称	说明	值
deploymentName	要针对错误情况使用的部署。	字符串
type	错误行为类型的部署。 可能的值为 LastSuccessful 和 SpecificDeployment。	“LastSuccessful” “SpecificDeployment”

ParametersLink

名称	说明	值
contentVersion	如果包含，则必须与模板中的 ContentVersion 匹配。	字符串
uri	参数文件的 URI。	字符串 (必需)

TemplateLink

名称	说明	值
contentVersion	如果包含，则必须与模板中的 ContentVersion 匹配。	string
id	模板规格的资源 ID。请使用 ID 或 uri 属性，但不能同时使用两者。	string
queryString	例如，查询字符串 (要与 templateLink URI 一起使用的 SAS 令牌) 。	string
relativePath	relativePath 属性可用于在相对于父级的位置部署链接模板。 如果父模板与 TemplateSpec 链接，则会引用 TemplateSpec 中的项目。 如果父级与 URI 链接，则子部署将是父级和 relativePath URI 的组合	字符串
uri	要部署的模板的 URI。 使用 uri 或 id 属性，但不能同时使用两者。	字符串

快速入门模板

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

模板	说明
Moesif API 分析和盈利	该模板会将 Azure API 管理的 API 调用记录到 Moesif API 分析和盈利平台
使用注册表创建容器应用和环境	使用Azure 容器注册表的基本容器应用创建容器应用环境。 它还部署 Log Analytics 工作区来存储日志。
使用容器应用创建 Dapr 微服务应用	使用容器应用创建 Dapr 微服务应用。
使用容器应用创建 Dapr pub-sub servicebus 应用	使用容器应用创建 Dapr pub-sub servicebus 应用。
由 Desired State Configuration 服务管理的服务器	此模板提供了一个示例，说明如何在单个部署中交付虚拟机和自动化帐户以管理计算机
为 Azure 业务连续性项创建警报规则	此模板创建警报规则和用户分配的 MSI。 它还向 MSI 读取者分配对订阅的访问权限，以便警报规则有权查询所需的受保护项和最新的恢复点详细信息。
Ubuntu VM 上的 Redis 群集	此模板在 Ubuntu 虚拟机映像上创建 Redis 群集，配置持久性并应用众所周知的优化和行之有效的做法
具有App 服务源和专用链接的 Front Door Premium	此模板创建 Front Door Premium 和 App 服务，并使用 Front Door 的专用终结点将流量发送到应用程序。
具有 Blob 源和专用链接的 Front Door Premium	此模板创建 Front Door Premium 和 Azure 存储 Blob 容器，并使用 Front Door 的专用终结点将流量发送到存储帐户。
具有 VM 和专用链接服务的 Front Door Premium	此模板创建一个 Front Door Premium 和一个配置为 Web 服务器的虚拟机。 Front Door 使用具有专用链接服务的专用终结点将流量发送到 VM。
具有API 管理源的 Front Door 标准版/高级版	此模板创建 Front Door Premium 和 API 管理 实例，并使用 NSG 和全局API 管理策略来验证流量是否已通过 Front Door 源。
具有应用程序网关源的 Front Door 标准版/高级版	此模板创建 Front Door 标准版/高级版和应用程序网关实例，并使用 NSG 和 WAF 策略来验证流量是否已通过 Front Door 源。
带有容器实例和应用程序网关的 Front Door	此模板使用容器组和应用程序网关创建 Front Door 标准版/高级版。
具有Azure Functions源的 Front Door 标准版/高级版	此模板创建 Front Door 标准版/高级版（Azure Functions应用），并配置函数应用以验证流量是否已通过 Front Door 源。
具有静态网站源的 Front Door 标准版/高级版	此模板创建 Front Door 标准版/高级版和 Azure 存储静态网站，并将 Front Door 配置为将流量发送到静态网站。
从加密的 VHD 创建加密的托管磁盘	此模板允许使用现有的加密 VHD 和加密设置创建加密托管磁盘。
在正在运行的 Windows VM 上禁用加密	此模板在正在运行的 Windows VM 上禁用加密
在运行的 Windows VM & AAD 上启用加密	此模板使用 AAD 客户端证书指纹在正在运行的 Windows VM 上启用加密。 证书应已部署到 VM 之前
SUSE 上的 GlassFish	此模板部署负载均衡的 GlassFish (v3 或 v4) 群集，其中包含用户定义的 SUSE (OpenSUSE 或 SLES) VM。
部署 Linux VM 的多个 VM 规模集	此模板允许部署 Linux VM 的多个 VM 规模集。
部署 Windows VM 的多个 VM 规模集	此模板允许部署 Windows VM 的多个 VM 规模集。
部署简单的 Linux VM 并将专用 IP 更新为静态	此模板允许使用 Ubuntu 从市场部署简单的 Linux VM。 这会使用动态分配的 IP 地址在资源组位置部署 VNET、子网和 A1 大小的 VM，然后将其转换为静态 IP。
在部署期间使用自定义脚本扩展的输出	这对于 VM 的计算在部署期间执行 Azure 资源管理器不提供的某些任务非常有用。 然后，可以在部署中的其他位置利用该计算 (脚本) 的输出。 如果在部署中需要计算资源， (例如 jumpbox、DC 等) ，则这非常有用，如果不是，则有点浪费。
使用 MSI 部署 Linux 或 Windows VM	此模板允许使用托管服务标识部署 Linux 或 Windows VM。
具有 MSI 访问存储的 Linux VM	此模板部署具有系统分配的托管标识的 Linux VM，该标识有权访问不同资源组中的存储帐户。
带自动备份的 SQL Server 2014 SP2 Enterprise	此模板将创建启用了自动备份功能的 SQL Server 2014 SP2 企业版
SQL Server 2014 SP1 Enterprise with Azure 密钥保管库	此模板将创建启用了 Azure 密钥保管库 集成功能的 SQL Server 2014 SP1 Enterprise 版本。
虚拟机方案的病毒攻击	这将部署 2 个虚拟机、OMS 和其他网络资源。 一个没有 Endpoint Protection 的虚拟机，另一个虚拟机安装了 enpoint Protection。 按照指南执行病毒攻击，并执行缓解和预防病毒攻击的方案。
创建数据管理网关并在 Azure VM 上安装	此模板部署虚拟机并创建可行的数据管理网关
Azure VM 上的自承载Integration Runtime	此模板创建自承载集成运行时并将其注册到 Azure 虚拟机上
由 Azure 自动化 管理的 VM 规模集配置	部署 VM 规模集，其中虚拟机部署为 Azure 自动化 Desired State Configuration 服务中的已注册节点，并在部署后保证节点配置一致性。 注意：只有在成功创建 Azure 自动化 DSC 的Azure 自动化帐户后，注册密钥和注册 URL 才是必需的先决条件。
VMSS 灵活业务流程模式快速入门 Linux	此模板部署一个简单的 VM 规模集，其中包含Azure 负载均衡器后面的实例。 VM 规模集处于灵活业务流程模式。 使用 os 参数选择 Linux (Ubuntu) 或 Windows (Windows Server Datacenter 2019) 部署。 注意：此快速入门模板允许从任何 Internet 地址 (SSH、RDP) 对 VM 管理端口进行网络访问，不应用于生产部署。
使用 MSI 部署 Linux 或 Windows VMSS	此模板允许使用托管服务标识部署 Linux 或 Windows 虚拟机规模集。 然后，该标识用于访问 Azure 服务。
使用现有存储帐户的按需 SFTP 服务器	此模板演示使用 Azure 容器实例 (ACI) 的按需 SFTP 服务器。
(AKS) 部署托管 Kubernetes 群集	此 ARM 模板演示如何将具有高级网络功能的 AKS 实例部署到现有虚拟网络中。 此外，针对包含 AKS 群集的子网，为所选服务主体分配网络参与者角色。
使用 AAD (AKS) 部署托管 Kubernetes 群集	此 ARM 模板演示了如何将具有高级网络功能的 AKS 实例部署到现有虚拟网络和 Azure AD 整数中。 此外，针对包含 AKS 群集的子网，为所选服务主体分配网络参与者角色。
FinOps 中心	此模板创建新的 FinOps 中心实例，包括 Data Lake 存储和数据工厂。
FinOps 工具包工作簿	此模板创建用于治理的新 Azure Monitor 工作簿。
使用自定义提供程序扩展现有 Azure 资源	此示例将详细介绍如何扩展现有 Azure 资源，以及如何资源管理器模板来添加自定义工作负载。
使用 PE、CMK 所有窗体部署 Azure Databricks 工作区	此模板允许创建具有 PrivateEndpoint 和托管服务的 Azure Databricks 工作区，以及使用 DBFS 加密的 CMK。
使用所有 3 种形式的 CMK 部署 Azure Databricks 工作区	此模板允许创建具有托管服务的 Azure Databricks 工作区，并使用 DBFS 加密创建 CMK。
使用 CMK 部署用于 DBFS 加密的 Azure Databricks WS	此模板允许使用 CMK 创建用于 DBFS 根加密的 Azure Databricks 工作区
使用 托管磁盘 CMK 部署 Azure Databricks 工作区	此模板允许使用 托管磁盘 CMK 创建 Azure Databricks 工作区。
使用托管服务 CMK 部署 Azure Databricks 工作区	此模板允许使用托管服务 CMK 创建 Azure Databricks 工作区。
创建新的 Datadog 组织	此模板创建一个新的 Datadog - 一个 Azure 本机 ISV 服务资源和一个 Datadog 组织，用于监视订阅中的资源。
使用脚本扩展在 Ubuntu VM 上安装 Mongo DB	此模板使用两个单独的脚本在 Ubuntu 虚拟机上部署配置和安装 Mongo DB。 此模板是一个很好的示例，展示了如何表示在同一虚拟机上运行的两个脚本之间的依赖关系。 此模板还部署存储帐户、虚拟网络、公共 IP 地址和网络接口。
创建 HA 数据管理网关并在 Azure VM 上安装	此模板使用可行的 HA 数据管理网关部署多个虚拟机
使用加密 (密钥保管库) 部署 Data Lake Store 帐户	此模板允许部署启用了数据加密的 Azure Data Lake Store 帐户。 此帐户使用 Azure 密钥保管库 来管理加密密钥。
使用 Azure 服务执行 ETL 作业	此模板提供了一个示例，说明如何对存储在 Azure Blob 存储 中的历史和实时流数据执行分析。 来自事件中心的数据由 Azure 流分析作业用于执行转换，输出存储在 Azure Blob 存储 中，并在 PowerBI 中可视化。 分析由 Azure 数据分析应用于 Blob 存储中存储的历史数据，并移动提取、转换和发布的数据，业务流程由数据工厂完成。 已发布的数据在 PowerBI 中进一步可视化
使用内置映像部署 Dev Box 服务	此模板提供了一种使用内置映像部署 Dev Box 服务的方法。
配置 Dev Box 服务	此模板将按照 Dev Box 快速入门指南创建所有 Dev Box 管理员资源。 可以查看创建的所有资源，也可以直接转到 DevPortal.microsoft.com 创建第一个 Dev Box。
具有函数和专用链接服务的 Azure 数字孪生	此模板创建一个 Azure 数字孪生服务，该服务配置有虚拟网络连接的 Azure 函数，该函数可以通过专用链接终结点与数字孪生进行通信。 它还创建专用 DNS区域，允许数字孪生终结点从虚拟网络到专用终结点内部子网 IP 地址的主机名无缝解析。 主机名作为设置存储到名为“ADT_ENDPOINT”的 Azure 函数。
具有时间数据历史记录连接的 Azure 数字孪生	此模板创建配置了时序数据历史记录连接的 Azure 数字孪生实例。 若要创建连接，必须创建其他资源，例如事件中心命名空间、事件中心、Azure 数据资源管理器群集和数据库。 数据将发送到事件中心，该事件中心最终将数据转发到 Azure 数据资源管理器 群集。 数据存储在群集的数据库表中
在 VNET 中使用自定义 Ambari + Hive 元存储 DB 的 HDInsight	此模板允许在现有虚拟网络中创建 HDInsight 群集，其中包含同时充当自定义 Ambari DB 和 Hive 元存储的新 SQL 数据库。 必须具有现有的 SQL Sever、存储帐户和 VNET。
配置 FHIR 服务以启用$import	此模板预配 FHIR 服务，以便为初始数据加载启用$import
创建密钥保管库、托管标识和角色分配	此模板创建密钥保管库、托管标识和角色分配。
将 KeyVault 与动态 resourceId 配合使用	此模板创建SQL Server并使用来自 密钥保管库 的管理员密码。 密钥保管库机密的引用参数是在部署时使用嵌套模板创建的。 这样，用户只需将参数值传递给模板，而不是在参数文件中创建引用参数。
使用 Helm (AKS) 的 Azure 容器服务	使用 Helm 通过 Azure 容器服务 (AKS) 部署托管群集
使用逻辑应用按计划运行计时器作业	此模板创建一对逻辑应用，用于创建计划的计时器作业实例。
用户分配的标识角色分配模板	一个模板，用于在 Azure 机器学习工作区所依赖的资源上创建用户分配标识的角色分配
Azure 机器学习端到端安全设置	这组 Bicep 模板演示如何在安全设置中端到端地设置 Azure 机器学习。 此参考实现包括工作区、计算群集、计算实例和附加的专用 AKS 群集。
Azure 机器学习端到端安全设置 (旧版)	这组 Bicep 模板演示如何在安全设置中端到端地设置 Azure 机器学习。 此参考实现包括工作区、计算群集、计算实例和附加的专用 AKS 群集。
创建 Azure 机器学习扫描作业	此模板创建用于超参数优化的 Azure 机器学习扫描作业。
(vnet) 创建 Azure 机器学习服务工作区	此部署模板指定 Azure 机器学习工作区及其关联的资源，包括 Azure 密钥保管库、Azure 存储、Azure 应用程序见解和Azure 容器注册表。 此配置描述了在网络隔离设置中开始使用 Azure 机器学习所需的资源集。
(旧版) 创建 Azure 机器学习服务工作区	此部署模板指定 Azure 机器学习工作区及其关联的资源，包括 Azure 密钥保管库、Azure 存储、Azure 应用程序见解和Azure 容器注册表。 此配置描述了在网络隔离设置中开始使用 Azure 机器学习所需的资源集。
使用 SMB 卷创建新的 ANF 资源	使用此模板可以创建新的Azure NetApp 文件资源，其中包含配置了 SMB 协议的单个容量池和单个卷。
具有 IP 限制的 Web 应用的应用程序网关	此模板在 Azure Web 应用前面创建应用程序网关，并在 Web 应用上启用了 IP 限制。
将 NSG 应用于现有子网	此模板将新创建的 NSG 应用于现有子网
使用流量分析的 NSG 流日志	此模板使用流量分析在现有 NSG 上创建 NSG 流日志
Azure 虚拟 WAN路由意向和策略	此模板预配 Azure 虚拟 WAN，其中两个中心启用了路由意向和策略功能。
将具有 Redis 安全规则的 NSG 添加到现有子网	此模板允许将具有预配置的 Azure Redis 缓存安全规则的 NSG 添加到 VNET 中的现有子网。 部署到现有 VNET 的资源组中。
通过 ACR 任务生成容器映像	此模板使用 DeploymentScript 协调 ACR，以从代码存储库生成容器映像。
将容器映像导入 ACR	此模板利用 bicep 注册表中的导入 ACR 模块将公共容器映像导入Azure 容器注册表。
使用证书创建应用程序网关	此模板演示如何生成密钥保管库自签名证书，然后从应用程序网关引用。
在 KeyVault 中创建 ssh 密钥和存储	此模板使用 deploymentScript 资源生成 ssh 密钥，并将私钥存储在 keyVault 中。
创建和部署模板Spec	此示例在同一模板中创建并部署 templateSpec 资源。 这不是一个典型的模式，只是为了显示 templateSpec 和部署资源如何协同工作。
从模板库模板创建 TemplateSpecs	此示例包含一个脚本，用于轻松地将模板库模板迁移到 templateSpec 资源。 模板提供的将部署可以使用迁移脚本导出的所有模板。
使用现有 SQL 虚拟机部署 SQL Always ON 安装程序	使用现有 SQL 虚拟机部署 SQL Always ON 安装程序。 虚拟机应已加入现有域，并且必须运行企业版SQL Server。
Azure Synapse概念证明	此模板为Azure Synapse创建概念证明环境，包括 SQL 池和可选的 Apache Spark 池
在 ASEv3 中创建 AppServicePlan 和应用	在 ASEv3 中创建 AppServicePlan 和应用
创建 Azure Native New Relic 资源	此模板设置“Azure Native New Relic 服务”来监视 Azure 订阅中的资源。

ARM 模板资源定义

部署资源类型可以部署到：

• 资源组 - 请参阅 资源组部署命令
• 订阅 - 请参阅 订阅部署命令
• 管理组 - 请参阅 管理组部署命令
• 租户 - 请参阅 租户部署命令

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

注解

对于 Bicep，请考虑 使用模块 而不是此资源类型。

资源格式

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

{
  "type": "Microsoft.Resources/deployments",
  "apiVersion": "2021-04-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "scope": "string",
  "properties": {
    "debugSetting": {
      "detailLevel": "string"
    },
    "expressionEvaluationOptions": {
      "scope": "string"
    },
    "mode": "string",
    "onErrorDeployment": {
      "deploymentName": "string",
      "type": "string"
    },
    "parameters": {},
    "parametersLink": {
      "contentVersion": "string",
      "uri": "string"
    },
    "template": {},
    "templateLink": {
      "contentVersion": "string",
      "id": "string",
      "queryString": "string",
      "relativePath": "string",
      "uri": "string"
    }
  },
  "resourceGroup": "string",
  "subscriptionId": "string"
}

属性值

deployments

名称	说明	Value
type	资源类型	“Microsoft.Resources/deployments”
apiVersion	资源 API 版本	'2021-04-01'
name	资源名称	字符串 (必需) 字符限制：1-64 有效字符： 字母数字、下划线、括号、连字符和句点。
location	用于存储部署数据的位置。	字符串
标记	部署标记	标记名称和值的字典。 请参阅 模板中的标记
scope	在租户和管理组部署中，向目标提供管理组 ID。 使用格式 Microsoft.Management/managementGroups/{managementGroupID}。	string
properties	部署属性。	DeploymentPropertiesOrDeploymentPropertiesExtended (必需)
resourceGroup	要部署到的资源组的名称。 如果未提供，请使用部署操作的资源组。	string
subscriptionId	要部署到的订阅的 ID。 如果未提供，请使用部署操作的订阅。	string

DeploymentPropertiesOrDeploymentPropertiesExtended

名称	说明	值
debugSetting	部署的调试设置。	DebugSetting
expressionEvaluationOptions	指定是在父模板还是嵌套模板的范围内计算模板表达式。 仅适用于嵌套模板。 如果未指定，默认值为 outer。	ExpressionEvaluationOptions
mode	用于部署资源的模式。 此值可以是“增量”或“完成”。 在增量模式下，将在不删除模板中未包含的现有资源的情况下部署资源。 在“完成”模式下，部署资源，并删除资源组中未包含在模板中的现有资源。 使用“完成”模式时要小心，因为可能会无意中删除资源。	“Complete” “增量” (必需)
onErrorDeployment	错误行为的部署。	OnErrorDeploymentOrOnErrorDeploymentExtended
parameters	定义模板部署参数的名称和值对。 如果要直接在请求中提供参数值，而不是链接到现有参数文件，请使用此元素。 使用 parametersLink 属性或 parameters 属性，但不能同时使用两者。 它可以是 JObject 或格式正确的 JSON 字符串。
parametersLink	参数文件的 URI。 使用此元素链接到现有参数文件。 使用 parametersLink 属性或 parameters 属性，但不能同时使用两者。	ParametersLink
template	模板内容。 如果要直接在请求中传递模板语法，而不是链接到现有模板，请使用此元素。 它可以是 JObject 或格式正确的 JSON 字符串。 使用 templateLink 属性或模板属性，但不能同时使用两者。
templateLink	模板的 URI。 使用 templateLink 属性或模板属性，但不能同时使用两者。	TemplateLink

DebugSetting

名称	说明	值
detailLevel	指定要记录用于调试的信息类型。 允许的值是 none、requestContent、responseContent，或者用逗号分隔的 requestContent 和 responseContent。 默认值为 none。 设置此值时，请仔细考虑在部署期间传入的信息类型。 通过记录有关请求或响应的信息，可能会公开通过部署操作检索的机密数据。	字符串

ExpressionEvaluationOptions

名称	说明	值
scope	用于计算嵌套模板中参数、变量和函数的范围。	“Inner” “NotSpecified” “Outer”

OnErrorDeploymentOrOnErrorDeploymentExtended

名称	说明	值
deploymentName	要针对错误情况使用的部署。	字符串
type	错误行为类型的部署。 可能的值为 LastSuccessful 和 SpecificDeployment。	“LastSuccessful” “SpecificDeployment”

ParametersLink

名称	说明	值
contentVersion	如果包含，则必须与模板中的 ContentVersion 匹配。	字符串
uri	参数文件的 URI。	字符串 (必需)

TemplateLink

名称	说明	值
contentVersion	如果包含，则必须与模板中的 ContentVersion 匹配。	string
id	模板规格的资源 ID。请使用 ID 或 uri 属性，但不能同时使用两者。	字符串
queryString	例如，查询字符串 (要与 templateLink URI 一起使用的 SAS 令牌) 。	string
relativePath	relativePath 属性可用于在相对于父级的位置部署链接模板。 如果父模板与 TemplateSpec 链接，则会引用 TemplateSpec 中的项目。 如果父级与 URI 链接，则子部署将是父级和 relativePath URI 的组合	字符串
uri	要部署的模板的 URI。 使用 uri 或 id 属性，但不能同时使用两者。	字符串

快速入门模板

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

模板	说明
Moesif API 分析和盈利	该模板会将 Azure API 管理的 API 调用记录到 Moesif API 分析和盈利平台
使用注册表创建容器应用和环境	使用Azure 容器注册表的基本容器应用创建容器应用环境。 它还部署 Log Analytics 工作区来存储日志。
使用容器应用创建 Dapr 微服务应用	使用容器应用创建 Dapr 微服务应用。
使用容器应用创建 Dapr pub-sub servicebus 应用	使用容器应用创建 Dapr pub-sub servicebus 应用。
由 Desired State Configuration 服务管理的服务器	此模板提供了一个示例，说明如何在单个部署中交付虚拟机和自动化帐户以管理计算机
为 Azure 业务连续性项创建警报规则	此模板创建警报规则和用户分配的 MSI。 它还向 MSI 读取者分配对订阅的访问权限，以便警报规则有权查询所需的受保护项和最新的恢复点详细信息。
Ubuntu VM 上的 Redis 群集	此模板在 Ubuntu 虚拟机映像上创建 Redis 群集，配置持久性并应用众所周知的优化和行之有效的做法
具有App 服务源和专用链接的 Front Door Premium	此模板创建 Front Door Premium 和 App 服务，并使用 Front Door 的专用终结点将流量发送到应用程序。
具有 Blob 源和专用链接的 Front Door Premium	此模板创建 Front Door Premium 和 Azure 存储 Blob 容器，并使用 Front Door 的专用终结点将流量发送到存储帐户。
具有 VM 和专用链接服务的 Front Door Premium	此模板创建一个 Front Door Premium 和一个配置为 Web 服务器的虚拟机。 Front Door 使用具有专用链接服务的专用终结点将流量发送到 VM。
具有API 管理源的 Front Door 标准版/高级版	此模板创建 Front Door Premium 和 API 管理 实例，并使用 NSG 和全局API 管理策略来验证流量是否已通过 Front Door 源。
具有应用程序网关源的 Front Door 标准版/高级版	此模板创建 Front Door 标准版/高级版和应用程序网关实例，并使用 NSG 和 WAF 策略验证流量是否已通过 Front Door 源。
带有容器实例和应用程序网关的 Front Door	此模板使用容器组和应用程序网关创建 Front Door 标准版/高级版。
具有Azure Functions源的 Front Door 标准版/高级版	此模板创建 Front Door 标准版/高级版（Azure Functions应用），并配置函数应用以验证流量是否已通过 Front Door 源。
具有静态网站源的 Front Door 标准版/高级版	此模板创建 Front Door 标准版/高级版和 Azure 存储静态网站，并将 Front Door 配置为将流量发送到静态网站。
从加密的 VHD 创建加密的托管磁盘	此模板允许你使用现有的加密 VHD 和加密设置创建加密的托管磁盘。
在正在运行的 Windows VM 上禁用加密	此模板在正在运行的 Windows VM 上禁用加密
在运行的 Windows VM & AAD 上启用加密	此模板使用 AAD 客户端证书指纹在正在运行的 Windows VM 上启用加密。 证书应早前已部署到 VM
SUSE 上的 GlassFish	此模板) 群集部署负载均衡的 GlassFish (v3 或 v4，由用户定义的 SUSE (OpenSUSE 或 SLES) VM 组成。
部署 Linux VM 的多个 VM 规模集	此模板允许部署 Linux VM 的多个 VM 规模集。
部署 Windows VM 的多个 VM 规模集	此模板允许部署 Windows VM 的多个 VM 规模集。
部署简单的 Linux VM 并将专用 IP 更新为静态	此模板允许从市场使用 Ubuntu 部署简单的 Linux VM。 这会使用动态分配的 IP 地址在资源组位置部署 VNET、子网和 A1 大小的 VM，然后将其转换为静态 IP。
在部署期间使用自定义脚本扩展的输出	这对于 VM 的计算在部署期间执行 Azure 资源管理器不提供的某些任务非常有用。 然后，可以在部署的其他位置利用该计算 (脚本) 的输出。 如果在部署中需要计算资源， (例如 jumpbox、DC 等) ，这非常有用，否则会有点浪费。
使用 MSI 部署 Linux 或 Windows VM	此模板允许使用托管服务标识部署 Linux 或 Windows VM。
具有 MSI 访问存储的 Linux VM	此模板部署具有系统分配的托管标识的 Linux VM，该标识有权访问不同资源组中的存储帐户。
具有自动备份的 SQL Server 2014 SP2 Enterprise	此模板将创建启用了自动备份功能的 SQL Server 2014 SP2 企业版
SQL Server 2014 SP1 Enterprise with Azure 密钥保管库	此模板将创建启用了 Azure 密钥保管库 集成功能的 SQL Server 2014 SP1 企业版。
针对虚拟机方案的病毒攻击	这将部署 2 个虚拟机、OMS 和其他网络资源。 一个未安装终结点保护的虚拟机，另一个虚拟机安装了 enpoint Protection。 按照指南执行病毒攻击，并执行方案以缓解和预防病毒攻击。
创建数据管理网关并在 Azure VM 上安装	此模板部署虚拟机并创建可行的数据管理网关
Azure VM 上的自承载Integration Runtime	此模板创建自承载集成运行时并将其注册到 Azure 虚拟机上
由 Azure 自动化 管理的 VM 规模集配置	部署 VM 规模集，其中虚拟机部署为 Azure 自动化 Desired State Configuration 服务中的已注册节点，并在部署后保证节点配置一致性。 注意：必需的先决条件 注册密钥和注册 URL 仅在成功创建 Azure 自动化 DSC 的 Azure 自动化 帐户后可用。
VMSS 灵活业务流程模式快速入门 Linux	此模板部署一个简单的 VM 规模集，其中实例位于Azure 负载均衡器后面。 VM 规模集处于灵活业务流程模式。 使用 os 参数选择 Linux (Ubuntu) 或 Windows (Windows Server Datacenter 2019) 部署。 注意：此快速入门模板允许从任何 Internet 地址 (SSH、RDP) 对 VM 管理端口进行网络访问，不应用于生产部署。
使用 MSI 部署 Linux 或 Windows VMSS	此模板允许使用托管服务标识部署 Linux 或 Windows 虚拟机规模集。 然后，该标识用于访问 Azure 服务。
使用现有存储帐户的按需 SFTP 服务器	此模板演示使用 Azure 容器实例 (ACI) 的按需 SFTP 服务器。
(AKS) 部署托管 Kubernetes 群集	此 ARM 模板演示如何将具有高级网络功能的 AKS 实例部署到现有虚拟网络中。 此外，针对包含 AKS 群集的子网为所选服务主体分配网络参与者角色。
使用 AAD (AKS) 部署托管 Kubernetes 群集	此 ARM 模板演示如何将具有高级网络功能的 AKS 实例部署到现有虚拟网络和 Azure AD 整数中。 此外，针对包含 AKS 群集的子网为所选服务主体分配网络参与者角色。
FinOps 中心	此模板创建新的 FinOps 中心实例，包括 Data Lake Storage 和数据工厂。
FinOps 工具包工作簿	此模板将创建新的 Azure Monitor 工作簿进行治理。
使用自定义提供程序扩展现有 Azure 资源	此示例将详细介绍如何扩展现有 Azure 资源和资源管理器模板以添加到自定义工作负荷中。
使用 PE、CMK 所有表单部署 Azure Databricks 工作区	通过此模板，可以创建具有 PrivateEndpoint 和托管服务的 Azure Databricks 工作区，以及使用 DBFS 加密的 CMK。
使用所有 3 种形式的 CMK 部署 Azure Databricks 工作区	使用此模板可以创建包含托管服务和 CMK 和 DBFS 加密的 Azure Databricks 工作区。
使用 CMK 部署 Azure Databricks WS 进行 DBFS 加密	此模板允许你使用 CMK 创建用于 DBFS 根加密的 Azure Databricks 工作区
使用 托管磁盘 CMK 部署 Azure Databricks 工作区	此模板允许你使用 托管磁盘 CMK 创建 Azure Databricks 工作区。
使用托管服务 CMK 部署 Azure Databricks 工作区	此模板允许你使用托管服务 CMK 创建 Azure Databricks 工作区。
创建新的 Datadog 组织	此模板创建新的 Datadog - Azure Native ISV 服务资源和 Datadog 组织，用于监视订阅中的资源。
使用脚本扩展在 Ubuntu VM 上安装 Mongo DB	此模板使用两个单独的脚本在 Ubuntu 虚拟机上部署配置和安装 Mongo DB。 此模板是一个很好的示例，展示了如何在同一虚拟机上运行的两个脚本之间表达依赖关系。 此模板还部署存储帐户、虚拟网络、公共 IP 地址和网络接口。
创建 HA 数据管理网关并在 Azure VM 上安装	此模板使用可行的 HA 数据管理网关部署多个虚拟机
使用加密 (密钥保管库) 部署 Data Lake Store 帐户	此模板允许部署启用了数据加密的 Azure Data Lake Store 帐户。 此帐户使用 Azure 密钥保管库来管理加密密钥。
使用 Azure 服务执行 ETL 作业	此模板提供了一个示例，说明如何对存储在 Azure Blob 存储 中的历史和实时流式处理数据执行分析。 Azure 流分析作业从事件中心获取数据来执行转换，输出存储在 Azure Blob 存储 中并在 PowerBI 中可视化。 分析应用于 Azure 数据分析存储在 Blob 存储中的历史数据，提取、转换和发布的数据的移动，业务流程由数据工厂完成。 已发布的数据在 PowerBI 中进一步可视化
使用内置映像部署 Dev Box 服务	此模板提供了一种使用内置映像部署 Dev Box 服务的方法。
配置 Dev Box 服务	此模板将按照 Dev Box 快速入门指南创建所有 Dev Box 管理员资源。 可以查看创建的所有资源，也可以直接转到 DevPortal.microsoft.com 创建第一个 Dev Box。
具有函数和专用链接服务的 Azure 数字孪生	此模板创建一个 Azure 数字孪生服务，该服务配置了一个虚拟网络连接的 Azure 函数，该函数可以通过专用链接终结点与数字孪生进行通信。 它还创建一个专用 DNS区域，允许数字孪生终结点从虚拟网络无缝主机名解析到专用终结点内部子网 IP 地址。 主机名存储为名为“ADT_ENDPOINT”的 Azure 函数的设置。
具有时间数据历史记录连接的 Azure 数字孪生	此模板创建配置了时序数据历史记录连接的 Azure 数字孪生实例。 若要创建连接，必须创建其他资源，例如事件中心命名空间、事件中心、Azure 数据资源管理器群集和数据库。 数据将发送到事件中心，该事件中心最终将数据转发到 Azure 数据资源管理器 群集。 数据存储在群集的数据库表中
在 VNET 中使用自定义 Ambari + Hive 元存储 DB 的 HDInsight	此模板允许在现有虚拟网络中创建 HDInsight 群集，其中包含同时充当自定义 Ambari DB 和 Hive 元存储的新 SQL 数据库。 必须具有现有的 SQL Sever、存储帐户和 VNET。
配置 FHIR 服务以启用 $import	此模板预配 FHIR 服务，以便为初始数据加载启用$import
创建密钥保管库、托管标识和角色分配	此模板创建密钥保管库、托管标识和角色分配。
将 KeyVault 与动态 resourceId 配合使用	此模板创建SQL Server并使用来自 密钥保管库 的管理员密码。 密钥保管库机密的引用参数是在部署时使用嵌套模板创建的。 这样，用户只需将参数值传递给模板，而不是在参数文件中创建引用参数。
使用 Helm (AKS) 的 Azure 容器服务	使用 Helm 通过 Azure 容器服务 (AKS) 部署托管群集
使用逻辑应用按计划运行计时器作业	此模板创建一对逻辑应用，用于创建计划的计时器作业实例。
用户分配的标识角色分配模板	一个模板，用于在 Azure 机器学习工作区所依赖的资源上创建用户分配标识的角色分配
Azure 机器学习端到端安全设置	这组 Bicep 模板演示如何在安全设置中端到端地设置 Azure 机器学习。 此参考实现包括工作区、计算群集、计算实例和附加的专用 AKS 群集。
Azure 机器学习端到端安全设置 (旧版)	这组 Bicep 模板演示如何在安全设置中端到端地设置 Azure 机器学习。 此参考实现包括工作区、计算群集、计算实例和附加的专用 AKS 群集。
创建 Azure 机器学习扫描作业	此模板创建用于超参数优化的 Azure 机器学习扫描作业。
(vnet) 创建 Azure 机器学习服务工作区	此部署模板指定 Azure 机器学习工作区及其关联的资源，包括 Azure 密钥保管库、Azure 存储、Azure 应用程序见解和Azure 容器注册表。 此配置描述了在网络隔离设置中开始使用 Azure 机器学习所需的资源集。
(旧版) 创建 Azure 机器学习服务工作区	此部署模板指定 Azure 机器学习工作区及其关联的资源，包括 Azure 密钥保管库、Azure 存储、Azure 应用程序见解和Azure 容器注册表。 此配置描述了在网络隔离设置中开始使用 Azure 机器学习所需的资源集。
使用 SMB 卷创建新的 ANF 资源	使用此模板可以创建新的Azure NetApp 文件资源，其中包含配置了 SMB 协议的单个容量池和单个卷。
具有 IP 限制的 Web 应用的应用程序网关	此模板在 Azure Web 应用前面创建一个应用程序网关，并在 Web 应用上启用了 IP 限制。
将 NSG 应用于现有子网	此模板将新创建的 NSG 应用于现有子网
使用流量分析的 NSG 流日志	此模板使用流量分析在现有 NSG 上创建 NSG 流日志
Azure 虚拟 WAN 路由意向和策略	此模板预配 Azure 虚拟 WAN，其中包含启用了路由意向和策略功能的两个中心。
将具有 Redis 安全规则的 NSG 添加到现有子网	此模板允许将具有预配置的 Azure Redis 缓存安全规则的 NSG 添加到 VNET 中的现有子网。 部署到现有 VNET 的资源组中。
通过 ACR 任务生成容器映像	此模板使用 DeploymentScript 来协调 ACR，以便从代码存储库生成容器映像。
将容器映像导入 ACR	此模板利用从 bicep 注册表导入 ACR 模块将公共容器映像导入Azure 容器注册表。
使用证书创建应用程序网关	此模板演示如何生成密钥保管库自签名证书，然后从应用程序网关引用。
创建 ssh 密钥并将其存储在 KeyVault 中	此模板使用 deploymentScript 资源生成 ssh 密钥，并将私钥存储在 keyVault 中。
创建和部署模板Spec	此示例在同一模板中创建并部署 templateSpec 资源。 这不是一个典型的模式，只是为了显示 templateSpec 和部署资源应如何协同工作。
从模板库模板创建 TemplateSpecs	此示例包含一个脚本，用于轻松地将模板库模板迁移到 templateSpec 资源。 模板提供将部署可以使用迁移脚本导出的所有模板。
使用现有 SQL 虚拟机部署 SQL Always ON 安装程序	使用现有 SQL 虚拟机部署 SQL Always ON 安装程序。 虚拟机应已加入现有域，并且必须运行企业版SQL Server。
Azure Synapse概念证明	此模板为Azure Synapse创建概念证明环境，包括 SQL 池和可选的 Apache Spark 池
在 ASEv3 中创建 AppServicePlan 和应用	在 ASEv3 中创建 AppServicePlan 和应用
创建 Azure 本机 New Relic 资源	此模板设置“Azure 本机 New Relic 服务”来监视 Azure 订阅中的资源。

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

部署资源类型可以部署到：

• 资源组
• 订阅
• 管理组
• 租户

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Resources/deployments@2021-04-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      debugSetting = {
        detailLevel = "string"
      }
      expressionEvaluationOptions = {
        scope = "string"
      }
      mode = "string"
      onErrorDeployment = {
        deploymentName = "string"
        type = "string"
      }
      parametersLink = {
        contentVersion = "string"
        uri = "string"
      }
      templateLink = {
        contentVersion = "string"
        id = "string"
        queryString = "string"
        relativePath = "string"
        uri = "string"
      }
    }
    resourceGroup = "string"
    subscriptionId = "string"
    scope = "string"
  })
}

属性值

deployments

名称	说明	Value
type	资源类型	“Microsoft.Resources/deployments@2021-04-01”
name	资源名称	字符串 (必需) 字符限制：1-64 有效字符： 字母数字、下划线、括号、连字符和句点。
location	用于存储部署数据的位置。	字符串
parent_id	若要部署到资源组，请使用该资源组的 ID。 若要部署到订阅，请使用该订阅的 ID。 若要部署到管理组，请使用该管理组的 ID。 若要部署到租户，请使用 /。	字符串 (必需)
标记	部署标记	标记名称和值的字典。
properties	部署属性。	DeploymentPropertiesOrDeploymentPropertiesExtended (必需)
resourceGroup	要部署到的资源组的名称。 如果未提供，请使用部署操作的资源组。	字符串
subscriptionId	要部署到的订阅的 ID。 如果未提供，请使用部署操作的订阅。	字符串

DeploymentPropertiesOrDeploymentPropertiesExtended

名称	说明	值
debugSetting	部署的调试设置。	DebugSetting
expressionEvaluationOptions	指定是在父模板还是嵌套模板的范围内计算模板表达式。 仅适用于嵌套模板。 如果未指定，默认值为 outer。	ExpressionEvaluationOptions
mode	用于部署资源的模式。 此值可以是“增量”或“完成”。 在增量模式下，将在不删除模板中未包含的现有资源的情况下部署资源。 在“完成”模式下，部署资源，并删除资源组中未包含在模板中的现有资源。 使用“完成”模式时要小心，因为可能会无意中删除资源。	“Complete” “增量” (必需)
onErrorDeployment	错误行为的部署。	OnErrorDeploymentOrOnErrorDeploymentExtended
parameters	定义模板部署参数的名称和值对。 如果要直接在请求中提供参数值，而不是链接到现有参数文件，请使用此元素。 使用 parametersLink 属性或 parameters 属性，但不能同时使用两者。 它可以是 JObject 或格式正确的 JSON 字符串。
parametersLink	参数文件的 URI。 使用此元素链接到现有参数文件。 使用 parametersLink 属性或 parameters 属性，但不能同时使用两者。	ParametersLink
template	模板内容。 如果要直接在请求中传递模板语法，而不是链接到现有模板，请使用此元素。 它可以是 JObject 或格式正确的 JSON 字符串。 使用 templateLink 属性或模板属性，但不能同时使用两者。
templateLink	模板的 URI。 使用 templateLink 属性或模板属性，但不能同时使用两者。	TemplateLink

DebugSetting

名称	说明	值
detailLevel	指定要记录用于调试的信息类型。 允许的值是 none、requestContent、responseContent，或者用逗号分隔的 requestContent 和 responseContent。 默认值为 none。 设置此值时，请仔细考虑在部署期间传入的信息类型。 通过记录有关请求或响应的信息，可能会公开通过部署操作检索的机密数据。	字符串

ExpressionEvaluationOptions

名称	说明	值
scope	用于计算嵌套模板中参数、变量和函数的范围。	“Inner” “NotSpecified” “Outer”

OnErrorDeploymentOrOnErrorDeploymentExtended

名称	说明	值
deploymentName	要针对错误情况使用的部署。	string
type	错误行为类型的部署。 可能的值为 LastSuccessful 和 SpecificDeployment。	“LastSuccessful” “SpecificDeployment”

ParametersLink

名称	说明	值
contentVersion	如果包含，则必须与模板中的 ContentVersion 匹配。	字符串
uri	参数文件的 URI。	字符串 (必需)

TemplateLink

名称	说明	值
contentVersion	如果包含，则必须与模板中的 ContentVersion 匹配。	string
id	模板规格的资源 ID。请使用 ID 或 uri 属性，但不能同时使用两者。	字符串
queryString	例如，查询字符串 (要与 templateLink URI 一起使用的 SAS 令牌) 。	string
relativePath	relativePath 属性可用于在相对于父级的位置部署链接模板。 如果父模板与 TemplateSpec 链接，则会引用 TemplateSpec 中的项目。 如果父级与 URI 链接，则子部署将是父级和 relativePath URI 的组合	字符串
uri	要部署的模板的 URI。 使用 uri 或 id 属性，但不能同时使用两者。	字符串