# @azure/synapse 中文文档

规范地址：https://npmcn.com/package/%40azure/synapse/

版本：1\.0\.0-preview\.1
npm 元数据更新时间：2026-03-19T19:53:29.880Z
中文译文更新时间：2026-11-07T20:10:56.357Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40azure/synapse
原文对照：https://npmcn.com/package/%40azure/synapse/?lang=original
项目主页：https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/synapse/synapse
源码仓库：https://github.com/Azure/azure-sdk-for-js

弃用说明：New packages available\.

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

- 包体积（解压后）：724 kB，79 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- 首次发布：2020-02-27T00:21:09.069Z
- 最新版本发布：2020-02-27T00:21:09.384Z
- 近 30 天下载量：2686（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：1（近 12 个月 0 个）

## 中文简介

SynapseClient 库中含有节点.js和浏览器的打字类型定义.

## 安装

```sh
npm install @azure/synapse
```

也可以使用：`pnpm add @azure/synapse`、`yarn add @azure/synapse`、`bun add @azure/synapse`

## README

## 用于 JavaScript 的 Azure SynapseClient SDK

这个软件包包含了SynapseClient的同位素SDK.

### 目前得到支持的环境

-   节点.js 6.x.x 或更高版本
-   浏览器 JavaScript

### 如何安装

```bash
npm install @azure/synapse
```

### 如何使用

#### nodejs - 认证,客户端创建并获得HistoryServerData监测,作为TypeScript所写的示例.

##### 安装 @ azure/ ms- rest- nodeaut

-   请安装最小版本 `"@azure/ms-rest-nodeauth": "^3.0.0"`。 。 。 .

```bash
npm install @azure/ms-rest-nodeauth@"^3.0.0"
```

##### 样本代码

```typescript
import * as msRest from "@azure/ms-rest-js";
import * as msRestAzure from "@azure/ms-rest-azure-js";
import * as msRestNodeAuth from "@azure/ms-rest-nodeauth";
import { SynapseClient, SynapseModels, SynapseMappers } from "@azure/synapse";
const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];

msRestNodeAuth.interactiveLogin().then((creds) => {
  const client = new SynapseClient(creds, subscriptionId);
  const workspaceName = "testworkspaceName";
  const poolName = "testpoolName";
  const livyId = "testlivyId";
  const appId = "testappId";
  const attemptId = "testattemptId";
  client.monitoring.getHistoryServerData(workspaceName, poolName, livyId, appId, attemptId).then((result) => {
    console.log("The result is:");
    console.log(result);
  });
}).catch((err) => {
  console.error(err);
});
```

#### 浏览器 - 认证,客户端创建和获取HistoryServerData 监视器,作为JavaScript所写的示例.

##### 安装 @azure/ ms- rest- browseauth

```bash
npm install @azure/ms-rest-browserauth
```

##### 样本代码

见 [https://github.com/Azure/ms-rest-browserauth 页面存档备份,存于互联网档案馆](https://github.com/Azure/ms-rest-browserauth) 在浏览器中学习如何认证给Azure.

-   索引.html

```html
<!DOCTYPE html>
<html lang="en">
  <head>
    <title>@azure/synapse sample</title>
    <script src="node_modules/@azure/ms-rest-js/dist/msRest.browser.js"></script>
    <script src="node_modules/@azure/ms-rest-azure-js/dist/msRestAzure.js"></script>
    <script src="node_modules/@azure/ms-rest-browserauth/dist/msAuth.js"></script>
    <script src="node_modules/@azure/synapse/dist/synapse.js"></script>
    <script type="text/javascript">
      const subscriptionId = "<Subscription_Id>";
      const authManager = new msAuth.AuthManager({
        clientId: "<client id for your Azure AD app>",
        tenant: "<optional tenant for your organization>"
      });
      authManager.finalizeLogin().then((res) => {
        if (!res.isLoggedIn) {
          // may cause redirects
          authManager.login();
        }
        const client = new Azure.Synapse.SynapseClient(res.creds, subscriptionId);
        const workspaceName = "testworkspaceName";
        const poolName = "testpoolName";
        const livyId = "testlivyId";
        const appId = "testappId";
        const attemptId = "testattemptId";
        client.monitoring.getHistoryServerData(workspaceName, poolName, livyId, appId, attemptId).then((result) => {
          console.log("The result is:");
          console.log(result);
        }).catch((err) => {
          console.log("An error occurred:");
          console.error(err);
        });
      });
    </script>
  </head>
  <body></body>
</html>
```

## 相关项目

-   [Microsoft Azure SDK 用于 Javascript](https://github.com/Azure/azure-sdk-for-js)

![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js/sdk/synapse/synapse/README.png)

## 常见问题

### @azure/synapse 是什么？

SynapseClient 库中含有节点\.js和浏览器的打字类型定义\.注意：该包已被作者标记为弃用——New packages available\.

### 如何安装 @azure/synapse？

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

### @azure/synapse 支持 TypeScript 吗？

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

### @azure/synapse 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @azure/synapse 可以商用吗？

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

### @azure/synapse 的下载量有多少？

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

### @azure/synapse 还在维护吗？

最新版本 1\.0\.0-preview\.1 发布于 2020/02/27（6 年前）；至今共发布 1 个版本，其中过去 12 个月发布了 0 个；首次发布于 2020/02/27。作者已将其标记为弃用，新项目建议寻找替代方案。

