使用 Azurite 模拟器进行本地 Azure 存储开发

Azurite 在 Visual Studio 2022 自动可用。 Azurite 可执行文件作为 Visual Studio 新版本发布的一部分进行更新。 如果运行的是早期版本的 Visual Studio，则可以使用节点包管理器 (npm) 或 DockerHub 或者通过克隆 Azurite GitHub 存储库来安装 Azurite。

在 Visual Studio Code 中，选择“扩展”图标并搜索“Azurite”。 选择“安装”按钮以安装 Azurite 扩展。

也可在浏览器中导航到 Visual Studio Code 扩展市场。 选择“安装”按钮打开 Visual Studio Code，并直接转到 Azurite 扩展页。

若要在 Visual Studio Code 中配置 Azurite 设置，请选择“扩展”图标。 为“Azurite”条目选择“管理”齿轮按钮。 选择“扩展设置”。

支持以下设置：

• azurite.blobHost - Blob 服务的侦听终结点。 默认设置为 127.0.0.1。

• azurite.blobPort - Blob 服务的侦听端口。 默认端口为 10000。

• azurite.queueHost - 队列服务的侦听终结点。 默认设置为 127.0.0.1。

• azurite.queuePort - 队列服务的侦听端口。 默认端口为 10001。

• azurite.tableHost - 表服务侦听终结点，默认设置是 127.0.0.1。

• azurite.tablePort - 表服务侦听端口，默认值是 10002。

• azurite.cert - 本地受信任 PEM 的路径或 PFX 证书文件路径，用于启用 HTTPS 模式。

• azurite.debug - 将调试日志输出到 Azurite 通道。 默认值是 false。

• azurite.key - 指向本地受信任 PEM 密钥文件的路径，当 Azurite: Cert 指向 PEM 文件时需要该路径。

• azurite.location - 工作区位置路径。 默认值为 Visual Studio Code 的工作文件夹。

• azurite.loose - 启用松散模式，将会忽略不受支持的标头和参数。

• azurite.oauth - 可选 OAuth 级别。

• azurite.pwd - PFX 文件的密码。 在“Azurite:证书”指向 PFX 文件时是必需的。

• azurite.silent - 无提示模式会禁用访问日志。 默认值是 false秒。

• azurite.skipApiVersionCheck - 跳过请求 API 版本检查。 默认值是 false秒。

• azurite.disableProductStyleUrl：强制从请求 URI 路径（而不是从请求 URI 主机）分析存储帐户名称。

此安装方法需要安装 Node.js 8.0 或更高版本。 Node 包管理器 (npm) 是每个 Node.js 安装随附的包管理工具。 安装 Node.js 后，请执行以下 npm 命令以安装 Azurite。

npm install -g azurite

使用以下命令通过 DockerHub 提取最新的 Azurite 映像：

docker pull mcr.microsoft.com/azure-storage/azurite

此安装方法需要安装 Git 和 Node.js 8.0 或更高版本。 使用以下控制台命令克隆 Azurite 项目的 GitHub 存储库。

git clone https://github.com/Azure/Azurite.git

克隆源代码后，从克隆的存储库的根目录执行以下命令，以生成并安装 Azurite。

npm install
npm run build
npm install -g

若要将 Azurite 与 Visual Studio 中的大多数项目类型一起使用，你首先需要运行 Azurite 可执行文件。 在可执行文件运行后，Azurite 将侦听来自应用程序的连接请求。 若要了解详细信息，请参阅从命令行运行 Azurite。

对于 Azure Functions 项目和 ASP.NET 项目，你可以选择将项目配置为自动启动 Azurite。 此配置是在项目设置过程中完成的。 虽然此项目配置会自动启动 Azurite，但 Visual Studio 不会公开详细的 Azurite 配置选项。 若要自定义详细的 Azurite 配置选项，请在启动 Visual Studio 之前运行 Azurite 可执行文件。

若要详细了解如何配置 Azure Functions 项目和 ASP.NET 项目以自动启动 Azurite，请参阅以下指南：

• 从 Azure Functions 项目运行 Azurite
• 从 ASP.NET 项目运行 Azurite

下表显示了在 Windows 计算机上运行的各个 Visual Studio 版本的 Azurite 可执行文件的位置：

你可以在 Visual Studio 安装的扩展文件夹中找到 Azurite 可执行文件，详见 Azurite 可执行文件位置表。

导航到相应的位置并启动 azurite.exe。 运行可执行文件后，Azurite 将侦听连接。

若要详细了解可用于配置 Azurite 的命令行选项，请参阅命令行选项。

在 Visual Studio 2022 中，创建一个 Azure Functions 项目。 设置项目选项时，请选中名为“将 Azurite 用于运行时存储帐户”的框。

