JavaScript 用 Azure Template クライアント ライブラリ - バージョン 1.0.0-beta.1
このプロジェクトは、Azure SDK for JavaScript のテンプレート パッケージとして使用されます。 これは、Azure SDK 開発者が新しいパッケージをブートストラップするのを支援することを目的としており、Azure サービスのクライアント ライブラリのコードとドキュメントを整理する方法の例を提供します。
はじめに
現在サポートされている環境
- Node.js の LTS バージョン
- Safari、Chrome、Edge、Firefox の最新バージョン。
詳細については、Microsoft のサポート ポリシーを参照してください。
前提条件
通常は、必要な Azure サービスをプロビジョニングするためのシェル コマンドをここに配置します。
@azure/template
パッケージのインストール
を使用して JavaScript 用テンプレート クライアント ライブラリを npm
インストールします。
npm install @azure/template
ブラウザーのサポート
JavaScript バンドル
ブラウザーでこのクライアント ライブラリを使用するには、まず bundler を使用する必要があります。 これを行う方法の詳細については、 バンドルに関するドキュメントを参照してください。
CORS
ブラウザー用に開発する必要がある場合は、ストレージ アカウントの クロスオリジン リソース共有 (CORS) ルールを設定する必要があります。 Azure portalに移動してAzure Storage Explorer、ストレージ アカウントを見つけ、BLOB/キュー/ファイル/テーブル サービスの新しい CORS ルールを作成します。
たとえば、デバッグ用に次の CORS 設定を作成できます。 ただし、運用環境の要件に従って、設定を慎重にカスタマイズしてください。
- 許可される配信元: *
- 使用できる動詞: DELETE、GET、HEAD、MERGE、POST、OPTIONS、PUT
- 許可されるヘッダー: *
- 公開されているヘッダー: *
- 最大経過時間 (秒): 86400
その他の例
最上位の例には、通常、メイン クライアントの作成と認証などが含まれます。 サービスで複数の認証方法 (キーベースや Azure Active Directory など) がサポートされている場合は、それぞれの例を個別に指定できます。
主要な概念
ConfigurationClient
ここでプライマリ クライアントについて説明します。 実行できる操作と、開発者がそれを使用するタイミングについて説明します。
その他の例
説明する最上位レベルのサービス概念ごとにセクションを作成します。
例
最初の例
他のユーザーがライブラリを使用してサービスで共通のタスクを実行する方法について、いくつかのコード例を作成します。
トラブルシューティング
ログ記録
ログの記録を有効にすると、エラーに関する有用な情報を明らかにするのに役立つ場合があります。 HTTP 要求と応答のログを表示するには、環境変数 AZURE_LOG_LEVEL
を info
に設定します。 または、@azure/logger
で setLogLevel
を呼び出して、実行時にログ記録を有効にすることもできます。
const { setLogLevel } = require("@azure/logger");
setLogLevel("info");
ログを有効にする方法の詳細については、@azure/logger パッケージに関するドキュメントを参照してください。
次の手順
クライアント ライブラリの使用方法を示す詳細な例については、 samples ディレクトリを参照してください。
共同作成
このライブラリに投稿する場合、コードをビルドしてテストする方法の詳細については、投稿ガイドを参照してください。
関連プロジェクト
Azure SDK for JavaScript