# @azbake/arm-helper 中文文档

规范地址：https://npmcn.com/package/%40azbake/arm-helper/

版本：0\.1\.112
npm 元数据更新时间：2024-07-25T14:32:45.800Z
中文译文更新时间：2026-11-07T16:05:16.753Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40azbake/arm-helper
原文对照：https://npmcn.com/package/%40azbake/arm-helper/?lang=original
项目主页：https://github.com/HomecareHomebase/azure-bake
源码仓库：https://github.com/HomecareHomebase/azure-bake

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：51.6 kB，16 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@azbake/core \*，@azure/arm-resources \*
- 首次发布：2019-02-12T15:48:52.457Z
- 最新版本发布：2024-07-25T14:32:45.612Z
- 近 30 天下载量：5569（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：43（近 12 个月 0 个）

## 中文简介

通过 Bake 安装 ARM 模板的助手类 .

## 安装

```sh
npm install @azbake/arm-helper
```

也可以使用：`pnpm add @azbake/arm-helper`、`yarn add @azbake/arm-helper`、`bun add @azbake/arm-helper`

## README

## 更改日志

-   [@azbake/ arm- 帮助器](https://npmcn.com/package/%40azbake/arm-helper/CHANGELOG.md)

## 概览

亚美尼亚 帮助器(Helper)是Bake的一个实用插件,可以被成份用来方便地部署ARM模板.

## 使用量

要使用,请安装该工具,作为您配方的依赖性 .

```bash
  npm i @azbake/arm-helper
```

## ARM 帮助类

用于部署ARM模板和将烘焙参数转换为ARM模板参数的类别.

### 构造器

ARM 帮助( 文本)

### 职能

| 函数 | 说明 |
| --- | --- |
| 部署模板( 部署名称、 模板、 参数、 资源组) | 部署带有指定参数的指定的ARM模板. |
| BakeParamsTOARMPArams( 部署名称、 参数) | 将烘焙参数转换为ARM期望的ARM参数格式. |

### 构造细节

#### ARM 帮助( 文本)

```typescript
new ARMHelper(context)
```

##### 参数

| 参数 | 类型 | 所需经费 | 说明 |
| --- | --- | --- | --- |
| `context` | 部署内容 | 对 | 当前烘焙部署背景 |

### 函数细节

#### 部署模板( 部署名称、 模板、 参数、 资源组)

向指定的资源组部署带有指定参数的指定的ARM模板。 这是一个长期运行的函数,应该与 `await` 操作员.

```typescript
public async DeployTemplate(deploymentName, template, params, resourceGroup)
```

##### 参数

| 参数 | 类型 | 所需经费 | 说明 |
| --- | --- | --- | --- |
| `deploymentName` | 字符串 | 对 | 阿祖尔的部署名称. |
| `template` | 任意 | 对 | JSON 代表臂模板的对象 |
| `params` | 任意 | 对 | JSON 对象代表ARM 模板中使用的参数 |
| `resourceGroup` | 字符串 | 对 | ARM 模板将部署到 |

##### 回返

`Promise<void>`

#### BakeParamsTOARMPArams( 部署名称、 参数)

读取 Bake 参数并将其转换为 ARM 模板参数可接受的值.

```typescript
public BakeParamsToARMParams(deploymentName, params)
```

##### 参数

| 参数 | 类型 | 所需经费 | 说明 |
| --- | --- | --- | --- |
| `deploymentName` | 字符串 | 对 | Azure部署名称 |
| `params` | `Map<string, BakeVariable>` | 对 | 参数传入成分中 |

##### 回返

`any`

JSON 参数对象在部署时可以加载到ARM模板.

## 示例

```typescript
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())
  }
}

```

## 常见问题

### @azbake/arm-helper 是什么？

通过 Bake 安装 ARM 模板的助手类 \.

### 如何安装 @azbake/arm-helper？

在项目目录运行 npm install @azbake/arm-helper，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@azbake/core（\*）、@azure/arm-resources（\*）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @azbake/arm-helper 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @azbake/arm-helper 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @azbake/arm-helper 可以商用吗？

@azbake/arm-helper 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @azbake/arm-helper 的下载量有多少？

根据 npm 官方下载统计，@azbake/arm-helper 在 2026/10/08 – 2026/11/06 这 30 天内被下载 5,569 次，日均约 186 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @azbake/arm-helper 还在维护吗？

最新版本 0\.1\.112 发布于 2024/07/25（2 年前）；至今共发布 43 个版本，其中过去 12 个月发布了 0 个；首次发布于 2019/02/12。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。