JavaScript 用 Azure Open Energy Platform Management クライアント ライブラリ - バージョン 1.0.0-beta.3

  • [アーティクル]

このパッケージには、Azure Open Energy Platform Management クライアント用の同型 SDK (Node.js とブラウザーの両方で実行) が含まれています。

オープン エネルギー プラットフォーム管理サービス API

ソースコード | パッケージ (NPM) | API リファレンス ドキュメント | サンプル

はじめに

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

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

前提条件

@azure/arm-oep パッケージのインストール

を使用して、JavaScript 用の Azure Open Energy Platform Management クライアント ライブラリを npmインストールします。

npm install @azure/arm-oep

OpenEnergyPlatformManagementServiceAPIs を作成して認証する

Azure Open Energy Platform Management API にアクセスするためのクライアント オブジェクトを作成するには、Azure Open Energy Platform Management リソースの と credentialが必要endpointです。 Azure Open Energy Platform Management クライアントは、Azure Active Directory 資格情報を使用して認証できます。 Azure Portal で、Azure Open Energy Platform Management リソースのエンドポイントを見つけることができます。

@azure/ID ライブラリまたは既存の AAD トークンからの資格情報を使用して、Azure Active Directory で認証できます。

次に示す DefaultAzureCredential プロバイダー、または Azure SDK で提供されている他の資格情報プロバイダーを使用するには、パッケージを @azure/identity インストールしてください。

npm install @azure/identity

また、サービス プリンシパルに適切なロールを割り当てることで、 新しい AAD アプリケーションを登録し、Azure Open Energy Platform Management へのアクセス 権を付与する必要があります (注: などの "Owner" ロールでは、必要なアクセス許可は付与されません)。 AAD アプリケーションのクライアント ID、テナント ID、およびクライアント シークレットの値を、環境変数 AZURE_CLIENT_IDAZURE_TENANT_ID、、AZURE_CLIENT_SECRET、 として設定します。

Azure AD アプリケーションを作成する方法の詳細については、 こちらのガイドを参照してください。

const { OpenEnergyPlatformManagementServiceAPIs } = require("@azure/arm-oep");
const { DefaultAzureCredential } = require("@azure/identity");
// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.

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

// For client-side applications running in the browser, use this code instead:
// const credential = new InteractiveBrowserCredential({
//   tenantId: "<YOUR_TENANT_ID>",
//   clientId: "<YOUR_CLIENT_ID>"
// });
// const client = new OpenEnergyPlatformManagementServiceAPIs(credential, subscriptionId);

JavaScript バンドル

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

主要な概念

OpenEnergyPlatformManagementServiceAPIs

OpenEnergyPlatformManagementServiceAPIs は、Azure Open Energy Platform Management クライアント ライブラリを使用する開発者向けの主要なインターフェイスです。 このクライアント オブジェクトのメソッドを調べて、アクセスできる Azure Open Energy Platform Management サービスのさまざまな機能を理解します。

トラブルシューティング

ログの記録

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

const { setLogLevel } = require("@azure/logger");
setLogLevel("info");

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

次のステップ

このライブラリの使用方法の詳細な例については、 samples ディレクトリを参照してください。

共同作成

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

インプレッション数