创建项目后，Azurite 会自动启动。 Azurite 可执行文件位置表中详细介绍了 Azurite 可执行文件的位置。 输出类似于以下屏幕截图：

以后可以通过修改项目的连接的服务依赖项来更改此配置选项。

在 Visual Studio 2022 中，创建 ASP.NET Core Web App 项目。 然后打开“连接的服务”对话框，选择“添加服务依赖项”，然后选择“存储 Azurite 仿真器” 。

在“配置存储 Azurite 仿真器”对话框，将“连接字符串名称”字段设置为 StorageConnectionString，然后选择“完成” 。

配置完成后，选择“关闭”，Azurite 仿真器将自动启动。 Azurite 可执行文件位置表中详细介绍了 Azurite 可执行文件的位置。 输出类似于以下屏幕截图：

以后可以通过修改项目的连接的服务依赖项来更改此配置选项。

该 Azurite 扩展支持以下 Visual Studio Code 命令。 若要打开命令面板，请在 Visual Studio Code 中按 F1。

• Azurite:Clean - 重置所有 Azurite 服务永久性数据
• Azurite:Clean Blob Service - 清理 Blob 服务
• Azurite:Clean Queue Service - 清理队列服务
• Azurite: Clean Table Service - 清理表服务
• Azurite:Close - 关闭所有 Azurite 服务
• Azurite:Close Blob Service - 关闭 Blob 服务
• Azurite:Close Queue Service - 关闭队列服务
• Azurite: Close Table Service - 关闭表服务
• Azurite:Start - 启动所有 Azurite 服务
• Azurite:Start Blob Service - 启动 Blob 服务
• Azurite:Start Queue Service - 启动队列服务
• Azurite: Start Table Service - 启动表服务

发出以下命令启动 Azurite：

azurite --silent --location c:\azurite --debug c:\azurite\debug.log

此命令告知 Azurite 要将所有数据存储在特定目录 c:\azurite 中。 如果省略了 --location 选项，则它将使用当前工作目录。

运行 Azurite Docker 映像：

以下命令运行 Azurite Docker 映像。 -p 10000:10000 参数将来自主机端口 10000 的请求重定向到 Docker 实例。

docker run -p 10000:10000 -p 10001:10001 -p 10002:10002 \
    mcr.microsoft.com/azure-storage/azurite

指定工作区位置：

在以下示例中，-v c:/azurite:/data 参数指定“c:/azurite”作为 Azurite 永久性数据的位置。 必须在运行 Docker 命令之前创建目录“c:/azurite”。

docker run -p 10000:10000 -p 10001:10001 -p 10002:10002 \
    -v c:/azurite:/data mcr.microsoft.com/azure-storage/azurite

仅运行 blob 服务

docker run -p 10000:10000 mcr.microsoft.com/azure-storage/azurite \
    azurite-blob --blobHost 0.0.0.0 --blobPort 10000

若要详细了解如何在启动时配置 Azurite，请参阅命令行选项。

若要立即开始使用命令行，请创建名为 c:\azurite 的目录，然后发出以下命令以启动 Azurite：

azurite --silent --location c:\azurite --debug c:\azurite\debug.log

此命令告知 Azurite 要将所有数据存储在特定目录 c:\azurite 中。 如果省略了 --location 选项，则它将使用当前工作目录。

可选 - 默认情况下，Azurite 侦听本地服务器 127.0.0.1。 可根据需要使用 --blobHost 开关设置地址。

仅接受本地计算机上的请求：

azurite --blobHost 127.0.0.1

允许远程请求：

azurite --blobHost 0.0.0.0

可选 - 默认情况下，Azurite 侦听本地服务器 127.0.0.1。 可根据需要使用 --queueHost 开关设置地址。

仅接受本地计算机上的请求：

azurite --queueHost 127.0.0.1

允许远程请求：

azurite --queueHost 0.0.0.0

可选 - 默认情况下，Azurite 侦听本地服务器 127.0.0.1。 可根据需要使用 --tableHost 开关设置地址。

仅接受本地计算机上的请求：

azurite --tableHost 127.0.0.1

允许远程请求：

azurite --tableHost 0.0.0.0

可选 - 默认情况下，Azurite 在端口 10000 上侦听 blob 服务。 使用 --blobPort 开关可指定所需的侦听端口。

自定义 Blob 服务侦听端口：

azurite --blobPort 8888

让系统自动选择可用端口：

azurite --blobPort 0

Azurite 启动期间，会显示正在使用的端口。

可选 - 默认情况下，Azurite 在端口 10001 上侦听队列服务。 使用 --queuePort 开关可指定所需的侦听端口。

自定义队列服务侦听端口：

azurite --queuePort 8888

让系统自动选择可用端口：

azurite --queuePort 0

