开始使用 Azure Blob 存储和 JavaScript 或 TypeScript

本文介绍如何使用适用于 TypeScript 的 Azure Blob 存储客户端库连接到 Azure Blob 存储。 连接后,使用开发人员指南来了解如何针对 Blob 存储服务的容器、blob 和功能运行代码。

若要从完整示例开始,请参阅适用于 JavaScriptTypeScript 的客户端库快速入门。

API 参考 | 包 (npm) | 库源代码 | 示例

先决条件

设置项目

本部分逐步指导如何准备一个项目,使其与适用于 JavaScript 的 Azure Blob 存储客户端库配合使用。

打开命令提示符,然后导航到项目文件夹。 将 <project-directory> 更改为你的文件夹名称:

cd <project-directory>

如果目录中没有 package.json 文件,请初始化项目以创建该文件:

npm init -y

从项目目录中,使用 npm installyarn add 命令安装 Azure Blob 存储和 Azure 标识客户端库的包。 与 Azure 服务建立无密码连接需要 @azure/identity 包

npm install @azure/storage-blob @azure/identity

授予访问权限并连接到 Blob 存储

若要将应用连接到 Blob 存储,请创建 BlobServiceClient 类的实例。 此对象是在存储帐户级别与数据资源交互的起点。 可以将其用于对存储账户及其容器执行操作。 还可以使用服务客户端创建容器客户端或 blob 客户端,具体取决于需要使用的资源。

若要详细了解如何创建和管理客户端对象(包括最佳做法),请参阅创建和管理与数据资源交互的客户端对象

你可以使用 Microsoft Entra 授权令牌、帐户访问密钥或共享访问签名 (SAS) 来为 BlobServiceClient 对象授权。 为了获得最佳安全性,Azure 建议尽可能使用具有托管标识的 Microsoft Entra ID 来授权针对 blob 数据的请求。 有关详细信息,请参阅使用 Microsoft Entra ID 授予对 blob 的访问权限

若要通过 Microsoft Entra ID 授权,需要使用安全主体。 需要哪种类型的安全主体取决于应用的运行位置。 使用下表作为指南:

应用的运行位置 安全主体 指南
本地计算机(开发和测试) 服务主体 若要了解如何注册应用、设置 Microsoft Entra 组、分配角色和配置环境变量,请参阅使用开发人员服务主体授权访问
本地计算机(开发和测试) 用户标识 若要了解如何设置 Microsoft Entra 组、分配角色和登录到 Azure,请参阅使用开发人员凭据授权访问
在 Azure 中托管 托管标识 若要了解如何启用托管标识和分配角色,请参阅使用托管标识授权从 Azure 托管应用访问
托管在 Azure 外部(例如本地应用) 服务主体 若要了解如何注册应用、分配角色和配置环境变量,请参阅使用应用程序服务主体授权从本地应用访问

使用 DefaultAzureCredential 授权访问

要授予访问权限并连接到 Blob 存储,一种简单且安全的方法是通过创建 DefaultAzureCredential 实例来获取 OAuth 令牌。 然后,你可以使用该凭据创建 BlobServiceClient 对象。

以下示例使用 DefaultAzureCredential 创建 BlobServiceClient 对象:

const accountName = "<account-name>";
const accountURL = `https://${accountName}.blob.core.chinacloudapi.cn`;
const blobServiceClient = new BlobServiceClient(
  accountURL,
  new DefaultAzureCredential()
);

此代码示例可用于 JavaScript 或 TypeScript 项目。

生成应用

在生成应用以使用 Azure Blob 存储中的数据资源时,代码主要与三种资源类型进行交互:存储帐户、容器和 Blob。 若要详细了解这些资源类型、它们彼此之间的关系以及应用如何与资源交互,请参阅了解应用如何与 Blob 存储数据资源交互

以下指南介绍了如何使用适用于 JavaScript 的 Azure 存储客户端库来访问数据和执行特定操作:

指南 说明
配置重试策略 针对客户端操作实施重试策略。
复制 blob 将 Blob 从一个位置移复制到另一个位置。
创建容器 创建 Blob 容器。
创建用户委托 SAS 为容器或 blob 创建用户委派 SAS。
创建和管理 Blob 租用 在 Blob 上建立和管理锁。
创建和管理容器租用 在容器上建立和管理锁。
删除和还原 删除 Blob 和还原已软删除的 Blob。
删除和还原容器 删除容器和还原已软删除的容器。
下载 blob 使用字符串、流和文件路径下载 Blob。
使用标记查找 Blob 设置和检索标记,以及使用标记来查找 Blob。
列出 Blob 以不同的方式列出 Blob。
列出容器 列出帐户中的容器以及可用于自定义列表的各个选项。
管理属性和元数据 (Blob) 获取和设置 Blob 的属性与元数据。
管理属性和元数据(容器) 获取和设置容器的属性与元数据。
优化数据传输性能 优化数据传输操作的性能。
设置或更改 blob 的访问层 设置或更改块 blob 的访问层。
上传 Blob 了解如何使用字符串、流、文件路径和其他方法上传 Blob。