# @ediri/azapi 中文文档

规范地址：https://npmcn.com/package/%40ediri/azapi/

版本：1\.12\.2
npm 元数据更新时间：2024-05-11T13:03:34.145Z
中文译文更新时间：2026-11-13T06:58:28.108Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40ediri/azapi
原文对照：https://npmcn.com/package/%40ediri/azapi/?lang=original
项目主页：https://github.com/dirien/pulumi-azapi
源码仓库：https://github.com/dirien/pulumi-azapi

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

- 包体积（解压后）：196 kB，52 个文件
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2023-02-19T11:29:37.386Z
- 最新版本发布：2024-05-11T13:03:33.700Z
- 近 30 天下载量：36221（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 0 个）

## 中文简介

用于创建和管理 Azapi 资源的 Pulumi 软件包

## 安装

```sh
npm install @ediri/azapi
```

也可以使用：`pnpm add @ediri/azapi`、`yarn add @ediri/azapi`、`bun add @ediri/azapi`

## README

# AZAPI 资源提供者

![AzAPI](https://npmcn.com/package/%40ediri/azapi/img/azure.png)

AZAPI 资源提供者允许您管理 [阿扎皮尔](https://learn.microsoft.com/en-us/azure/developer/terraform/overview-azapi-provider) 资源.

## 安装

此软件包可用于几种语言/平台:

### 节点.js (JavaScript/TypeScript) (中文(简体) )

要从 JavaScript 或 TypeScript 在 Node.js 中使用, 请使用其中之一安装 `npm`数字 :

```bash
npm install @ediri/azapi
```

或者说 `yarn`数字 :

```bash
yarn add @ediri/azapi
```

### 蟒

要从 Python 中使用,请使用 `pip`数字 :

```bash
pip install ediri_azapi
```

### 走开

要从 Go 使用, 请使用 `go get` 以获取库的最新版本 :

```bash
go get github.com/dirien/pulumi-azapi/sdk
```

### . NET 网络

要使用.NET,请使用 `dotnet add package`数字 :

```bash
dotnet add package ediri.Azapi
```

## 配置

支持以下配置点 `AzAPI` 提供者 :

-   `ClientId` - (备选)应使用的客户身份。 这也可以来源于 `ARM_CLIENT_ID` 环境变量.
    
-   `Environment` - (可选)应该使用的云环境。 可能值为 `public`, (中文(简体) ), `usgovernment` 财务报告和审定财务报表 `china`默认为 `public`。也可以从 `ARM_ENVIRONMENT` 环境变量.
    
-   `SubscriptionId` - (备选)应使用的订阅ID。 这也可以来源于 `ARM_SUBSCRIPTION_ID` 环境变量.
    
-   `TenantId` - (可选)应使用房客身份证。 这也可以来源于 `ARM_TENANT_ID` 环境变量.
    

* * *

使用下列属性可以配置某些资源的行为:

-   `DefaultTags` - (可选的)标记绘图,该标记应作为默认标记分配给azure资源. `tags` 每个资源块可以覆盖 `default_tags`。 。 。 .
    
-   `DefaultLocation` - (可选) 默认的 Azure 区域应存在 Azure 资源 . `location` 每个资源块可以覆盖 `default_location`改变这种情况迫使创造出新的资源.
    

* * *

使用客户端证书认证为服务特等时,可设置以下字段:

-   `ClientCertificatePassword` - (可选) 与客户端证书相关的密码 。 这也可以来源于 `ARM_CLIENT_CERTIFICATE_PASSWORD` 环境变量.
    
-   `ClientCertificatePath` - (备选) 与服务特等相关的客户端证书的路径,应当使用. 这也可以来源于 `ARM_CLIENT_CERTIFICATE_PATH` 环境变量.
    

* * *

使用客户端机密认证为服务特等时,可以设置以下字段:

-   `ClientSecret` - (可选)客户端机密,应当使用。 这也可以来源于 `ARM_CLIENT_SECRET` 环境变量.

* * *

使用 Open ID 连接认证为服务特等时,可以设置以下字段:

-   `OidcRequestToken` - (备选) 向OIDC供应商提出请求的无记名代号. 这也可以来源于 `ARM_OIDC_REQUEST_TOKEN` 或者说 `ACTIONS_ID_TOKEN_REQUEST_TOKEN` 环境变量.
    
-   `OidcRequestUrl` - (备选) OIDC 提供方的 URL 请求标识符 。 这也可以来源于 `ARM_OIDC_REQUEST_URL` 或者说 `ACTIONS_ID_TOKEN_REQUEST_URL` 环境变量.
    
-   `OidcToken` - (可选)使用OpenID Connect(OIDC)认证时的ID符. 这也可以来源于 `ARM_OIDC_TOKEN` 环境变量.
    
-   `OidcTokenFilePath` - (可选) 使用 OpenID Connect(OIDC) 认证时包含有ID符的文件路径. 这也可以来源于 `ARM_OIDC_TOKEN_FILE_PATH` 环境变量.
    
-   `UseOidc` - (可选)OIDC是否应用于认证? 这也可以来源于 `ARM_USE_OIDC` 环境变量。 默认为 `false`。 。 。 .
    

* * *

对于一些先进的情景,例如需要更多颗粒权限的地方 - 可以设置以下属性:

-   `DisableCorrelationRequestId` - (可选) 禁用发送 `x-ms-correlation-request-id` 头曰. 这也可以来源于 `ARM_DISABLE_CORRELATION_REQUEST_ID` 环境变量。 默认为 `false`。 。 。 .
    
-   `DisableTerraformPartnerId` - (可选) 如果自定义, 则禁用发送 Terraform 伴侣 ID `partner_id` 没有指定,这使得微软能够更好地理解Terraform的使用. 合伙人ID不给HashiCorp任何直接的使用信息. 这也可以来源于 `ARM_DISABLE_TERRAFORM_PARTNER_ID` 环境变量。 默认为 `false`。 。 。 .
    
-   `PartnerId` - (可选)图形用户界面/用户界面 [登记](https://docs.microsoft.com/azure/marketplace/azure-partner-customer-usage-attribution#register-guids-and-offers) 与微软合作,促进合作伙伴资源使用归属. 这也可以来源于 `ARM_PARTNER_ID` 环境变量.
    
-   `SkipProviderRegistration` - (可选)提供者是否应当跳过注册其所支持的资源提供者? 这也可以来源于 `ARM_SKIP_PROVIDER_REGISTRATION` 环境变量。 默认为 `false`。 。 。 .
    

## 参考文献

详细参考文件请访问 [pulumi 登记册](https://www.pulumi.com/registry/packages/azapi/api-docs/)。 。 。 .

## 常见问题

### @ediri/azapi 是什么？

用于创建和管理 Azapi 资源的 Pulumi 软件包

### 如何安装 @ediri/azapi？

在项目目录运行 npm install @ediri/azapi，或使用 pnpm add / yarn add / bun add。

### @ediri/azapi 支持 TypeScript 吗？

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

### @ediri/azapi 可以商用吗？

@ediri/azapi 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @ediri/azapi 的下载量有多少？

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

### @ediri/azapi 还在维护吗？

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