Azurite 启动期间，会显示正在使用的端口。

可选 - 默认情况下，Azurite 在端口 10002 上侦听表服务。 使用 --tablePort 开关可指定所需的侦听端口。

自定义表服务侦听端口：

azurite --tablePort 11111

让系统自动选择可用端口：

azurite --tablePort 0

Azurite 启动期间，会显示正在使用的端口。

要仅连接到 Blob 存储，连接字符串为：

DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=http://127.0.0.1:10000/devstoreaccount1;

要仅连接到队列存储，连接字符串为：

DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;QueueEndpoint=http://127.0.0.1:10001/devstoreaccount1;

要仅连接到表存储，连接字符串为：

DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;TableEndpoint=http://127.0.0.1:10002/devstoreaccount1;

若只使用 blob 服务，则 HTTPS 连接字符串为：

DefaultEndpointsProtocol=https;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=https://127.0.0.1:10000/devstoreaccount1;

若只使用队列服务，则 HTTPS 连接字符串为：

DefaultEndpointsProtocol=https;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;QueueEndpoint=https://127.0.0.1:10001/devstoreaccount1;

若只使用表服务，则 HTTPS 连接字符串为：

DefaultEndpointsProtocol=https;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;TableEndpoint=https://127.0.0.1:10002/devstoreaccount1;

若要与 Blob 存储资源进行交互，可以实例化 BlobContainerClient、BlobServiceClient 或 BlobClient。

以下示例演示如何使用三种不同的授权机制对 BlobContainerClient 对象进行授权：DefaultAzureCredential、连接字符串和共享密钥。 DefaultAzureCredential 提供基于持有者令牌的身份验证机制，并使用用于身份验证的凭据类型链。 进行身份验证后，此凭据会提供 OAuth 令牌作为客户端实例化的一部分。 有关详细信息，请参阅 DefaultAzureCredential 类引用。

// With container URL and DefaultAzureCredential
var client = new BlobContainerClient(
    new Uri("https://127.0.0.1:10000/devstoreaccount1/container-name"), new DefaultAzureCredential()
  );

// With connection string
var client = new BlobContainerClient(
    "DefaultEndpointsProtocol=https;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=https://127.0.0.1:10000/devstoreaccount1;", "container-name"
  );

// With account name and key
var client = new BlobContainerClient(
    new Uri("https://127.0.0.1:10000/devstoreaccount1/container-name"),
    new StorageSharedKeyCredential("devstoreaccount1", "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==")
  );

若要与队列存储资源进行交互，可以实例化 QueueClient 或 QueueServiceClient。

以下示例演示如何使用三种不同的授权机制来创建并对 QueueClient 对象进行授权：DefaultAzureCredential、连接字符串和共享密钥。 DefaultAzureCredential 提供基于持有者令牌的身份验证机制，并使用用于身份验证的凭据类型链。 进行身份验证后，此凭据会提供 OAuth 令牌作为客户端实例化的一部分。 有关详细信息，请参阅 DefaultAzureCredential 类引用。

// With queue URL and DefaultAzureCredential
var client = new QueueClient(
    new Uri("https://127.0.0.1:10001/devstoreaccount1/queue-name"), new DefaultAzureCredential()
  );

// With connection string
var client = new QueueClient(
    "DefaultEndpointsProtocol=https;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;QueueEndpoint=https://127.0.0.1:10001/devstoreaccount1;", "queue-name"
  );

// With account name and key
var client = new QueueClient(
    new Uri("https://127.0.0.1:10001/devstoreaccount1/queue-name"),
    new StorageSharedKeyCredential("devstoreaccount1", "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==")
  );

若要与表存储资源进行交互，可以实例化 TableClient 或 TableServiceClient。

以下示例演示如何使用三种不同的授权机制来创建并对 TableClient 对象进行授权：DefaultAzureCredential、连接字符串和共享密钥。 DefaultAzureCredential 提供基于持有者令牌的身份验证机制，并使用用于身份验证的凭据类型链。 进行身份验证后，此凭据会提供 OAuth 令牌作为客户端实例化的一部分。 有关详细信息，请参阅 DefaultAzureCredential 类引用。

// With table URL and DefaultAzureCredential
var client = new Client(
    new Uri("https://127.0.0.1:10002/devstoreaccount1/table-name"), new DefaultAzureCredential()
  );

// With connection string
var client = new TableClient(
    "DefaultEndpointsProtocol=https;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;TableEndpoint=https://127.0.0.1:10002/devstoreaccount1;", "table-name"
  );

// With account name and key
var client = new TableClient(
    new Uri("https://127.0.0.1:10002/devstoreaccount1/table-name"),
    new StorageSharedKeyCredential("devstoreaccount1", "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==")
  );