你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Azure FileShares client library for JavaScript - version 1.0.0-beta.1

该包包含一个同构的 SDK（既能在 Node.js 上运行，也可在浏览器中运行），用于 FileShare 客户端Azure。

Azure File Shares Resource Provider API.

关键链接：

入门

当前支持的环境

详情请参见我们的支持政策。

先决条件

安装 @azure/arm-fileshares 包

安装JavaScript的Azure文件共享客户端库，npm：

npm install @azure/arm-fileshares

创建和验证 FileSharesClient

要创建客户端对象访问Azure FileShares API，你需要Azure FileShares资源的endpoint和一个credential。 Azure FileShares客户端可以使用Azure Active Directory凭证进行认证。 你可以在Azure 门户中找到你Azure文件共享资源的端点。

你可以用@azure/identity库中的凭据或现有的AAD令牌Azure Active Directory进行认证。

要使用下方显示的DefaultAzureCredential提供商，或Azure SDK附带的其他凭证提供商，请安装@azure/identity包：

npm install @azure/identity

你还需要注册一个新的AAD应用，并通过将合适的角色分配给服务主体，授予Azure FileShares的访问权限（注意：像"Owner"这样的角色不会授予必要的权限）。

如需了解如何创建Azure AD应用程序的更多信息，请访问本指南。

使用 Node.js 和类似 Node 的环境，可以使用 DefaultAzureCredential 类对客户端进行身份验证。

import { FileSharesClient } from "@azure/arm-fileshares";
import { DefaultAzureCredential } from "@azure/identity";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new FileSharesClient(new DefaultAzureCredential(), subscriptionId);

对于浏览器环境，使用InteractiveBrowserCredential包中的@azure/identity进行认证。

import { InteractiveBrowserCredential } from "@azure/identity";
import { FileSharesClient } from "@azure/arm-fileshares";

const credential = new InteractiveBrowserCredential({
  tenantId: "<YOUR_TENANT_ID>",
  clientId: "<YOUR_CLIENT_ID>",
});
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new FileSharesClient(credential, subscriptionId);

JavaScript 捆绑包

若要在浏览器中使用此客户端库，首先需要使用捆绑程序。 有关如何执行此作的详细信息，请参阅我们的 捆绑文档。

重要概念

文件共享客户端

FileSharesClient 是使用 Azure FileShares 客户端库开发者的主要接口。 探索该客户端对象的方法，以了解您可以访问的 Azure 文件共享服务的不同功能。

示例

获取文件共享

import { FileSharesClient } from "@azure/arm-fileshares";
import { DefaultAzureCredential } from "@azure/identity";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new FileSharesClient(new DefaultAzureCredential(), subscriptionId);
const result = await client.fileShares.get("myResourceGroup", "myFileShare");
console.log(result);

按订阅方式分配的列表文件

import { FileSharesClient } from "@azure/arm-fileshares";
import { DefaultAzureCredential } from "@azure/identity";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new FileSharesClient(new DefaultAzureCredential(), subscriptionId);
const shares = [];
for await (const item of client.fileShares.listBySubscription()) {
  shares.push(item);
}
console.log(shares);

创建或更新文件共享

import { FileSharesClient } from "@azure/arm-fileshares";
import { DefaultAzureCredential } from "@azure/identity";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new FileSharesClient(new DefaultAzureCredential(), subscriptionId);
const result = await client.fileShares.createOrUpdate("myResourceGroup", "myFileShare", {
  properties: {
    mountName: "myfileshare",
    mediaTier: "SSD",
    redundancy: "Local",
    protocol: "NFS",
    provisionedStorageGiB: 8,
  },
  location: "westus",
});
console.log(result);

故障排除

Logging

启用日志记录可能有助于发现有关故障的有用信息。 若要查看 HTTP 请求和响应的日志，请将 AZURE_LOG_LEVEL 环境变量设置为 info。 或者，可以通过在 setLogLevel中调用 @azure/logger 在运行时启用日志记录：

import { setLogLevel } from "@azure/logger";

setLogLevel("info");

有关如何启用日志的更详细说明，可以查看 @azure/记录器包文档。

后续步骤

请查看 samples 目录，了解如何使用该库的详细示例。

Contributing

若要参与此库，请阅读 参与指南 ，详细了解如何生成和测试代码。

  • Microsoft JavaScript0 Azure SDK
  • Last updated on