Azure Template client library for JavaScript - バージョン 1.0.0-beta.3

このプロジェクトは、Azure SDK for JavaScript のテンプレート パッケージとして使用されます。 これは、Azure SDK 開発者が新しいパッケージをブートストラップするのに役立つことを目的としており、Azure サービスのクライアント ライブラリのコードとドキュメントを整理する方法の例を提供します。

作業の開始

現在サポートされている環境

詳細については、 サポート ポリシー を参照してください。

前提条件

通常は、必要な Azure サービスをプロビジョニングするためのシェル コマンドをここに配置します。

@azure/template パッケージをインストールする

JavaScript のテンプレート クライアント ライブラリを npm でインストールします。

npm install @azure/template

ブラウザーのサポート

JavaScript バンドル

ブラウザーでこのクライアント ライブラリを使用するには、まず、バンドルを使用する必要があります。 これを行う方法の詳細については、バンドルドキュメントを参照してください。

CORS

ブラウザー用に開発する必要がある場合は、ストレージ アカウントの Cross-Origin Resource Sharing (CORS) ルールを設定する必要があります。 Azure portal と Azure Storage Explorer に移動し、ストレージ アカウントを見つけて、BLOB/キュー/ファイル/テーブル サービスの新しい CORS ルールを作成します。

たとえば、デバッグ用に次の CORS 設定を作成できます。 ただし、本番環境の要件に応じて設定を慎重にカスタマイズしてください。

  • 許可されるオリジン: *
  • 許可される動詞: DELETE、GET、HEAD、MERGE、POST、OPTIONS、PUT
  • 許可されるヘッダー: *
  • 公開ヘッダー: *
  • 最大経過時間(秒):86400

その他の例

トップレベルの例としては、通常、メインクライアントの作成や認証などが含まれます。 サービスが複数の認証手段 (e.g. key ベースと Azure Active Directory) をサポートしている場合は、それぞれに個別の例を示すことができます。

主な概念

ConfigurationClient

ここでは、主なクライアントについて説明してください。 それがどのような操作を行うことができるか、そして開発者がいつそれを使用したいかについて話してください。

その他の例

説明する最上位のサービス概念ごとにセクションを作成します。

Examples

最初の例

他のユーザーがライブラリを使用してサービスで共通のタスクを実行する方法について、いくつかのコード例を作成します。

Troubleshooting

伐採

ログ記録を有効にすると、エラーに関する有用な情報を明らかにするのに役立つ場合があります。 HTTP 要求と応答のログを表示するには、AZURE_LOG_LEVEL 環境変数を infoに設定します。 または、setLogLevelで @azure/logger を呼び出すことによって、実行時にログを有効にすることもできます。

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

setLogLevel("info");

ログを有効にする方法の詳細な手順については、 @azure/logger パッケージのドキュメントを参照してください。

次のステップ

クライアントライブラリの使い方を示す詳細な例があるsamplesディレクトリをご覧ください。

Contributing

このライブラリに投稿する場合は、コードをビルドしてテストする方法の詳細については、 投稿ガイド をお読みください。

  • Last updated on