你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Microsoft.Resources 部署 2024-03-01
Bicep 资源定义
可以使用目标操作部署部署资源类型:
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
言论
对于 Bicep,请考虑使用模块 而不是此资源类型
资源格式
若要创建 Microsoft.Resources/deployments 资源,请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Resources/deployments@2024-03-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: {
{customized property}: {
reference: {
keyVault: {
id: 'string'
}
secretName: 'string'
secretVersion: 'string'
}
value: any()
}
}
parametersLink: {
contentVersion: 'string'
uri: 'string'
}
template: any()
templateLink: {
contentVersion: 'string'
id: 'string'
queryString: 'string'
relativePath: 'string'
uri: 'string'
}
}
resourceGroup: 'string'
subscriptionId: 'string'
}
属性值
部署
名字 | 描述 | 价值 |
---|---|---|
名字 | 资源名称 | string (必需) 字符限制:1-64 有效字符: 字母数字、下划线、括号、连字符和句点。 |
位置 | 用于存储部署数据的位置。 | 字符串 |
标签 | 部署标记 | 标记名称和值的字典。 请参阅模板 中的 |
范围 | 在租户和管理组部署中,提供目标管理组 ID。 使用 Microsoft.Management/managementGroups/{managementGroupID} 格式。 |
字符串 |
性能 | 部署属性。 | DeploymentPropertiesOrDeploymentPropertiesExtended(必需) |
resourceGroup | 要部署到的资源组的名称。 如果未提供,请使用部署操作的资源组。 | 字符串 |
subscriptionId | 要部署到的订阅的 ID。 如果未提供,请使用部署操作的订阅。 | 字符串 |
DeploymentPropertiesOrDeploymentPropertiesExtended
名字 | 描述 | 价值 |
---|---|---|
debugSetting | 部署的调试设置。 | DebugSetting |
expressionEvaluationOptions | 指定模板表达式是在父模板或嵌套模板的范围内计算的。 仅适用于嵌套模板。 如果未指定,则默认值为外部值。 | ExpressionEvaluationOptions |
模式 | 用于部署资源的模式。 此值可以是增量值,也可以是“完成”。 在增量模式下,部署资源而不删除模板中不包含的现有资源。 在“完成”模式下,将部署资源,并删除模板中不包含的资源组中的现有资源。 使用“完成”模式时请注意,因为可能会无意中删除资源。 | “Complete” “增量”(必需) |
onErrorDeployment | 错误行为的部署。 | OnErrorDeploymentOrOnErrorDeploymentExtended |
参数 | 定义模板部署参数的名称和值对。 如果要直接在请求中提供参数值,而不是链接到现有参数文件,请使用此元素。 使用 parametersLink 属性或 parameters 属性,但不能同时使用两者。 它可以是 JObject 或格式良好的 JSON 字符串。 | DeploymentPropertiesParameters |
parametersLink | 参数文件的 URI。 使用此元素链接到现有参数文件。 使用 parametersLink 属性或 parameters 属性,但不能同时使用两者。 | ParametersLink |
模板 | 模板内容。 如果要直接在请求中传递模板语法,而不是链接到现有模板,请使用此元素。 它可以是 JObject 或格式正确的 JSON 字符串。 使用 templateLink 属性或模板属性,但不能同时使用这两者。 | 对于 Bicep,可以使用 any() 函数。 |
templateLink | 模板的 URI。 使用 templateLink 属性或模板属性,但不能同时使用这两者。 | TemplateLink |
DebugSetting
名字 | 描述 | 价值 |
---|---|---|
detailLevel | 指定要记录以供调试的信息的类型。 允许的值不为 none、requestContent、responseContent,或两者均用逗号分隔的 requestContent 和 responseContent。 默认值为 none。 设置此值时,请仔细考虑在部署期间传入的信息类型。 通过记录有关请求或响应的信息,可能会公开通过部署操作检索的敏感数据。 | 字符串 |
ExpressionEvaluationOptions
名字 | 描述 | 价值 |
---|---|---|
范围 | 用于计算嵌套模板中的参数、变量和函数的范围。 | “Inner” “NotSpecified” “Outer” |
OnErrorDeploymentOrOnErrorDeploymentExtended
名字 | 描述 | 价值 |
---|---|---|
deploymentName | 要用于错误案例的部署。 | 字符串 |
类型 | 错误行为类型的部署。 可能的值为 LastSuccessful 和 SpecificDeployment。 | “LastSuccessful” “SpecificDeployment” |
DeploymentPropertiesParameters
名字 | 描述 | 价值 |
---|---|---|
{自定义属性} | DeploymentParameter |
DeploymentParameter
名字 | 描述 | 价值 |
---|---|---|
参考 | Azure Key Vault 参数引用。 | KeyVaultParameterReference |
价值 | 参数的输入值。 | 对于 Bicep,可以使用 any() 函数。 |
KeyVaultParameterReference
名字 | 描述 | 价值 |
---|---|---|
keyVault | Azure Key Vault 参考。 | KeyVaultReference(必需) |
secretName | Azure Key Vault 机密名称。 | string (必需) |
secretVersion | Azure Key Vault 机密版本。 | 字符串 |
KeyVaultReference
名字 | 描述 | 价值 |
---|---|---|
id | Azure Key Vault 资源 ID。 | string (必需) |
ParametersLink
名字 | 描述 | 价值 |
---|---|---|
contentVersion | 如果包含,则必须匹配模板中的 ContentVersion。 | 字符串 |
uri | 参数文件的 URI。 | string (必需) |
TemplateLink
名字 | 描述 | 价值 |
---|---|---|
contentVersion | 如果包含,则必须匹配模板中的 ContentVersion。 | 字符串 |
id | 模板规格的资源 ID。请使用 ID 或 uri 属性,但不能同时使用这两个属性。 | 字符串 |
queryString | 要与 templateLink URI 一起使用的查询字符串(例如 SAS 令牌)。 | 字符串 |
relativePath | relativePath 属性可用于在相对于父级的位置部署链接模板。 如果父模板与 TemplateSpec 链接,则会引用 TemplateSpec 中的项目。 如果父级已链接到 URI,则子部署将是父 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 读取器访问权限,以便警报规则有权查询所需的受保护项和最新的恢复点详细信息。 |
创建 Azure Stack HCI 23H2 群集 |
此模板使用 ARM 模板创建 Azure Stack HCI 23H2 群集。 |
创建 Azure Stack HCI 23H2 群集 |
此模板使用 ARM 模板(使用自定义存储 IP)创建 Azure Stack HCI 23H2 群集 |
在无交换机-双链路网络模式下创建 Azure Stack HCI 23H2 群集 |
此模板使用 ARM 模板创建 Azure Stack HCI 23H2 群集。 |
在 Switchless-SingleLink 网络模式下创建 Azure Stack HCI 23H2 群集 |
此模板使用 ARM 模板创建 Azure Stack HCI 23H2 群集。 |
Ubuntu VM 上的 Redis 群集 |
此模板在 Ubuntu 虚拟机映像上创建 Redis 群集,配置持久性并应用已知的优化和经过验证的做法 |
使用应用服务源和专用链接 |
此模板创建 Front Door Premium 和应用服务,并使用 Front Door 的专用终结点将流量发送到应用程序。 |
使用 blob 源和专用链接 |
此模板创建 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 标准版/高级版。 |
使用 Azure Functions 源 |
此模板创建 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 (v3 或 v4) 群集,其中包含用户定义的 SUSE(OpenSUSE 或 SLES) VM 数。 |
部署多个 Linux VM 规模集 |
此模板允许部署多个 Linux VM 规模集。 |
部署多个 VM 规模集的 Windows VM |
使用此模板可以部署多个 Windows VM 规模集。 |
部署简单的 Linux VM 并将专用 IP 更新为静态 |
通过此模板,可以从市场使用 Ubuntu 部署简单的 Linux VM。 这会在资源组位置部署 VNET、子网和 A1 大小的 VM,该 VM 具有动态分配的 IP 地址,然后将其转换为静态 IP。 |
部署 期间使用自定义脚本扩展的输出 |
这对于 VM 的计算在部署期间执行 Azure 资源管理器不提供的某些任务非常有用。 然后,可以在部署中的其他位置利用该计算(脚本)的输出。 如果部署中需要计算资源(例如 jumpbox、DC 等),则此资源会浪费一点(如果不是)。 |
使用 MSI 部署 Linux 或 Windows VM |
使用此模板,可以使用托管服务标识部署 Linux 或 Windows VM。 |
使用 MSI 访问存储 |
此模板部署具有系统分配的托管标识的 Linux VM,该标识有权访问其他资源组中的存储帐户。 |
使用自动备份 |
此模板将创建启用了自动备份功能的 SQL Server 2014 SP2 Enterprise 版本 |
使用 Azure Key Vault |
此模板将创建启用了 Azure Key Vault 集成功能的 SQL Server 2014 SP1 Enterprise 版本。 |
虚拟机方案中的病毒攻击 |
这将部署 2 个虚拟机、OMS 和其他网络资源。 一个没有终结点保护的虚拟机,另一个虚拟机安装了 enpoint protection。 按照准则执行病毒攻击,并执行缓解和预防病毒攻击的方案。 |
创建数据管理网关并在 Azure VM 上安装 |
此模板部署虚拟机并创建可行的数据管理网关 |
Azure VM 上的自承载集成运行时 |
此模板创建自承载集成运行时并在 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 地址访问 VM 管理端口(SSH、RDP),并且不应用于生产部署。 |
使用 MSI 部署 Linux 或 Windows VMSS |
使用此模板,可以使用托管服务标识部署 Linux 或 Windows 虚拟机规模集。 然后,该标识用于访问 Azure 服务。 |
使用现有存储帐户 |
此模板演示使用 Azure 容器实例(ACI)的按需 SFTP 服务器。 |
部署托管 Kubernetes 群集(AKS) |
此 ARM 模板演示如何将具有高级网络功能的 AKS 实例部署到现有虚拟网络。 此外,所选的服务主体将针对包含 AKS 群集的子网分配网络参与者角色。 |
使用 AAD 部署托管 Kubernetes 群集(AKS) |
此 ARM 模板演示如何将具有高级网络功能的 AKS 实例部署到现有虚拟网络和 Azure AD 整数。 此外,所选的服务主体将针对包含 AKS 群集的子网分配网络参与者角色。 |
FinOps 中心 |
此模板创建新的 FinOps 中心实例,包括 Data Lake 存储和数据工厂。 |
FinOps 工具包工作簿 |
此模板创建一个新的 Azure Monitor 工作簿进行治理。 |
成本优化工作簿 |
此模板基于 Well-Architected 框架创建新的 Azure Monitor 工作簿,用于成本优化。 |
使用自定义提供程序扩展现有 Azure 资源 |
此示例将详细介绍如何扩展现有 Azure 资源和资源管理器模板以添加自定义工作负载。 |
创建数据库观察程序 |
此示例为 Azure SQL 创建数据库观察程序,并配置其数据存储、SQL 目标和托管专用终结点 |
使用 PE 部署 Azure Databricks 工作区,CMK 所有窗体 |
使用此模板,可以使用 PrivateEndpoint 和托管服务和 CMK 和 DBFS 加密创建 Azure Databricks 工作区。 |
使用默认存储防火墙 |
使用此模板,可以使用 Privateendpoint、所有三种形式的 CMK 和 User-Assigned Access Connector 创建启用了默认存储防火墙的 Azure Databricks 工作区。 |
部署包含所有 3 种 CMK 形式的 Azure Databricks 工作区 |
使用此模板,可以使用托管服务和 CMK 和 DBFS 加密创建 Azure Databricks 工作区。 |
使用 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 数据管理网关部署多个虚拟机 |
使用加密(Key Vault) 部署 Data Lake Store 帐户 |
使用此模板,可以部署启用了数据加密的 Azure Data Lake Store 帐户。 此帐户使用 Azure Key Vault 管理加密密钥。 |
使用 Azure 服务执行 ETL 作业 |
此模板提供了有关如何对 Azure Blob 存储中存储的历史数据和实时流数据执行分析的示例。 来自事件中心的数据由 Azure 流分析作业执行转换,输出存储在 Azure Blob 存储中,并在 PowerBI 中可视化。 分析应用于 Azure 数据分析存储在 Blob 存储中的历史数据,以及提取、转换和已发布数据移动,业务流程由数据工厂完成。 已发布的数据在 PowerBI 中进一步可视化 |
配置部署环境服务 |
此模板提供了配置部署环境的方法。 |
使用内置映像 部署 Dev Box Service |
此模板提供了使用内置映像部署 Dev Box 服务的方法。 |
配置 Dev Box 服务 |
根据 Dev Box 快速入门指南(https://learn.microsoft.com/azure/dev-box/quickstart-create-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 群集,该群集具有新的 SQL DB,该数据库既充当自定义 Ambari DB,又充当 Hive 元存储。 必须具有现有的 SQL Sever、存储帐户和 VNET。 |
配置 FHIR 服务以启用$import |
此模板预配 FHIR 服务以启用初始数据加载$import |
创建密钥保管库、托管标识和角色分配 |
此模板创建密钥保管库、托管标识和角色分配。 |
将 KeyVault 与 Dynamic resourceId 配合使用 |
此模板创建 SQL Server 并使用 Key Vault 中的管理员密码。 使用嵌套模板在部署时创建 Key Vault 机密的引用参数。 这样,用户只需将参数值传递给模板,而不是在参数文件中创建引用参数。 |
使用 Helm |
使用 Helm 部署具有 Azure 容器服务(AKS)的托管群集 |
使用逻辑应用 按计划执行的计时器作业 |
此模板创建一对逻辑应用,用于创建计划的计时器作业实例。 |
Azure AI Studio 基本设置 |
此模板集演示如何使用基本设置设置设置 Azure AI Studio,这意味着启用了公共 Internet 访问、Microsoft托管密钥进行加密和 AI 资源的Microsoft托管标识配置。 |
Azure AI Studio 基本设置 |
此模板集演示如何使用基本设置设置设置 Azure AI Studio,这意味着启用了公共 Internet 访问、Microsoft托管密钥进行加密和 AI 资源的Microsoft托管标识配置。 |
使用 Microsoft Entra ID 身份验证 |
此模板集演示如何为依赖资源(例如 Azure AI 服务和 Azure 存储)设置具有 Microsoft Entra ID 身份验证的 Azure AI Studio。 |
Azure AI Studio 网络受限 |
此模板集演示如何使用禁用专用链接和出口设置 Azure AI Studio,并使用Microsoft托管密钥进行加密和 AI 资源的Microsoft托管标识配置。 |
用户分配的标识角色分配模板 |
一个模板,用于在 Azure 机器学习工作区依赖的资源上创建用户分配的用户分配标识的角色分配 |
Azure 机器学习端到端安全设置 |
此 Bicep 模板集演示如何在安全设置中端到端设置 Azure 机器学习。 此参考实现包括工作区、计算群集、计算实例和附加的专用 AKS 群集。 |
Azure 机器学习端到端安全设置(旧版) |
此 Bicep 模板集演示如何在安全设置中端到端设置 Azure 机器学习。 此参考实现包括工作区、计算群集、计算实例和附加的专用 AKS 群集。 |
创建 Azure 机器学习扫描作业 |
此模板创建用于超参数优化的 Azure 机器学习扫描作业。 |
Azure AI Studio 网络受限 |
此模板集演示如何使用禁用专用链接和出口设置 Azure AI Studio,并使用Microsoft托管密钥进行加密和 AI 资源的Microsoft托管标识配置。 |
创建 Azure 机器学习服务工作区(vnet) |
此部署模板指定 Azure 机器学习工作区及其关联的资源,包括 Azure Key Vault、Azure 存储、Azure Application Insights 和 Azure 容器注册表。 此配置描述了在网络隔离设置中开始使用 Azure 机器学习所需的资源集。 |
创建 Azure 机器学习服务工作区(旧版) |
此部署模板指定 Azure 机器学习工作区及其关联的资源,包括 Azure Key Vault、Azure 存储、Azure Application Insights 和 Azure 容器注册表。 此配置描述了在网络隔离设置中开始使用 Azure 机器学习所需的资源集。 |
使用 SMB 卷 创建新的 ANF 资源 |
使用此模板,可以使用单个容量池和配置 SMB 协议的单个卷创建新的 Azure NetApp 文件资源。 |
为具有 IP 限制的 Web 应用 应用程序网关 |
此模板在 Azure Web 应用前创建应用程序网关,并在 Web 应用上启用了 IP 限制。 |
将 NSG 应用到现有子网 |
此模板将新创建的 NSG 应用到现有子网 |
使用流量分析 |
此模板使用流量分析在现有 NSG 上创建 NSG 流日志 |
将具有 Redis 安全规则的 NSG 添加到现有子网 |
此模板允许将具有预配置的 Azure Redis 缓存安全规则的 NSG 添加到 VNET 中的现有子网。 部署到现有 VNET 的资源组。 |
使用 ACR 任务 生成容器映像 |
此模板使用 DeploymentScript 来协调 ACR,以便从代码存储库生成容器映像。 |
将容器映像导入 ACR |
此模板利用 bicep 注册表中的 Import ACR 模块将公共容器映像导入 Azure 容器注册表。 |
使用证书创建应用程序网关 |
此模板演示如何生成 Key Vault 自签名证书,然后从应用程序网关引用。 |
创建 ssh 密钥并将其存储在 KeyVault |
此模板使用 deploymentScript 资源生成 ssh 密钥,并将私钥存储在 keyVault 中。 |
创建和部署 templateSpec |
此示例在同一模板中创建和部署 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 和 App |
创建 Azure 本机 New Relic 资源 |
此模板设置“Azure Native New Relic 服务”来监视 Azure 订阅中的资源。 |
ARM 模板资源定义
可以使用目标操作部署部署资源类型:
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
言论
对于 Bicep,请考虑使用模块 而不是此资源类型
资源格式
若要创建 Microsoft.Resources/deployments 资源,请将以下 JSON 添加到模板。
{
"type": "Microsoft.Resources/deployments",
"apiVersion": "2024-03-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": {
"{customized property}": {
"reference": {
"keyVault": {
"id": "string"
},
"secretName": "string",
"secretVersion": "string"
},
"value": {}
}
},
"parametersLink": {
"contentVersion": "string",
"uri": "string"
},
"template": {},
"templateLink": {
"contentVersion": "string",
"id": "string",
"queryString": "string",
"relativePath": "string",
"uri": "string"
}
},
"resourceGroup": "string",
"subscriptionId": "string"
}
属性值
部署
名字 | 描述 | 价值 |
---|---|---|
类型 | 资源类型 | “Microsoft.Resources/deployments” |
apiVersion | 资源 API 版本 | '2024-03-01' |
名字 | 资源名称 | string (必需) 字符限制:1-64 有效字符: 字母数字、下划线、括号、连字符和句点。 |
位置 | 用于存储部署数据的位置。 | 字符串 |
标签 | 部署标记 | 标记名称和值的字典。 请参阅模板 中的 |
范围 | 在租户和管理组部署中,提供目标管理组 ID。 使用 Microsoft.Management/managementGroups/{managementGroupID} 格式。 |
字符串 |
性能 | 部署属性。 | DeploymentPropertiesOrDeploymentPropertiesExtended(必需) |
resourceGroup | 要部署到的资源组的名称。 如果未提供,请使用部署操作的资源组。 | 字符串 |
subscriptionId | 要部署到的订阅的 ID。 如果未提供,请使用部署操作的订阅。 | 字符串 |
DeploymentPropertiesOrDeploymentPropertiesExtended
名字 | 描述 | 价值 |
---|---|---|
debugSetting | 部署的调试设置。 | DebugSetting |
expressionEvaluationOptions | 指定模板表达式是在父模板或嵌套模板的范围内计算的。 仅适用于嵌套模板。 如果未指定,则默认值为外部值。 | ExpressionEvaluationOptions |
模式 | 用于部署资源的模式。 此值可以是增量值,也可以是“完成”。 在增量模式下,部署资源而不删除模板中不包含的现有资源。 在“完成”模式下,将部署资源,并删除模板中不包含的资源组中的现有资源。 使用“完成”模式时请注意,因为可能会无意中删除资源。 | “Complete” “增量”(必需) |
onErrorDeployment | 错误行为的部署。 | OnErrorDeploymentOrOnErrorDeploymentExtended |
参数 | 定义模板部署参数的名称和值对。 如果要直接在请求中提供参数值,而不是链接到现有参数文件,请使用此元素。 使用 parametersLink 属性或 parameters 属性,但不能同时使用两者。 它可以是 JObject 或格式良好的 JSON 字符串。 | DeploymentPropertiesParameters |
parametersLink | 参数文件的 URI。 使用此元素链接到现有参数文件。 使用 parametersLink 属性或 parameters 属性,但不能同时使用两者。 | ParametersLink |
模板 | 模板内容。 如果要直接在请求中传递模板语法,而不是链接到现有模板,请使用此元素。 它可以是 JObject 或格式正确的 JSON 字符串。 使用 templateLink 属性或模板属性,但不能同时使用这两者。 | |
templateLink | 模板的 URI。 使用 templateLink 属性或模板属性,但不能同时使用这两者。 | TemplateLink |
DebugSetting
名字 | 描述 | 价值 |
---|---|---|
detailLevel | 指定要记录以供调试的信息的类型。 允许的值不为 none、requestContent、responseContent,或两者均用逗号分隔的 requestContent 和 responseContent。 默认值为 none。 设置此值时,请仔细考虑在部署期间传入的信息类型。 通过记录有关请求或响应的信息,可能会公开通过部署操作检索的敏感数据。 | 字符串 |
ExpressionEvaluationOptions
名字 | 描述 | 价值 |
---|---|---|
范围 | 用于计算嵌套模板中的参数、变量和函数的范围。 | “Inner” “NotSpecified” “Outer” |
OnErrorDeploymentOrOnErrorDeploymentExtended
名字 | 描述 | 价值 |
---|---|---|
deploymentName | 要用于错误案例的部署。 | 字符串 |
类型 | 错误行为类型的部署。 可能的值为 LastSuccessful 和 SpecificDeployment。 | “LastSuccessful” “SpecificDeployment” |
DeploymentPropertiesParameters
名字 | 描述 | 价值 |
---|---|---|
{自定义属性} | DeploymentParameter |
DeploymentParameter
名字 | 描述 | 价值 |
---|---|---|
参考 | Azure Key Vault 参数引用。 | KeyVaultParameterReference |
价值 | 参数的输入值。 |
KeyVaultParameterReference
名字 | 描述 | 价值 |
---|---|---|
keyVault | Azure Key Vault 参考。 | KeyVaultReference(必需) |
secretName | Azure Key Vault 机密名称。 | string (必需) |
secretVersion | Azure Key Vault 机密版本。 | 字符串 |
KeyVaultReference
名字 | 描述 | 价值 |
---|---|---|
id | Azure Key Vault 资源 ID。 | string (必需) |
ParametersLink
名字 | 描述 | 价值 |
---|---|---|
contentVersion | 如果包含,则必须匹配模板中的 ContentVersion。 | 字符串 |
uri | 参数文件的 URI。 | string (必需) |
TemplateLink
名字 | 描述 | 价值 |
---|---|---|
contentVersion | 如果包含,则必须匹配模板中的 ContentVersion。 | 字符串 |
id | 模板规格的资源 ID。请使用 ID 或 uri 属性,但不能同时使用这两个属性。 | 字符串 |
queryString | 要与 templateLink URI 一起使用的查询字符串(例如 SAS 令牌)。 | 字符串 |
relativePath | relativePath 属性可用于在相对于父级的位置部署链接模板。 如果父模板与 TemplateSpec 链接,则会引用 TemplateSpec 中的项目。 如果父级已链接到 URI,则子部署将是父 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 读取器访问权限,以便警报规则有权查询所需的受保护项和最新的恢复点详细信息。 |
创建 Azure Stack HCI 23H2 群集 |
此模板使用 ARM 模板创建 Azure Stack HCI 23H2 群集。 |
创建 Azure Stack HCI 23H2 群集 |
此模板使用 ARM 模板(使用自定义存储 IP)创建 Azure Stack HCI 23H2 群集 |
在无交换机-双链路网络模式下创建 Azure Stack HCI 23H2 群集 |
此模板使用 ARM 模板创建 Azure Stack HCI 23H2 群集。 |
在 Switchless-SingleLink 网络模式下创建 Azure Stack HCI 23H2 群集 |
此模板使用 ARM 模板创建 Azure Stack HCI 23H2 群集。 |
Ubuntu VM 上的 Redis 群集 |
此模板在 Ubuntu 虚拟机映像上创建 Redis 群集,配置持久性并应用已知的优化和经过验证的做法 |
使用应用服务源和专用链接 |
此模板创建 Front Door Premium 和应用服务,并使用 Front Door 的专用终结点将流量发送到应用程序。 |
使用 blob 源和专用链接 |
此模板创建 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 标准版/高级版。 |
使用 Azure Functions 源 |
此模板创建 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 (v3 或 v4) 群集,其中包含用户定义的 SUSE(OpenSUSE 或 SLES) VM 数。 |
部署多个 Linux VM 规模集 |
此模板允许部署多个 Linux VM 规模集。 |
部署多个 VM 规模集的 Windows VM |
使用此模板可以部署多个 Windows VM 规模集。 |
部署简单的 Linux VM 并将专用 IP 更新为静态 |
通过此模板,可以从市场使用 Ubuntu 部署简单的 Linux VM。 这会在资源组位置部署 VNET、子网和 A1 大小的 VM,该 VM 具有动态分配的 IP 地址,然后将其转换为静态 IP。 |
部署 期间使用自定义脚本扩展的输出 |
这对于 VM 的计算在部署期间执行 Azure 资源管理器不提供的某些任务非常有用。 然后,可以在部署中的其他位置利用该计算(脚本)的输出。 如果部署中需要计算资源(例如 jumpbox、DC 等),则此资源会浪费一点(如果不是)。 |
使用 MSI 部署 Linux 或 Windows VM |
使用此模板,可以使用托管服务标识部署 Linux 或 Windows VM。 |
使用 MSI 访问存储 |
此模板部署具有系统分配的托管标识的 Linux VM,该标识有权访问其他资源组中的存储帐户。 |
使用自动备份 |
此模板将创建启用了自动备份功能的 SQL Server 2014 SP2 Enterprise 版本 |
使用 Azure Key Vault |
此模板将创建启用了 Azure Key Vault 集成功能的 SQL Server 2014 SP1 Enterprise 版本。 |
虚拟机方案中的病毒攻击 |
这将部署 2 个虚拟机、OMS 和其他网络资源。 一个没有终结点保护的虚拟机,另一个虚拟机安装了 enpoint protection。 按照准则执行病毒攻击,并执行缓解和预防病毒攻击的方案。 |
创建数据管理网关并在 Azure VM 上安装 |
此模板部署虚拟机并创建可行的数据管理网关 |
Azure VM 上的自承载集成运行时 |
此模板创建自承载集成运行时并在 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 地址访问 VM 管理端口(SSH、RDP),并且不应用于生产部署。 |
使用 MSI 部署 Linux 或 Windows VMSS |
使用此模板,可以使用托管服务标识部署 Linux 或 Windows 虚拟机规模集。 然后,该标识用于访问 Azure 服务。 |
使用现有存储帐户 |
此模板演示使用 Azure 容器实例(ACI)的按需 SFTP 服务器。 |
部署托管 Kubernetes 群集(AKS) |
此 ARM 模板演示如何将具有高级网络功能的 AKS 实例部署到现有虚拟网络。 此外,所选的服务主体将针对包含 AKS 群集的子网分配网络参与者角色。 |
使用 AAD 部署托管 Kubernetes 群集(AKS) |
此 ARM 模板演示如何将具有高级网络功能的 AKS 实例部署到现有虚拟网络和 Azure AD 整数。 此外,所选的服务主体将针对包含 AKS 群集的子网分配网络参与者角色。 |
FinOps 中心 |
此模板创建新的 FinOps 中心实例,包括 Data Lake 存储和数据工厂。 |
FinOps 工具包工作簿 |
此模板创建一个新的 Azure Monitor 工作簿进行治理。 |
成本优化工作簿 |
此模板基于 Well-Architected 框架创建新的 Azure Monitor 工作簿,用于成本优化。 |
使用自定义提供程序扩展现有 Azure 资源 |
此示例将详细介绍如何扩展现有 Azure 资源和资源管理器模板以添加自定义工作负载。 |
创建数据库观察程序 |
此示例为 Azure SQL 创建数据库观察程序,并配置其数据存储、SQL 目标和托管专用终结点 |
使用 PE 部署 Azure Databricks 工作区,CMK 所有窗体 |
使用此模板,可以使用 PrivateEndpoint 和托管服务和 CMK 和 DBFS 加密创建 Azure Databricks 工作区。 |
使用默认存储防火墙 |
使用此模板,可以使用 Privateendpoint、所有三种形式的 CMK 和 User-Assigned Access Connector 创建启用了默认存储防火墙的 Azure Databricks 工作区。 |
部署包含所有 3 种 CMK 形式的 Azure Databricks 工作区 |
使用此模板,可以使用托管服务和 CMK 和 DBFS 加密创建 Azure Databricks 工作区。 |
使用 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 数据管理网关部署多个虚拟机 |
使用加密(Key Vault) 部署 Data Lake Store 帐户 |
使用此模板,可以部署启用了数据加密的 Azure Data Lake Store 帐户。 此帐户使用 Azure Key Vault 管理加密密钥。 |
使用 Azure 服务执行 ETL 作业 |
此模板提供了有关如何对 Azure Blob 存储中存储的历史数据和实时流数据执行分析的示例。 来自事件中心的数据由 Azure 流分析作业执行转换,输出存储在 Azure Blob 存储中,并在 PowerBI 中可视化。 分析应用于 Azure 数据分析存储在 Blob 存储中的历史数据,以及提取、转换和已发布数据移动,业务流程由数据工厂完成。 已发布的数据在 PowerBI 中进一步可视化 |
配置部署环境服务 |
此模板提供了配置部署环境的方法。 |
使用内置映像 部署 Dev Box Service |
此模板提供了使用内置映像部署 Dev Box 服务的方法。 |
配置 Dev Box 服务 |
根据 Dev Box 快速入门指南(https://learn.microsoft.com/azure/dev-box/quickstart-create-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 群集,该群集具有新的 SQL DB,该数据库既充当自定义 Ambari DB,又充当 Hive 元存储。 必须具有现有的 SQL Sever、存储帐户和 VNET。 |
配置 FHIR 服务以启用$import |
此模板预配 FHIR 服务以启用初始数据加载$import |
创建密钥保管库、托管标识和角色分配 |
此模板创建密钥保管库、托管标识和角色分配。 |
将 KeyVault 与 Dynamic resourceId 配合使用 |
此模板创建 SQL Server 并使用 Key Vault 中的管理员密码。 使用嵌套模板在部署时创建 Key Vault 机密的引用参数。 这样,用户只需将参数值传递给模板,而不是在参数文件中创建引用参数。 |
使用 Helm |
使用 Helm 部署具有 Azure 容器服务(AKS)的托管群集 |
使用逻辑应用 按计划执行的计时器作业 |
此模板创建一对逻辑应用,用于创建计划的计时器作业实例。 |
Azure AI Studio 基本设置 |
此模板集演示如何使用基本设置设置设置 Azure AI Studio,这意味着启用了公共 Internet 访问、Microsoft托管密钥进行加密和 AI 资源的Microsoft托管标识配置。 |
Azure AI Studio 基本设置 |
此模板集演示如何使用基本设置设置设置 Azure AI Studio,这意味着启用了公共 Internet 访问、Microsoft托管密钥进行加密和 AI 资源的Microsoft托管标识配置。 |
使用 Microsoft Entra ID 身份验证 |
此模板集演示如何为依赖资源(例如 Azure AI 服务和 Azure 存储)设置具有 Microsoft Entra ID 身份验证的 Azure AI Studio。 |
Azure AI Studio 网络受限 |
此模板集演示如何使用禁用专用链接和出口设置 Azure AI Studio,并使用Microsoft托管密钥进行加密和 AI 资源的Microsoft托管标识配置。 |
用户分配的标识角色分配模板 |
一个模板,用于在 Azure 机器学习工作区依赖的资源上创建用户分配的用户分配标识的角色分配 |
Azure 机器学习端到端安全设置 |
此 Bicep 模板集演示如何在安全设置中端到端设置 Azure 机器学习。 此参考实现包括工作区、计算群集、计算实例和附加的专用 AKS 群集。 |
Azure 机器学习端到端安全设置(旧版) |
此 Bicep 模板集演示如何在安全设置中端到端设置 Azure 机器学习。 此参考实现包括工作区、计算群集、计算实例和附加的专用 AKS 群集。 |
创建 Azure 机器学习扫描作业 |
此模板创建用于超参数优化的 Azure 机器学习扫描作业。 |
Azure AI Studio 网络受限 |
此模板集演示如何使用禁用专用链接和出口设置 Azure AI Studio,并使用Microsoft托管密钥进行加密和 AI 资源的Microsoft托管标识配置。 |
创建 Azure 机器学习服务工作区(vnet) |
此部署模板指定 Azure 机器学习工作区及其关联的资源,包括 Azure Key Vault、Azure 存储、Azure Application Insights 和 Azure 容器注册表。 此配置描述了在网络隔离设置中开始使用 Azure 机器学习所需的资源集。 |
创建 Azure 机器学习服务工作区(旧版) |
此部署模板指定 Azure 机器学习工作区及其关联的资源,包括 Azure Key Vault、Azure 存储、Azure Application Insights 和 Azure 容器注册表。 此配置描述了在网络隔离设置中开始使用 Azure 机器学习所需的资源集。 |
使用 SMB 卷 创建新的 ANF 资源 |
使用此模板,可以使用单个容量池和配置 SMB 协议的单个卷创建新的 Azure NetApp 文件资源。 |
为具有 IP 限制的 Web 应用 应用程序网关 |
此模板在 Azure Web 应用前创建应用程序网关,并在 Web 应用上启用了 IP 限制。 |
将 NSG 应用到现有子网 |
此模板将新创建的 NSG 应用到现有子网 |
使用流量分析 |
此模板使用流量分析在现有 NSG 上创建 NSG 流日志 |
将具有 Redis 安全规则的 NSG 添加到现有子网 |
此模板允许将具有预配置的 Azure Redis 缓存安全规则的 NSG 添加到 VNET 中的现有子网。 部署到现有 VNET 的资源组。 |
使用 ACR 任务 生成容器映像 |
此模板使用 DeploymentScript 来协调 ACR,以便从代码存储库生成容器映像。 |
将容器映像导入 ACR |
此模板利用 bicep 注册表中的 Import ACR 模块将公共容器映像导入 Azure 容器注册表。 |
使用证书创建应用程序网关 |
此模板演示如何生成 Key Vault 自签名证书,然后从应用程序网关引用。 |
创建 ssh 密钥并将其存储在 KeyVault |
此模板使用 deploymentScript 资源生成 ssh 密钥,并将私钥存储在 keyVault 中。 |
创建和部署 templateSpec |
此示例在同一模板中创建和部署 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 和 App |
创建 Azure 本机 New Relic 资源 |
此模板设置“Azure Native New Relic 服务”来监视 Azure 订阅中的资源。 |
Terraform (AzAPI 提供程序)资源定义
可以使用目标操作部署部署资源类型:
- 资源组
- 订阅
- 管理组
- 租户
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.Resources/deployments 资源,请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Resources/deployments@2024-03-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"
}
parameters = {
{customized property} = {
reference = {
keyVault = {
id = "string"
}
secretName = "string"
secretVersion = "string"
}
}
}
parametersLink = {
contentVersion = "string"
uri = "string"
}
templateLink = {
contentVersion = "string"
id = "string"
queryString = "string"
relativePath = "string"
uri = "string"
}
}
resourceGroup = "string"
subscriptionId = "string"
scope = "string"
})
}
属性值
部署
名字 | 描述 | 价值 |
---|---|---|
类型 | 资源类型 | “Microsoft.Resources/deployments@2024-03-01” |
名字 | 资源名称 | string (必需) 字符限制:1-64 有效字符: 字母数字、下划线、括号、连字符和句点。 |
位置 | 用于存储部署数据的位置。 | 字符串 |
parent_id | 若要部署到资源组,请使用该资源组的 ID。 若要部署到订阅,请使用该订阅的 ID。 若要部署到管理组,请使用该管理组的 ID。 若要部署到租户,请使用 / 。 |
string (必需) |
标签 | 部署标记 | 标记名称和值的字典。 |
性能 | 部署属性。 | DeploymentPropertiesOrDeploymentPropertiesExtended(必需) |
resourceGroup | 要部署到的资源组的名称。 如果未提供,请使用部署操作的资源组。 | 字符串 |
subscriptionId | 要部署到的订阅的 ID。 如果未提供,请使用部署操作的订阅。 | 字符串 |
DeploymentPropertiesOrDeploymentPropertiesExtended
名字 | 描述 | 价值 |
---|---|---|
debugSetting | 部署的调试设置。 | DebugSetting |
expressionEvaluationOptions | 指定模板表达式是在父模板或嵌套模板的范围内计算的。 仅适用于嵌套模板。 如果未指定,则默认值为外部值。 | ExpressionEvaluationOptions |
模式 | 用于部署资源的模式。 此值可以是增量值,也可以是“完成”。 在增量模式下,部署资源而不删除模板中不包含的现有资源。 在“完成”模式下,将部署资源,并删除模板中不包含的资源组中的现有资源。 使用“完成”模式时请注意,因为可能会无意中删除资源。 | “完成” “增量”(必需) |
onErrorDeployment | 错误行为的部署。 | OnErrorDeploymentOrOnErrorDeploymentExtended |
参数 | 定义模板部署参数的名称和值对。 如果要直接在请求中提供参数值,而不是链接到现有参数文件,请使用此元素。 使用 parametersLink 属性或 parameters 属性,但不能同时使用两者。 它可以是 JObject 或格式良好的 JSON 字符串。 | DeploymentPropertiesParameters |
parametersLink | 参数文件的 URI。 使用此元素链接到现有参数文件。 使用 parametersLink 属性或 parameters 属性,但不能同时使用两者。 | ParametersLink |
模板 | 模板内容。 如果要直接在请求中传递模板语法,而不是链接到现有模板,请使用此元素。 它可以是 JObject 或格式正确的 JSON 字符串。 使用 templateLink 属性或模板属性,但不能同时使用这两者。 | |
templateLink | 模板的 URI。 使用 templateLink 属性或模板属性,但不能同时使用这两者。 | TemplateLink |
DebugSetting
名字 | 描述 | 价值 |
---|---|---|
detailLevel | 指定要记录以供调试的信息的类型。 允许的值不为 none、requestContent、responseContent,或两者均用逗号分隔的 requestContent 和 responseContent。 默认值为 none。 设置此值时,请仔细考虑在部署期间传入的信息类型。 通过记录有关请求或响应的信息,可能会公开通过部署操作检索的敏感数据。 | 字符串 |
ExpressionEvaluationOptions
名字 | 描述 | 价值 |
---|---|---|
范围 | 用于计算嵌套模板中的参数、变量和函数的范围。 | “Inner” “NotSpecified” “Outer” |
OnErrorDeploymentOrOnErrorDeploymentExtended
名字 | 描述 | 价值 |
---|---|---|
deploymentName | 要用于错误案例的部署。 | 字符串 |
类型 | 错误行为类型的部署。 可能的值为 LastSuccessful 和 SpecificDeployment。 | “LastSuccessful” “SpecificDeployment” |
DeploymentPropertiesParameters
名字 | 描述 | 价值 |
---|---|---|
{自定义属性} | DeploymentParameter |
DeploymentParameter
名字 | 描述 | 价值 |
---|---|---|
参考 | Azure Key Vault 参数引用。 | KeyVaultParameterReference |
价值 | 参数的输入值。 |
KeyVaultParameterReference
名字 | 描述 | 价值 |
---|---|---|
keyVault | Azure Key Vault 参考。 | KeyVaultReference(必需) |
secretName | Azure Key Vault 机密名称。 | string (必需) |
secretVersion | Azure Key Vault 机密版本。 | 字符串 |
KeyVaultReference
名字 | 描述 | 价值 |
---|---|---|
id | Azure Key Vault 资源 ID。 | string (必需) |
ParametersLink
名字 | 描述 | 价值 |
---|---|---|
contentVersion | 如果包含,则必须匹配模板中的 ContentVersion。 | 字符串 |
uri | 参数文件的 URI。 | string (必需) |
TemplateLink
名字 | 描述 | 价值 |
---|---|---|
contentVersion | 如果包含,则必须匹配模板中的 ContentVersion。 | 字符串 |
id | 模板规格的资源 ID。请使用 ID 或 uri 属性,但不能同时使用这两个属性。 | 字符串 |
queryString | 要与 templateLink URI 一起使用的查询字符串(例如 SAS 令牌)。 | 字符串 |
relativePath | relativePath 属性可用于在相对于父级的位置部署链接模板。 如果父模板与 TemplateSpec 链接,则会引用 TemplateSpec 中的项目。 如果父级已链接到 URI,则子部署将是父 URI 和 relativePath URI 的组合 | 字符串 |
uri | 要部署的模板的 URI。 使用 URI 或 ID 属性,但不能同时使用这两个属性。 | 字符串 |