更改日志
概览
亚美尼亚 帮助器(Helper)是Bake的一个实用插件,可以被成份用来方便地部署ARM模板.
使用量
要使用,请安装该工具,作为您配方的依赖性 .
npm i @azbake/arm-helper
ARM 帮助类
用于部署ARM模板和将烘焙参数转换为ARM模板参数的类别.
构造器
ARM 帮助( 文本)
职能
| 函数 | 说明 |
|---|---|
| 部署模板( 部署名称、 模板、 参数、 资源组) | 部署带有指定参数的指定的ARM模板. |
| BakeParamsTOARMPArams( 部署名称、 参数) | 将烘焙参数转换为ARM期望的ARM参数格式. |
构造细节
ARM 帮助( 文本)
new ARMHelper(context)
参数
| 参数 | 类型 | 所需经费 | 说明 |
|---|---|---|---|
context | 部署内容 | 对 | 当前烘焙部署背景 |
函数细节
部署模板( 部署名称、 模板、 参数、 资源组)
向指定的资源组部署带有指定参数的指定的ARM模板。 这是一个长期运行的函数,应该与 await 操作员.
public async DeployTemplate(deploymentName, template, params, resourceGroup)
参数
| 参数 | 类型 | 所需经费 | 说明 |
|---|---|---|---|
deploymentName | 字符串 | 对 | 阿祖尔的部署名称. |
template | 任意 | 对 | JSON 代表臂模板的对象 |
params | 任意 | 对 | JSON 对象代表ARM 模板中使用的参数 |
resourceGroup | 字符串 | 对 | ARM 模板将部署到 |
回返
Promise<void>
BakeParamsTOARMPArams( 部署名称、 参数)
读取 Bake 参数并将其转换为 ARM 模板参数可接受的值.
public BakeParamsToARMParams(deploymentName, params)
参数
| 参数 | 类型 | 所需经费 | 说明 |
|---|---|---|---|
deploymentName | 字符串 | 对 | Azure部署名称 |
params | Map<string, BakeVariable> | 对 | 参数传入成分中 |
回返
any
JSON 参数对象在部署时可以加载到ARM模板.
示例
import { BaseIngredient, IngredientManager } from "@azbake/core"
import { ARMHelper } from "@azbake/arm-helper"
import arm from "./arm.json"
export class MyIngredient extends BaseIngredient {
public async Execute(): Promise<void> {
const util = IngredientManager.getIngredientFunction("coreutils", this._ctx)
const helper = new ARMHelper(this._ctx)
const parameters = await helper.BakeParamsToARMParamsAsync(this._name, this._ingredient.properties.parameters)
await helper.DeployTemplate(this._name, arm, parameters, await util.resource_group())
}
}