你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
此项目用作 Azure SDK for JavaScript 的模板包。 它旨在帮助 Azure SDK 开发人员启动新包,并提供如何组织 Azure 服务的客户端库的代码和文档的示例。
入门
目前支持的环境
- Node.js的 LTS 版本
- Safari、Chrome、Edge 和 Firefox 的最新版本。
有关更多详细信息,请参阅我们的支持政策。
先决条件
通常,您会在此处放置一个 shell 命令来配置必要的 Azure 服务。
安装 @azure/template 包
使用以下命令 npm安装适用于 JavaScript 的模板客户端库:
npm install @azure/template
浏览器支持
JavaScript 捆绑包
若要在浏览器中使用此客户端库,首先需要使用捆绑程序。 有关如何执行此操作的详细信息,请参阅我们的 捆绑文档。
CORS
如果需要针对浏览器进行开发,则需要为存储帐户设置 跨域资源共享 (CORS) 规则。 转到 Azure 门户和 Azure 存储资源管理器,找到您的存储帐户,为 blob/queue/file/table 服务创建新的 CORS 规则。
例如,您可以创建以下 CORS 设置以进行调试。 但请根据你在生产环境中的要求仔细自定义设置。
- 允许的来源: *
- 允许的动词:DELETE、GET、HEAD、MERGE、POST、OPTIONS、PUT
- 允许的标头: *
- 公开的标头:*
- 最大使用期限(秒):86400
更多示例
顶级示例通常包括创建和验证主 Client 等内容。 如果您的服务支持多种身份验证方法(基于 e.g. key 和 Azure Active Directory),则可以单独提供每种方法的示例。
重要概念
ConfigurationClient
在此处描述您的主要客户。 讨论它可以执行哪些作以及开发人员何时希望使用它。
其他示例
为要解释的每个顶级服务概念创建一个部分。
示例
第一个例子
创建多个代码示例,说明某人如何使用您的库完成服务的常见任务。
Troubleshooting
Logging
启用日志记录可能有助于发现有关故障的有用信息。 若要查看 HTTP 请求和响应的日志,请将 AZURE_LOG_LEVEL 环境变量设置为 info。 或者,可以通过在 setLogLevel中调用 @azure/logger 在运行时启用日志记录:
import { setLogLevel } from "@azure/logger";
setLogLevel("info");
有关如何启用日志的更详细说明,可以查看 @azure/记录器包文档。
后续步骤
请查看 samples 目录,那里有详细示例,展示了如何使用客户端库。
Contributing
若要参与此库,请阅读 贡献指南 了解有关如何生成和测试代码的详细信息。